xref: /dragonfly/sys/sys/param.h (revision b8d2998c)
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)param.h	8.3 (Berkeley) 4/4/95
39  * $FreeBSD: src/sys/sys/param.h,v 1.61.2.38 2003/05/22 17:12:01 fjoe Exp $
40  * $DragonFly: src/sys/sys/param.h,v 1.53 2008/11/11 00:55:49 pavalos Exp $
41  */
42 
43 #ifndef _SYS_PARAM_H_
44 #define _SYS_PARAM_H_
45 
46 #define BSD	200708		/* XXX kern.osrevision */
47 #define BSD4_3	1		/* XXX obsolete */
48 #define BSD4_4	1		/* XXX obsolete */
49 
50 /*
51  * __DragonFly_version number.  The number doesn't really meaningfully
52  * translate to a version number.
53  *
54  * 170000 - base development version after 1.6 branch
55  * 170001 - base development version before 1.8 branch
56  * 190000 - base development version after 1.8 branch
57  * 195000 - base development version after 1.10 branch
58  * 197500 - base development version before 1.12 branch
59  * 197600 - 1.12 branch
60  * 197700 - base development version after 1.12 branch
61  * 199900 - base development version before 2.0 branch
62  * 200000 - 2.0 branch
63  * 200100 - base development version after 2.0 branch
64  * 200101 - lchflags syscall
65  * 200200 - 2.2 branch
66  * 200201 - base development version after 2.2 branch
67  * 200202 - major changes to libc
68  * 200203 - introduce PCI domain
69  * 200204 - suser() & suser_cred() removal
70  * 200205 - devfs import
71  * 200206 - *sleep() renames
72  * 200400 - 2.4 release
73  * 200500 - 2.5 master
74  * 200600 - 2.6 release
75  * 200700 - 2.7 master
76  * 200800 - 2.8 release			October 2010
77  * 200900 - 2.9 master
78  * 200901 - prototype changes for alphasort(3) and scandir(3)
79  */
80 #undef __DragonFly_version
81 #define __DragonFly_version 200901	/* propagated to newvers */
82 
83 #include <sys/_null.h>
84 
85 #ifndef LOCORE
86 #include <sys/types.h>
87 #endif
88 
89 /*
90  * Machine-independent constants (some used in following include files).
91  * Redefined constants are from POSIX 1003.1 limits file.
92  *
93  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
94  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
95  */
96 #include <sys/syslimits.h>
97 
98 #define MAXCOMLEN	16		/* max command name remembered */
99 #define MAXINTERP	32		/* max interpreter file name length */
100 #define MAXLOGNAME	17		/* max login name length (incl. NUL) */
101 #define MAXUPRC		CHILD_MAX	/* max simultaneous processes */
102 #define NCARGS		ARG_MAX		/* max bytes for an exec function */
103 #define NGROUPS		NGROUPS_MAX	/* max number groups */
104 #define NOFILE		OPEN_MAX	/* max open files per process */
105 #define NOGROUP		65535		/* marker for empty group set member */
106 #define MAXHOSTNAMELEN	256		/* max hostname size */
107 
108 /* More types and definitions used throughout the kernel. */
109 #ifdef _KERNEL
110 #include <sys/cdefs.h>
111 #include <sys/errno.h>
112 #include <sys/time.h>
113 
114 #define FALSE	0
115 #define TRUE	1
116 #endif
117 
118 #ifndef _KERNEL
119 /* Signals. */
120 #include <sys/select.h>
121 #include <sys/signal.h>
122 #endif
123 
124 /* Machine type dependent parameters. */
125 #include <machine/param.h>
126 #ifndef _KERNEL
127 #include <machine/limits.h>
128 #endif
129 
130 #define PCATCH		0x00000100	/* tsleep checks signals */
131 #define PUSRFLAG1	0x00000200	/* Subsystem specific flag */
132 #define PINTERLOCKED	0x00000400	/* Interlocked tsleep */
133 #define PWAKEUP_CPUMASK	0x00003FFF	/* start cpu for chained wakeups */
134 #define PWAKEUP_MYCPU	0x00004000	/* wakeup on current cpu only */
135 #define PWAKEUP_ONE	0x00008000	/* argument to wakeup: only one */
136 #define PDOMAIN_MASK	0xFFFF0000	/* address domains for wakeup */
137 #define PDOMAIN_UMTX	0x00010000	/* independant domain for UMTX */
138 #define PWAKEUP_ENCODE(domain, cpu)	((domain) | (cpu))
139 #define PWAKEUP_DECODE(domain)		((domain) & PWAKEUP_CPUMASK)
140 
141 #define NZERO	0		/* default "nice" */
142 
143 #define NBPW	sizeof(int)	/* number of bytes per word (integer) */
144 
145 #define CMASK	022		/* default file mask: S_IWGRP|S_IWOTH */
146 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
147 #define NOUDEV	(udev_t)(-1)	/* non-existent device */
148 #define NOMAJ	256		/* non-existent device */
149 #endif
150 
151 #ifndef _KERNEL
152 #define NODEV	(dev_t)(-1)	/* non-existent device */
153 #endif
154 
155 /*
156  * cpu_mi_feature bits
157  */
158 #define CPU_MI_BZERONT	0x00000001
159 
160 /*
161  * File system parameters and macros.
162  *
163  * MAXBSIZE -	Filesystems are made out of blocks of at most MAXBSIZE bytes
164  *		per block.  MAXBSIZE may be made larger without effecting
165  *		any existing filesystems as long as it does not exceed MAXPHYS,
166  *		and may be made smaller at the risk of not being able to use
167  *		filesystems which require a block size exceeding MAXBSIZE.
168  *
169  * BKVASIZE -	Nominal buffer space per buffer, in bytes.  BKVASIZE is the
170  *		minimum KVM memory reservation the kernel is willing to make.
171  *		Filesystems can of course request smaller chunks.  Actual
172  *		backing memory uses a chunk size of a page (PAGE_SIZE).
173  *
174  *		If you make BKVASIZE too small you risk seriously fragmenting
175  *		the buffer KVM map which may slow things down a bit.  If you
176  *		make it too big the kernel will not be able to optimally use
177  *		the KVM memory reserved for the buffer cache and will wind
178  *		up with too-few buffers.
179  *
180  *		The default is 16384, roughly 2x the block size used by a
181  *		normal UFS filesystem.
182  */
183 #define MAXBSIZE	65536	/* must be power of 2 */
184 #define BKVASIZE	16384	/* must be power of 2 */
185 #define BKVAMASK	(BKVASIZE-1)
186 #define MAXFRAG 	8
187 
188 /*
189  * MAXPATHLEN defines the longest permissible path length after expanding
190  * symbolic links. It is used to allocate a temporary buffer from the buffer
191  * pool in which to do the name expansion, hence should be a power of two,
192  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
193  * maximum number of symbolic links that may be expanded in a path name.
194  * It should be set high enough to allow all legitimate uses, but halt
195  * infinite loops reasonably quickly.
196  */
197 #define MAXPATHLEN	PATH_MAX
198 #define MAXSYMLINKS	32
199 
200 /* Bit map related macros. */
201 #define setbit(a,i)	((a)[(i)/NBBY] |= 1<<((i)%NBBY))
202 #define clrbit(a,i)	((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
203 #define isset(a,i)	((a)[(i)/NBBY] & (1<<((i)%NBBY)))
204 #define isclr(a,i)	(((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
205 
206 /* Macros for counting and rounding. */
207 #ifndef howmany
208 #define howmany(x, y)	(((x)+((y)-1))/(y))
209 #endif
210 #define rounddown(x, y)	(((x)/(y))*(y))
211 #define rounddown2(x, y) ((x) & ~((y) - 1))	   /* y power of two */
212 #define roundup(x, y)	((((x)+((y)-1))/(y))*(y))  /* to any y */
213 #define roundup2(x, y)	(((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
214 #define powerof2(x)	((((x)-1)&(x))==0)
215 
216 /*
217  * VM objects can be larger than the virtual address space, make sure
218  * we don't cut-off the mask.
219  */
220 #define trunc_page64(x)           ((x) & ~(int64_t)PAGE_MASK)
221 #define round_page64(x)           (((x) + PAGE_MASK) & ~(int64_t)PAGE_MASK)
222 
223 /* Macros for min/max. */
224 #define MIN(a,b) (((a)<(b))?(a):(b))
225 #define MAX(a,b) (((a)>(b))?(a):(b))
226 
227 /*
228  * Constants for setting the parameters of the kernel memory allocator.
229  *
230  * 2 ** MINBUCKET is the smallest unit of memory that will be
231  * allocated. It must be at least large enough to hold a pointer.
232  *
233  * Units of memory less or equal to MAXALLOCSAVE will permanently
234  * allocate physical memory; requests for these size pieces of
235  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
236  * always allocate and free physical memory; requests for these
237  * size allocations should be done infrequently as they will be slow.
238  *
239  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
240  * MAXALLOCSIZE must be a power of two.
241  */
242 #define MINBUCKET	4		/* 4 => min allocation of 16 bytes */
243 #define MAXALLOCSAVE	(2 * PAGE_SIZE)
244 
245 /*
246  * Scale factor for scaled integers used to count %cpu time and load avgs.
247  *
248  * The number of CPU `tick's that map to a unique `%age' can be expressed
249  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
250  * can be calculated (assuming 32 bits) can be closely approximated using
251  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
252  *
253  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
254  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
255  */
256 #define FSHIFT	11		/* bits to right of fixed binary point */
257 #define FSCALE	(1<<FSHIFT)
258 
259 #define dbtoc(db)			/* calculates devblks to pages */ \
260 	((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
261 
262 #define ctodb(db)			/* calculates pages to devblks */ \
263 	((db) << (PAGE_SHIFT - DEV_BSHIFT))
264 
265 #define MJUMPAGESIZE	PAGE_SIZE	/* jumbo cluster 4k */
266 #define MJUM9BYTES	(9 * 1024)	/* jumbo cluster 9k */
267 #define MJUM16BYTES	(16 * 1024)	/* jumbo cluster 16k */
268 
269 /*
270  * MBUF Management.
271  *
272  * Because many drivers can't deal with multiple DMA segments all mbufs
273  * must avoid crossing a page boundary.  While we can accomodate mbufs
274  * which are not a power-of-2 sized kmalloc() will only guarantee
275  * non-crossing alignment if we use a power-of-2.  256 is no longer large
276  * enough due to m_hdr and m_pkthdr bloat.
277  *
278  * MCLBYTES must be a power of 2 and is typically significantly larger
279  * than MSIZE, sufficient to hold a standard-mtu packet.  2K is considered
280  * reasonable.
281  */
282 #ifndef MSIZE
283 #define MSIZE		512		/* size of an mbuf */
284 #endif
285 
286 #ifndef MCLSHIFT
287 #define MCLSHIFT        12              /* convert bytes to m_buf clusters */
288 #endif
289 #define MCLBYTES        (1 << MCLSHIFT) /* size of an m_buf cluster */
290 #define MCLOFSET        (MCLBYTES - 1)  /* offset within an m_buf cluster */
291 
292 /*
293  * Make this available for most of the kernel.  There were too many
294  * things that included sys/systm.h just for panic().
295  */
296 #ifdef _KERNEL
297 void	panic (const char *, ...) __dead2 __printflike(1, 2);
298 #endif
299 
300 #ifndef htonl
301 #define	htonl(x)	__htonl(x)
302 #endif
303 #ifndef htons
304 #define	htons(x)	__htons(x)
305 #endif
306 #ifndef ntohl
307 #define	ntohl(x)	__ntohl(x)
308 #endif
309 #ifndef ntohs
310 #define	ntohs(x)	__ntohs(x)
311 #endif
312 
313 #endif	/* _SYS_PARAM_H_ */
314