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