xref: /freebsd/sys/i386/include/pcpu.h (revision 595e514d0df2bac5b813d35f83e32875dbf16a83)
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 	int	pc_resched_irq;						\
75 	int	pc_callfunc_irq;					\
76 	int	pc_virq_to_irq[NR_VIRQS];				\
77 	int	pc_ipi_to_irq[NR_IPIS];					\
78 	char	__pad[77]
79 
80 #elif defined(XENHVM)
81 
82 #define	PCPU_XEN_FIELDS							\
83 	;								\
84 	unsigned int pc_last_processed_l1i;				\
85 	unsigned int pc_last_processed_l2i;				\
86 	char	__pad[229]
87 
88 #else /* !XEN && !XENHVM */
89 
90 #define PCPU_XEN_FIELDS							\
91 	;								\
92 	char	__pad[237]
93 
94 #endif
95 
96 #define	PCPU_MD_FIELDS							\
97 	char	pc_monitorbuf[128] __aligned(128); /* cache line */	\
98 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
99 	struct	pmap *pc_curpmap;					\
100 	struct	i386tss pc_common_tss;					\
101 	struct	segment_descriptor pc_common_tssd;			\
102 	struct	segment_descriptor *pc_tss_gdt;				\
103 	struct	segment_descriptor *pc_fsgs_gdt;			\
104 	int	pc_currentldt;						\
105 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
106 	u_int	pc_apic_id;						\
107 	int	pc_private_tss;		/* Flag indicating private tss*/\
108 	u_int	pc_cmci_mask		/* MCx banks for CMCI */	\
109 	PCPU_XEN_FIELDS
110 
111 #ifdef _KERNEL
112 
113 #ifdef lint
114 
115 extern struct pcpu *pcpup;
116 
117 #define	PCPU_GET(member)	(pcpup->pc_ ## member)
118 #define	PCPU_ADD(member, val)	(pcpup->pc_ ## member += (val))
119 #define	PCPU_INC(member)	PCPU_ADD(member, 1)
120 #define	PCPU_PTR(member)	(&pcpup->pc_ ## member)
121 #define	PCPU_SET(member, val)	(pcpup->pc_ ## member = (val))
122 
123 #elif defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
124 
125 /*
126  * Evaluates to the byte offset of the per-cpu variable name.
127  */
128 #define	__pcpu_offset(name)						\
129 	__offsetof(struct pcpu, name)
130 
131 /*
132  * Evaluates to the type of the per-cpu variable name.
133  */
134 #define	__pcpu_type(name)						\
135 	__typeof(((struct pcpu *)0)->name)
136 
137 /*
138  * Evaluates to the address of the per-cpu variable name.
139  */
140 #define	__PCPU_PTR(name) __extension__ ({				\
141 	__pcpu_type(name) *__p;						\
142 									\
143 	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
144 	    : "=r" (__p)						\
145 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
146 	      "i" (__pcpu_offset(name)));				\
147 									\
148 	__p;								\
149 })
150 
151 /*
152  * Evaluates to the value of the per-cpu variable name.
153  */
154 #define	__PCPU_GET(name) __extension__ ({				\
155 	__pcpu_type(name) __res;					\
156 	struct __s {							\
157 		u_char	__b[MIN(sizeof(__res), 4)];			\
158 	} __s;								\
159 									\
160 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
161 	    sizeof(__res) == 4) {					\
162 		__asm __volatile("mov %%fs:%1,%0"			\
163 		    : "=r" (__s)					\
164 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
165 		*(struct __s *)(void *)&__res = __s;			\
166 	} else {							\
167 		__res = *__PCPU_PTR(name);				\
168 	}								\
169 	__res;								\
170 })
171 
172 /*
173  * Adds a value of the per-cpu counter name.  The implementation
174  * must be atomic with respect to interrupts.
175  */
176 #define	__PCPU_ADD(name, val) do {					\
177 	__pcpu_type(name) __val;					\
178 	struct __s {							\
179 		u_char	__b[MIN(sizeof(__val), 4)];			\
180 	} __s;								\
181 									\
182 	__val = (val);							\
183 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
184 	    sizeof(__val) == 4) {					\
185 		__s = *(struct __s *)(void *)&__val;			\
186 		__asm __volatile("add %1,%%fs:%0"			\
187 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
188 		    : "r" (__s));					\
189 	} else								\
190 		*__PCPU_PTR(name) += __val;				\
191 } while (0)
192 
193 /*
194  * Increments the value of the per-cpu counter name.  The implementation
195  * must be atomic with respect to interrupts.
196  */
197 #define	__PCPU_INC(name) do {						\
198 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
199 	    sizeof(__pcpu_type(name)) == 2 ||				\
200 	    sizeof(__pcpu_type(name)) == 4);				\
201 	if (sizeof(__pcpu_type(name)) == 1) {				\
202 		__asm __volatile("incb %%fs:%0"				\
203 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
204 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
205 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
206 		__asm __volatile("incw %%fs:%0"				\
207 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
208 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
209 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
210 		__asm __volatile("incl %%fs:%0"				\
211 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
212 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
213 	}								\
214 } while (0)
215 
216 /*
217  * Sets the value of the per-cpu variable name to value val.
218  */
219 #define	__PCPU_SET(name, val) do {					\
220 	__pcpu_type(name) __val;					\
221 	struct __s {							\
222 		u_char	__b[MIN(sizeof(__val), 4)];			\
223 	} __s;								\
224 									\
225 	__val = (val);							\
226 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
227 	    sizeof(__val) == 4) {					\
228 		__s = *(struct __s *)(void *)&__val;			\
229 		__asm __volatile("mov %1,%%fs:%0"			\
230 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
231 		    : "r" (__s));					\
232 	} else {							\
233 		*__PCPU_PTR(name) = __val;				\
234 	}								\
235 } while (0)
236 
237 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
238 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
239 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
240 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
241 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
242 
243 #define	OFFSETOF_CURTHREAD	0
244 #ifdef __clang__
245 #pragma clang diagnostic push
246 #pragma clang diagnostic ignored "-Wnull-dereference"
247 #endif
248 static __inline __pure2 struct thread *
249 __curthread(void)
250 {
251 	struct thread *td;
252 
253 	__asm("movl %%fs:%1,%0" : "=r" (td)
254 	    : "m" (*(char *)OFFSETOF_CURTHREAD));
255 	return (td);
256 }
257 #ifdef __clang__
258 #pragma clang diagnostic pop
259 #endif
260 #define	curthread		(__curthread())
261 
262 #define	OFFSETOF_CURPCB		16
263 static __inline __pure2 struct pcb *
264 __curpcb(void)
265 {
266 	struct pcb *pcb;
267 
268 	__asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
269 	return (pcb);
270 }
271 #define	curpcb		(__curpcb())
272 
273 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
274 
275 #error "this file needs to be ported to your compiler"
276 
277 #endif /* lint, etc. */
278 
279 #endif /* _KERNEL */
280 
281 #endif /* !_MACHINE_PCPU_H_ */
282