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