]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/amd64/include/pcpu.h
Mitigations for Microarchitectural Data Sampling.
[FreeBSD/FreeBSD.git] / sys / amd64 / include / pcpu.h
1 /*-
2  * Copyright (c) Peter Wemm <peter@netplex.com.au>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28
29 #ifndef _MACHINE_PCPU_H_
30 #define _MACHINE_PCPU_H_
31
32 #ifndef _SYS_CDEFS_H_
33 #error "sys/cdefs.h is a prerequisite for this file"
34 #endif
35
36 #define PC_PTI_STACK_SZ 16
37 /*
38  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
39  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
40  * The reason for doing it via a struct is so that an array of pointers
41  * to each CPU's data can be set up for things like "check curproc on all
42  * other processors"
43  */
44 #define PCPU_MD_FIELDS                                                  \
45         char    pc_monitorbuf[128] __aligned(128); /* cache line */     \
46         struct  pcpu *pc_prvspace;      /* Self-reference */            \
47         struct  pmap *pc_curpmap;                                       \
48         struct  amd64tss *pc_tssp;      /* TSS segment active on CPU */ \
49         struct  amd64tss *pc_commontssp;/* Common TSS for the CPU */    \
50         uint64_t pc_kcr3;                                               \
51         uint64_t pc_ucr3;                                               \
52         uint64_t pc_saved_ucr3;                                         \
53         register_t pc_rsp0;                                             \
54         register_t pc_scratch_rsp;      /* User %rsp in syscall */      \
55         register_t pc_scratch_rax;                                      \
56         u_int   pc_apic_id;                                             \
57         u_int   pc_acpi_id;             /* ACPI CPU id */               \
58         /* Pointer to the CPU %fs descriptor */                         \
59         struct user_segment_descriptor  *pc_fs32p;                      \
60         /* Pointer to the CPU %gs descriptor */                         \
61         struct user_segment_descriptor  *pc_gs32p;                      \
62         /* Pointer to the CPU LDT descriptor */                         \
63         struct system_segment_descriptor *pc_ldt;                       \
64         /* Pointer to the CPU TSS descriptor */                         \
65         struct system_segment_descriptor *pc_tss;                       \
66         uint64_t        pc_pm_save_cnt;                                 \
67         u_int   pc_cmci_mask;           /* MCx banks for CMCI */        \
68         uint64_t pc_dbreg[16];          /* ddb debugging regs */        \
69         uint64_t pc_pti_stack[PC_PTI_STACK_SZ];                         \
70         int pc_dbreg_cmd;               /* ddb debugging reg cmd */     \
71         u_int   pc_vcpu_id;             /* Xen vCPU ID */               \
72         uint32_t pc_pcid_next;                                          \
73         uint32_t pc_pcid_gen;                                           \
74         uint32_t pc_smp_tlb_done;       /* TLB op acknowledgement */    \
75         uint32_t pc_ibpb_set;                                           \
76         void    *pc_mds_buf;                                            \
77         void    *pc_mds_buf64;                                          \
78         uint32_t pc_pad[20];                                            \
79         uint8_t pc_mds_tmp[64];                                         \
80         char    __pad[960]              /* be divisor of PAGE_SIZE      \
81                                            after cache alignment */
82
83 #define PC_DBREG_CMD_NONE       0
84 #define PC_DBREG_CMD_LOAD       1
85
86 #ifdef _KERNEL
87
88 #ifdef lint
89
90 extern struct pcpu *pcpup;
91
92 #define PCPU_GET(member)        (pcpup->pc_ ## member)
93 #define PCPU_ADD(member, val)   (pcpup->pc_ ## member += (val))
94 #define PCPU_INC(member)        PCPU_ADD(member, 1)
95 #define PCPU_PTR(member)        (&pcpup->pc_ ## member)
96 #define PCPU_SET(member, val)   (pcpup->pc_ ## member = (val))
97
98 #elif 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("movq %%gs:%1,%0; addq %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(__pcpu_type(name)), 8)];         \
133         } __s;                                                          \
134                                                                         \
135         if (sizeof(__res) == 1 || sizeof(__res) == 2 ||                 \
136             sizeof(__res) == 4 || sizeof(__res) == 8) {                 \
137                 __asm __volatile("mov %%gs:%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 the value to 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(__pcpu_type(name)), 8)];         \
155         } __s;                                                          \
156                                                                         \
157         __val = (val);                                                  \
158         if (sizeof(__val) == 1 || sizeof(__val) == 2 ||                 \
159             sizeof(__val) == 4 || sizeof(__val) == 8) {                 \
160                 __s = *(struct __s *)(void *)&__val;                    \
161                 __asm __volatile("add %1,%%gs:%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             sizeof(__pcpu_type(name)) == 8);                            \
177         if (sizeof(__pcpu_type(name)) == 1) {                           \
178                 __asm __volatile("incb %%gs:%0"                         \
179                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
180                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
181         } else if (sizeof(__pcpu_type(name)) == 2) {                    \
182                 __asm __volatile("incw %%gs:%0"                         \
183                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
184                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
185         } else if (sizeof(__pcpu_type(name)) == 4) {                    \
186                 __asm __volatile("incl %%gs:%0"                         \
187                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
188                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
189         } else if (sizeof(__pcpu_type(name)) == 8) {                    \
190                 __asm __volatile("incq %%gs:%0"                         \
191                     : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
192                     : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
193         }                                                               \
194 } while (0)
195
196 /*
197  * Sets the value of the per-cpu variable name to value val.
198  */
199 #define __PCPU_SET(name, val) {                                         \
200         __pcpu_type(name) __val;                                        \
201         struct __s {                                                    \
202                 u_char  __b[MIN(sizeof(__pcpu_type(name)), 8)];         \
203         } __s;                                                          \
204                                                                         \
205         __val = (val);                                                  \
206         if (sizeof(__val) == 1 || sizeof(__val) == 2 ||                 \
207             sizeof(__val) == 4 || sizeof(__val) == 8) {                 \
208                 __s = *(struct __s *)(void *)&__val;                    \
209                 __asm __volatile("mov %1,%%gs:%0"                       \
210                     : "=m" (*(struct __s *)(__pcpu_offset(name)))       \
211                     : "r" (__s));                                       \
212         } else {                                                        \
213                 *__PCPU_PTR(name) = __val;                              \
214         }                                                               \
215 }
216
217 #define PCPU_GET(member)        __PCPU_GET(pc_ ## member)
218 #define PCPU_ADD(member, val)   __PCPU_ADD(pc_ ## member, val)
219 #define PCPU_INC(member)        __PCPU_INC(pc_ ## member)
220 #define PCPU_PTR(member)        __PCPU_PTR(pc_ ## member)
221 #define PCPU_SET(member, val)   __PCPU_SET(pc_ ## member, val)
222
223 #define OFFSETOF_CURTHREAD      0
224 #ifdef __clang__
225 #pragma clang diagnostic push
226 #pragma clang diagnostic ignored "-Wnull-dereference"
227 #endif
228 static __inline __pure2 struct thread *
229 __curthread(void)
230 {
231         struct thread *td;
232
233         __asm("movq %%gs:%1,%0" : "=r" (td)
234             : "m" (*(char *)OFFSETOF_CURTHREAD));
235         return (td);
236 }
237 #ifdef __clang__
238 #pragma clang diagnostic pop
239 #endif
240 #define curthread               (__curthread())
241
242 #define OFFSETOF_CURPCB         32
243 static __inline __pure2 struct pcb *
244 __curpcb(void)
245 {
246         struct pcb *pcb;
247
248         __asm("movq %%gs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
249         return (pcb);
250 }
251 #define curpcb          (__curpcb())
252
253 #define IS_BSP()        (PCPU_GET(cpuid) == 0)
254
255 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
256
257 #error "this file needs to be ported to your compiler"
258
259 #endif /* lint, etc. */
260
261 #endif /* _KERNEL */
262
263 #endif /* !_MACHINE_PCPU_H_ */