xref: /freebsd/sys/amd64/include/pcpu.h (revision 3416500aef140042c64bc149cb1ec6620483bc44)
1 /*-
2  * Copyright (c) Peter Wemm <peter@netplex.com.au>
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 /*
37  * The SMP parts are setup in pmap.c and locore.s for the BSP, and
38  * mp_machdep.c sets up the data for the AP's to "see" when they awake.
39  * The reason for doing it via a struct is so that an array of pointers
40  * to each CPU's data can be set up for things like "check curproc on all
41  * other processors"
42  */
43 #define	PCPU_MD_FIELDS							\
44 	char	pc_monitorbuf[128] __aligned(128); /* cache line */	\
45 	struct	pcpu *pc_prvspace;	/* Self-reference */		\
46 	struct	pmap *pc_curpmap;					\
47 	struct	amd64tss *pc_tssp;	/* TSS segment active on CPU */	\
48 	struct	amd64tss *pc_commontssp;/* Common TSS for the CPU */	\
49 	register_t pc_rsp0;						\
50 	register_t pc_scratch_rsp;	/* User %rsp in syscall */	\
51 	u_int	pc_apic_id;						\
52 	u_int   pc_acpi_id;		/* ACPI CPU id */		\
53 	/* Pointer to the CPU %fs descriptor */				\
54 	struct user_segment_descriptor	*pc_fs32p;			\
55 	/* Pointer to the CPU %gs descriptor */				\
56 	struct user_segment_descriptor	*pc_gs32p;			\
57 	/* Pointer to the CPU LDT descriptor */				\
58 	struct system_segment_descriptor *pc_ldt;			\
59 	/* Pointer to the CPU TSS descriptor */				\
60 	struct system_segment_descriptor *pc_tss;			\
61 	uint64_t	pc_pm_save_cnt;					\
62 	u_int	pc_cmci_mask;		/* MCx banks for CMCI */	\
63 	uint64_t pc_dbreg[16];		/* ddb debugging regs */	\
64 	int pc_dbreg_cmd;		/* ddb debugging reg cmd */	\
65 	u_int	pc_vcpu_id;		/* Xen vCPU ID */		\
66 	uint32_t pc_pcid_next;						\
67 	uint32_t pc_pcid_gen;						\
68 	uint32_t pc_smp_tlb_done;	/* TLB op acknowledgement */	\
69 	char	__pad[384]		/* be divisor of PAGE_SIZE	\
70 					   after cache alignment */
71 
72 #define	PC_DBREG_CMD_NONE	0
73 #define	PC_DBREG_CMD_LOAD	1
74 
75 #ifdef _KERNEL
76 
77 #ifdef lint
78 
79 extern struct pcpu *pcpup;
80 
81 #define	get_pcpu()		(pcpup)
82 #define	PCPU_GET(member)	(pcpup->pc_ ## member)
83 #define	PCPU_ADD(member, val)	(pcpup->pc_ ## member += (val))
84 #define	PCPU_INC(member)	PCPU_ADD(member, 1)
85 #define	PCPU_PTR(member)	(&pcpup->pc_ ## member)
86 #define	PCPU_SET(member, val)	(pcpup->pc_ ## member = (val))
87 
88 #elif defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
89 
90 /*
91  * Evaluates to the byte offset of the per-cpu variable name.
92  */
93 #define	__pcpu_offset(name)						\
94 	__offsetof(struct pcpu, name)
95 
96 /*
97  * Evaluates to the type of the per-cpu variable name.
98  */
99 #define	__pcpu_type(name)						\
100 	__typeof(((struct pcpu *)0)->name)
101 
102 /*
103  * Evaluates to the address of the per-cpu variable name.
104  */
105 #define	__PCPU_PTR(name) __extension__ ({				\
106 	__pcpu_type(name) *__p;						\
107 									\
108 	__asm __volatile("movq %%gs:%1,%0; addq %2,%0"			\
109 	    : "=r" (__p)						\
110 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
111 	      "i" (__pcpu_offset(name)));				\
112 									\
113 	__p;								\
114 })
115 
116 /*
117  * Evaluates to the value of the per-cpu variable name.
118  */
119 #define	__PCPU_GET(name) __extension__ ({				\
120 	__pcpu_type(name) __res;					\
121 	struct __s {							\
122 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
123 	} __s;								\
124 									\
125 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
126 	    sizeof(__res) == 4 || sizeof(__res) == 8) {			\
127 		__asm __volatile("mov %%gs:%1,%0"			\
128 		    : "=r" (__s)					\
129 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
130 		*(struct __s *)(void *)&__res = __s;			\
131 	} else {							\
132 		__res = *__PCPU_PTR(name);				\
133 	}								\
134 	__res;								\
135 })
136 
137 /*
138  * Adds the value to the per-cpu counter name.  The implementation
139  * must be atomic with respect to interrupts.
140  */
141 #define	__PCPU_ADD(name, val) do {					\
142 	__pcpu_type(name) __val;					\
143 	struct __s {							\
144 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
145 	} __s;								\
146 									\
147 	__val = (val);							\
148 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
149 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
150 		__s = *(struct __s *)(void *)&__val;			\
151 		__asm __volatile("add %1,%%gs:%0"			\
152 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
153 		    : "r" (__s));					\
154 	} else								\
155 		*__PCPU_PTR(name) += __val;				\
156 } while (0)
157 
158 /*
159  * Increments the value of the per-cpu counter name.  The implementation
160  * must be atomic with respect to interrupts.
161  */
162 #define	__PCPU_INC(name) do {						\
163 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
164 	    sizeof(__pcpu_type(name)) == 2 ||				\
165 	    sizeof(__pcpu_type(name)) == 4 ||				\
166 	    sizeof(__pcpu_type(name)) == 8);				\
167 	if (sizeof(__pcpu_type(name)) == 1) {				\
168 		__asm __volatile("incb %%gs:%0"				\
169 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
170 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
171 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
172 		__asm __volatile("incw %%gs:%0"				\
173 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
174 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
175 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
176 		__asm __volatile("incl %%gs:%0"				\
177 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
178 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
179 	} else if (sizeof(__pcpu_type(name)) == 8) {			\
180 		__asm __volatile("incq %%gs:%0"				\
181 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
182 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
183 	}								\
184 } while (0)
185 
186 /*
187  * Sets the value of the per-cpu variable name to value val.
188  */
189 #define	__PCPU_SET(name, val) {						\
190 	__pcpu_type(name) __val;					\
191 	struct __s {							\
192 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
193 	} __s;								\
194 									\
195 	__val = (val);							\
196 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
197 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
198 		__s = *(struct __s *)(void *)&__val;			\
199 		__asm __volatile("mov %1,%%gs:%0"			\
200 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
201 		    : "r" (__s));					\
202 	} else {							\
203 		*__PCPU_PTR(name) = __val;				\
204 	}								\
205 }
206 
207 #define	get_pcpu() __extension__ ({					\
208 	struct pcpu *__pc;						\
209 									\
210 	__asm __volatile("movq %%gs:%1,%0"				\
211 	    : "=r" (__pc)						\
212 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
213 	__pc;								\
214 })
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("movq %%gs:%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		32
242 static __inline __pure2 struct pcb *
243 __curpcb(void)
244 {
245 	struct pcb *pcb;
246 
247 	__asm("movq %%gs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
248 	return (pcb);
249 }
250 #define	curpcb		(__curpcb())
251 
252 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
253 
254 #else /* !lint || defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
255 
256 #error "this file needs to be ported to your compiler"
257 
258 #endif /* lint, etc. */
259 
260 #endif /* _KERNEL */
261 
262 #endif /* !_MACHINE_PCPU_H_ */
263