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