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