xref: /illumos-gate/usr/src/uts/common/sys/param.h (revision f48205be)
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 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
27 /*	  All Rights Reserved  	*/
28 
29 /*
30  * University Copyright- Copyright (c) 1982, 1986, 1988
31  * The Regents of the University of California
32  * All Rights Reserved
33  *
34  * University Acknowledgment- Portions of this document are derived from
35  * software developed by the University of California, Berkeley, and its
36  * contributors.
37  */
38 
39 #ifndef _SYS_PARAM_H
40 #define	_SYS_PARAM_H
41 
42 #pragma ident	"%Z%%M%	%I%	%E% SMI"
43 
44 #ifndef _ASM		/* Avoid typedef headaches for assembly files */
45 #include <sys/types.h>
46 #include <sys/isa_defs.h>
47 #endif /* _ASM */
48 
49 
50 #ifdef	__cplusplus
51 extern "C" {
52 #endif
53 
54 /*
55  * Fundamental variables; don't change too often.
56  */
57 
58 /*
59  * _POSIX_VDISABLE has historically been defined in <sys/param.h> since
60  * an early merge with AT&T source.  It has also historically been defined
61  * in <sys/termios.h>. The POSIX standard, IEEE Std. 1003.1-1988 initially
62  * required the existence of _POSIX_VDISABLE in <sys/termios.h>.
63  * Subsequent versions of the IEEE Standard as well as the X/Open
64  * specifications required that _POSIX_VDISABLE be defined in <unistd.h>
65  * while still allowing for it's existence in other headers.  With the
66  * introduction of XPG6, _POSIX_VDISABLE can only be defined in <unistd.h>.
67  */
68 #if !defined(_XPG6) || defined(__EXTENSIONS__)
69 #ifndef	_POSIX_VDISABLE
70 #define	_POSIX_VDISABLE 0	/* Disable special character functions */
71 #endif
72 #endif /* !defined(_XPG6) || defined(__EXTENSIONS__) */
73 
74 #ifndef	MAX_INPUT
75 #define	MAX_INPUT	512	/* Maximum bytes stored in the input queue */
76 #endif
77 
78 #ifndef	MAX_CANON
79 #define	MAX_CANON	256	/* Maximum bytes for canonical processing */
80 #endif
81 
82 #define	UID_NOBODY	60001	/* user ID no body */
83 #define	GID_NOBODY	UID_NOBODY
84 
85 #define	UID_NOACCESS	60002	/* user ID no access */
86 
87 #ifdef _KERNEL
88 #define	MAX_TASKID	999999
89 #define	MAX_MAXPID	999999
90 #define	MAXEPHUID	0xfffffffcu	/* max ephemeral user id */
91 #endif
92 
93 #ifdef DEBUG
94 #define	DEFAULT_MAXPID	999999
95 #define	DEFAULT_JUMPPID	100000
96 #else
97 #define	DEFAULT_MAXPID	30000
98 #define	DEFAULT_JUMPPID	0
99 
100 #endif
101 
102 #define	MAXUID		2147483647	/* max user id */
103 
104 #define	MAXPROJID	MAXUID		/* max project id */
105 #define	MAXLINK		32767	/* max links */
106 
107 #define	MINEPHUID	0x80000000u	/* min ephemeral user id */
108 
109 #define	NMOUNT		40	/* est. of # mountable fs for quota calc */
110 
111 #define	CANBSIZ		256	/* max size of typewriter line	*/
112 
113 #define	NOFILE		20	/* this define is here for	*/
114 				/* compatibility purposes only	*/
115 				/* and will be removed in a	*/
116 				/* later release		*/
117 
118 /*
119  * These define the maximum and minimum allowable values of the
120  * configurable parameter NGROUPS_MAX.
121  */
122 #define	NGROUPS_UMIN	0
123 #define	NGROUPS_UMAX	32
124 
125 /*
126  * NGROUPS_MAX_DEFAULT: *MUST* match NGROUPS_MAX value in limits.h.
127  * Remember that the NFS protocol must rev. before this can be increased
128  */
129 #define	NGROUPS_MAX_DEFAULT	16
130 
131 /*
132  * Default process priority.  Keep it in sync with limits.h.
133  */
134 #define	NZERO	20
135 
136 /*
137  * Fundamental constants of the implementation--cannot be changed easily.
138  */
139 
140 #define	NBPW	sizeof (int)	/* number of bytes in an integer */
141 
142 #ifndef	NULL
143 #if defined(_LP64)
144 #define	NULL    0L
145 #else
146 #define	NULL	0
147 #endif
148 #endif
149 
150 #define	CMASK	022		/* default mask for file creation */
151 #define	CDLIMIT	(1L<<11)	/* default max write address */
152 #define	NBPS		0x20000	/* Number of bytes per segment */
153 #define	NBPSCTR		512	/* Bytes per disk sector.	*/
154 #define	UBSIZE		512	/* unix block size.		*/
155 #define	SCTRSHFT	9	/* Shift for BPSECT.		*/
156 
157 #ifdef _LITTLE_ENDIAN
158 #define	lobyte(X)	(((unsigned char *)&(X))[0])
159 #define	hibyte(X)	(((unsigned char *)&(X))[1])
160 #define	loword(X)	(((ushort_t *)&(X))[0])
161 #define	hiword(X)	(((ushort_t *)&(X))[1])
162 #endif
163 #ifdef _BIG_ENDIAN
164 #define	lobyte(X)	(((unsigned char *)&(X))[1])
165 #define	hibyte(X)	(((unsigned char *)&(X))[0])
166 #define	loword(X)	(((ushort_t *)&(X))[1])
167 #define	hiword(X)	(((ushort_t *)&(X))[0])
168 #endif
169 
170 /* REMOTE -- whether machine is primary, secondary, or regular */
171 #define	SYSNAME 9		/* # chars in system name */
172 #define	PREMOTE 39
173 
174 /*
175  * MAXPATHLEN defines the longest permissible path length,
176  * including the terminating null, after expanding symbolic links.
177  * TYPICALMAXPATHLEN is used in a few places as an optimization
178  * with a local buffer on the stack to avoid kmem_alloc().
179  * MAXSYMLINKS defines the maximum number of symbolic links
180  * that may be expanded in a path name. It should be set high
181  * enough to allow all legitimate uses, but halt infinite loops
182  * reasonably quickly.
183  * MAXNAMELEN is the length (including the terminating null) of
184  * the longest permissible file (component) name.
185  */
186 #define	MAXPATHLEN	1024
187 #define	TYPICALMAXPATHLEN	64
188 #define	MAXSYMLINKS	20
189 #define	MAXNAMELEN	256
190 
191 #ifndef NADDR
192 #define	NADDR 13
193 #endif
194 
195 /*
196  * The following are defined to be the same as
197  * defined in /usr/include/limits.h.  They are
198  * needed for pipe and FIFO compatibility.
199  */
200 #ifndef PIPE_BUF	/* max # bytes atomic in write to a pipe */
201 #define	PIPE_BUF	5120
202 #endif	/* PIPE_BUF */
203 
204 #ifndef PIPE_MAX	/* max # bytes written to a pipe in a write */
205 #define	PIPE_MAX	5120
206 #endif	/* PIPE_MAX */
207 
208 #ifndef NBBY
209 #define	NBBY	8			/* number of bits per byte */
210 #endif
211 
212 /* macros replacing interleaving functions */
213 #define	dkblock(bp)	((bp)->b_blkno)
214 #define	dkunit(bp)	(minor((bp)->b_dev) >> 3)
215 
216 /*
217  * File system parameters and macros.
218  *
219  * The file system is made out of blocks of at most MAXBSIZE units,
220  * with smaller units (fragments) only in the last direct block.
221  * MAXBSIZE primarily determines the size of buffers in the buffer
222  * pool. It may be made larger without any effect on existing
223  * file systems; however making it smaller make make some file
224  * systems unmountable.
225  *
226  * Note that the blocked devices are assumed to have DEV_BSIZE
227  * "sectors" and that fragments must be some multiple of this size.
228  */
229 #define	MAXBSIZE	8192
230 #define	DEV_BSIZE	512
231 #define	DEV_BSHIFT	9		/* log2(DEV_BSIZE) */
232 #define	MAXFRAG 	8
233 #ifdef	_SYSCALL32
234 #define	MAXOFF32_T	0x7fffffff
235 #endif
236 #ifdef	_LP64
237 #define	MAXOFF_T	0x7fffffffffffffffl
238 #define	MAXOFFSET_T	0x7fffffffffffffffl
239 #else
240 #define	MAXOFF_T	0x7fffffffl
241 #ifdef _LONGLONG_TYPE
242 #define	MAXOFFSET_T 	0x7fffffffffffffffLL
243 #else
244 #define	MAXOFFSET_T	0x7fffffff
245 #endif
246 #endif	/* _LP64 */
247 
248 #define	btodb(bytes)			/* calculates (bytes / DEV_BSIZE) */ \
249 	((unsigned long)(bytes) >> DEV_BSHIFT)
250 #define	dbtob(db)			/* calculates (db * DEV_BSIZE) */ \
251 	((unsigned long)(db) << DEV_BSHIFT)
252 
253 /*	64 bit versions of btodb and dbtob */
254 #define	lbtodb(bytes)			/* calculates (bytes / DEV_BSIZE) */ \
255 	((u_offset_t)(bytes) >> DEV_BSHIFT)
256 #define	ldbtob(db)			/* calculates (db * DEV_BSIZE) */ \
257 	((u_offset_t)(db) << DEV_BSHIFT)
258 
259 #ifndef _ASM	/* Avoid typedef headaches for assembly files */
260 #ifndef NODEV
261 #define	NODEV	(dev_t)(-1l)
262 #ifdef _SYSCALL32
263 #define	NODEV32	(dev32_t)(-1)
264 #endif	/* _SYSCALL32 */
265 #endif	/* NODEV */
266 #endif	/* _ASM */
267 
268 /*
269  * Size of arg list passed in by user.
270  */
271 #define	NCARGS32	0x100000
272 #define	NCARGS64	0x200000
273 #ifdef	_LP64
274 #define	NCARGS		NCARGS64
275 #else	/* _LP64 */
276 #define	NCARGS		NCARGS32
277 #endif	/* _LP64 */
278 
279 /*
280  * Scale factor for scaled integers used to count
281  * %cpu time and load averages.
282  */
283 #define	FSHIFT	8		/* bits to right of fixed binary point */
284 #define	FSCALE	(1<<FSHIFT)
285 
286 /*
287  * Delay units are in microseconds.
288  *
289  * XXX	These macros are not part of the DDI!
290  */
291 #if defined(_KERNEL) && !defined(_ASM)
292 extern void drv_usecwait(clock_t);
293 #define	DELAY(n)	drv_usecwait(n)
294 #define	CDELAY(c, n)	\
295 { \
296 	register int N = n; \
297 	while (--N > 0) { \
298 		if (c) \
299 			break; \
300 		drv_usecwait(1); \
301 	} \
302 }
303 #endif	/* defined(_KERNEL) && !defined(_ASM) */
304 
305 #ifdef	__cplusplus
306 }
307 #endif
308 
309 /*
310  * The following is to free utilities from machine dependencies within
311  * an architecture. Must be included after definition of DEV_BSIZE.
312  */
313 
314 #if (defined(_KERNEL) || defined(_KMEMUSER))
315 
316 #if defined(_MACHDEP)
317 #include <sys/machparam.h>
318 #endif
319 
320 #ifdef	__cplusplus
321 extern "C" {
322 #endif
323 
324 #if defined(_KERNEL) && !defined(_ASM)
325 extern int cpu_decay_factor;
326 extern pid_t maxpid;
327 extern pid_t jump_pid;
328 
329 extern uintptr_t _kernelbase;
330 extern uintptr_t _userlimit;
331 extern uintptr_t _userlimit32;
332 #endif  /* defined(_KERNEL) && !defined(_ASM) */
333 
334 
335 #if !defined(_MACHDEP)
336 
337 /*
338  * Implementation architecture independent sections of the kernel use
339  * this section.
340  */
341 #if defined(_KERNEL) && !defined(_ASM)
342 extern int hz;
343 extern int snooping;
344 extern uint_t snoop_interval;
345 extern const unsigned long _pagesize;
346 extern const unsigned int _pageshift;
347 extern const unsigned long _pageoffset;
348 extern const unsigned long long _pagemask;
349 extern const unsigned long _mmu_pagesize;
350 extern const unsigned int _mmu_pageshift;
351 extern const unsigned long _mmu_pageoffset;
352 extern const unsigned long _mmu_pagemask;
353 extern const uintptr_t _argsbase;
354 extern const unsigned long _defaultstksz;
355 extern const unsigned int _nbpg;
356 extern const int _ncpu;
357 extern const int _clsize;
358 #endif	/* defined(_KERNEL) && !defined(_ASM) */
359 
360 #define	PAGESIZE	_pagesize
361 #define	PAGESHIFT	_pageshift
362 #define	PAGEOFFSET	_pageoffset
363 #define	PAGEMASK	_pagemask
364 #define	MMU_PAGESIZE	_mmu_pagesize
365 #define	MMU_PAGESHIFT	_mmu_pageshift
366 #define	MMU_PAGEOFFSET	_mmu_pageoffset
367 #define	MMU_PAGEMASK	_mmu_pagemask
368 
369 #define	KERNELBASE	_kernelbase
370 #define	USERLIMIT	_userlimit
371 #define	USERLIMIT32	_userlimit32
372 #define	ARGSBASE	_argsbase
373 #define	DEFAULTSTKSZ	_defaultstksz
374 #define	NCPU		_ncpu
375 
376 #endif	/* defined(_MACHDEP) */
377 
378 /*
379  * Some random macros for units conversion.
380  *
381  * These are machine independent but contain constants (*PAGESHIFT) which
382  * are only defined in the machine dependent file.
383  */
384 
385 /*
386  * MMU pages to bytes, and back (with and without rounding)
387  */
388 #define	mmu_ptob(x)	((x) << MMU_PAGESHIFT)
389 #define	mmu_btop(x)	(((x)) >> MMU_PAGESHIFT)
390 #define	mmu_btopr(x)	((((x) + MMU_PAGEOFFSET) >> MMU_PAGESHIFT))
391 
392 /*
393  * 2 versions of pages to disk blocks
394  */
395 #define	mmu_ptod(x)	((x) << (MMU_PAGESHIFT - DEV_BSHIFT))
396 #define	ptod(x)		((x) << (PAGESHIFT - DEV_BSHIFT))
397 
398 /*
399  * pages to bytes, and back (with and without rounding)
400  * Large Files: The explicit cast of x to unsigned int is deliberately
401  * removed as part of large files work. We pass longlong values to
402  * theses macros.
403  *
404  * Cast the input to ptob() to be a page count. This enforces 64-bit
405  * math on 64-bit kernels. For 32-bit kernels, callers must explicitly
406  * cast the input to be a 64-bit type if values greater than 4GB/PAGESIZE
407  * are possible.
408  */
409 
410 #ifdef _LP64
411 #define	ptob(x)		(((pgcnt_t)(x)) << PAGESHIFT)
412 #else
413 #define	ptob(x)		((x) << PAGESHIFT)
414 #endif /* _LP64 */
415 #define	btop(x)		(((x) >> PAGESHIFT))
416 #define	btopr(x)	((((x) + PAGEOFFSET) >> PAGESHIFT))
417 
418 /*
419  * disk blocks to pages, rounded and truncated
420  */
421 #define	NDPP		(PAGESIZE/DEV_BSIZE)	/* # of disk blocks per page */
422 #define	dtop(DD)	(((DD) + NDPP - 1) >> (PAGESHIFT - DEV_BSHIFT))
423 #define	dtopt(DD)	((DD) >> (PAGESHIFT - DEV_BSHIFT))
424 
425 /*
426  * kB to pages and back
427  */
428 #define	kbtop(x)	((x) >> (PAGESHIFT - 10))
429 #define	ptokb(x)	((x) << (PAGESHIFT - 10))
430 
431 /*
432  * POSIX.4 related configuration parameters
433  */
434 #define	_AIO_LISTIO_MAX		(4096)
435 #define	_AIO_MAX		(-1)
436 #define	_MQ_OPEN_MAX		(-1)
437 #define	_MQ_PRIO_MAX		(32)
438 #define	_SEM_NSEMS_MAX		INT_MAX
439 #define	_SEM_VALUE_MAX		INT_MAX
440 
441 #ifdef	__cplusplus
442 }
443 #endif
444 
445 #else	/* (defined(_KERNEL) || defined(_KMEMUSER)) */
446 
447 /*
448  * The following are assorted machine dependent values which can be
449  * obtained in a machine independent manner through sysconf(2) or
450  * sysinfo(2). In order to guarantee that these provide the expected
451  * value at all times, the System Private interface (leading underscore)
452  * is used.
453  */
454 
455 #include <sys/unistd.h>
456 
457 #ifdef	__cplusplus
458 extern "C" {
459 #endif
460 
461 #if !defined(_ASM)
462 extern long _sysconf(int);	/* System Private interface to sysconf() */
463 #endif	/* !defined(_ASM) */
464 
465 #define	HZ		((clock_t)_sysconf(_SC_CLK_TCK))
466 #define	TICK		(1000000000/((clock_t)_sysconf(_SC_CLK_TCK)))
467 #define	PAGESIZE	(_sysconf(_SC_PAGESIZE))
468 #define	PAGEOFFSET	(PAGESIZE - 1)
469 #define	PAGEMASK	(~PAGEOFFSET)
470 #define	MAXPID		((pid_t)_sysconf(_SC_MAXPID))
471 #define	MAXEPHUID	((uid_t)_sysconf(_SC_EPHID_MAX))
472 
473 #ifdef	__cplusplus
474 }
475 #endif
476 
477 #endif	/* (defined(_KERNEL) || defined(_KMEMUSER)) &&  defined(_MACHDEP) */
478 
479 #endif	/* _SYS_PARAM_H */
480