xref: /freebsd/sys/amd64/include/pcpu.h (revision daceb336172a6b0572de864b97e70b28451ca636)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) Peter Wemm <peter@netplex.com.au>
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 #define	PC_PTI_STACK_SZ	16
39 
40 struct monitorbuf {
41 	int idle_state;		/* Used by cpu_idle_mwait. */
42 	int stop_state;		/* Used by cpustop_handler. */
43 	char padding[128 - (2 * sizeof(int))];
44 };
45 _Static_assert(sizeof(struct monitorbuf) == 128, "2x cache line");
46 
47 /*
48  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
49  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
50  * The reason for doing it via a struct is so that an array of pointers
51  * to each CPU's data can be set up for things like "check curproc on all
52  * other processors"
53  */
54 #define	PCPU_MD_FIELDS							\
55 	struct monitorbuf pc_monitorbuf __aligned(128);	/* cache line */\
56 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
57 	struct	pmap *pc_curpmap;					\
58 	struct	amd64tss *pc_tssp;	/* TSS segment active on CPU */	\
59 	struct	amd64tss *pc_commontssp;/* Common TSS for the CPU */	\
60 	uint64_t pc_kcr3;						\
61 	uint64_t pc_ucr3;						\
62 	uint64_t pc_saved_ucr3;						\
63 	register_t pc_rsp0;						\
64 	register_t pc_scratch_rsp;	/* User %rsp in syscall */	\
65 	register_t pc_scratch_rax;					\
66 	u_int	pc_apic_id;						\
67 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
68 	/* Pointer to the CPU %fs descriptor */				\
69 	struct user_segment_descriptor	*pc_fs32p;			\
70 	/* Pointer to the CPU %gs descriptor */				\
71 	struct user_segment_descriptor	*pc_gs32p;			\
72 	/* Pointer to the CPU LDT descriptor */				\
73 	struct system_segment_descriptor *pc_ldt;			\
74 	/* Pointer to the CPU TSS descriptor */				\
75 	struct system_segment_descriptor *pc_tss;			\
76 	uint64_t	pc_pm_save_cnt;					\
77 	u_int	pc_cmci_mask;		/* MCx banks for CMCI */	\
78 	uint64_t pc_dbreg[16];		/* ddb debugging regs */	\
79 	uint64_t pc_pti_stack[PC_PTI_STACK_SZ];				\
80 	register_t pc_pti_rsp0;						\
81 	int pc_dbreg_cmd;		/* ddb debugging reg cmd */	\
82 	u_int	pc_vcpu_id;		/* Xen vCPU ID */		\
83 	uint32_t pc_pcid_next;						\
84 	uint32_t pc_pcid_gen;						\
85 	uint32_t pc_smp_tlb_done;	/* TLB op acknowledgement */	\
86 	uint32_t pc_ibpb_set;						\
87 	char	__pad[3288]		/* pad to UMA_PCPU_ALLOC_SIZE */
88 
89 #define	PC_DBREG_CMD_NONE	0
90 #define	PC_DBREG_CMD_LOAD	1
91 
92 #ifdef _KERNEL
93 
94 #define MONITOR_STOPSTATE_RUNNING	0
95 #define MONITOR_STOPSTATE_STOPPED	1
96 
97 #if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
98 
99 /*
100  * Evaluates to the byte offset of the per-cpu variable name.
101  */
102 #define	__pcpu_offset(name)						\
103 	__offsetof(struct pcpu, name)
104 
105 /*
106  * Evaluates to the type of the per-cpu variable name.
107  */
108 #define	__pcpu_type(name)						\
109 	__typeof(((struct pcpu *)0)->name)
110 
111 /*
112  * Evaluates to the address of the per-cpu variable name.
113  */
114 #define	__PCPU_PTR(name) __extension__ ({				\
115 	__pcpu_type(name) *__p;						\
116 									\
117 	__asm __volatile("movq %%gs:%1,%0; addq %2,%0"			\
118 	    : "=r" (__p)						\
119 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
120 	      "i" (__pcpu_offset(name)));				\
121 									\
122 	__p;								\
123 })
124 
125 /*
126  * Evaluates to the value of the per-cpu variable name.
127  */
128 #define	__PCPU_GET(name) __extension__ ({				\
129 	__pcpu_type(name) __res;					\
130 	struct __s {							\
131 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
132 	} __s;								\
133 									\
134 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
135 	    sizeof(__res) == 4 || sizeof(__res) == 8) {			\
136 		__asm __volatile("mov %%gs:%1,%0"			\
137 		    : "=r" (__s)					\
138 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
139 		*(struct __s *)(void *)&__res = __s;			\
140 	} else {							\
141 		__res = *__PCPU_PTR(name);				\
142 	}								\
143 	__res;								\
144 })
145 
146 /*
147  * Adds the value to the per-cpu counter name.  The implementation
148  * must be atomic with respect to interrupts.
149  */
150 #define	__PCPU_ADD(name, val) do {					\
151 	__pcpu_type(name) __val;					\
152 	struct __s {							\
153 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
154 	} __s;								\
155 									\
156 	__val = (val);							\
157 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
158 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
159 		__s = *(struct __s *)(void *)&__val;			\
160 		__asm __volatile("add %1,%%gs:%0"			\
161 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
162 		    : "r" (__s));					\
163 	} else								\
164 		*__PCPU_PTR(name) += __val;				\
165 } while (0)
166 
167 /*
168  * Increments the value of the per-cpu counter name.  The implementation
169  * must be atomic with respect to interrupts.
170  */
171 #define	__PCPU_INC(name) do {						\
172 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
173 	    sizeof(__pcpu_type(name)) == 2 ||				\
174 	    sizeof(__pcpu_type(name)) == 4 ||				\
175 	    sizeof(__pcpu_type(name)) == 8);				\
176 	if (sizeof(__pcpu_type(name)) == 1) {				\
177 		__asm __volatile("incb %%gs:%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 %%gs:%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 %%gs:%0"				\
186 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
187 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
188 	} else if (sizeof(__pcpu_type(name)) == 8) {			\
189 		__asm __volatile("incq %%gs:%0"				\
190 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
191 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
192 	}								\
193 } while (0)
194 
195 /*
196  * Sets the value of the per-cpu variable name to value val.
197  */
198 #define	__PCPU_SET(name, val) {						\
199 	__pcpu_type(name) __val;					\
200 	struct __s {							\
201 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
202 	} __s;								\
203 									\
204 	__val = (val);							\
205 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
206 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
207 		__s = *(struct __s *)(void *)&__val;			\
208 		__asm __volatile("mov %1,%%gs:%0"			\
209 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
210 		    : "r" (__s));					\
211 	} else {							\
212 		*__PCPU_PTR(name) = __val;				\
213 	}								\
214 }
215 
216 #define	get_pcpu() __extension__ ({					\
217 	struct pcpu *__pc;						\
218 									\
219 	__asm __volatile("movq %%gs:%1,%0"				\
220 	    : "=r" (__pc)						\
221 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
222 	__pc;								\
223 })
224 
225 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
226 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
227 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
228 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
229 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
230 
231 #define	OFFSETOF_CURTHREAD	0
232 #ifdef __clang__
233 #pragma clang diagnostic push
234 #pragma clang diagnostic ignored "-Wnull-dereference"
235 #endif
236 static __inline __pure2 struct thread *
237 __curthread(void)
238 {
239 	struct thread *td;
240 
241 	__asm("movq %%gs:%P1,%0" : "=r" (td) : "n" (OFFSETOF_CURTHREAD));
242 	return (td);
243 }
244 #ifdef __clang__
245 #pragma clang diagnostic pop
246 #endif
247 #define	curthread		(__curthread())
248 
249 #define	OFFSETOF_CURPCB		32
250 static __inline __pure2 struct pcb *
251 __curpcb(void)
252 {
253 	struct pcb *pcb;
254 
255 	__asm("movq %%gs:%P1,%0" : "=r" (pcb) : "n" (OFFSETOF_CURPCB));
256 	return (pcb);
257 }
258 #define	curpcb		(__curpcb())
259 
260 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
261 
262 #else /* !__GNUCLIKE_ASM || !__GNUCLIKE___TYPEOF */
263 
264 #error "this file needs to be ported to your compiler"
265 
266 #endif /* __GNUCLIKE_ASM && __GNUCLIKE___TYPEOF */
267 
268 #endif /* _KERNEL */
269 
270 #endif /* !_MACHINE_PCPU_H_ */
271