sys/sys/pcpu.h

   1 /*-
   2  * Copyright (c) 2001 Wind River Systems, Inc.
   3  * All rights reserved.
   4  * Written by: John Baldwin <jhb@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 4. Neither the name of the author nor the names of any co-contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_PCPU_H_
  34 #define _SYS_PCPU_H_
  35
  36 #ifdef LOCORE
  37 #error "no assembler-serviceable parts inside"
  38 #endif
  39
  40 #include <sys/queue.h>
  41 #include <sys/vmmeter.h>
  42 #include <sys/resource.h>
  43 #include <machine/pcpu.h>
  44
  45 struct pcb;
  46 struct thread;
  47
  48 /*
  49  * Define a set for pcpu data.
  50  *
  51  * We don't use SET_DECLARE because it defines the set as 'a' when we
  52  * want 'aw'.  GCC considers uninitialized data in a seperate section
  53  * writable and there is no generic zero initializer that works for
  54  * structs and scalars.
  55  */
  56 extern uintptr_t *__start_set_pcpu;
  57 extern uintptr_t *__stop_set_pcpu;
  58
  59 __asm__(
  60 #if defined(__arm__)
  61         ".section set_pcpu, \"aw\", %progbits\n"
  62 #else
  63         ".section set_pcpu, \"aw\", @progbits\n"
  64 #endif
  65         "\t.p2align " __XSTRING(CACHE_LINE_SHIFT) "\n"
  66         "\t.previous");
  67
  68 /*
  69  * Array of dynamic pcpu base offsets.  Indexed by id.
  70  */
  71 extern uintptr_t dpcpu_off[];
  72
  73 /*
  74  * Convenience defines.
  75  */
  76 #define DPCPU_START             (uintptr_t)&__start_set_pcpu
  77 #define DPCPU_STOP              (uintptr_t)&__stop_set_pcpu
  78 #define DPCPU_BYTES             (DPCPU_STOP - DPCPU_START)
  79 #define DPCPU_MODMIN            2048
  80 #define DPCPU_SIZE              roundup2(DPCPU_BYTES, PAGE_SIZE)
  81 #define DPCPU_MODSIZE           (DPCPU_SIZE - (DPCPU_BYTES - DPCPU_MODMIN))
  82
  83 /*
  84  * Declaration and definition.
  85  */
  86 #define DPCPU_NAME(n)           pcpu_entry_##n
  87 #define DPCPU_DECLARE(t, n)     extern t DPCPU_NAME(n)
  88 #define DPCPU_DEFINE(t, n)      t DPCPU_NAME(n) __section("set_pcpu") __used
  89
  90 /*
  91  * Accessors with a given base.
  92  */
  93 #define _DPCPU_PTR(b, n)                                                \
  94     (__typeof(DPCPU_NAME(n))*)((b) + (uintptr_t)&DPCPU_NAME(n))
  95 #define _DPCPU_GET(b, n)        (*_DPCPU_PTR(b, n))
  96 #define _DPCPU_SET(b, n, v)     (*_DPCPU_PTR(b, n) = v)
  97
  98 /*
  99  * Accessors for the current cpu.
 100  */
 101 #define DPCPU_PTR(n)            _DPCPU_PTR(PCPU_GET(dynamic), n)
 102 #define DPCPU_GET(n)            (*DPCPU_PTR(n))
 103 #define DPCPU_SET(n, v)         (*DPCPU_PTR(n) = v)
 104
 105 /*
 106  * Accessors for remote cpus.
 107  */
 108 #define DPCPU_ID_PTR(i, n)      _DPCPU_PTR(dpcpu_off[(i)], n)
 109 #define DPCPU_ID_GET(i, n)      (*DPCPU_ID_PTR(i, n))
 110 #define DPCPU_ID_SET(i, n, v)   (*DPCPU_ID_PTR(i, n) = v)
 111
 112 /*
 113  * XXXUPS remove as soon as we have per cpu variable
 114  * linker sets and  can define rm_queue in _rm_lock.h
 115 */
 116 struct rm_queue {
 117         struct rm_queue* volatile rmq_next;
 118         struct rm_queue* volatile rmq_prev;
 119 };
 120
 121 #define PCPU_NAME_LEN (sizeof("CPU ") + sizeof(__XSTRING(MAXCPU) + 1))
 122
 123
 124 /*
 125  * This structure maps out the global data that needs to be kept on a
 126  * per-cpu basis.  The members are accessed via the PCPU_GET/SET/PTR
 127  * macros defined in <machine/pcpu.h>.  Machine dependent fields are
 128  * defined in the PCPU_MD_FIELDS macro defined in <machine/pcpu.h>.
 129  */
 130 struct pcpu {
 131         struct thread   *pc_curthread;          /* Current thread */
 132         struct thread   *pc_idlethread;         /* Idle thread */
 133         struct thread   *pc_fpcurthread;        /* Fp state owner */
 134         struct thread   *pc_deadthread;         /* Zombie thread or NULL */
 135         struct pcb      *pc_curpcb;             /* Current pcb */
 136         uint64_t        pc_switchtime;
 137         int             pc_switchticks;
 138         u_int           pc_cpuid;               /* This cpu number */
 139         cpumask_t       pc_cpumask;             /* This cpu mask */
 140         cpumask_t       pc_other_cpus;          /* Mask of all other cpus */
 141         SLIST_ENTRY(pcpu) pc_allcpu;
 142         struct lock_list_entry *pc_spinlocks;
 143 #ifdef KTR
 144         char            pc_name[PCPU_NAME_LEN]; /* String name for KTR. */
 145 #endif
 146         struct vmmeter  pc_cnt;                 /* VM stats counters */
 147         long            pc_cp_time[CPUSTATES];  /* statclock ticks */
 148         struct device   *pc_device;
 149         void            *pc_netisr;             /* netisr SWI cookie. */
 150
 151         /*
 152          * Stuff for read mostly lock
 153          *
 154          * XXXUPS remove as soon as we have per cpu variable
 155          * linker sets.
 156          */
 157         struct rm_queue  pc_rm_queue;
 158
 159         /*
 160          * Dynamic per-cpu data area.
 161          */
 162         uintptr_t       pc_dynamic;
 163
 164         /*
 165          * Keep MD fields last, so that CPU-specific variations on a
 166          * single architecture don't result in offset variations of
 167          * the machine-independent fields of the pcpu. Even though
 168          * the pcpu structure is private to the kernel, some ports
 169          * (e.g. lsof, part of gtop) define _KERNEL and include this
 170          * header. While strictly speaking this is wrong, there's no
 171          * reason not to keep the offsets of the MI fields contants.
 172          * If only to make kernel debugging easier...
 173          */
 174         PCPU_MD_FIELDS;
 175 } __aligned(128);
 176
 177 #ifdef _KERNEL
 178
 179 SLIST_HEAD(cpuhead, pcpu);
 180
 181 extern struct cpuhead cpuhead;
 182
 183 #define curcpu          PCPU_GET(cpuid)
 184 #define curproc         (curthread->td_proc)
 185 #ifndef curthread
 186 #define curthread       PCPU_GET(curthread)
 187 #endif
 188 #define curvidata       PCPU_GET(vidata)
 189
 190 /*
 191  * Machine dependent callouts.  cpu_pcpu_init() is responsible for
 192  * initializing machine dependent fields of struct pcpu, and
 193  * db_show_mdpcpu() is responsible for handling machine dependent
 194  * fields for the DDB 'show pcpu' command.
 195  */
 196
 197 extern struct pcpu *cpuid_to_pcpu[MAXCPU];
 198
 199
 200 void    cpu_pcpu_init(struct pcpu *pcpu, int cpuid, size_t size);
 201 void    db_show_mdpcpu(struct pcpu *pcpu);
 202
 203 void    pcpu_destroy(struct pcpu *pcpu);
 204 struct  pcpu *pcpu_find(u_int cpuid);
 205 void    pcpu_init(struct pcpu *pcpu, int cpuid, size_t size);
 206 void    *dpcpu_alloc(int size);
 207 void    dpcpu_copy(void *s, int size);
 208 void    dpcpu_free(void *s, int size);
 209 void    dpcpu_init(void *dpcpu, int cpuid);
 210
 211 #endif  /* _KERNEL */
 212
 213 #endif /* !_SYS_PCPU_H_ */