1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2001 Wind River Systems, Inc. 5 * All rights reserved. 6 * Written by: John Baldwin <jhb@FreeBSD.org> 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the author nor the names of any co-contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $FreeBSD$ 33 */ 34 35 #ifndef _SYS_PCPU_H_ 36 #define _SYS_PCPU_H_ 37 38 #ifdef LOCORE 39 #error "no assembler-serviceable parts inside" 40 #endif 41 42 #include <sys/_cpuset.h> 43 #include <sys/_lock.h> 44 #include <sys/_mutex.h> 45 #include <sys/_sx.h> 46 #include <sys/queue.h> 47 #include <sys/_rmlock.h> 48 #include <sys/resource.h> 49 #include <machine/pcpu.h> 50 51 #define DPCPU_SETNAME "set_pcpu" 52 #define DPCPU_SYMPREFIX "pcpu_entry_" 53 54 #ifdef _KERNEL 55 56 /* 57 * Define a set for pcpu data. 58 */ 59 extern uintptr_t *__start_set_pcpu; 60 __GLOBL(__start_set_pcpu); 61 extern uintptr_t *__stop_set_pcpu; 62 __GLOBL(__stop_set_pcpu); 63 64 /* 65 * Array of dynamic pcpu base offsets. Indexed by id. 66 */ 67 extern uintptr_t dpcpu_off[]; 68 69 /* 70 * Convenience defines. 71 */ 72 #define DPCPU_START ((uintptr_t)&__start_set_pcpu) 73 #define DPCPU_STOP ((uintptr_t)&__stop_set_pcpu) 74 #define DPCPU_BYTES (DPCPU_STOP - DPCPU_START) 75 #define DPCPU_MODMIN 2048 76 #define DPCPU_SIZE roundup2(DPCPU_BYTES, PAGE_SIZE) 77 #define DPCPU_MODSIZE (DPCPU_SIZE - (DPCPU_BYTES - DPCPU_MODMIN)) 78 79 /* 80 * Declaration and definition. 81 */ 82 #define DPCPU_NAME(n) pcpu_entry_##n 83 #define DPCPU_DECLARE(t, n) extern t DPCPU_NAME(n) 84 #define DPCPU_DEFINE(t, n) t DPCPU_NAME(n) __section(DPCPU_SETNAME) __used 85 86 /* 87 * Accessors with a given base. 88 */ 89 #define _DPCPU_PTR(b, n) \ 90 (__typeof(DPCPU_NAME(n))*)((b) + (uintptr_t)&DPCPU_NAME(n)) 91 #define _DPCPU_GET(b, n) (*_DPCPU_PTR(b, n)) 92 #define _DPCPU_SET(b, n, v) (*_DPCPU_PTR(b, n) = v) 93 94 /* 95 * Accessors for the current cpu. 96 */ 97 #define DPCPU_PTR(n) _DPCPU_PTR(PCPU_GET(dynamic), n) 98 #define DPCPU_GET(n) (*DPCPU_PTR(n)) 99 #define DPCPU_SET(n, v) (*DPCPU_PTR(n) = v) 100 101 /* 102 * Accessors for remote cpus. 103 */ 104 #define DPCPU_ID_PTR(i, n) _DPCPU_PTR(dpcpu_off[(i)], n) 105 #define DPCPU_ID_GET(i, n) (*DPCPU_ID_PTR(i, n)) 106 #define DPCPU_ID_SET(i, n, v) (*DPCPU_ID_PTR(i, n) = v) 107 108 /* 109 * Utility macros. 110 */ 111 #define DPCPU_SUM(n) __extension__ \ 112 ({ \ 113 u_int _i; \ 114 __typeof(*DPCPU_PTR(n)) sum; \ 115 \ 116 sum = 0; \ 117 CPU_FOREACH(_i) { \ 118 sum += *DPCPU_ID_PTR(_i, n); \ 119 } \ 120 sum; \ 121 }) 122 123 #define DPCPU_VARSUM(n, var) __extension__ \ 124 ({ \ 125 u_int _i; \ 126 __typeof((DPCPU_PTR(n))->var) sum; \ 127 \ 128 sum = 0; \ 129 CPU_FOREACH(_i) { \ 130 sum += (DPCPU_ID_PTR(_i, n))->var; \ 131 } \ 132 sum; \ 133 }) 134 135 #define DPCPU_ZERO(n) do { \ 136 u_int _i; \ 137 \ 138 CPU_FOREACH(_i) { \ 139 bzero(DPCPU_ID_PTR(_i, n), sizeof(*DPCPU_PTR(n))); \ 140 } \ 141 } while(0) 142 143 #endif /* _KERNEL */ 144 145 /* 146 * This structure maps out the global data that needs to be kept on a 147 * per-cpu basis. The members are accessed via the PCPU_GET/SET/PTR 148 * macros defined in <machine/pcpu.h>. Machine dependent fields are 149 * defined in the PCPU_MD_FIELDS macro defined in <machine/pcpu.h>. 150 */ 151 struct pcpu { 152 struct thread *pc_curthread; /* Current thread */ 153 struct thread *pc_idlethread; /* Idle thread */ 154 struct thread *pc_fpcurthread; /* Fp state owner */ 155 struct thread *pc_deadthread; /* Zombie thread or NULL */ 156 struct pcb *pc_curpcb; /* Current pcb */ 157 uint64_t pc_switchtime; /* cpu_ticks() at last csw */ 158 int pc_switchticks; /* `ticks' at last csw */ 159 u_int pc_cpuid; /* This cpu number */ 160 STAILQ_ENTRY(pcpu) pc_allcpu; 161 struct lock_list_entry *pc_spinlocks; 162 long pc_cp_time[CPUSTATES]; /* statclock ticks */ 163 struct device *pc_device; 164 void *pc_netisr; /* netisr SWI cookie */ 165 int pc_unused1; /* unused field */ 166 int pc_domain; /* Memory domain. */ 167 struct rm_queue pc_rm_queue; /* rmlock list of trackers */ 168 uintptr_t pc_dynamic; /* Dynamic per-cpu data area */ 169 uint64_t pc_early_dummy_counter; /* Startup time counter(9) */ 170 171 /* 172 * Keep MD fields last, so that CPU-specific variations on a 173 * single architecture don't result in offset variations of 174 * the machine-independent fields of the pcpu. Even though 175 * the pcpu structure is private to the kernel, some ports 176 * (e.g., lsof, part of gtop) define _KERNEL and include this 177 * header. While strictly speaking this is wrong, there's no 178 * reason not to keep the offsets of the MI fields constant 179 * if only to make kernel debugging easier. 180 */ 181 PCPU_MD_FIELDS; 182 } __aligned(CACHE_LINE_SIZE); 183 184 #ifdef CTASSERT 185 /* 186 * To minimize memory waste in per-cpu UMA zones, size of struct pcpu 187 * should be denominator of PAGE_SIZE. 188 */ 189 CTASSERT((PAGE_SIZE / sizeof(struct pcpu)) * sizeof(struct pcpu) == PAGE_SIZE); 190 #endif 191 192 #ifdef _KERNEL 193 194 STAILQ_HEAD(cpuhead, pcpu); 195 196 extern struct cpuhead cpuhead; 197 extern struct pcpu *cpuid_to_pcpu[]; 198 199 #define curcpu PCPU_GET(cpuid) 200 #define curproc (curthread->td_proc) 201 #ifndef curthread 202 #define curthread PCPU_GET(curthread) 203 #endif 204 #define curvidata PCPU_GET(vidata) 205 206 /* Accessor to elements allocated via UMA_ZONE_PCPU zone. */ 207 static inline void * 208 zpcpu_get(void *base) 209 { 210 211 return ((char *)(base) + sizeof(struct pcpu) * curcpu); 212 } 213 214 static inline void * 215 zpcpu_get_cpu(void *base, int cpu) 216 { 217 218 return ((char *)(base) + sizeof(struct pcpu) * cpu); 219 } 220 221 /* 222 * Machine dependent callouts. cpu_pcpu_init() is responsible for 223 * initializing machine dependent fields of struct pcpu, and 224 * db_show_mdpcpu() is responsible for handling machine dependent 225 * fields for the DDB 'show pcpu' command. 226 */ 227 void cpu_pcpu_init(struct pcpu *pcpu, int cpuid, size_t size); 228 void db_show_mdpcpu(struct pcpu *pcpu); 229 230 void *dpcpu_alloc(int size); 231 void dpcpu_copy(void *s, int size); 232 void dpcpu_free(void *s, int size); 233 void dpcpu_init(void *dpcpu, int cpuid); 234 void pcpu_destroy(struct pcpu *pcpu); 235 struct pcpu *pcpu_find(u_int cpuid); 236 void pcpu_init(struct pcpu *pcpu, int cpuid, size_t size); 237 238 #endif /* _KERNEL */ 239 240 #endif /* !_SYS_PCPU_H_ */ 241