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