xref: /illumos-gate/usr/src/uts/common/sys/systm.h (revision ae46e4c775f2becc5343ff90b60a95acb79735f9)
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 volatile clock_t lbolt;	/* time in HZ since last boot */
65 extern volatile int64_t lbolt64;	/* lbolt computed as 64-bit value */
66 extern int interrupts_unleashed;	/* set after the spl0() in main() */
67 
68 extern char runin;		/* scheduling flag */
69 extern char runout;		/* scheduling flag */
70 extern char wake_sched;		/* causes clock to wake swapper on next tick */
71 extern char wake_sched_sec;	/* causes clock to wake swapper after a sec */
72 
73 extern pgcnt_t	maxmem;		/* max available memory (pages) */
74 extern pgcnt_t	physmem;	/* physical memory (pages) on this CPU */
75 extern pfn_t	physmax;	/* highest numbered physical page present */
76 extern pgcnt_t	physinstalled;	/* physical pages including PROM/boot use */
77 
78 extern caddr_t	s_text;		/* start of kernel text segment */
79 extern caddr_t	e_text;		/* end of kernel text segment */
80 extern caddr_t	s_data;		/* start of kernel text segment */
81 extern caddr_t	e_data;		/* end of kernel text segment */
82 
83 extern pgcnt_t	availrmem;	/* Available resident (not swapable)	*/
84 				/* memory in pages.			*/
85 extern pgcnt_t	availrmem_initial;	/* initial value of availrmem	*/
86 extern pgcnt_t	segspt_minfree;	/* low water mark for availrmem in seg_spt */
87 extern pgcnt_t	freemem;	/* Current free memory.			*/
88 
89 extern dev_t	rootdev;	/* device of the root */
90 extern struct vnode *rootvp;	/* vnode of root device */
91 extern boolean_t root_is_svm;		/* root is a mirrored device flag */
92 extern boolean_t root_is_ramdisk;	/* root is boot_archive ramdisk */
93 extern uint32_t  ramdisk_size;		/* (KB) set only for sparc netboots */
94 extern char *volatile panicstr;	/* panic string pointer */
95 extern va_list  panicargs;	/* panic arguments */
96 extern volatile int quiesce_active;	/* quiesce(9E) is in progress */
97 
98 extern int	rstchown;	/* 1 ==> restrictive chown(2) semantics */
99 extern int	klustsize;
100 
101 extern int	abort_enable;	/* Platform input-device abort policy */
102 
103 extern int	audit_active;	/* Solaris Auditing active 1, absent 0. */
104 
105 extern int	avenrun[];	/* array of load averages */
106 
107 extern char *isa_list;		/* For sysinfo's isalist option */
108 
109 extern int noexec_user_stack;		/* patchable via /etc/system */
110 extern int noexec_user_stack_log;	/* patchable via /etc/system */
111 
112 /*
113  * Use NFS client operations in the global zone only.  Under contract with
114  * admin/install; do not change without coordinating with that consolidation.
115  */
116 extern int nfs_global_client_only;
117 
118 extern void report_stack_exec(proc_t *, caddr_t);
119 
120 extern void startup(void);
121 extern void clkstart(void);
122 extern void post_startup(void);
123 extern void kern_setup1(void);
124 extern void ka_init(void);
125 extern void nodename_set(void);
126 
127 /*
128  * for tod fault detection
129  */
130 enum tod_fault_type {
131 	TOD_REVERSED = 0,
132 	TOD_STALLED,
133 	TOD_JUMPED,
134 	TOD_RATECHANGED,
135 	TOD_RDONLY,
136 	TOD_NOFAULT
137 };
138 
139 extern time_t tod_validate(time_t);
140 extern void tod_fault_reset(void);
141 extern void plat_tod_fault(enum tod_fault_type);
142 
143 #ifndef _LP64
144 #ifndef min
145 int min(int, int);
146 #endif
147 
148 #ifndef max
149 int max(int, int);
150 #endif
151 
152 uint_t umin(uint_t, uint_t);
153 uint_t umax(uint_t, uint_t);
154 #endif /* !_LP64 */
155 int grow(caddr_t);
156 int grow_internal(caddr_t, uint_t);
157 int brk_internal(caddr_t, uint_t);
158 typedef uint64_t callout_id_t;
159 timeout_id_t timeout(void (*)(void *), void *, clock_t);
160 timeout_id_t realtime_timeout(void (*)(void *), void *, clock_t);
161 clock_t untimeout(timeout_id_t);
162 /*
163  * The last argument to timeout_generic() is flags. See callo.h for the
164  * flags definitions.
165  */
166 callout_id_t timeout_generic(int, void (*)(void *), void *, hrtime_t, hrtime_t,
167     int);
168 callout_id_t timeout_default(void (*)(void *), void *, clock_t);
169 callout_id_t realtime_timeout_default(void (*)(void *), void *, clock_t);
170 /*
171  * The last argument to untimeout_generic() is flags. See callout.c for the
172  * use.
173  */
174 hrtime_t untimeout_generic(callout_id_t, int);
175 clock_t untimeout_default(callout_id_t, int);
176 void delay(clock_t);
177 int delay_sig(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 *);
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 *);
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 
275 void softcall_init(void);
276 void softcall(void (*)(void *), void *);
277 void softint(void);
278 
279 extern void sync_icache(caddr_t, uint_t);
280 extern void sync_data_memory(caddr_t, size_t);
281 extern void hot_patch_kernel_text(caddr_t, uint32_t, uint_t);
282 
283 void _insque(caddr_t, caddr_t);
284 void _remque(caddr_t);
285 
286 /* casts to keep lint happy */
287 #define	insque(q, p)	_insque((caddr_t)q, (caddr_t)p)
288 #define	remque(q)	_remque((caddr_t)q)
289 
290 #pragma unknown_control_flow(on_fault)
291 
292 struct timeval;
293 extern void	uniqtime(struct timeval *);
294 struct timeval32;
295 extern void	uniqtime32(struct timeval32 *);
296 
297 uint_t page_num_pagesizes(void);
298 size_t page_get_pagesize(uint_t n);
299 
300 extern int maxusers;
301 extern int pidmax;
302 
303 extern void param_preset(void);
304 extern void param_calc(int);
305 extern void param_init(void);
306 extern void param_check(void);
307 
308 #endif /* _KERNEL */
309 
310 /*
311  * Structure of the system-entry table.
312  *
313  * 	Changes to struct sysent should maintain binary compatibility with
314  *	loadable system calls, although the interface is currently private.
315  *
316  *	This means it should only be expanded on the end, and flag values
317  * 	should not be reused.
318  *
319  *	It is desirable to keep the size of this struct a power of 2 for quick
320  *	indexing.
321  */
322 struct sysent {
323 	char		sy_narg;	/* total number of arguments */
324 #ifdef _LP64
325 	unsigned short	sy_flags;	/* various flags as defined below */
326 #else
327 	unsigned char	sy_flags;	/* various flags as defined below */
328 #endif
329 	int		(*sy_call)();	/* argp, rvalp-style handler */
330 	krwlock_t	*sy_lock;	/* lock for loadable system calls */
331 	int64_t		(*sy_callc)();	/* C-style call hander or wrapper */
332 };
333 
334 extern struct sysent	sysent[];
335 #ifdef _SYSCALL32_IMPL
336 extern struct sysent	sysent32[];
337 #endif
338 
339 extern struct sysent	nosys_ent;	/* entry for invalid system call */
340 
341 #define	NSYSCALL 	256		/* number of system calls */
342 
343 #define	LOADABLE_SYSCALL(s)	(s->sy_flags & SE_LOADABLE)
344 #define	LOADED_SYSCALL(s)	(s->sy_flags & SE_LOADED)
345 
346 /*
347  * sy_flags values
348  * 	Values 1, 2, and 4 were used previously for SETJUMP, ASYNC, and IOSYS.
349  */
350 #define	SE_32RVAL1	0x0		/* handler returns int32_t in rval1 */
351 #define	SE_32RVAL2	0x1		/* handler returns int32_t in rval2 */
352 #define	SE_64RVAL	0x2		/* handler returns int64_t in rvals */
353 #define	SE_RVAL_MASK	0x3		/* mask of rval_t bits */
354 
355 #define	SE_LOADABLE	0x08		/* syscall is loadable */
356 #define	SE_LOADED	0x10		/* syscall is completely loaded */
357 #define	SE_NOUNLOAD	0x20		/* syscall never needs unload */
358 #define	SE_ARGC		0x40		/* syscall takes C-style args */
359 
360 /*
361  * Structure of the return-value parameter passed by reference to
362  * system entries.
363  */
364 union rval {
365 	struct	{
366 		int	r_v1;
367 		int	r_v2;
368 	} r_v;
369 	off_t	r_off;
370 	offset_t r_offset;
371 	time_t	r_time;
372 	int64_t	r_vals;
373 };
374 #define	r_val1	r_v.r_v1
375 #define	r_val2	r_v.r_v2
376 
377 typedef union rval rval_t;
378 
379 #ifdef	_KERNEL
380 
381 extern void reset_syscall_args(void);
382 extern int save_syscall_args(void);
383 extern uint_t get_syscall_args(klwp_t *lwp, long *argp, int *nargsp);
384 #ifdef _SYSCALL32_IMPL
385 extern uint_t get_syscall32_args(klwp_t *lwp, int *argp, int *nargp);
386 #endif
387 
388 extern uint_t set_errno(uint_t error);
389 #pragma rarely_called(set_errno)
390 
391 extern int64_t syscall_ap(void);
392 extern int64_t loadable_syscall(long, long, long, long, long, long, long, long);
393 extern int64_t nosys(void);
394 
395 extern void swtch(void);
396 
397 extern uint_t	kcpc_key;	/* TSD key for performance counter context */
398 
399 /*
400  * initname holds the path to init and is used as a point of rendezvous
401  * between krtld (which processes the boot arguments) and the kernel.
402  */
403 #define	INITNAME_SZ	32
404 extern char initname[INITNAME_SZ];
405 
406 /*
407  * initargs holds the arguments to init (such as -v, -s, -r, -m verbose) and
408  * is a point of rendezvous between krtld (which processes the boot arguments)
409  * and the kernel.
410  */
411 extern char initargs[BOOTARGS_MAX];
412 
413 extern int exec_init(const char *, const char *);
414 extern int start_init_common(void);
415 
416 #endif	/* _KERNEL */
417 
418 #if defined(_KERNEL) || defined(_BOOT)
419 
420 size_t strlcat(char *, const char *, size_t);
421 size_t strlen(const char *) __PURE;
422 char *strcat(char *, const char *);
423 char *strncat(char *, const char *, size_t);
424 char *strcpy(char *, const char *);
425 char *strncpy(char *, const char *, size_t);
426 /* Need to be consistent with <string.h> C++ definitions */
427 #if __cplusplus >= 199711L
428 extern const char *strchr(const char *, int);
429 #ifndef _STRCHR_INLINE
430 #define	_STRCHR_INLINE
431 extern "C++" {
432 	inline char *strchr(char *__s, int __c) {
433 		return (char *)strchr((const char *)__s, __c);
434 	}
435 }
436 #endif /* _STRCHR_INLINE */
437 extern const char *strrchr(const char *, int);
438 #ifndef	_STRRCHR_INLINE
439 #define	_STRRCHR_INLINE
440 extern "C++" {
441 	inline char *strrchr(char *__s, int __c) {
442 		return (char *)strrchr((const char *)__s, __c);
443 	}
444 }
445 #endif	/* _STRRCHR_INLINE */
446 extern const char *strstr(const char *, const char *);
447 #ifndef	_STRSTR_INLINE
448 #define	_STRSTR_INLINE
449 extern "C++" {
450 	inline char *strstr(char *__s1, const char *__s2) {
451 		return (char *)strstr((const char *)__s1, __s2);
452 	}
453 }
454 #endif  /* _STRSTR_INLINE */
455 #else	/* __cplusplus >= 199711L */
456 char *strchr(const char *, int);
457 char *strrchr(const char *, int);
458 char *strstr(const char *, const char *);
459 #endif	/* __cplusplus >= 199711L */
460 char *strnrchr(const char *, int, size_t);
461 int strcmp(const char *, const char *) __PURE;
462 int strncmp(const char *, const char *, size_t) __PURE;
463 int strcasecmp(const char *, const char *) __PURE;
464 int strncasecmp(const char *, const char *, size_t) __PURE;
465 /* Need to be consistent with <string.h> C++ definitions */
466 #if __cplusplus >= 199711L
467 extern const char *strpbrk(const char *, const char *);
468 #ifndef _STRPBRK_INLINE
469 #define	_STRPBRK_INLINE
470 extern "C++" {
471 	inline char *strpbrk(char *__s1, const char *__s2) {
472 		return (char *)strpbrk((const char *)__s1, __s2);
473 	}
474 }
475 #endif /* _STRPBRK_INLINE */
476 #else /* __cplusplus >= 199711L */
477 char *strpbrk(const char *, const char *);
478 #endif /* __cplusplus >= 199711L */
479 void bcopy(const void *, void *, size_t);
480 void bzero(void *, size_t);
481 
482 extern void *memset(void *, int, size_t);
483 extern void *memcpy(void *, const void *, size_t);
484 extern void *memmove(void *, const void *, size_t);
485 extern int memcmp(const void *, const void *, size_t);
486 
487 #ifdef __lint
488 extern	int	__lintzero;	/* for spoofing lint */
489 #else	/* __lint */
490 #define	__lintzero 0
491 #endif	/* __lint */
492 #endif /* _KERNEL || _BOOT */
493 
494 #ifdef	__cplusplus
495 }
496 #endif
497 
498 #endif	/* _SYS_SYSTM_H */
499