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/*
45 * The SMP parts are setup in pmap.c and machdep.c for the BSP, and
46 * pmap.c and mp_machdep.c sets up the data for the AP's to "see" when
47 * they awake.  The reason for doing it via a struct is so that an
48 * array of pointers to each CPU's data can be set up for things like
49 * "check curproc on all other processors"
50 */
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	segment_descriptor pc_common_tssd;			\
57	struct	segment_descriptor *pc_tss_gdt;				\
58	struct	segment_descriptor *pc_fsgs_gdt;			\
59	struct	i386tss *pc_common_tssp;				\
60	u_int	pc_kesp0;						\
61	u_int	pc_trampstk;						\
62	int	pc_currentldt;						\
63	u_int   pc_acpi_id;		/* ACPI CPU id */		\
64	u_int	pc_apic_id;						\
65	int	pc_private_tss;		/* Flag indicating private tss*/\
66	u_int	pc_cmci_mask;		/* MCx banks for CMCI */	\
67	u_int	pc_vcpu_id;		/* Xen vCPU ID */		\
68	struct	mtx pc_cmap_lock;					\
69	void	*pc_cmap_pte1;						\
70	void	*pc_cmap_pte2;						\
71	caddr_t	pc_cmap_addr1;						\
72	caddr_t	pc_cmap_addr2;						\
73	vm_offset_t pc_qmap_addr;	/* KVA for temporary mappings */\
74	vm_offset_t pc_copyout_maddr;					\
75	vm_offset_t pc_copyout_saddr;					\
76	struct	mtx pc_copyout_mlock;					\
77	struct	sx pc_copyout_slock;					\
78	char	*pc_copyout_buf;					\
79	vm_offset_t pc_pmap_eh_va;					\
80	caddr_t pc_pmap_eh_ptep;					\
81	uint32_t pc_smp_tlb_done;	/* TLB op acknowledgement */	\
82	uint32_t pc_ibpb_set;						\
83	void	*pc_mds_buf;						\
84	void	*pc_mds_buf64;						\
85	uint32_t pc_pad[4];						\
86	uint8_t	pc_mds_tmp[64];						\
87	char	__pad[3522]
88
89#ifdef _KERNEL
90
91#if defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF)
92
93/*
94 * Evaluates to the byte offset of the per-cpu variable name.
95 */
96#define	__pcpu_offset(name)						\
97	__offsetof(struct pcpu, name)
98
99/*
100 * Evaluates to the type of the per-cpu variable name.
101 */
102#define	__pcpu_type(name)						\
103	__typeof(((struct pcpu *)0)->name)
104
105/*
106 * Evaluates to the address of the per-cpu variable name.
107 */
108#define	__PCPU_PTR(name) __extension__ ({				\
109	__pcpu_type(name) *__p;						\
110									\
111	__asm __volatile("movl %%fs:%1,%0; addl %2,%0"			\
112	    : "=r" (__p)						\
113	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))),	\
114	      "i" (__pcpu_offset(name)));				\
115									\
116	__p;								\
117})
118
119/*
120 * Evaluates to the value of the per-cpu variable name.
121 */
122#define	__PCPU_GET(name) __extension__ ({				\
123	__pcpu_type(name) __res;					\
124	struct __s {							\
125		u_char	__b[MIN(sizeof(__res), 4)];			\
126	} __s;								\
127									\
128	if (sizeof(__res) == 1 || sizeof(__res) == 2 ||			\
129	    sizeof(__res) == 4) {					\
130		__asm __volatile("mov %%fs:%1,%0"			\
131		    : "=r" (__s)					\
132		    : "m" (*(struct __s *)(__pcpu_offset(name))));	\
133		*(struct __s *)(void *)&__res = __s;			\
134	} else {							\
135		__res = *__PCPU_PTR(name);				\
136	}								\
137	__res;								\
138})
139
140/*
141 * Adds a value of the per-cpu counter name.  The implementation
142 * must be atomic with respect to interrupts.
143 */
144#define	__PCPU_ADD(name, val) do {					\
145	__pcpu_type(name) __val;					\
146	struct __s {							\
147		u_char	__b[MIN(sizeof(__val), 4)];			\
148	} __s;								\
149									\
150	__val = (val);							\
151	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
152	    sizeof(__val) == 4) {					\
153		__s = *(struct __s *)(void *)&__val;			\
154		__asm __volatile("add %1,%%fs:%0"			\
155		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
156		    : "r" (__s));					\
157	} else								\
158		*__PCPU_PTR(name) += __val;				\
159} while (0)
160
161/*
162 * Increments the value of the per-cpu counter name.  The implementation
163 * must be atomic with respect to interrupts.
164 */
165#define	__PCPU_INC(name) do {						\
166	CTASSERT(sizeof(__pcpu_type(name)) == 1 ||			\
167	    sizeof(__pcpu_type(name)) == 2 ||				\
168	    sizeof(__pcpu_type(name)) == 4);				\
169	if (sizeof(__pcpu_type(name)) == 1) {				\
170		__asm __volatile("incb %%fs:%0"				\
171		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
172		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
173	} else if (sizeof(__pcpu_type(name)) == 2) {			\
174		__asm __volatile("incw %%fs:%0"				\
175		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
176		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
177	} else if (sizeof(__pcpu_type(name)) == 4) {			\
178		__asm __volatile("incl %%fs:%0"				\
179		    : "=m" (*(__pcpu_type(name) *)(__pcpu_offset(name)))\
180		    : "m" (*(__pcpu_type(name) *)(__pcpu_offset(name))));\
181	}								\
182} while (0)
183
184/*
185 * Sets the value of the per-cpu variable name to value val.
186 */
187#define	__PCPU_SET(name, val) do {					\
188	__pcpu_type(name) __val;					\
189	struct __s {							\
190		u_char	__b[MIN(sizeof(__val), 4)];			\
191	} __s;								\
192									\
193	__val = (val);							\
194	if (sizeof(__val) == 1 || sizeof(__val) == 2 ||			\
195	    sizeof(__val) == 4) {					\
196		__s = *(struct __s *)(void *)&__val;			\
197		__asm __volatile("mov %1,%%fs:%0"			\
198		    : "=m" (*(struct __s *)(__pcpu_offset(name)))	\
199		    : "r" (__s));					\
200	} else {							\
201		*__PCPU_PTR(name) = __val;				\
202	}								\
203} while (0)
204
205#define	get_pcpu() __extension__ ({					\
206	struct pcpu *__pc;						\
207									\
208	__asm __volatile("movl %%fs:%1,%0"				\
209	    : "=r" (__pc)						\
210	    : "m" (*(struct pcpu *)(__pcpu_offset(pc_prvspace))));	\
211	__pc;								\
212})
213
214#define	PCPU_GET(member)	__PCPU_GET(pc_ ## member)
215#define	PCPU_ADD(member, val)	__PCPU_ADD(pc_ ## member, val)
216#define	PCPU_INC(member)	__PCPU_INC(pc_ ## member)
217#define	PCPU_PTR(member)	__PCPU_PTR(pc_ ## member)
218#define	PCPU_SET(member, val)	__PCPU_SET(pc_ ## member, val)
219
220#define	IS_BSP()	(PCPU_GET(cpuid) == 0)
221
222#else /* defined(__GNUCLIKE_ASM) && defined(__GNUCLIKE___TYPEOF) */
223
224#error "this file needs to be ported to your compiler"
225
226#endif /* __GNUCLIKE_ASM etc. */
227
228#endif /* _KERNEL */
229
230#endif /* !_MACHINE_PCPU_H_ */
231