xref: /freebsd/sys/amd64/include/pcpu.h (revision 87c1627502a5dde91e5284118eec8682b60f27a2)
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 	char	__pad[293]		/* be divisor of PAGE_SIZE	\
82 					   after cache alignment */
83 
84 #ifdef _KERNEL
85 
86 #ifdef lint
87 
88 extern struct pcpu *pcpup;
89 
90 #define	PCPU_GET(member)	(pcpup->pc_ ## member)
91 #define	PCPU_ADD(member, val)	(pcpup->pc_ ## member += (val))
92 #define	PCPU_INC(member)	PCPU_ADD(member, 1)
93 #define	PCPU_PTR(member)	(&pcpup->pc_ ## member)
94 #define	PCPU_SET(member, val)	(pcpup->pc_ ## member = (val))
95 
96 #elif defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
97 
98 /*
99  * Evaluates to the byte offset of the per-cpu variable name.
100  */
101 #define	__pcpu_offset(name)						\
102 	__offsetof(struct pcpu, name)
103 
104 /*
105  * Evaluates to the type of the per-cpu variable name.
106  */
107 #define	__pcpu_type(name)						\
108 	__typeof(((struct pcpu *)0)->name)
109 
110 /*
111  * Evaluates to the address of the per-cpu variable name.
112  */
113 #define	__PCPU_PTR(name) __extension__ ({				\
114 	__pcpu_type(name) *__p;						\
115 									\
116 	__asm __volatile("movq %%gs:%1,%0; addq %2,%0"			\
117 	    : "=r" (__p)						\
118 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
119 	      "i" (__pcpu_offset(name)));				\
120 									\
121 	__p;								\
122 })
123 
124 /*
125  * Evaluates to the value of the per-cpu variable name.
126  */
127 #define	__PCPU_GET(name) __extension__ ({				\
128 	__pcpu_type(name) __res;					\
129 	struct __s {							\
130 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
131 	} __s;								\
132 									\
133 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
134 	    sizeof(__res) == 4 || sizeof(__res) == 8) {			\
135 		__asm __volatile("mov %%gs:%1,%0"			\
136 		    : "=r" (__s)					\
137 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
138 		*(struct __s *)(void *)&__res = __s;			\
139 	} else {							\
140 		__res = *__PCPU_PTR(name);				\
141 	}								\
142 	__res;								\
143 })
144 
145 /*
146  * Adds the value to the per-cpu counter name.  The implementation
147  * must be atomic with respect to interrupts.
148  */
149 #define	__PCPU_ADD(name, val) do {					\
150 	__pcpu_type(name) __val;					\
151 	struct __s {							\
152 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
153 	} __s;								\
154 									\
155 	__val = (val);							\
156 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
157 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
158 		__s = *(struct __s *)(void *)&__val;			\
159 		__asm __volatile("add %1,%%gs:%0"			\
160 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
161 		    : "r" (__s));					\
162 	} else								\
163 		*__PCPU_PTR(name) += __val;				\
164 } while (0)
165 
166 /*
167  * Increments the value of the per-cpu counter name.  The implementation
168  * must be atomic with respect to interrupts.
169  */
170 #define	__PCPU_INC(name) do {						\
171 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
172 	    sizeof(__pcpu_type(name)) == 2 ||				\
173 	    sizeof(__pcpu_type(name)) == 4 ||				\
174 	    sizeof(__pcpu_type(name)) == 8);				\
175 	if (sizeof(__pcpu_type(name)) == 1) {				\
176 		__asm __volatile("incb %%gs:%0"				\
177 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
178 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
179 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
180 		__asm __volatile("incw %%gs:%0"				\
181 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
182 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
183 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
184 		__asm __volatile("incl %%gs:%0"				\
185 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
186 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
187 	} else if (sizeof(__pcpu_type(name)) == 8) {			\
188 		__asm __volatile("incq %%gs:%0"				\
189 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
190 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
191 	}								\
192 } while (0)
193 
194 /*
195  * Sets the value of the per-cpu variable name to value val.
196  */
197 #define	__PCPU_SET(name, val) {						\
198 	__pcpu_type(name) __val;					\
199 	struct __s {							\
200 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
201 	} __s;								\
202 									\
203 	__val = (val);							\
204 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
205 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
206 		__s = *(struct __s *)(void *)&__val;			\
207 		__asm __volatile("mov %1,%%gs:%0"			\
208 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
209 		    : "r" (__s));					\
210 	} else {							\
211 		*__PCPU_PTR(name) = __val;				\
212 	}								\
213 }
214 
215 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
216 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
217 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
218 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
219 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
220 
221 #define	OFFSETOF_CURTHREAD	0
222 #ifdef __clang__
223 #pragma clang diagnostic push
224 #pragma clang diagnostic ignored "-Wnull-dereference"
225 #endif
226 static __inline __pure2 struct thread *
227 __curthread(void)
228 {
229 	struct thread *td;
230 
231 	__asm("movq %%gs:%1,%0" : "=r" (td)
232 	    : "m" (*(char *)OFFSETOF_CURTHREAD));
233 	return (td);
234 }
235 #ifdef __clang__
236 #pragma clang diagnostic pop
237 #endif
238 #define	curthread		(__curthread())
239 
240 #define	OFFSETOF_CURPCB		32
241 static __inline __pure2 struct pcb *
242 __curpcb(void)
243 {
244 	struct pcb *pcb;
245 
246 	__asm("movq %%gs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
247 	return (pcb);
248 }
249 #define	curpcb		(__curpcb())
250 
251 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
252 
253 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
254 
255 #error "this file needs to be ported to your compiler"
256 
257 #endif /* lint, etc. */
258 
259 #endif /* _KERNEL */
260 
261 #endif /* !_MACHINE_PCPU_H_ */
262