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 struct monitorbuf {
  45         int idle_state;         /* Used by cpu_idle_mwait. */
  46         int stop_state;         /* Used by cpustop_handler. */
  47         char padding[128 - (2 * sizeof(int))];
  48 };
  49 _Static_assert(sizeof(struct monitorbuf) == 128, "2x cache line");
  50
  51 /*
  52  * The SMP parts are setup in pmap.c and machdep.c for the BSP, and
  53  * pmap.c and mp_machdep.c sets up the data for the AP's to "see" when
  54  * they awake.  The reason for doing it via a struct is so that an
  55  * array of pointers to each CPU's data can be set up for things like
  56  * "check curproc on all other processors"
  57  */
  58
  59 #define PCPU_MD_FIELDS                                                  \
  60         struct monitorbuf pc_monitorbuf __aligned(128); /* cache line */\
  61         struct  pcpu *pc_prvspace;      /* Self-reference */            \
  62         struct  pmap *pc_curpmap;                                       \
  63         struct  segment_descriptor pc_common_tssd;                      \
  64         struct  segment_descriptor *pc_tss_gdt;                         \
  65         struct  segment_descriptor *pc_fsgs_gdt;                        \
  66         struct  i386tss *pc_common_tssp;                                \
  67         u_int   pc_kesp0;                                               \
  68         u_int   pc_trampstk;                                            \
  69         int     pc_currentldt;                                          \
  70         u_int   pc_acpi_id;             /* ACPI CPU id */               \
  71         u_int   pc_apic_id;                                             \
  72         int     pc_private_tss;         /* Flag indicating private tss*/\
  73         u_int   pc_cmci_mask;           /* MCx banks for CMCI */        \
  74         u_int   pc_vcpu_id;             /* Xen vCPU ID */               \
  75         struct  mtx pc_cmap_lock;                                       \
  76         void    *pc_cmap_pte1;                                          \
  77         void    *pc_cmap_pte2;                                          \
  78         caddr_t pc_cmap_addr1;                                          \
  79         caddr_t pc_cmap_addr2;                                          \
  80         vm_offset_t pc_qmap_addr;       /* KVA for temporary mappings */\
  81         vm_offset_t pc_copyout_maddr;                                   \
  82         vm_offset_t pc_copyout_saddr;                                   \
  83         struct  mtx pc_copyout_mlock;                                   \
  84         struct  sx pc_copyout_slock;                                    \
  85         char    *pc_copyout_buf;                                        \
  86         vm_offset_t pc_pmap_eh_va;                                      \
  87         caddr_t pc_pmap_eh_ptep;                                                \
  88         uint32_t pc_smp_tlb_done;       /* TLB op acknowledgement */    \
  89         uint32_t pc_ibpb_set;                                           \
  90         u_int   pc_ipi_bitmap;                                          \
  91         char    __pad[3606]
  92
  93 #ifdef _KERNEL
  94
  95 #define MONITOR_STOPSTATE_RUNNING       0
  96 #define MONITOR_STOPSTATE_STOPPED       1
  97
  98 #if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
  99
 100 /*
 101  * Evaluates to the byte offset of the per-cpu variable name.
 102  */
 103 #define __pcpu_offset(name)                                             \
 104         __offsetof(struct pcpu, name)
 105
 106 /*
 107  * Evaluates to the type of the per-cpu variable name.
 108  */
 109 #define __pcpu_type(name)                                               \
 110         __typeof(((struct pcpu *)0)->name)
 111
 112 /*
 113  * Evaluates to the address of the per-cpu variable name.
 114  */
 115 #define __PCPU_PTR(name) __extension__ ({                               \
 116         __pcpu_type(name) *__p;                                         \
 117                                                                         \
 118         __asm __volatile("movl %%fs:%1,%0; addl %2,%0"                  \
 119             : "=r" (__p)                                                \
 120             : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),       \
 121               "i" (__pcpu_offset(name)));                               \
 122                                                                         \
 123         __p;                                                            \
 124 })
 125
 126 /*
 127  * Evaluates to the value of the per-cpu variable name.
 128  */
 129 #define __PCPU_GET(name) __extension__ ({                               \
 130         __pcpu_type(name) __res;                                        \
 131         struct __s {                                                    \
 132                 u_char  __b[MIN(sizeof(__res), 4)];                     \
 133         } __s;                                                          \
 134                                                                         \
 135         if (sizeof(__res) == 1 || sizeof(__res) == 2 ||                 \
 136             sizeof(__res) == 4) {                                       \
 137                 __asm __volatile("mov %%fs:%1,%0"                       \
 138                     : "=r" (__s)                                        \
 139                     : "m" (*(struct __s *)(__pcpu_offset(name))));      \
 140                 *(struct __s *)(void *)&__res = __s;                    \
 141         } else {                                                        \
 142                 __res = *__PCPU_PTR(name);                              \
 143         }                                                               \
 144         __res;                                                          \
 145 })
 146
 147 /*
 148  * Adds a value of the per-cpu counter name.  The implementation
 149  * must be atomic with respect to interrupts.
 150  */
 151 #define __PCPU_ADD(name, val) do {                                      \
 152         __pcpu_type(name) __val;                                        \
 153         struct __s {                                                    \
 154                 u_char  __b[MIN(sizeof(__val), 4)];                     \
 155         } __s;                                                          \
 156                                                                         \
 157         __val = (val);                                                  \
 158         if (sizeof(__val) == 1 || sizeof(__val) == 2 ||                 \
 159             sizeof(__val) == 4) {                                       \
 160                 __s = *(struct __s *)(void *)&__val;                    \
 161                 __asm __volatile("add %1,%%fs:%0"                       \
 162                     : "=m" (*(struct __s *)(__pcpu_offset(name)))       \
 163                     : "r" (__s));                                       \
 164         } else                                                          \
 165                 *__PCPU_PTR(name) += __val;                             \
 166 } while (0)
 167
 168 /*
 169  * Increments the value of the per-cpu counter name.  The implementation
 170  * must be atomic with respect to interrupts.
 171  */
 172 #define __PCPU_INC(name) do {                                           \
 173         CTASSERT(sizeof(__pcpu_type(name)) == 1 ||                      \
 174             sizeof(__pcpu_type(name)) == 2 ||                           \
 175             sizeof(__pcpu_type(name)) == 4);                            \
 176         if (sizeof(__pcpu_type(name)) == 1) {                           \
 177                 __asm __volatile("incb %%fs:%0"                         \
 178                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
 179                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
 180         } else if (sizeof(__pcpu_type(name)) == 2) {                    \
 181                 __asm __volatile("incw %%fs:%0"                         \
 182                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
 183                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
 184         } else if (sizeof(__pcpu_type(name)) == 4) {                    \
 185                 __asm __volatile("incl %%fs:%0"                         \
 186                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
 187                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
 188         }                                                               \
 189 } while (0)
 190
 191 /*
 192  * Sets the value of the per-cpu variable name to value val.
 193  */
 194 #define __PCPU_SET(name, val) do {                                      \
 195         __pcpu_type(name) __val;                                        \
 196         struct __s {                                                    \
 197                 u_char  __b[MIN(sizeof(__val), 4)];                     \
 198         } __s;                                                          \
 199                                                                         \
 200         __val = (val);                                                  \
 201         if (sizeof(__val) == 1 || sizeof(__val) == 2 ||                 \
 202             sizeof(__val) == 4) {                                       \
 203                 __s = *(struct __s *)(void *)&__val;                    \
 204                 __asm __volatile("mov %1,%%fs:%0"                       \
 205                     : "=m" (*(struct __s *)(__pcpu_offset(name)))       \
 206                     : "r" (__s));                                       \
 207         } else {                                                        \
 208                 *__PCPU_PTR(name) = __val;                              \
 209         }                                                               \
 210 } while (0)
 211
 212 #define get_pcpu() __extension__ ({                                     \
 213         struct pcpu *__pc;                                              \
 214                                                                         \
 215         __asm __volatile("movl %%fs:%1,%0"                              \
 216             : "=r" (__pc)                                               \
 217             : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));      \
 218         __pc;                                                           \
 219 })
 220
 221 #define PCPU_GET(member)        __PCPU_GET(pc_ ## member)
 222 #define PCPU_ADD(member, val)   __PCPU_ADD(pc_ ## member, val)
 223 #define PCPU_INC(member)        __PCPU_INC(pc_ ## member)
 224 #define PCPU_PTR(member)        __PCPU_PTR(pc_ ## member)
 225 #define PCPU_SET(member, val)   __PCPU_SET(pc_ ## member, val)
 226
 227 #define OFFSETOF_CURTHREAD      0
 228 #ifdef __clang__
 229 #pragma clang diagnostic push
 230 #pragma clang diagnostic ignored "-Wnull-dereference"
 231 #endif
 232 static __inline __pure2 struct thread *
 233 __curthread(void)
 234 {
 235         struct thread *td;
 236
 237         __asm("movl %%fs:%1,%0" : "=r" (td)
 238             : "m" (*(char *)OFFSETOF_CURTHREAD));
 239         return (td);
 240 }
 241 #ifdef __clang__
 242 #pragma clang diagnostic pop
 243 #endif
 244 #define curthread               (__curthread())
 245
 246 #define OFFSETOF_CURPCB         16
 247 static __inline __pure2 struct pcb *
 248 __curpcb(void)
 249 {
 250         struct pcb *pcb;
 251
 252         __asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
 253         return (pcb);
 254 }
 255 #define curpcb          (__curpcb())
 256
 257 #define IS_BSP()        (PCPU_GET(cpuid) == 0)
 258
 259 #else /* defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
 260
 261 #error "this file needs to be ported to your compiler"
 262
 263 #endif /* __GNUCLIKE_ASM etc. */
 264
 265 #endif /* _KERNEL */
 266
 267 #endif /* !_MACHINE_PCPU_H_ */