1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 22 /* All Rights Reserved */ 23 24 25 /* 26 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 27 * Use is subject to license terms. 28 */ 29 30 #ifndef _SYS_SYSTM_H 31 #define _SYS_SYSTM_H 32 33 #include <sys/types.h> 34 #include <sys/t_lock.h> 35 #include <sys/proc.h> 36 #include <sys/dditypes.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * The pc_t is the type of the kernel's program counter. In general, a 44 * pc_t is a uintptr_t -- except for a sparcv9 kernel, in which case all 45 * instruction text is below 4G, and a pc_t is thus a uint32_t. 46 */ 47 #ifdef __sparcv9 48 typedef uint32_t pc_t; 49 #else 50 typedef uintptr_t pc_t; 51 #endif 52 53 /* 54 * Random set of variables used by more than one routine. 55 */ 56 57 #ifdef _KERNEL 58 #include <sys/varargs.h> 59 #include <sys/uadmin.h> 60 61 extern int hz; /* system clock rate */ 62 extern struct vnode *rootdir; /* pointer to vnode of root directory */ 63 extern struct vnode *devicesdir; /* pointer to /devices vnode */ 64 extern int interrupts_unleashed; /* set after the spl0() in main() */ 65 66 extern char runin; /* scheduling flag */ 67 extern char runout; /* scheduling flag */ 68 extern char wake_sched; /* causes clock to wake swapper on next tick */ 69 extern char wake_sched_sec; /* causes clock to wake swapper after a sec */ 70 71 extern pgcnt_t maxmem; /* max available memory (pages) */ 72 extern pgcnt_t physmem; /* physical memory (pages) on this CPU */ 73 extern pfn_t physmax; /* highest numbered physical page present */ 74 extern pgcnt_t physinstalled; /* physical pages including PROM/boot use */ 75 76 extern caddr_t s_text; /* start of kernel text segment */ 77 extern caddr_t e_text; /* end of kernel text segment */ 78 extern caddr_t s_data; /* start of kernel text segment */ 79 extern caddr_t e_data; /* end of kernel text segment */ 80 81 extern pgcnt_t availrmem; /* Available resident (not swapable) */ 82 /* memory in pages. */ 83 extern pgcnt_t availrmem_initial; /* initial value of availrmem */ 84 extern pgcnt_t segspt_minfree; /* low water mark for availrmem in seg_spt */ 85 extern pgcnt_t freemem; /* Current free memory. */ 86 87 extern dev_t rootdev; /* device of the root */ 88 extern struct vnode *rootvp; /* vnode of root device */ 89 extern boolean_t root_is_svm; /* root is a mirrored device flag */ 90 extern boolean_t root_is_ramdisk; /* root is boot_archive ramdisk */ 91 extern uint32_t ramdisk_size; /* (KB) set only for sparc netboots */ 92 extern char *volatile panicstr; /* panic string pointer */ 93 extern va_list panicargs; /* panic arguments */ 94 extern volatile int quiesce_active; /* quiesce(9E) is in progress */ 95 96 extern int rstchown; /* 1 ==> restrictive chown(2) semantics */ 97 extern int klustsize; 98 99 extern int abort_enable; /* Platform input-device abort policy */ 100 101 extern int audit_active; /* Solaris Auditing active 1, absent 0. */ 102 103 extern int avenrun[]; /* array of load averages */ 104 105 extern char *isa_list; /* For sysinfo's isalist option */ 106 107 extern int noexec_user_stack; /* patchable via /etc/system */ 108 extern int noexec_user_stack_log; /* patchable via /etc/system */ 109 110 /* 111 * Use NFS client operations in the global zone only. Under contract with 112 * admin/install; do not change without coordinating with that consolidation. 113 */ 114 extern int nfs_global_client_only; 115 116 extern void report_stack_exec(proc_t *, caddr_t); 117 118 extern void startup(void); 119 extern void clkstart(void); 120 extern void post_startup(void); 121 extern void kern_setup1(void); 122 extern void ka_init(void); 123 extern void nodename_set(void); 124 125 /* 126 * for tod fault detection 127 */ 128 enum tod_fault_type { 129 TOD_REVERSED = 0, 130 TOD_STALLED, 131 TOD_JUMPED, 132 TOD_RATECHANGED, 133 TOD_RDONLY, 134 TOD_NOFAULT 135 }; 136 137 extern time_t tod_validate(time_t); 138 extern void tod_fault_reset(void); 139 extern void plat_tod_fault(enum tod_fault_type); 140 141 #ifndef _LP64 142 #ifndef min 143 int min(int, int); 144 #endif 145 146 #ifndef max 147 int max(int, int); 148 #endif 149 150 uint_t umin(uint_t, uint_t); 151 uint_t umax(uint_t, uint_t); 152 #endif /* !_LP64 */ 153 int grow(caddr_t); 154 int grow_internal(caddr_t, uint_t); 155 int brk_internal(caddr_t, uint_t); 156 typedef uint64_t callout_id_t; 157 timeout_id_t timeout(void (*)(void *), void *, clock_t); 158 timeout_id_t realtime_timeout(void (*)(void *), void *, clock_t); 159 clock_t untimeout(timeout_id_t); 160 /* 161 * The last argument to timeout_generic() is flags. See callo.h for the 162 * flags definitions. 163 */ 164 callout_id_t timeout_generic(int, void (*)(void *), void *, hrtime_t, hrtime_t, 165 int); 166 callout_id_t timeout_default(void (*)(void *), void *, clock_t); 167 callout_id_t realtime_timeout_default(void (*)(void *), void *, clock_t); 168 /* 169 * The last argument to untimeout_generic() is flags. See callout.c for the 170 * use. 171 */ 172 hrtime_t untimeout_generic(callout_id_t, int); 173 clock_t untimeout_default(callout_id_t, int); 174 void delay(clock_t); 175 int delay_sig(clock_t); 176 void delay_random(clock_t); 177 int nodev(); 178 int nulldev(); 179 major_t getudev(void); 180 int cmpldev(dev32_t *, dev_t); 181 dev_t expldev(dev32_t); 182 int bcmp(const void *, const void *, size_t) __PURE; 183 int stoi(char **); 184 void numtos(ulong_t, char *); 185 char *kmem_asprintf(const char *fmt, ...); 186 int strident_valid(const char *); 187 void strident_canon(char *, size_t); 188 int getsubopt(char **optionsp, char * const *tokens, char **valuep); 189 char *append_subopt(const char *, size_t, char *, const char *); 190 int ffs(uintmax_t); 191 int copyin(const void *, void *, size_t); 192 void copyin_noerr(const void *, void *, size_t); 193 int xcopyin(const void *, void *, size_t); 194 int xcopyin_nta(const void *, void *, size_t, int); 195 int copyout(const void *, void *, size_t); 196 void copyout_noerr(const void *, void *, size_t); 197 int xcopyout(const void *, void *, size_t); 198 int xcopyout_nta(const void *, void *, size_t, int); 199 int copyinstr(const char *, char *, size_t, size_t *); 200 int copyinstr_noerr(const char *, char *, size_t, size_t *); 201 int copyoutstr(const char *, char *, size_t, size_t *); 202 int copyoutstr_noerr(const char *, char *, size_t, size_t *); 203 int copystr(const char *, char *, size_t, size_t *); 204 void ucopy(const void *, void *, size_t); 205 void ucopystr(const char *, char *, size_t, size_t *); 206 void pgcopy(const void *, void *, size_t); 207 void ovbcopy(const void *, void *, size_t); 208 void uzero(void *, size_t); 209 int kcopy(const void *, void *, size_t); 210 int kcopy_nta(const void *, void *, size_t, int); 211 int kzero(void *, size_t); 212 213 int fuword8(const void *, uint8_t *); 214 int fuword16(const void *, uint16_t *); 215 int fuword32(const void *, uint32_t *); 216 int fulword(const void *, ulong_t *); 217 void fuword8_noerr(const void *, uint8_t *); 218 void fuword16_noerr(const void *, uint16_t *); 219 void fuword32_noerr(const void *, uint32_t *); 220 void fulword_noerr(const void *, ulong_t *); 221 222 #ifdef _LP64 223 int fuword64(const void *, uint64_t *); 224 void fuword64_noerr(const void *, uint64_t *); 225 #endif 226 227 int subyte(void *, uint8_t); 228 int suword8(void *, uint8_t); 229 int suword16(void *, uint16_t); 230 int suword32(void *, uint32_t); 231 int sulword(void *, ulong_t); 232 void subyte_noerr(void *, uint8_t); 233 void suword8_noerr(void *, uint8_t); 234 void suword16_noerr(void *, uint16_t); 235 void suword32_noerr(void *, uint32_t); 236 void sulword_noerr(void *, ulong_t); 237 238 #ifdef _LP64 239 int suword64(void *, uint64_t); 240 void suword64_noerr(void *, uint64_t); 241 #endif 242 243 #if !defined(_BOOT) 244 int setjmp(label_t *); 245 extern void longjmp(label_t *) 246 __NORETURN; 247 #pragma unknown_control_flow(setjmp) 248 #endif 249 250 void prefetch_read_once(void *); 251 void prefetch_write_once(void *); 252 void prefetch_read_many(void *); 253 void prefetch_write_many(void *); 254 caddr_t caller(void); 255 caddr_t callee(void); 256 int getpcstack(pc_t *, int); 257 int on_fault(label_t *); 258 void no_fault(void); 259 void halt(char *); 260 int scanc(size_t, uchar_t *, uchar_t *, uchar_t); 261 int movtuc(size_t, uchar_t *, uchar_t *, uchar_t *); 262 int splr(int); 263 int splhigh(void); 264 int splhi(void); 265 int splzs(void); 266 int spl0(void); 267 int spl6(void); 268 int spl7(void); 269 int spl8(void); 270 void splx(int); 271 void set_base_spl(void); 272 int __ipltospl(int); 273 274 void softcall_init(void); 275 void softcall(void (*)(void *), void *); 276 void softint(void); 277 278 extern void sync_icache(caddr_t, uint_t); 279 extern void sync_data_memory(caddr_t, size_t); 280 extern void hot_patch_kernel_text(caddr_t, uint32_t, uint_t); 281 282 void _insque(caddr_t, caddr_t); 283 void _remque(caddr_t); 284 285 /* casts to keep lint happy */ 286 #define insque(q, p) _insque((caddr_t)q, (caddr_t)p) 287 #define remque(q) _remque((caddr_t)q) 288 289 #pragma unknown_control_flow(on_fault) 290 291 struct timeval; 292 extern void uniqtime(struct timeval *); 293 struct timeval32; 294 extern void uniqtime32(struct timeval32 *); 295 296 uint_t page_num_pagesizes(void); 297 size_t page_get_pagesize(uint_t n); 298 299 extern int maxusers; 300 extern int pidmax; 301 302 extern void param_preset(void); 303 extern void param_calc(int); 304 extern void param_init(void); 305 extern void param_check(void); 306 307 #endif /* _KERNEL */ 308 309 /* 310 * Structure of the system-entry table. 311 * 312 * Changes to struct sysent should maintain binary compatibility with 313 * loadable system calls, although the interface is currently private. 314 * 315 * This means it should only be expanded on the end, and flag values 316 * should not be reused. 317 * 318 * It is desirable to keep the size of this struct a power of 2 for quick 319 * indexing. 320 */ 321 struct sysent { 322 char sy_narg; /* total number of arguments */ 323 #ifdef _LP64 324 unsigned short sy_flags; /* various flags as defined below */ 325 #else 326 unsigned char sy_flags; /* various flags as defined below */ 327 #endif 328 int (*sy_call)(); /* argp, rvalp-style handler */ 329 krwlock_t *sy_lock; /* lock for loadable system calls */ 330 int64_t (*sy_callc)(); /* C-style call hander or wrapper */ 331 }; 332 333 extern struct sysent sysent[]; 334 #ifdef _SYSCALL32_IMPL 335 extern struct sysent sysent32[]; 336 #endif 337 338 extern struct sysent nosys_ent; /* entry for invalid system call */ 339 340 #define NSYSCALL 256 /* number of system calls */ 341 342 #define LOADABLE_SYSCALL(s) (s->sy_flags & SE_LOADABLE) 343 #define LOADED_SYSCALL(s) (s->sy_flags & SE_LOADED) 344 345 /* 346 * sy_flags values 347 * Values 1, 2, and 4 were used previously for SETJUMP, ASYNC, and IOSYS. 348 */ 349 #define SE_32RVAL1 0x0 /* handler returns int32_t in rval1 */ 350 #define SE_32RVAL2 0x1 /* handler returns int32_t in rval2 */ 351 #define SE_64RVAL 0x2 /* handler returns int64_t in rvals */ 352 #define SE_RVAL_MASK 0x3 /* mask of rval_t bits */ 353 354 #define SE_LOADABLE 0x08 /* syscall is loadable */ 355 #define SE_LOADED 0x10 /* syscall is completely loaded */ 356 #define SE_NOUNLOAD 0x20 /* syscall never needs unload */ 357 #define SE_ARGC 0x40 /* syscall takes C-style args */ 358 359 /* 360 * Structure of the return-value parameter passed by reference to 361 * system entries. 362 */ 363 union rval { 364 struct { 365 int r_v1; 366 int r_v2; 367 } r_v; 368 off_t r_off; 369 offset_t r_offset; 370 time_t r_time; 371 int64_t r_vals; 372 }; 373 #define r_val1 r_v.r_v1 374 #define r_val2 r_v.r_v2 375 376 typedef union rval rval_t; 377 378 #ifdef _KERNEL 379 380 extern void reset_syscall_args(void); 381 extern int save_syscall_args(void); 382 extern uint_t get_syscall_args(klwp_t *lwp, long *argp, int *nargsp); 383 #ifdef _SYSCALL32_IMPL 384 extern uint_t get_syscall32_args(klwp_t *lwp, int *argp, int *nargp); 385 #endif 386 387 extern uint_t set_errno(uint_t error); 388 #pragma rarely_called(set_errno) 389 390 extern int64_t syscall_ap(void); 391 extern int64_t loadable_syscall(long, long, long, long, long, long, long, long); 392 extern int64_t nosys(void); 393 394 extern void swtch(void); 395 396 extern uint_t kcpc_key; /* TSD key for performance counter context */ 397 398 /* 399 * initname holds the path to init and is used as a point of rendezvous 400 * between krtld (which processes the boot arguments) and the kernel. 401 */ 402 #define INITNAME_SZ 32 403 extern char initname[INITNAME_SZ]; 404 405 /* 406 * initargs holds the arguments to init (such as -v, -s, -r, -m verbose) and 407 * is a point of rendezvous between krtld (which processes the boot arguments) 408 * and the kernel. 409 */ 410 extern char initargs[BOOTARGS_MAX]; 411 412 extern int exec_init(const char *, const char *); 413 extern int start_init_common(void); 414 415 #endif /* _KERNEL */ 416 417 #if defined(_KERNEL) || defined(_BOOT) 418 419 size_t strlcat(char *, const char *, size_t); 420 size_t strlen(const char *) __PURE; 421 char *strcat(char *, const char *); 422 char *strncat(char *, const char *, size_t); 423 char *strcpy(char *, const char *); 424 char *strncpy(char *, const char *, size_t); 425 /* Need to be consistent with <string.h> C++ definitions */ 426 #if __cplusplus >= 199711L 427 extern const char *strchr(const char *, int); 428 #ifndef _STRCHR_INLINE 429 #define _STRCHR_INLINE 430 extern "C++" { 431 inline char *strchr(char *__s, int __c) { 432 return (char *)strchr((const char *)__s, __c); 433 } 434 } 435 #endif /* _STRCHR_INLINE */ 436 extern const char *strrchr(const char *, int); 437 #ifndef _STRRCHR_INLINE 438 #define _STRRCHR_INLINE 439 extern "C++" { 440 inline char *strrchr(char *__s, int __c) { 441 return (char *)strrchr((const char *)__s, __c); 442 } 443 } 444 #endif /* _STRRCHR_INLINE */ 445 extern const char *strstr(const char *, const char *); 446 #ifndef _STRSTR_INLINE 447 #define _STRSTR_INLINE 448 extern "C++" { 449 inline char *strstr(char *__s1, const char *__s2) { 450 return (char *)strstr((const char *)__s1, __s2); 451 } 452 } 453 #endif /* _STRSTR_INLINE */ 454 #else /* __cplusplus >= 199711L */ 455 char *strchr(const char *, int); 456 char *strrchr(const char *, int); 457 char *strstr(const char *, const char *); 458 #endif /* __cplusplus >= 199711L */ 459 char *strnrchr(const char *, int, size_t); 460 int strcmp(const char *, const char *) __PURE; 461 int strncmp(const char *, const char *, size_t) __PURE; 462 int strcasecmp(const char *, const char *) __PURE; 463 int strncasecmp(const char *, const char *, size_t) __PURE; 464 /* Need to be consistent with <string.h> C++ definitions */ 465 #if __cplusplus >= 199711L 466 extern const char *strpbrk(const char *, const char *); 467 #ifndef _STRPBRK_INLINE 468 #define _STRPBRK_INLINE 469 extern "C++" { 470 inline char *strpbrk(char *__s1, const char *__s2) { 471 return (char *)strpbrk((const char *)__s1, __s2); 472 } 473 } 474 #endif /* _STRPBRK_INLINE */ 475 #else /* __cplusplus >= 199711L */ 476 char *strpbrk(const char *, const char *); 477 #endif /* __cplusplus >= 199711L */ 478 void bcopy(const void *, void *, size_t); 479 void bzero(void *, size_t); 480 481 extern void *memset(void *, int, size_t); 482 extern void *memcpy(void *, const void *, size_t); 483 extern void *memmove(void *, const void *, size_t); 484 extern int memcmp(const void *, const void *, size_t); 485 486 #ifdef __lint 487 extern int __lintzero; /* for spoofing lint */ 488 #else /* __lint */ 489 #define __lintzero 0 490 #endif /* __lint */ 491 #endif /* _KERNEL || _BOOT */ 492 493 #ifdef __cplusplus 494 } 495 #endif 496 497 #endif /* _SYS_SYSTM_H */ 498