sys/i386/include/pcpu.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) Peter Wemm
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _MACHINE_PCPU_H_
  32 #define _MACHINE_PCPU_H_
  33
  34 #ifndef _SYS_CDEFS_H_
  35 #error "sys/cdefs.h is a prerequisite for this file"
  36 #endif
  37
  38 #include <machine/segments.h>
  39 #include <machine/tss.h>
  40
  41 #include <sys/_lock.h>
  42 #include <sys/_mutex.h>
  43
  44 /*
  45  * The SMP parts are setup in pmap.c and machdep.c for the BSP, and
  46  * pmap.c and mp_machdep.c sets up the data for the AP's to "see" when
  47  * they awake.  The reason for doing it via a struct is so that an
  48  * array of pointers to each CPU's data can be set up for things like
  49  * "check curproc on all other processors"
  50  */
  51
  52 #define PCPU_MD_FIELDS                                                  \
  53         char    pc_monitorbuf[128] __aligned(128); /* cache line */     \
  54         struct  pcpu *pc_prvspace;      /* Self-reference */            \
  55         struct  pmap *pc_curpmap;                                       \
  56         struct  segment_descriptor pc_common_tssd;                      \
  57         struct  segment_descriptor *pc_tss_gdt;                         \
  58         struct  segment_descriptor *pc_fsgs_gdt;                        \
  59         struct  i386tss *pc_common_tssp;                                \
  60         u_int   pc_kesp0;                                               \
  61         u_int   pc_trampstk;                                            \
  62         int     pc_currentldt;                                          \
  63         u_int   pc_acpi_id;             /* ACPI CPU id */               \
  64         u_int   pc_apic_id;                                             \
  65         int     pc_private_tss;         /* Flag indicating private tss*/\
  66         u_int   pc_cmci_mask;           /* MCx banks for CMCI */        \
  67         u_int   pc_vcpu_id;             /* Xen vCPU ID */               \
  68         struct  mtx pc_cmap_lock;                                       \
  69         void    *pc_cmap_pte1;                                          \
  70         void    *pc_cmap_pte2;                                          \
  71         caddr_t pc_cmap_addr1;                                          \
  72         caddr_t pc_cmap_addr2;                                          \
  73         vm_offset_t pc_qmap_addr;       /* KVA for temporary mappings */\
  74         vm_offset_t pc_copyout_maddr;                                   \
  75         vm_offset_t pc_copyout_saddr;                                   \
  76         struct  mtx pc_copyout_mlock;                                   \
  77         struct  sx pc_copyout_slock;                                    \
  78         char    *pc_copyout_buf;                                        \
  79         vm_offset_t pc_pmap_eh_va;                                      \
  80         caddr_t pc_pmap_eh_ptep;                                                \
  81         uint32_t pc_smp_tlb_done;       /* TLB op acknowledgement */    \
  82         uint32_t pc_ibpb_set;                                           \
  83         char    __pad[538]
  84
  85 #ifdef _KERNEL
  86
  87 #if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
  88
  89 /*
  90  * Evaluates to the byte offset of the per-cpu variable name.
  91  */
  92 #define __pcpu_offset(name)                                             \
  93         __offsetof(struct pcpu, name)
  94
  95 /*
  96  * Evaluates to the type of the per-cpu variable name.
  97  */
  98 #define __pcpu_type(name)                                               \
  99         __typeof(((struct pcpu *)0)->name)
 100
 101 /*
 102  * Evaluates to the address of the per-cpu variable name.
 103  */
 104 #define __PCPU_PTR(name) __extension__ ({                               \
 105         __pcpu_type(name) *__p;                                         \
 106                                                                         \
 107         __asm __volatile("movl %%fs:%1,%0; addl %2,%0"                  \
 108             : "=r" (__p)                                                \
 109             : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),       \
 110               "i" (__pcpu_offset(name)));                               \
 111                                                                         \
 112         __p;                                                            \
 113 })
 114
 115 /*
 116  * Evaluates to the value of the per-cpu variable name.
 117  */
 118 #define __PCPU_GET(name) __extension__ ({                               \
 119         __pcpu_type(name) __res;                                        \
 120         struct __s {                                                    \
 121                 u_char  __b[MIN(sizeof(__res), 4)];                     \
 122         } __s;                                                          \
 123                                                                         \
 124         if (sizeof(__res) == 1 || sizeof(__res) == 2 ||                 \
 125             sizeof(__res) == 4) {                                       \
 126                 __asm __volatile("mov %%fs:%1,%0"                       \
 127                     : "=r" (__s)                                        \
 128                     : "m" (*(struct __s *)(__pcpu_offset(name))));      \
 129                 *(struct __s *)(void *)&__res = __s;                    \
 130         } else {                                                        \
 131                 __res = *__PCPU_PTR(name);                              \
 132         }                                                               \
 133         __res;                                                          \
 134 })
 135
 136 /*
 137  * Adds a value of the per-cpu counter name.  The implementation
 138  * must be atomic with respect to interrupts.
 139  */
 140 #define __PCPU_ADD(name, val) do {                                      \
 141         __pcpu_type(name) __val;                                        \
 142         struct __s {                                                    \
 143                 u_char  __b[MIN(sizeof(__val), 4)];                     \
 144         } __s;                                                          \
 145                                                                         \
 146         __val = (val);                                                  \
 147         if (sizeof(__val) == 1 || sizeof(__val) == 2 ||                 \
 148             sizeof(__val) == 4) {                                       \
 149                 __s = *(struct __s *)(void *)&__val;                    \
 150                 __asm __volatile("add %1,%%fs:%0"                       \
 151                     : "=m" (*(struct __s *)(__pcpu_offset(name)))       \
 152                     : "r" (__s));                                       \
 153         } else                                                          \
 154                 *__PCPU_PTR(name) += __val;                             \
 155 } while (0)
 156
 157 /*
 158  * Increments the value of the per-cpu counter name.  The implementation
 159  * must be atomic with respect to interrupts.
 160  */
 161 #define __PCPU_INC(name) do {                                           \
 162         CTASSERT(sizeof(__pcpu_type(name)) == 1 ||                      \
 163             sizeof(__pcpu_type(name)) == 2 ||                           \
 164             sizeof(__pcpu_type(name)) == 4);                            \
 165         if (sizeof(__pcpu_type(name)) == 1) {                           \
 166                 __asm __volatile("incb %%fs:%0"                         \
 167                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
 168                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
 169         } else if (sizeof(__pcpu_type(name)) == 2) {                    \
 170                 __asm __volatile("incw %%fs:%0"                         \
 171                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
 172                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
 173         } else if (sizeof(__pcpu_type(name)) == 4) {                    \
 174                 __asm __volatile("incl %%fs:%0"                         \
 175                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
 176                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
 177         }                                                               \
 178 } while (0)
 179
 180 /*
 181  * Sets the value of the per-cpu variable name to value val.
 182  */
 183 #define __PCPU_SET(name, val) do {                                      \
 184         __pcpu_type(name) __val;                                        \
 185         struct __s {                                                    \
 186                 u_char  __b[MIN(sizeof(__val), 4)];                     \
 187         } __s;                                                          \
 188                                                                         \
 189         __val = (val);                                                  \
 190         if (sizeof(__val) == 1 || sizeof(__val) == 2 ||                 \
 191             sizeof(__val) == 4) {                                       \
 192                 __s = *(struct __s *)(void *)&__val;                    \
 193                 __asm __volatile("mov %1,%%fs:%0"                       \
 194                     : "=m" (*(struct __s *)(__pcpu_offset(name)))       \
 195                     : "r" (__s));                                       \
 196         } else {                                                        \
 197                 *__PCPU_PTR(name) = __val;                              \
 198         }                                                               \
 199 } while (0)
 200
 201 #define get_pcpu() __extension__ ({                                     \
 202         struct pcpu *__pc;                                              \
 203                                                                         \
 204         __asm __volatile("movl %%fs:%1,%0"                              \
 205             : "=r" (__pc)                                               \
 206             : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));      \
 207         __pc;                                                           \
 208 })
 209
 210 #define PCPU_GET(member)        __PCPU_GET(pc_ ## member)
 211 #define PCPU_ADD(member, val)   __PCPU_ADD(pc_ ## member, val)
 212 #define PCPU_INC(member)        __PCPU_INC(pc_ ## member)
 213 #define PCPU_PTR(member)        __PCPU_PTR(pc_ ## member)
 214 #define PCPU_SET(member, val)   __PCPU_SET(pc_ ## member, val)
 215
 216 #define OFFSETOF_CURTHREAD      0
 217 #ifdef __clang__
 218 #pragma clang diagnostic push
 219 #pragma clang diagnostic ignored "-Wnull-dereference"
 220 #endif
 221 static __inline __pure2 struct thread *
 222 __curthread(void)
 223 {
 224         struct thread *td;
 225
 226         __asm("movl %%fs:%1,%0" : "=r" (td)
 227             : "m" (*(char *)OFFSETOF_CURTHREAD));
 228         return (td);
 229 }
 230 #ifdef __clang__
 231 #pragma clang diagnostic pop
 232 #endif
 233 #define curthread               (__curthread())
 234
 235 #define OFFSETOF_CURPCB         16
 236 static __inline __pure2 struct pcb *
 237 __curpcb(void)
 238 {
 239         struct pcb *pcb;
 240
 241         __asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
 242         return (pcb);
 243 }
 244 #define curpcb          (__curpcb())
 245
 246 #define IS_BSP()        (PCPU_GET(cpuid) == 0)
 247
 248 #else /* defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
 249
 250 #error "this file needs to be ported to your compiler"
 251
 252 #endif /* __GNUCLIKE_ASM etc. */
 253
 254 #endif /* _KERNEL */
 255
 256 #endif /* !_MACHINE_PCPU_H_ */