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