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