xref: /freebsd/sys/i386/include/pcpu.h (revision c9083b850aed19fff781fd82084e8308c9ae6df6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) Peter Wemm
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _MACHINE_PCPU_H_
32 #define	_MACHINE_PCPU_H_
33 
34 #ifndef _SYS_CDEFS_H_
35 #error "sys/cdefs.h is a prerequisite for this file"
36 #endif
37 
38 #include <machine/segments.h>
39 #include <machine/tss.h>
40 
41 #include <sys/_lock.h>
42 #include <sys/_mutex.h>
43 
44 struct monitorbuf {
45 	int idle_state;		/* Used by cpu_idle_mwait. */
46 	int stop_state;		/* Used by cpustop_handler. */
47 	char padding[128 - (2 * sizeof(int))];
48 };
49 _Static_assert(sizeof(struct monitorbuf) == 128, "2x cache line");
50 
51 /*
52  * The SMP parts are setup in pmap.c and machdep.c for the BSP, and
53  * pmap.c and mp_machdep.c sets up the data for the AP's to "see" when
54  * they awake.  The reason for doing it via a struct is so that an
55  * array of pointers to each CPU's data can be set up for things like
56  * "check curproc on all other processors"
57  */
58 
59 #define	PCPU_MD_FIELDS							\
60 	struct monitorbuf pc_monitorbuf __aligned(128);	/* cache line */\
61 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
62 	struct	pmap *pc_curpmap;					\
63 	struct	segment_descriptor pc_common_tssd;			\
64 	struct	segment_descriptor *pc_tss_gdt;				\
65 	struct	segment_descriptor *pc_fsgs_gdt;			\
66 	struct	i386tss *pc_common_tssp;				\
67 	u_int	pc_kesp0;						\
68 	u_int	pc_trampstk;						\
69 	int	pc_currentldt;						\
70 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
71 	u_int	pc_apic_id;						\
72 	int	pc_private_tss;		/* Flag indicating private tss*/\
73 	u_int	pc_cmci_mask;		/* MCx banks for CMCI */	\
74 	u_int	pc_vcpu_id;		/* Xen vCPU ID */		\
75 	struct	mtx pc_cmap_lock;					\
76 	void	*pc_cmap_pte1;						\
77 	void	*pc_cmap_pte2;						\
78 	caddr_t	pc_cmap_addr1;						\
79 	caddr_t	pc_cmap_addr2;						\
80 	vm_offset_t pc_qmap_addr;	/* KVA for temporary mappings */\
81 	vm_offset_t pc_copyout_maddr;					\
82 	vm_offset_t pc_copyout_saddr;					\
83 	struct	mtx pc_copyout_mlock;					\
84 	struct	sx pc_copyout_slock;					\
85 	char	*pc_copyout_buf;					\
86 	vm_offset_t pc_pmap_eh_va;					\
87 	caddr_t pc_pmap_eh_ptep;						\
88 	uint32_t pc_smp_tlb_done;	/* TLB op acknowledgement */	\
89 	uint32_t pc_ibpb_set;						\
90 	char	__pad[3610]
91 
92 #ifdef _KERNEL
93 
94 #define MONITOR_STOPSTATE_RUNNING	0
95 #define MONITOR_STOPSTATE_STOPPED	1
96 
97 #if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
98 
99 /*
100  * Evaluates to the byte offset of the per-cpu variable name.
101  */
102 #define	__pcpu_offset(name)						\
103 	__offsetof(struct pcpu, name)
104 
105 /*
106  * Evaluates to the type of the per-cpu variable name.
107  */
108 #define	__pcpu_type(name)						\
109 	__typeof(((struct pcpu *)0)->name)
110 
111 /*
112  * Evaluates to the address of the per-cpu variable name.
113  */
114 #define	__PCPU_PTR(name) __extension__ ({				\
115 	__pcpu_type(name) *__p;						\
116 									\
117 	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
118 	    : "=r" (__p)						\
119 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
120 	      "i" (__pcpu_offset(name)));				\
121 									\
122 	__p;								\
123 })
124 
125 /*
126  * Evaluates to the value of the per-cpu variable name.
127  */
128 #define	__PCPU_GET(name) __extension__ ({				\
129 	__pcpu_type(name) __res;					\
130 	struct __s {							\
131 		u_char	__b[MIN(sizeof(__res), 4)];			\
132 	} __s;								\
133 									\
134 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
135 	    sizeof(__res) == 4) {					\
136 		__asm __volatile("mov %%fs:%1,%0"			\
137 		    : "=r" (__s)					\
138 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
139 		*(struct __s *)(void *)&__res = __s;			\
140 	} else {							\
141 		__res = *__PCPU_PTR(name);				\
142 	}								\
143 	__res;								\
144 })
145 
146 /*
147  * Adds a value of the per-cpu counter name.  The implementation
148  * must be atomic with respect to interrupts.
149  */
150 #define	__PCPU_ADD(name, val) do {					\
151 	__pcpu_type(name) __val;					\
152 	struct __s {							\
153 		u_char	__b[MIN(sizeof(__val), 4)];			\
154 	} __s;								\
155 									\
156 	__val = (val);							\
157 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
158 	    sizeof(__val) == 4) {					\
159 		__s = *(struct __s *)(void *)&__val;			\
160 		__asm __volatile("add %1,%%fs:%0"			\
161 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
162 		    : "r" (__s));					\
163 	} else								\
164 		*__PCPU_PTR(name) += __val;				\
165 } while (0)
166 
167 /*
168  * Increments the value of the per-cpu counter name.  The implementation
169  * must be atomic with respect to interrupts.
170  */
171 #define	__PCPU_INC(name) do {						\
172 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
173 	    sizeof(__pcpu_type(name)) == 2 ||				\
174 	    sizeof(__pcpu_type(name)) == 4);				\
175 	if (sizeof(__pcpu_type(name)) == 1) {				\
176 		__asm __volatile("incb %%fs:%0"				\
177 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
178 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
179 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
180 		__asm __volatile("incw %%fs:%0"				\
181 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
182 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
183 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
184 		__asm __volatile("incl %%fs:%0"				\
185 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
186 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
187 	}								\
188 } while (0)
189 
190 /*
191  * Sets the value of the per-cpu variable name to value val.
192  */
193 #define	__PCPU_SET(name, val) do {					\
194 	__pcpu_type(name) __val;					\
195 	struct __s {							\
196 		u_char	__b[MIN(sizeof(__val), 4)];			\
197 	} __s;								\
198 									\
199 	__val = (val);							\
200 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
201 	    sizeof(__val) == 4) {					\
202 		__s = *(struct __s *)(void *)&__val;			\
203 		__asm __volatile("mov %1,%%fs:%0"			\
204 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
205 		    : "r" (__s));					\
206 	} else {							\
207 		*__PCPU_PTR(name) = __val;				\
208 	}								\
209 } while (0)
210 
211 #define	get_pcpu() __extension__ ({					\
212 	struct pcpu *__pc;						\
213 									\
214 	__asm __volatile("movl %%fs:%1,%0"				\
215 	    : "=r" (__pc)						\
216 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
217 	__pc;								\
218 })
219 
220 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
221 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
222 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
223 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
224 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
225 
226 #define	OFFSETOF_CURTHREAD	0
227 #ifdef __clang__
228 #pragma clang diagnostic push
229 #pragma clang diagnostic ignored "-Wnull-dereference"
230 #endif
231 static __inline __pure2 struct thread *
232 __curthread(void)
233 {
234 	struct thread *td;
235 
236 	__asm("movl %%fs:%1,%0" : "=r" (td)
237 	    : "m" (*(char *)OFFSETOF_CURTHREAD));
238 	return (td);
239 }
240 #ifdef __clang__
241 #pragma clang diagnostic pop
242 #endif
243 #define	curthread		(__curthread())
244 
245 #define	OFFSETOF_CURPCB		16
246 static __inline __pure2 struct pcb *
247 __curpcb(void)
248 {
249 	struct pcb *pcb;
250 
251 	__asm("movl %%fs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
252 	return (pcb);
253 }
254 #define	curpcb		(__curpcb())
255 
256 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
257 
258 #else /* defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
259 
260 #error "this file needs to be ported to your compiler"
261 
262 #endif /* __GNUCLIKE_ASM etc. */
263 
264 #endif /* _KERNEL */
265 
266 #endif /* !_MACHINE_PCPU_H_ */
267