xref: /freebsd/sys/i386/include/pcpu.h (revision d940bfec8c329dd82d8d54efebd81c8aa420503b)
1 /*-
2  * Copyright (c) Peter Wemm
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 #include <machine/segments.h>
37 #include <machine/tss.h>
38 
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 
47 #if defined(XEN) || defined(XENHVM)
48 #ifndef NR_VIRQS
49 #define	NR_VIRQS	24
50 #endif
51 #ifndef NR_IPIS
52 #define	NR_IPIS		2
53 #endif
54 #endif
55 
56 #if defined(XEN)
57 
58 /* These are peridically updated in shared_info, and then copied here. */
59 struct shadow_time_info {
60 	uint64_t tsc_timestamp;     /* TSC at last update of time vals.  */
61 	uint64_t system_timestamp;  /* Time, in nanosecs, since boot.    */
62 	uint32_t tsc_to_nsec_mul;
63 	uint32_t tsc_to_usec_mul;
64 	int tsc_shift;
65 	uint32_t version;
66 };
67 
68 #define	PCPU_XEN_FIELDS							\
69 	;								\
70 	u_int	pc_cr3;		/* track cr3 for R1/R3*/		\
71 	vm_paddr_t *pc_pdir_shadow;					\
72 	uint64_t pc_processed_system_time;				\
73 	struct shadow_time_info pc_shadow_time;				\
74 	char	__pad[189]
75 
76 #else /* !XEN */
77 
78 #define PCPU_XEN_FIELDS							\
79 	;								\
80 	char	__pad[237]
81 
82 #endif
83 
84 #define	PCPU_MD_FIELDS							\
85 	char	pc_monitorbuf[128] __aligned(128); /* cache line */	\
86 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
87 	struct	pmap *pc_curpmap;					\
88 	struct	i386tss pc_common_tss;					\
89 	struct	segment_descriptor pc_common_tssd;			\
90 	struct	segment_descriptor *pc_tss_gdt;				\
91 	struct	segment_descriptor *pc_fsgs_gdt;			\
92 	int	pc_currentldt;						\
93 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
94 	u_int	pc_apic_id;						\
95 	int	pc_private_tss;		/* Flag indicating private tss*/\
96 	u_int	pc_cmci_mask		/* MCx banks for CMCI */	\
97 	PCPU_XEN_FIELDS
98 
99 #ifdef _KERNEL
100 
101 #ifdef lint
102 
103 extern struct pcpu *pcpup;
104 
105 #define	PCPU_GET(member)	(pcpup->pc_ ## member)
106 #define	PCPU_ADD(member, val)	(pcpup->pc_ ## member += (val))
107 #define	PCPU_INC(member)	PCPU_ADD(member, 1)
108 #define	PCPU_PTR(member)	(&pcpup->pc_ ## member)
109 #define	PCPU_SET(member, val)	(pcpup->pc_ ## member = (val))
110 
111 #elif defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
112 
113 /*
114  * Evaluates to the byte offset of the per-cpu variable name.
115  */
116 #define	__pcpu_offset(name)						\
117 	__offsetof(struct pcpu, name)
118 
119 /*
120  * Evaluates to the type of the per-cpu variable name.
121  */
122 #define	__pcpu_type(name)						\
123 	__typeof(((struct pcpu *)0)->name)
124 
125 /*
126  * Evaluates to the address of the per-cpu variable name.
127  */
128 #define	__PCPU_PTR(name) __extension__ ({				\
129 	__pcpu_type(name) *__p;						\
130 									\
131 	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
132 	    : "=r" (__p)						\
133 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
134 	      "i" (__pcpu_offset(name)));				\
135 									\
136 	__p;								\
137 })
138 
139 /*
140  * Evaluates to the value of the per-cpu variable name.
141  */
142 #define	__PCPU_GET(name) __extension__ ({				\
143 	__pcpu_type(name) __res;					\
144 	struct __s {							\
145 		u_char	__b[MIN(sizeof(__res), 4)];			\
146 	} __s;								\
147 									\
148 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
149 	    sizeof(__res) == 4) {					\
150 		__asm __volatile("mov %%fs:%1,%0"			\
151 		    : "=r" (__s)					\
152 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
153 		*(struct __s *)(void *)&__res = __s;			\
154 	} else {							\
155 		__res = *__PCPU_PTR(name);				\
156 	}								\
157 	__res;								\
158 })
159 
160 /*
161  * Adds a value of the per-cpu counter name.  The implementation
162  * must be atomic with respect to interrupts.
163  */
164 #define	__PCPU_ADD(name, val) do {					\
165 	__pcpu_type(name) __val;					\
166 	struct __s {							\
167 		u_char	__b[MIN(sizeof(__val), 4)];			\
168 	} __s;								\
169 									\
170 	__val = (val);							\
171 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
172 	    sizeof(__val) == 4) {					\
173 		__s = *(struct __s *)(void *)&__val;			\
174 		__asm __volatile("add %1,%%fs:%0"			\
175 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
176 		    : "r" (__s));					\
177 	} else								\
178 		*__PCPU_PTR(name) += __val;				\
179 } while (0)
180 
181 /*
182  * Increments the value of the per-cpu counter name.  The implementation
183  * must be atomic with respect to interrupts.
184  */
185 #define	__PCPU_INC(name) do {						\
186 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
187 	    sizeof(__pcpu_type(name)) == 2 ||				\
188 	    sizeof(__pcpu_type(name)) == 4);				\
189 	if (sizeof(__pcpu_type(name)) == 1) {				\
190 		__asm __volatile("incb %%fs:%0"				\
191 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
192 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
193 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
194 		__asm __volatile("incw %%fs:%0"				\
195 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
196 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
197 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
198 		__asm __volatile("incl %%fs:%0"				\
199 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
200 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
201 	}								\
202 } while (0)
203 
204 /*
205  * Sets the value of the per-cpu variable name to value val.
206  */
207 #define	__PCPU_SET(name, val) do {					\
208 	__pcpu_type(name) __val;					\
209 	struct __s {							\
210 		u_char	__b[MIN(sizeof(__val), 4)];			\
211 	} __s;								\
212 									\
213 	__val = (val);							\
214 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
215 	    sizeof(__val) == 4) {					\
216 		__s = *(struct __s *)(void *)&__val;			\
217 		__asm __volatile("mov %1,%%fs:%0"			\
218 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
219 		    : "r" (__s));					\
220 	} else {							\
221 		*__PCPU_PTR(name) = __val;				\
222 	}								\
223 } while (0)
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("movl %%fs:%1,%0" : "=r" (td)
242 	    : "m" (*(char *)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		16
251 static __inline __pure2 struct pcb *
252 __curpcb(void)
253 {
254 	struct pcb *pcb;
255 
256 	__asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
257 	return (pcb);
258 }
259 #define	curpcb		(__curpcb())
260 
261 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
262 
263 #error "this file needs to be ported to your compiler"
264 
265 #endif /* lint, etc. */
266 
267 #endif /* _KERNEL */
268 
269 #endif /* !_MACHINE_PCPU_H_ */
270