xref: /freebsd/sys/i386/include/pcpu.h (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
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 	void	*pc_mds_buf;						\
91 	void	*pc_mds_buf64;						\
92 	uint32_t pc_pad[4];						\
93 	uint8_t	pc_mds_tmp[64];						\
94 	u_int	pc_ipi_bitmap;						\
95 	char	__pad[3518]
96 
97 #ifdef _KERNEL
98 
99 #define MONITOR_STOPSTATE_RUNNING	0
100 #define MONITOR_STOPSTATE_STOPPED	1
101 
102 #if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
103 
104 /*
105  * Evaluates to the byte offset of the per-cpu variable name.
106  */
107 #define	__pcpu_offset(name)						\
108 	__offsetof(struct pcpu, name)
109 
110 /*
111  * Evaluates to the type of the per-cpu variable name.
112  */
113 #define	__pcpu_type(name)						\
114 	__typeof(((struct pcpu *)0)->name)
115 
116 /*
117  * Evaluates to the address of the per-cpu variable name.
118  */
119 #define	__PCPU_PTR(name) __extension__ ({				\
120 	__pcpu_type(name) *__p;						\
121 									\
122 	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
123 	    : "=r" (__p)						\
124 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
125 	      "i" (__pcpu_offset(name)));				\
126 									\
127 	__p;								\
128 })
129 
130 /*
131  * Evaluates to the value of the per-cpu variable name.
132  */
133 #define	__PCPU_GET(name) __extension__ ({				\
134 	__pcpu_type(name) __res;					\
135 	struct __s {							\
136 		u_char	__b[MIN(sizeof(__res), 4)];			\
137 	} __s;								\
138 									\
139 	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
140 	    sizeof(__res) == 4) {					\
141 		__asm __volatile("mov %%fs:%1,%0"			\
142 		    : "=r" (__s)					\
143 		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
144 		*(struct __s *)(void *)&__res = __s;			\
145 	} else {							\
146 		__res = *__PCPU_PTR(name);				\
147 	}								\
148 	__res;								\
149 })
150 
151 /*
152  * Adds a value of the per-cpu counter name.  The implementation
153  * must be atomic with respect to interrupts.
154  */
155 #define	__PCPU_ADD(name, val) do {					\
156 	__pcpu_type(name) __val;					\
157 	struct __s {							\
158 		u_char	__b[MIN(sizeof(__val), 4)];			\
159 	} __s;								\
160 									\
161 	__val = (val);							\
162 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
163 	    sizeof(__val) == 4) {					\
164 		__s = *(struct __s *)(void *)&__val;			\
165 		__asm __volatile("add %1,%%fs:%0"			\
166 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
167 		    : "r" (__s));					\
168 	} else								\
169 		*__PCPU_PTR(name) += __val;				\
170 } while (0)
171 
172 /*
173  * Sets the value of the per-cpu variable name to value val.
174  */
175 #define	__PCPU_SET(name, val) do {					\
176 	__pcpu_type(name) __val;					\
177 	struct __s {							\
178 		u_char	__b[MIN(sizeof(__val), 4)];			\
179 	} __s;								\
180 									\
181 	__val = (val);							\
182 	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
183 	    sizeof(__val) == 4) {					\
184 		__s = *(struct __s *)(void *)&__val;			\
185 		__asm __volatile("mov %1,%%fs:%0"			\
186 		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
187 		    : "r" (__s));					\
188 	} else {							\
189 		*__PCPU_PTR(name) = __val;				\
190 	}								\
191 } while (0)
192 
193 #define	get_pcpu() __extension__ ({					\
194 	struct pcpu *__pc;						\
195 									\
196 	__asm __volatile("movl %%fs:%1,%0"				\
197 	    : "=r" (__pc)						\
198 	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
199 	__pc;								\
200 })
201 
202 #define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
203 #define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
204 #define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
205 #define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
206 
207 #define	IS_BSP()	(PCPU_GET(cpuid) == 0)
208 
209 #else /* defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
210 
211 #error "this file needs to be ported to your compiler"
212 
213 #endif /* __GNUCLIKE_ASM etc. */
214 
215 #endif /* _KERNEL */
216 
217 #endif /* !_MACHINE_PCPU_H_ */
218