xref: /freebsd/sys/amd64/include/pcpu.h (revision 718cf2ccb9956613756ab15d7a0e28f2c8e91cab)
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 #if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
78 
79 /*
80  * Evaluates to the byte offset of the per-cpu variable name.
81  */
82 #define	__pcpu_offset(name)						\
83 	__offsetof(struct pcpu, name)
84 
85 /*
86  * Evaluates to the type of the per-cpu variable name.
87  */
88 #define	__pcpu_type(name)						\
89 	__typeof(((struct pcpu *)0)->name)
90 
91 /*
92  * Evaluates to the address of the per-cpu variable name.
93  */
94 #define	__PCPU_PTR(name) __extension__ ({				\
95 	__pcpu_type(name) *__p;						\
96 									\
97 	__asm __volatile("movq %%gs:%1,%0; addq %2,%0"			\
98 	    : "=r" (__p)						\
99 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
100 	      "i" (__pcpu_offset(name)));				\
101 									\
102 	__p;								\
103 })
104 
105 /*
106  * Evaluates to the value of the per-cpu variable name.
107  */
108 #define	__PCPU_GET(name) __extension__ ({				\
109 	__pcpu_type(name) __res;					\
110 	struct __s {							\
111 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
112 	} __s;								\
113 									\
114 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
115 	    sizeof(__res) == 4 || sizeof(__res) == 8) {			\
116 		__asm __volatile("mov %%gs:%1,%0"			\
117 		    : "=r" (__s)					\
118 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
119 		*(struct __s *)(void *)&__res = __s;			\
120 	} else {							\
121 		__res = *__PCPU_PTR(name);				\
122 	}								\
123 	__res;								\
124 })
125 
126 /*
127  * Adds the value to the per-cpu counter name.  The implementation
128  * must be atomic with respect to interrupts.
129  */
130 #define	__PCPU_ADD(name, val) do {					\
131 	__pcpu_type(name) __val;					\
132 	struct __s {							\
133 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
134 	} __s;								\
135 									\
136 	__val = (val);							\
137 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
138 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
139 		__s = *(struct __s *)(void *)&__val;			\
140 		__asm __volatile("add %1,%%gs:%0"			\
141 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
142 		    : "r" (__s));					\
143 	} else								\
144 		*__PCPU_PTR(name) += __val;				\
145 } while (0)
146 
147 /*
148  * Increments the value of the per-cpu counter name.  The implementation
149  * must be atomic with respect to interrupts.
150  */
151 #define	__PCPU_INC(name) do {						\
152 	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
153 	    sizeof(__pcpu_type(name)) == 2 ||				\
154 	    sizeof(__pcpu_type(name)) == 4 ||				\
155 	    sizeof(__pcpu_type(name)) == 8);				\
156 	if (sizeof(__pcpu_type(name)) == 1) {				\
157 		__asm __volatile("incb %%gs:%0"				\
158 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
159 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
160 	} else if (sizeof(__pcpu_type(name)) == 2) {			\
161 		__asm __volatile("incw %%gs:%0"				\
162 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
163 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
164 	} else if (sizeof(__pcpu_type(name)) == 4) {			\
165 		__asm __volatile("incl %%gs:%0"				\
166 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
167 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
168 	} else if (sizeof(__pcpu_type(name)) == 8) {			\
169 		__asm __volatile("incq %%gs:%0"				\
170 		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
171 		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
172 	}								\
173 } while (0)
174 
175 /*
176  * Sets the value of the per-cpu variable name to value val.
177  */
178 #define	__PCPU_SET(name, val) {						\
179 	__pcpu_type(name) __val;					\
180 	struct __s {							\
181 		u_char	__b[MIN(sizeof(__pcpu_type(name)), 8)];		\
182 	} __s;								\
183 									\
184 	__val = (val);							\
185 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
186 	    sizeof(__val) == 4 || sizeof(__val) == 8) {			\
187 		__s = *(struct __s *)(void *)&__val;			\
188 		__asm __volatile("mov %1,%%gs:%0"			\
189 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
190 		    : "r" (__s));					\
191 	} else {							\
192 		*__PCPU_PTR(name) = __val;				\
193 	}								\
194 }
195 
196 #define	get_pcpu() __extension__ ({					\
197 	struct pcpu *__pc;						\
198 									\
199 	__asm __volatile("movq %%gs:%1,%0"				\
200 	    : "=r" (__pc)						\
201 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
202 	__pc;								\
203 })
204 
205 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
206 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
207 #define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
208 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
209 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
210 
211 #define	OFFSETOF_CURTHREAD	0
212 #ifdef __clang__
213 #pragma clang diagnostic push
214 #pragma clang diagnostic ignored "-Wnull-dereference"
215 #endif
216 static __inline __pure2 struct thread *
217 __curthread(void)
218 {
219 	struct thread *td;
220 
221 	__asm("movq %%gs:%1,%0" : "=r" (td)
222 	    : "m" (*(char *)OFFSETOF_CURTHREAD));
223 	return (td);
224 }
225 #ifdef __clang__
226 #pragma clang diagnostic pop
227 #endif
228 #define	curthread		(__curthread())
229 
230 #define	OFFSETOF_CURPCB		32
231 static __inline __pure2 struct pcb *
232 __curpcb(void)
233 {
234 	struct pcb *pcb;
235 
236 	__asm("movq %%gs:%1,%0" : "=r" (pcb) : "m" (*(char *)OFFSETOF_CURPCB));
237 	return (pcb);
238 }
239 #define	curpcb		(__curpcb())
240 
241 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
242 
243 #else /* !__GNUCLIKE_ASM || !__GNUCLIKE___TYPEOF */
244 
245 #error "this file needs to be ported to your compiler"
246 
247 #endif /* __GNUCLIKE_ASM && __GNUCLIKE___TYPEOF */
248 
249 #endif /* _KERNEL */
250 
251 #endif /* !_MACHINE_PCPU_H_ */
252