xref: /freebsd/sys/i386/include/pcpu.h (revision 1c05a6ea6b849ff95e539c31adea887c644a6a01)
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 #include <sys/_lock.h>
40 #include <sys/_mutex.h>
41 
42 /*
43  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
44  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
45  * The reason for doing it via a struct is so that an array of pointers
46  * to each CPU's data can be set up for things like "check curproc on all
47  * other processors"
48  */
49 
50 #define	PCPU_MD_FIELDS							\
51 	char	pc_monitorbuf[128] __aligned(128); /* cache line */	\
52 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
53 	struct	pmap *pc_curpmap;					\
54 	struct	i386tss pc_common_tss;					\
55 	struct	segment_descriptor pc_common_tssd;			\
56 	struct	segment_descriptor *pc_tss_gdt;				\
57 	struct	segment_descriptor *pc_fsgs_gdt;			\
58 	int	pc_currentldt;						\
59 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
60 	u_int	pc_apic_id;						\
61 	int	pc_private_tss;		/* Flag indicating private tss*/\
62 	u_int	pc_cmci_mask;		/* MCx banks for CMCI */	\
63 	u_int	pc_vcpu_id;		/* Xen vCPU ID */		\
64 	struct	mtx pc_cmap_lock;					\
65 	void	*pc_cmap_pte1;						\
66 	void	*pc_cmap_pte2;						\
67 	caddr_t	pc_cmap_addr1;						\
68 	caddr_t	pc_cmap_addr2;						\
69 	vm_offset_t pc_qmap_addr;	/* KVA for temporary mappings */\
70 	uint32_t pc_smp_tlb_done;	/* TLB op acknowledgement */	\
71 	char	__pad[445]
72 
73 #ifdef _KERNEL
74 
75 #ifdef lint
76 
77 extern struct pcpu *pcpup;
78 
79 #define	get_pcpu()		(pcpup)
80 #define	PCPU_GET(member)	(pcpup->pc_ ## member)
81 #define	PCPU_ADD(member, val)	(pcpup->pc_ ## member += (val))
82 #define	PCPU_INC(member)	PCPU_ADD(member, 1)
83 #define	PCPU_PTR(member)	(&pcpup->pc_ ## member)
84 #define	PCPU_SET(member, val)	(pcpup->pc_ ## member = (val))
85 
86 #elif defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
87 
88 /*
89  * Evaluates to the byte offset of the per-cpu variable name.
90  */
91 #define	__pcpu_offset(name)						\
92 	__offsetof(struct pcpu, name)
93 
94 /*
95  * Evaluates to the type of the per-cpu variable name.
96  */
97 #define	__pcpu_type(name)						\
98 	__typeof(((struct pcpu *)0)->name)
99 
100 /*
101  * Evaluates to the address of the per-cpu variable name.
102  */
103 #define	__PCPU_PTR(name) __extension__ ({				\
104 	__pcpu_type(name) *__p;						\
105 									\
106 	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
107 	    : "=r" (__p)						\
108 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
109 	      "i" (__pcpu_offset(name)));				\
110 									\
111 	__p;								\
112 })
113 
114 /*
115  * Evaluates to the value of the per-cpu variable name.
116  */
117 #define	__PCPU_GET(name) __extension__ ({				\
118 	__pcpu_type(name) __res;					\
119 	struct __s {							\
120 		u_char	__b[MIN(sizeof(__res), 4)];			\
121 	} __s;								\
122 									\
123 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
124 	    sizeof(__res) == 4) {					\
125 		__asm __volatile("mov %%fs:%1,%0"			\
126 		    : "=r" (__s)					\
127 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
128 		*(struct __s *)(void *)&__res = __s;			\
129 	} else {							\
130 		__res = *__PCPU_PTR(name);				\
131 	}								\
132 	__res;								\
133 })
134 
135 /*
136  * Adds a value of the per-cpu counter name.  The implementation
137  * must be atomic with respect to interrupts.
138  */
139 #define	__PCPU_ADD(name, val) do {					\
140 	__pcpu_type(name) __val;					\
141 	struct __s {							\
142 		u_char	__b[MIN(sizeof(__val), 4)];			\
143 	} __s;								\
144 									\
145 	__val = (val);							\
146 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
147 	    sizeof(__val) == 4) {					\
148 		__s = *(struct __s *)(void *)&__val;			\
149 		__asm __volatile("add %1,%%fs:%0"			\
150 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
151 		    : "r" (__s));					\
152 	} else								\
153 		*__PCPU_PTR(name) += __val;				\
154 } while (0)
155 
156 /*
157  * Increments the value of the per-cpu counter name.  The implementation
158  * must be atomic with respect to interrupts.
159  */
160 #define	__PCPU_INC(name) do {						\
161 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
162 	    sizeof(__pcpu_type(name)) == 2 ||				\
163 	    sizeof(__pcpu_type(name)) == 4);				\
164 	if (sizeof(__pcpu_type(name)) == 1) {				\
165 		__asm __volatile("incb %%fs:%0"				\
166 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
167 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
168 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
169 		__asm __volatile("incw %%fs:%0"				\
170 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
171 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
172 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
173 		__asm __volatile("incl %%fs:%0"				\
174 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
175 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
176 	}								\
177 } while (0)
178 
179 /*
180  * Sets the value of the per-cpu variable name to value val.
181  */
182 #define	__PCPU_SET(name, val) do {					\
183 	__pcpu_type(name) __val;					\
184 	struct __s {							\
185 		u_char	__b[MIN(sizeof(__val), 4)];			\
186 	} __s;								\
187 									\
188 	__val = (val);							\
189 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
190 	    sizeof(__val) == 4) {					\
191 		__s = *(struct __s *)(void *)&__val;			\
192 		__asm __volatile("mov %1,%%fs:%0"			\
193 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
194 		    : "r" (__s));					\
195 	} else {							\
196 		*__PCPU_PTR(name) = __val;				\
197 	}								\
198 } while (0)
199 
200 #define	get_pcpu() __extension__ ({					\
201 	struct pcpu *__pc;						\
202 									\
203 	__asm __volatile("movl %%fs:%1,%0"				\
204 	    : "=r" (__pc)						\
205 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
206 	__pc;								\
207 })
208 
209 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
210 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
211 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
212 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
213 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
214 
215 #define	OFFSETOF_CURTHREAD	0
216 #ifdef __clang__
217 #pragma clang diagnostic push
218 #pragma clang diagnostic ignored "-Wnull-dereference"
219 #endif
220 static __inline __pure2 struct thread *
221 __curthread(void)
222 {
223 	struct thread *td;
224 
225 	__asm("movl %%fs:%1,%0" : "=r" (td)
226 	    : "m" (*(char *)OFFSETOF_CURTHREAD));
227 	return (td);
228 }
229 #ifdef __clang__
230 #pragma clang diagnostic pop
231 #endif
232 #define	curthread		(__curthread())
233 
234 #define	OFFSETOF_CURPCB		16
235 static __inline __pure2 struct pcb *
236 __curpcb(void)
237 {
238 	struct pcb *pcb;
239 
240 	__asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
241 	return (pcb);
242 }
243 #define	curpcb		(__curpcb())
244 
245 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
246 
247 #error "this file needs to be ported to your compiler"
248 
249 #endif /* lint, etc. */
250 
251 #endif /* _KERNEL */
252 
253 #endif /* !_MACHINE_PCPU_H_ */
254