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