xref: /freebsd/sys/i386/include/pcpu.h (revision b2d48be1bc7df45ddd13b143a160d0acb5a383c5)
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 #define	PCPU_MD_FIELDS							\
48 	char	pc_monitorbuf[128] __aligned(128); /* cache line */	\
49 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
50 	struct	pmap *pc_curpmap;					\
51 	struct	i386tss pc_common_tss;					\
52 	struct	segment_descriptor pc_common_tssd;			\
53 	struct	segment_descriptor *pc_tss_gdt;				\
54 	struct	segment_descriptor *pc_fsgs_gdt;			\
55 	int	pc_currentldt;						\
56 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
57 	u_int	pc_apic_id;						\
58 	int	pc_private_tss;		/* Flag indicating private tss*/\
59 	u_int	pc_cmci_mask;		/* MCx banks for CMCI */	\
60 	u_int	pc_vcpu_id;		/* Xen vCPU ID */		\
61 	vm_offset_t pc_qmap_addr;	/* KVA for temporary mappings */\
62 	char	__pad[229]
63 
64 #ifdef _KERNEL
65 
66 #ifdef lint
67 
68 extern struct pcpu *pcpup;
69 
70 #define	PCPU_GET(member)	(pcpup->pc_ ## member)
71 #define	PCPU_ADD(member, val)	(pcpup->pc_ ## member += (val))
72 #define	PCPU_INC(member)	PCPU_ADD(member, 1)
73 #define	PCPU_PTR(member)	(&pcpup->pc_ ## member)
74 #define	PCPU_SET(member, val)	(pcpup->pc_ ## member = (val))
75 
76 #elif defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
77 
78 /*
79  * Evaluates to the byte offset of the per-cpu variable name.
80  */
81 #define	__pcpu_offset(name)						\
82 	__offsetof(struct pcpu, name)
83 
84 /*
85  * Evaluates to the type of the per-cpu variable name.
86  */
87 #define	__pcpu_type(name)						\
88 	__typeof(((struct pcpu *)0)->name)
89 
90 /*
91  * Evaluates to the address of the per-cpu variable name.
92  */
93 #define	__PCPU_PTR(name) __extension__ ({				\
94 	__pcpu_type(name) *__p;						\
95 									\
96 	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
97 	    : "=r" (__p)						\
98 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
99 	      "i" (__pcpu_offset(name)));				\
100 									\
101 	__p;								\
102 })
103 
104 /*
105  * Evaluates to the value of the per-cpu variable name.
106  */
107 #define	__PCPU_GET(name) __extension__ ({				\
108 	__pcpu_type(name) __res;					\
109 	struct __s {							\
110 		u_char	__b[MIN(sizeof(__res), 4)];			\
111 	} __s;								\
112 									\
113 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
114 	    sizeof(__res) == 4) {					\
115 		__asm __volatile("mov %%fs:%1,%0"			\
116 		    : "=r" (__s)					\
117 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
118 		*(struct __s *)(void *)&__res = __s;			\
119 	} else {							\
120 		__res = *__PCPU_PTR(name);				\
121 	}								\
122 	__res;								\
123 })
124 
125 /*
126  * Adds a value of the per-cpu counter name.  The implementation
127  * must be atomic with respect to interrupts.
128  */
129 #define	__PCPU_ADD(name, val) do {					\
130 	__pcpu_type(name) __val;					\
131 	struct __s {							\
132 		u_char	__b[MIN(sizeof(__val), 4)];			\
133 	} __s;								\
134 									\
135 	__val = (val);							\
136 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
137 	    sizeof(__val) == 4) {					\
138 		__s = *(struct __s *)(void *)&__val;			\
139 		__asm __volatile("add %1,%%fs:%0"			\
140 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
141 		    : "r" (__s));					\
142 	} else								\
143 		*__PCPU_PTR(name) += __val;				\
144 } while (0)
145 
146 /*
147  * Increments the value of the per-cpu counter name.  The implementation
148  * must be atomic with respect to interrupts.
149  */
150 #define	__PCPU_INC(name) do {						\
151 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
152 	    sizeof(__pcpu_type(name)) == 2 ||				\
153 	    sizeof(__pcpu_type(name)) == 4);				\
154 	if (sizeof(__pcpu_type(name)) == 1) {				\
155 		__asm __volatile("incb %%fs:%0"				\
156 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
157 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
158 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
159 		__asm __volatile("incw %%fs:%0"				\
160 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
161 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
162 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
163 		__asm __volatile("incl %%fs:%0"				\
164 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
165 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
166 	}								\
167 } while (0)
168 
169 /*
170  * Sets the value of the per-cpu variable name to value val.
171  */
172 #define	__PCPU_SET(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("mov %1,%%fs:%0"			\
183 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
184 		    : "r" (__s));					\
185 	} else {							\
186 		*__PCPU_PTR(name) = __val;				\
187 	}								\
188 } while (0)
189 
190 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
191 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
192 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
193 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
194 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
195 
196 #define	OFFSETOF_CURTHREAD	0
197 #ifdef __clang__
198 #pragma clang diagnostic push
199 #pragma clang diagnostic ignored "-Wnull-dereference"
200 #endif
201 static __inline __pure2 struct thread *
202 __curthread(void)
203 {
204 	struct thread *td;
205 
206 	__asm("movl %%fs:%1,%0" : "=r" (td)
207 	    : "m" (*(char *)OFFSETOF_CURTHREAD));
208 	return (td);
209 }
210 #ifdef __clang__
211 #pragma clang diagnostic pop
212 #endif
213 #define	curthread		(__curthread())
214 
215 #define	OFFSETOF_CURPCB		16
216 static __inline __pure2 struct pcb *
217 __curpcb(void)
218 {
219 	struct pcb *pcb;
220 
221 	__asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
222 	return (pcb);
223 }
224 #define	curpcb		(__curpcb())
225 
226 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
227 
228 #error "this file needs to be ported to your compiler"
229 
230 #endif /* lint, etc. */
231 
232 #endif /* _KERNEL */
233 
234 #endif /* !_MACHINE_PCPU_H_ */
235