1 /*- 2 * Copyright (c) 1982, 1988, 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * (c) UNIX System Laboratories, Inc. 5 * All or some portions of this file are derived from material licensed 6 * to the University of California by American Telephone and Telegraph 7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 8 * the permission of UNIX System Laboratories, Inc. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)systm.h 8.7 (Berkeley) 3/29/95 35 * $FreeBSD$ 36 */ 37 38 #ifndef _SYS_SYSTM_H_ 39 #define _SYS_SYSTM_H_ 40 41 #include <machine/atomic.h> 42 #include <machine/cpufunc.h> 43 #include <sys/callout.h> 44 #include <sys/cdefs.h> 45 #include <sys/queue.h> 46 #include <sys/stdint.h> /* for people using printf mainly */ 47 48 __NULLABILITY_PRAGMA_PUSH 49 50 extern int cold; /* nonzero if we are doing a cold boot */ 51 extern int suspend_blocked; /* block suspend due to pending shutdown */ 52 extern int rebooting; /* kern_reboot() has been called. */ 53 extern const char *panicstr; /* panic message */ 54 extern char version[]; /* system version */ 55 extern char compiler_version[]; /* compiler version */ 56 extern char copyright[]; /* system copyright */ 57 extern int kstack_pages; /* number of kernel stack pages */ 58 59 extern u_long pagesizes[]; /* supported page sizes */ 60 extern long physmem; /* physical memory */ 61 extern long realmem; /* 'real' memory */ 62 63 extern char *rootdevnames[2]; /* names of possible root devices */ 64 65 extern int boothowto; /* reboot flags, from console subsystem */ 66 extern int bootverbose; /* nonzero to print verbose messages */ 67 68 extern int maxusers; /* system tune hint */ 69 extern int ngroups_max; /* max # of supplemental groups */ 70 extern int vm_guest; /* Running as virtual machine guest? */ 71 72 /* 73 * Detected virtual machine guest types. The intention is to expand 74 * and/or add to the VM_GUEST_VM type if specific VM functionality is 75 * ever implemented (e.g. vendor-specific paravirtualization features). 76 * Keep in sync with vm_guest_sysctl_names[]. 77 */ 78 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV, 79 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_GUEST_BHYVE, VM_LAST }; 80 81 #if defined(WITNESS) || defined(INVARIANT_SUPPORT) 82 void kassert_panic(const char *fmt, ...) __printflike(1, 2); 83 #endif 84 85 #ifdef INVARIANTS /* The option is always available */ 86 #define KASSERT(exp,msg) do { \ 87 if (__predict_false(!(exp))) \ 88 kassert_panic msg; \ 89 } while (0) 90 #define VNASSERT(exp, vp, msg) do { \ 91 if (__predict_false(!(exp))) { \ 92 vn_printf(vp, "VNASSERT failed\n"); \ 93 kassert_panic msg; \ 94 } \ 95 } while (0) 96 #else 97 #define KASSERT(exp,msg) do { \ 98 } while (0) 99 100 #define VNASSERT(exp, vp, msg) do { \ 101 } while (0) 102 #endif 103 104 #ifndef CTASSERT /* Allow lint to override */ 105 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed") 106 #endif 107 108 /* 109 * Assert that a pointer can be loaded from memory atomically. 110 * 111 * This assertion enforces stronger alignment than necessary. For example, 112 * on some architectures, atomicity for unaligned loads will depend on 113 * whether or not the load spans multiple cache lines. 114 */ 115 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \ 116 KASSERT(sizeof(var) == sizeof(void *) && \ 117 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg) 118 119 /* 120 * Assert that a thread is in critical(9) section. 121 */ 122 #define CRITICAL_ASSERT(td) \ 123 KASSERT((td)->td_critnest >= 1, ("Not in critical section")); 124 125 /* 126 * If we have already panic'd and this is the thread that called 127 * panic(), then don't block on any mutexes but silently succeed. 128 * Otherwise, the kernel will deadlock since the scheduler isn't 129 * going to run the thread that holds any lock we need. 130 */ 131 #define SCHEDULER_STOPPED_TD(td) ({ \ 132 MPASS((td) == curthread); \ 133 __predict_false((td)->td_stopsched); \ 134 }) 135 #define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread) 136 137 /* 138 * Align variables. 139 */ 140 #define __read_mostly __section(".data.read_mostly") 141 #define __read_frequently __section(".data.read_frequently") 142 #define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \ 143 __section(".data.exclusive_cache_line") 144 /* 145 * XXX the hints declarations are even more misplaced than most declarations 146 * in this file, since they are needed in one file (per arch) and only used 147 * in two files. 148 * XXX most of these variables should be const. 149 */ 150 extern int osreldate; 151 extern int envmode; 152 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */ 153 extern int dynamic_kenv; 154 extern struct mtx kenv_lock; 155 extern char *kern_envp; 156 extern char static_env[]; 157 extern char static_hints[]; /* by config for now */ 158 159 extern char **kenvp; 160 161 extern const void *zero_region; /* address space maps to a zeroed page */ 162 163 extern int unmapped_buf_allowed; 164 165 #ifdef __LP64__ 166 #define IOSIZE_MAX iosize_max() 167 #define DEVFS_IOSIZE_MAX devfs_iosize_max() 168 #else 169 #define IOSIZE_MAX SSIZE_MAX 170 #define DEVFS_IOSIZE_MAX SSIZE_MAX 171 #endif 172 173 /* 174 * General function declarations. 175 */ 176 177 struct inpcb; 178 struct lock_object; 179 struct malloc_type; 180 struct mtx; 181 struct proc; 182 struct socket; 183 struct thread; 184 struct tty; 185 struct ucred; 186 struct uio; 187 struct _jmp_buf; 188 struct trapframe; 189 struct eventtimer; 190 191 int setjmp(struct _jmp_buf *) __returns_twice; 192 void longjmp(struct _jmp_buf *, int) __dead2; 193 int dumpstatus(vm_offset_t addr, off_t count); 194 int nullop(void); 195 int eopnotsupp(void); 196 int ureadc(int, struct uio *); 197 void hashdestroy(void *, struct malloc_type *, u_long); 198 void *hashinit(int count, struct malloc_type *type, u_long *hashmask); 199 void *hashinit_flags(int count, struct malloc_type *type, 200 u_long *hashmask, int flags); 201 #define HASH_NOWAIT 0x00000001 202 #define HASH_WAITOK 0x00000002 203 204 void *phashinit(int count, struct malloc_type *type, u_long *nentries); 205 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries, 206 int flags); 207 void g_waitidle(void); 208 209 void panic(const char *, ...) __dead2 __printflike(1, 2); 210 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0); 211 212 void cpu_boot(int); 213 void cpu_flush_dcache(void *, size_t); 214 void cpu_rootconf(void); 215 void critical_enter(void); 216 void critical_exit(void); 217 void init_param1(void); 218 void init_param2(long physpages); 219 void init_static_kenv(char *, size_t); 220 void tablefull(const char *); 221 #ifdef EARLY_PRINTF 222 typedef void early_putc_t(int ch); 223 extern early_putc_t *early_putc; 224 #endif 225 int kvprintf(char const *, void (*)(int, void*), void *, int, 226 __va_list) __printflike(1, 0); 227 void log(int, const char *, ...) __printflike(2, 3); 228 void log_console(struct uio *); 229 void vlog(int, const char *, __va_list) __printflike(2, 0); 230 int asprintf(char **ret, struct malloc_type *mtp, const char *format, 231 ...) __printflike(3, 4); 232 int printf(const char *, ...) __printflike(1, 2); 233 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4); 234 int sprintf(char *buf, const char *, ...) __printflike(2, 3); 235 int uprintf(const char *, ...) __printflike(1, 2); 236 int vprintf(const char *, __va_list) __printflike(1, 0); 237 int vasprintf(char **ret, struct malloc_type *mtp, const char *format, 238 __va_list ap) __printflike(3, 0); 239 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0); 240 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0); 241 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0); 242 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3); 243 int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3); 244 int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0); 245 long strtol(const char *, char **, int); 246 u_long strtoul(const char *, char **, int); 247 quad_t strtoq(const char *, char **, int); 248 u_quad_t strtouq(const char *, char **, int); 249 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4); 250 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0); 251 void hexdump(const void *ptr, int length, const char *hdr, int flags); 252 #define HD_COLUMN_MASK 0xff 253 #define HD_DELIM_MASK 0xff00 254 #define HD_OMIT_COUNT (1 << 16) 255 #define HD_OMIT_HEX (1 << 17) 256 #define HD_OMIT_CHARS (1 << 18) 257 258 #define ovbcopy(f, t, l) bcopy((f), (t), (l)) 259 void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len); 260 void bzero(void * _Nonnull buf, size_t len); 261 #define bzero(buf, len) ({ \ 262 if (__builtin_constant_p(len) && (len) <= 64) \ 263 __builtin_memset((buf), 0, (len)); \ 264 else \ 265 bzero((buf), (len)); \ 266 }) 267 void explicit_bzero(void * _Nonnull, size_t); 268 269 void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len); 270 void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n); 271 272 int copystr(const void * _Nonnull __restrict kfaddr, 273 void * _Nonnull __restrict kdaddr, size_t len, 274 size_t * __restrict lencopied); 275 int copyinstr(const void * __restrict udaddr, 276 void * _Nonnull __restrict kaddr, size_t len, 277 size_t * __restrict lencopied); 278 int copyin(const void * _Nonnull __restrict udaddr, 279 void * _Nonnull __restrict kaddr, size_t len); 280 int copyin_nofault(const void * _Nonnull __restrict udaddr, 281 void * _Nonnull __restrict kaddr, size_t len); 282 int copyout(const void * _Nonnull __restrict kaddr, 283 void * _Nonnull __restrict udaddr, size_t len); 284 int copyout_nofault(const void * _Nonnull __restrict kaddr, 285 void * _Nonnull __restrict udaddr, size_t len); 286 287 int fubyte(volatile const void *base); 288 long fuword(volatile const void *base); 289 int fuword16(volatile const void *base); 290 int32_t fuword32(volatile const void *base); 291 int64_t fuword64(volatile const void *base); 292 int fueword(volatile const void *base, long *val); 293 int fueword32(volatile const void *base, int32_t *val); 294 int fueword64(volatile const void *base, int64_t *val); 295 int subyte(volatile void *base, int byte); 296 int suword(volatile void *base, long word); 297 int suword16(volatile void *base, int word); 298 int suword32(volatile void *base, int32_t word); 299 int suword64(volatile void *base, int64_t word); 300 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval); 301 u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 302 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp, 303 uint32_t newval); 304 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp, 305 u_long newval); 306 307 void realitexpire(void *); 308 309 int sysbeep(int hertz, int period); 310 311 void hardclock(int usermode, uintfptr_t pc); 312 void hardclock_cnt(int cnt, int usermode); 313 void hardclock_cpu(int usermode); 314 void hardclock_sync(int cpu); 315 void softclock(void *); 316 void statclock(int usermode); 317 void statclock_cnt(int cnt, int usermode); 318 void profclock(int usermode, uintfptr_t pc); 319 void profclock_cnt(int cnt, int usermode, uintfptr_t pc); 320 321 int hardclockintr(void); 322 323 void startprofclock(struct proc *); 324 void stopprofclock(struct proc *); 325 void cpu_startprofclock(void); 326 void cpu_stopprofclock(void); 327 sbintime_t cpu_idleclock(void); 328 void cpu_activeclock(void); 329 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt); 330 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq); 331 extern int cpu_disable_c2_sleep; 332 extern int cpu_disable_c3_sleep; 333 334 char *kern_getenv(const char *name); 335 void freeenv(char *env); 336 int getenv_int(const char *name, int *data); 337 int getenv_uint(const char *name, unsigned int *data); 338 int getenv_long(const char *name, long *data); 339 int getenv_ulong(const char *name, unsigned long *data); 340 int getenv_string(const char *name, char *data, int size); 341 int getenv_int64(const char *name, int64_t *data); 342 int getenv_uint64(const char *name, uint64_t *data); 343 int getenv_quad(const char *name, quad_t *data); 344 int kern_setenv(const char *name, const char *value); 345 int kern_unsetenv(const char *name); 346 int testenv(const char *name); 347 348 typedef uint64_t (cpu_tick_f)(void); 349 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var); 350 extern cpu_tick_f *cpu_ticks; 351 uint64_t cpu_tickrate(void); 352 uint64_t cputick2usec(uint64_t tick); 353 354 #ifdef APM_FIXUP_CALLTODO 355 struct timeval; 356 void adjust_timeout_calltodo(struct timeval *time_change); 357 #endif /* APM_FIXUP_CALLTODO */ 358 359 #include <sys/libkern.h> 360 361 /* Initialize the world */ 362 void consinit(void); 363 void cpu_initclocks(void); 364 void cpu_initclocks_bsp(void); 365 void cpu_initclocks_ap(void); 366 void usrinfoinit(void); 367 368 /* Finalize the world */ 369 void kern_reboot(int) __dead2; 370 void shutdown_nice(int); 371 372 /* Timeouts */ 373 typedef void timeout_t(void *); /* timeout function type */ 374 #define CALLOUT_HANDLE_INITIALIZER(handle) \ 375 { NULL } 376 377 void callout_handle_init(struct callout_handle *); 378 struct callout_handle timeout(timeout_t *, void *, int); 379 void untimeout(timeout_t *, void *, struct callout_handle); 380 381 /* Stubs for obsolete functions that used to be for interrupt management */ 382 static __inline intrmask_t splbio(void) { return 0; } 383 static __inline intrmask_t splcam(void) { return 0; } 384 static __inline intrmask_t splclock(void) { return 0; } 385 static __inline intrmask_t splhigh(void) { return 0; } 386 static __inline intrmask_t splimp(void) { return 0; } 387 static __inline intrmask_t splnet(void) { return 0; } 388 static __inline intrmask_t spltty(void) { return 0; } 389 static __inline void splx(intrmask_t ipl __unused) { return; } 390 391 /* 392 * Common `proc' functions are declared here so that proc.h can be included 393 * less often. 394 */ 395 int _sleep(void * _Nonnull chan, struct lock_object *lock, int pri, 396 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags); 397 #define msleep(chan, mtx, pri, wmesg, timo) \ 398 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \ 399 tick_sbt * (timo), 0, C_HARDCLOCK) 400 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \ 401 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \ 402 (flags)) 403 int msleep_spin_sbt(void * _Nonnull chan, struct mtx *mtx, 404 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags); 405 #define msleep_spin(chan, mtx, wmesg, timo) \ 406 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \ 407 0, C_HARDCLOCK) 408 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr, 409 int flags); 410 #define pause(wmesg, timo) \ 411 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK) 412 #define tsleep(chan, pri, wmesg, timo) \ 413 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \ 414 0, C_HARDCLOCK) 415 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \ 416 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags)) 417 void wakeup(void * chan); 418 void wakeup_one(void * chan); 419 420 /* 421 * Common `struct cdev *' stuff are declared here to avoid #include poisoning 422 */ 423 424 struct cdev; 425 dev_t dev2udev(struct cdev *x); 426 const char *devtoname(struct cdev *cdev); 427 428 #ifdef __LP64__ 429 size_t devfs_iosize_max(void); 430 size_t iosize_max(void); 431 #endif 432 433 int poll_no_poll(int events); 434 435 /* XXX: Should be void nanodelay(u_int nsec); */ 436 void DELAY(int usec); 437 438 /* Root mount holdback API */ 439 struct root_hold_token; 440 441 struct root_hold_token *root_mount_hold(const char *identifier); 442 void root_mount_rel(struct root_hold_token *h); 443 int root_mounted(void); 444 445 446 /* 447 * Unit number allocation API. (kern/subr_unit.c) 448 */ 449 struct unrhdr; 450 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex); 451 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex); 452 void delete_unrhdr(struct unrhdr *uh); 453 void clear_unrhdr(struct unrhdr *uh); 454 void clean_unrhdr(struct unrhdr *uh); 455 void clean_unrhdrl(struct unrhdr *uh); 456 int alloc_unr(struct unrhdr *uh); 457 int alloc_unr_specific(struct unrhdr *uh, u_int item); 458 int alloc_unrl(struct unrhdr *uh); 459 void free_unr(struct unrhdr *uh, u_int item); 460 461 void intr_prof_stack_use(struct thread *td, struct trapframe *frame); 462 463 void counted_warning(unsigned *counter, const char *msg); 464 465 __NULLABILITY_PRAGMA_POP 466 467 #endif /* !_SYS_SYSTM_H_ */ 468