xref: /freebsd/sys/amd64/include/pcpu.h (revision d5368bf3dff2b4627e2d69cce5c5dd98428fdaba)
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 	u_int 	pc_ipi_bitmap;						\
88 	char	__pad[3284]		/* pad to UMA_PCPU_ALLOC_SIZE */
89 
90 #define	PC_DBREG_CMD_NONE	0
91 #define	PC_DBREG_CMD_LOAD	1
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("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	get_pcpu() __extension__ ({					\
218 	struct pcpu *__pc;						\
219 									\
220 	__asm __volatile("movq %%gs:%1,%0"				\
221 	    : "=r" (__pc)						\
222 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
223 	__pc;								\
224 })
225 
226 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
227 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
228 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
229 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
230 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
231 
232 #define	OFFSETOF_CURTHREAD	0
233 #ifdef __clang__
234 #pragma clang diagnostic push
235 #pragma clang diagnostic ignored "-Wnull-dereference"
236 #endif
237 static __inline __pure2 struct thread *
238 __curthread(void)
239 {
240 	struct thread *td;
241 
242 	__asm("movq %%gs:%P1,%0" : "=r" (td) : "n" (OFFSETOF_CURTHREAD));
243 	return (td);
244 }
245 #ifdef __clang__
246 #pragma clang diagnostic pop
247 #endif
248 #define	curthread		(__curthread())
249 
250 #define	OFFSETOF_CURPCB		32
251 static __inline __pure2 struct pcb *
252 __curpcb(void)
253 {
254 	struct pcb *pcb;
255 
256 	__asm("movq %%gs:%P1,%0" : "=r" (pcb) : "n" (OFFSETOF_CURPCB));
257 	return (pcb);
258 }
259 #define	curpcb		(__curpcb())
260 
261 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
262 
263 #else /* !__GNUCLIKE_ASM || !__GNUCLIKE___TYPEOF */
264 
265 #error "this file needs to be ported to your compiler"
266 
267 #endif /* __GNUCLIKE_ASM && __GNUCLIKE___TYPEOF */
268 
269 #endif /* _KERNEL */
270 
271 #endif /* !_MACHINE_PCPU_H_ */
272