xref: /dragonfly/sys/sys/param.h (revision 21c1c48a)
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  */
69 #undef __DragonFly_version
70 #define __DragonFly_version 200202	/* Master, propagated to newvers */
71 
72 #ifdef __FreeBSD__
73 /*
74  * __FreeBSD_version numbers for source compatibility.  This is temporary
75  * along with the __FreeBSD__ define in gcc2.  Note that gcc3 does not
76  * define __FreeBSD__ by default, only __DragonFly__.
77  */
78 #undef __FreeBSD_version
79 #define __FreeBSD_version 480101
80 #endif
81 
82 #include <sys/_null.h>
83 
84 #ifndef LOCORE
85 #include <sys/types.h>
86 #endif
87 
88 /*
89  * Machine-independent constants (some used in following include files).
90  * Redefined constants are from POSIX 1003.1 limits file.
91  *
92  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
93  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
94  */
95 #include <sys/syslimits.h>
96 
97 #define MAXCOMLEN	16		/* max command name remembered */
98 #define MAXINTERP	32		/* max interpreter file name length */
99 #define MAXLOGNAME	17		/* max login name length (incl. NUL) */
100 #define MAXUPRC		CHILD_MAX	/* max simultaneous processes */
101 #define NCARGS		ARG_MAX		/* max bytes for an exec function */
102 #define NGROUPS		NGROUPS_MAX	/* max number groups */
103 #define NOFILE		OPEN_MAX	/* max open files per process */
104 #define NOGROUP		65535		/* marker for empty group set member */
105 #define MAXHOSTNAMELEN	256		/* max hostname size */
106 
107 /* More types and definitions used throughout the kernel. */
108 #ifdef _KERNEL
109 #include <sys/cdefs.h>
110 #include <sys/errno.h>
111 #include <sys/time.h>
112 
113 #define FALSE	0
114 #define TRUE	1
115 #endif
116 
117 #ifndef _KERNEL
118 /* Signals. */
119 #include <sys/select.h>
120 #include <sys/signal.h>
121 #endif
122 
123 /* Machine type dependent parameters. */
124 #include <machine/param.h>
125 #ifndef _KERNEL
126 #include <machine/limits.h>
127 #endif
128 
129 #define PCATCH		0x00000100	/* tsleep checks signals */
130 #define PUSRFLAG1	0x00000200	/* Subsystem specific flag */
131 #define PWAKEUP_CPUMASK	0x00003FFF	/* start cpu for chained wakeups */
132 #define PWAKEUP_MYCPU	0x00004000	/* wakeup on current cpu only */
133 #define PWAKEUP_ONE	0x00008000	/* argument to wakeup: only one */
134 #define PDOMAIN_MASK	0xFFFF0000	/* address domains for wakeup */
135 #define PDOMAIN_UMTX	0x00010000	/* independant domain for UMTX */
136 #define PWAKEUP_ENCODE(domain, cpu)	((domain) | (cpu))
137 #define PWAKEUP_DECODE(domain)		((domain) & PWAKEUP_CPUMASK)
138 
139 #define NZERO	0		/* default "nice" */
140 
141 #define NBPW	sizeof(int)	/* number of bytes per word (integer) */
142 
143 #define CMASK	022		/* default file mask: S_IWGRP|S_IWOTH */
144 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
145 #define NOUDEV	(udev_t)(-1)	/* non-existent device */
146 #define NOMAJ	256		/* non-existent device */
147 #endif
148 
149 #ifndef _KERNEL
150 #define NODEV	(dev_t)(-1)	/* non-existent device */
151 #endif
152 
153 /*
154  * File system parameters and macros.
155  *
156  * MAXBSIZE -	Filesystems are made out of blocks of at most MAXBSIZE bytes
157  *		per block.  MAXBSIZE may be made larger without effecting
158  *		any existing filesystems as long as it does not exceed MAXPHYS,
159  *		and may be made smaller at the risk of not being able to use
160  *		filesystems which require a block size exceeding MAXBSIZE.
161  *
162  * BKVASIZE -	Nominal buffer space per buffer, in bytes.  BKVASIZE is the
163  *		minimum KVM memory reservation the kernel is willing to make.
164  *		Filesystems can of course request smaller chunks.  Actual
165  *		backing memory uses a chunk size of a page (PAGE_SIZE).
166  *
167  *		If you make BKVASIZE too small you risk seriously fragmenting
168  *		the buffer KVM map which may slow things down a bit.  If you
169  *		make it too big the kernel will not be able to optimally use
170  *		the KVM memory reserved for the buffer cache and will wind
171  *		up with too-few buffers.
172  *
173  *		The default is 16384, roughly 2x the block size used by a
174  *		normal UFS filesystem.
175  */
176 #define MAXBSIZE	65536	/* must be power of 2 */
177 #define BKVASIZE	16384	/* must be power of 2 */
178 #define BKVAMASK	(BKVASIZE-1)
179 #define MAXFRAG 	8
180 
181 /*
182  * MAXPATHLEN defines the longest permissible path length after expanding
183  * symbolic links. It is used to allocate a temporary buffer from the buffer
184  * pool in which to do the name expansion, hence should be a power of two,
185  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
186  * maximum number of symbolic links that may be expanded in a path name.
187  * It should be set high enough to allow all legitimate uses, but halt
188  * infinite loops reasonably quickly.
189  */
190 #define MAXPATHLEN	PATH_MAX
191 #define MAXSYMLINKS	32
192 
193 /* Bit map related macros. */
194 #define setbit(a,i)	((a)[(i)/NBBY] |= 1<<((i)%NBBY))
195 #define clrbit(a,i)	((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
196 #define isset(a,i)	((a)[(i)/NBBY] & (1<<((i)%NBBY)))
197 #define isclr(a,i)	(((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
198 
199 /* Macros for counting and rounding. */
200 #ifndef howmany
201 #define howmany(x, y)	(((x)+((y)-1))/(y))
202 #endif
203 #define rounddown(x, y)	(((x)/(y))*(y))
204 #define roundup(x, y)	((((x)+((y)-1))/(y))*(y))  /* to any y */
205 #define roundup2(x, y)	(((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
206 #define powerof2(x)	((((x)-1)&(x))==0)
207 
208 /* Macros for min/max. */
209 #define MIN(a,b) (((a)<(b))?(a):(b))
210 #define MAX(a,b) (((a)>(b))?(a):(b))
211 
212 /*
213  * Constants for setting the parameters of the kernel memory allocator.
214  *
215  * 2 ** MINBUCKET is the smallest unit of memory that will be
216  * allocated. It must be at least large enough to hold a pointer.
217  *
218  * Units of memory less or equal to MAXALLOCSAVE will permanently
219  * allocate physical memory; requests for these size pieces of
220  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
221  * always allocate and free physical memory; requests for these
222  * size allocations should be done infrequently as they will be slow.
223  *
224  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
225  * MAXALLOCSIZE must be a power of two.
226  */
227 #define MINBUCKET	4		/* 4 => min allocation of 16 bytes */
228 #define MAXALLOCSAVE	(2 * PAGE_SIZE)
229 
230 /*
231  * Scale factor for scaled integers used to count %cpu time and load avgs.
232  *
233  * The number of CPU `tick's that map to a unique `%age' can be expressed
234  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
235  * can be calculated (assuming 32 bits) can be closely approximated using
236  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
237  *
238  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
239  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
240  */
241 #define FSHIFT	11		/* bits to right of fixed binary point */
242 #define FSCALE	(1<<FSHIFT)
243 
244 #define dbtoc(db)			/* calculates devblks to pages */ \
245 	((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
246 
247 #define ctodb(db)			/* calculates pages to devblks */ \
248 	((db) << (PAGE_SHIFT - DEV_BSHIFT))
249 
250 
251 /*
252  * Make this available for most of the kernel.  There were too many
253  * things that included sys/systm.h just for panic().
254  */
255 #ifdef _KERNEL
256 void	panic (const char *, ...) __dead2 __printflike(1, 2);
257 #endif
258 
259 #ifndef htonl
260 #define	htonl(x)	__htonl(x)
261 #endif
262 #ifndef htons
263 #define	htons(x)	__htons(x)
264 #endif
265 #ifndef ntohl
266 #define	ntohl(x)	__ntohl(x)
267 #endif
268 #ifndef ntohs
269 #define	ntohs(x)	__ntohs(x)
270 #endif
271 
272 #endif	/* _SYS_PARAM_H_ */
273