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