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 #ifdef _KERNEL
  46
  47 /*
  48  * Define a set for pcpu data.
  49  */
  50 extern uintptr_t *__start_set_pcpu;
  51 __GLOBL(__start_set_pcpu);
  52 extern uintptr_t *__stop_set_pcpu;
  53 __GLOBL(__stop_set_pcpu);
  54
  55 /*
  56  * Array of dynamic pcpu base offsets.  Indexed by id.
  57  */
  58 extern uintptr_t dpcpu_off[];
  59
  60 /*
  61  * Convenience defines.
  62  */
  63 #define DPCPU_START             ((uintptr_t)&__start_set_pcpu)
  64 #define DPCPU_STOP              ((uintptr_t)&__stop_set_pcpu)
  65 #define DPCPU_BYTES             (DPCPU_STOP - DPCPU_START)
  66 #define DPCPU_MODMIN            2048
  67 #define DPCPU_SIZE              roundup2(DPCPU_BYTES, PAGE_SIZE)
  68 #define DPCPU_MODSIZE           (DPCPU_SIZE - (DPCPU_BYTES - DPCPU_MODMIN))
  69
  70 /*
  71  * Declaration and definition.
  72  */
  73 #define DPCPU_NAME(n)           pcpu_entry_##n
  74 #define DPCPU_DECLARE(t, n)     extern t DPCPU_NAME(n)
  75 #define DPCPU_DEFINE(t, n)      t DPCPU_NAME(n) __section("set_pcpu") __used
  76
  77 /*
  78  * Accessors with a given base.
  79  */
  80 #define _DPCPU_PTR(b, n)                                                \
  81     (__typeof(DPCPU_NAME(n))*)((b) + (uintptr_t)&DPCPU_NAME(n))
  82 #define _DPCPU_GET(b, n)        (*_DPCPU_PTR(b, n))
  83 #define _DPCPU_SET(b, n, v)     (*_DPCPU_PTR(b, n) = v)
  84
  85 /*
  86  * Accessors for the current cpu.
  87  */
  88 #define DPCPU_PTR(n)            _DPCPU_PTR(PCPU_GET(dynamic), n)
  89 #define DPCPU_GET(n)            (*DPCPU_PTR(n))
  90 #define DPCPU_SET(n, v)         (*DPCPU_PTR(n) = v)
  91
  92 /*
  93  * Accessors for remote cpus.
  94  */
  95 #define DPCPU_ID_PTR(i, n)      _DPCPU_PTR(dpcpu_off[(i)], n)
  96 #define DPCPU_ID_GET(i, n)      (*DPCPU_ID_PTR(i, n))
  97 #define DPCPU_ID_SET(i, n, v)   (*DPCPU_ID_PTR(i, n) = v)
  98
  99 /*
 100  * Utility macros.
 101  */
 102 #define DPCPU_SUM(n) __extension__                                      \
 103 ({                                                                      \
 104         u_int _i;                                                       \
 105         __typeof(*DPCPU_PTR(n)) sum;                                    \
 106                                                                         \
 107         sum = 0;                                                        \
 108         CPU_FOREACH(_i) {                                               \
 109                 sum += *DPCPU_ID_PTR(_i, n);                            \
 110         }                                                               \
 111         sum;                                                            \
 112 })
 113
 114 #define DPCPU_VARSUM(n, var) __extension__                              \
 115 ({                                                                      \
 116         u_int _i;                                                       \
 117         __typeof((DPCPU_PTR(n))->var) sum;                              \
 118                                                                         \
 119         sum = 0;                                                        \
 120         CPU_FOREACH(_i) {                                               \
 121                 sum += (DPCPU_ID_PTR(_i, n))->var;                      \
 122         }                                                               \
 123         sum;                                                            \
 124 })
 125
 126 #define DPCPU_ZERO(n) do {                                              \
 127         u_int _i;                                                       \
 128                                                                         \
 129         CPU_FOREACH(_i) {                                               \
 130                 bzero(DPCPU_ID_PTR(_i, n), sizeof(*DPCPU_PTR(n)));      \
 131         }                                                               \
 132 } while(0)
 133
 134 #endif /* _KERNEL */
 135
 136 /*
 137  * XXXUPS remove as soon as we have per cpu variable
 138  * linker sets and can define rm_queue in _rm_lock.h
 139  */
 140 struct rm_queue {
 141         struct rm_queue* volatile rmq_next;
 142         struct rm_queue* volatile rmq_prev;
 143 };
 144
 145 #define PCPU_NAME_LEN (sizeof("CPU ") + sizeof(__XSTRING(MAXCPU) + 1))
 146
 147 /*
 148  * This structure maps out the global data that needs to be kept on a
 149  * per-cpu basis.  The members are accessed via the PCPU_GET/SET/PTR
 150  * macros defined in <machine/pcpu.h>.  Machine dependent fields are
 151  * defined in the PCPU_MD_FIELDS macro defined in <machine/pcpu.h>.
 152  */
 153 struct pcpu {
 154         struct thread   *pc_curthread;          /* Current thread */
 155         struct thread   *pc_idlethread;         /* Idle thread */
 156         struct thread   *pc_fpcurthread;        /* Fp state owner */
 157         struct thread   *pc_deadthread;         /* Zombie thread or NULL */
 158         struct pcb      *pc_curpcb;             /* Current pcb */
 159         uint64_t        pc_switchtime;          /* cpu_ticks() at last csw */
 160         int             pc_switchticks;         /* `ticks' at last csw */
 161         u_int           pc_cpuid;               /* This cpu number */
 162         cpumask_t       pc_cpumask;             /* This cpu mask */
 163         cpumask_t       pc_other_cpus;          /* Mask of all other cpus */
 164         SLIST_ENTRY(pcpu) pc_allcpu;
 165         struct lock_list_entry *pc_spinlocks;
 166 #ifdef KTR
 167         char            pc_name[PCPU_NAME_LEN]; /* String name for KTR */
 168 #endif
 169         struct vmmeter  pc_cnt;                 /* VM stats counters */
 170         long            pc_cp_time[CPUSTATES];  /* statclock ticks */
 171         struct device   *pc_device;
 172         void            *pc_netisr;             /* netisr SWI cookie */
 173
 174         /*
 175          * Stuff for read mostly lock
 176          *
 177          * XXXUPS remove as soon as we have per cpu variable
 178          * linker sets.
 179          */
 180         struct rm_queue pc_rm_queue;
 181
 182         uintptr_t       pc_dynamic;             /* Dynamic per-cpu data area */
 183
 184         /*
 185          * Keep MD fields last, so that CPU-specific variations on a
 186          * single architecture don't result in offset variations of
 187          * the machine-independent fields of the pcpu.  Even though
 188          * the pcpu structure is private to the kernel, some ports
 189          * (e.g., lsof, part of gtop) define _KERNEL and include this
 190          * header.  While strictly speaking this is wrong, there's no
 191          * reason not to keep the offsets of the MI fields constant
 192          * if only to make kernel debugging easier.
 193          */
 194         PCPU_MD_FIELDS;
 195 } __aligned(128);
 196
 197 #ifdef _KERNEL
 198
 199 SLIST_HEAD(cpuhead, pcpu);
 200
 201 extern struct cpuhead cpuhead;
 202 extern struct pcpu *cpuid_to_pcpu[MAXCPU];
 203
 204 #define curcpu          PCPU_GET(cpuid)
 205 #define curproc         (curthread->td_proc)
 206 #ifndef curthread
 207 #define curthread       PCPU_GET(curthread)
 208 #endif
 209 #define curvidata       PCPU_GET(vidata)
 210
 211 /*
 212  * Machine dependent callouts.  cpu_pcpu_init() is responsible for
 213  * initializing machine dependent fields of struct pcpu, and
 214  * db_show_mdpcpu() is responsible for handling machine dependent
 215  * fields for the DDB 'show pcpu' command.
 216  */
 217 void    cpu_pcpu_init(struct pcpu *pcpu, int cpuid, size_t size);
 218 void    db_show_mdpcpu(struct pcpu *pcpu);
 219
 220 void    *dpcpu_alloc(int size);
 221 void    dpcpu_copy(void *s, int size);
 222 void    dpcpu_free(void *s, int size);
 223 void    dpcpu_init(void *dpcpu, int cpuid);
 224 void    pcpu_destroy(struct pcpu *pcpu);
 225 struct  pcpu *pcpu_find(u_int cpuid);
 226 void    pcpu_init(struct pcpu *pcpu, int cpuid, size_t size);
 227
 228 #endif /* _KERNEL */
 229
 230 #endif /* !_SYS_PCPU_H_ */