xref: /dragonfly/sys/sys/param.h (revision a68e0df0)
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 branch
73  * 200500 - 2.5 master
74  */
75 #undef __DragonFly_version
76 #define __DragonFly_version 200500	/* Master, propagated to newvers */
77 
78 #ifdef __FreeBSD__
79 /*
80  * __FreeBSD_version numbers for source compatibility.  This is temporary
81  * along with the __FreeBSD__ define in gcc2.  Note that gcc3 does not
82  * define __FreeBSD__ by default, only __DragonFly__.
83  */
84 #undef __FreeBSD_version
85 #define __FreeBSD_version 480101
86 #endif
87 
88 #include <sys/_null.h>
89 
90 #ifndef LOCORE
91 #include <sys/types.h>
92 #endif
93 
94 /*
95  * Machine-independent constants (some used in following include files).
96  * Redefined constants are from POSIX 1003.1 limits file.
97  *
98  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
99  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
100  */
101 #include <sys/syslimits.h>
102 
103 #define MAXCOMLEN	16		/* max command name remembered */
104 #define MAXINTERP	32		/* max interpreter file name length */
105 #define MAXLOGNAME	17		/* max login name length (incl. NUL) */
106 #define MAXUPRC		CHILD_MAX	/* max simultaneous processes */
107 #define NCARGS		ARG_MAX		/* max bytes for an exec function */
108 #define NGROUPS		NGROUPS_MAX	/* max number groups */
109 #define NOFILE		OPEN_MAX	/* max open files per process */
110 #define NOGROUP		65535		/* marker for empty group set member */
111 #define MAXHOSTNAMELEN	256		/* max hostname size */
112 
113 /* More types and definitions used throughout the kernel. */
114 #ifdef _KERNEL
115 #include <sys/cdefs.h>
116 #include <sys/errno.h>
117 #include <sys/time.h>
118 
119 #define FALSE	0
120 #define TRUE	1
121 #endif
122 
123 #ifndef _KERNEL
124 /* Signals. */
125 #include <sys/select.h>
126 #include <sys/signal.h>
127 #endif
128 
129 /* Machine type dependent parameters. */
130 #include <machine/param.h>
131 #ifndef _KERNEL
132 #include <machine/limits.h>
133 #endif
134 
135 #define PCATCH		0x00000100	/* tsleep checks signals */
136 #define PUSRFLAG1	0x00000200	/* Subsystem specific flag */
137 #define PINTERLOCKED	0x00000400	/* Interlocked tsleep */
138 #define PWAKEUP_CPUMASK	0x00003FFF	/* start cpu for chained wakeups */
139 #define PWAKEUP_MYCPU	0x00004000	/* wakeup on current cpu only */
140 #define PWAKEUP_ONE	0x00008000	/* argument to wakeup: only one */
141 #define PDOMAIN_MASK	0xFFFF0000	/* address domains for wakeup */
142 #define PDOMAIN_UMTX	0x00010000	/* independant domain for UMTX */
143 #define PWAKEUP_ENCODE(domain, cpu)	((domain) | (cpu))
144 #define PWAKEUP_DECODE(domain)		((domain) & PWAKEUP_CPUMASK)
145 
146 #define NZERO	0		/* default "nice" */
147 
148 #define NBPW	sizeof(int)	/* number of bytes per word (integer) */
149 
150 #define CMASK	022		/* default file mask: S_IWGRP|S_IWOTH */
151 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
152 #define NOUDEV	(udev_t)(-1)	/* non-existent device */
153 #define NOMAJ	256		/* non-existent device */
154 #endif
155 
156 #ifndef _KERNEL
157 #define NODEV	(dev_t)(-1)	/* non-existent device */
158 #endif
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 roundup(x, y)	((((x)+((y)-1))/(y))*(y))  /* to any y */
212 #define roundup2(x, y)	(((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
213 #define powerof2(x)	((((x)-1)&(x))==0)
214 
215 /*
216  * VM objects can be larger than the virtual address space, make sure
217  * we don't cut-off the mask.
218  */
219 #define trunc_page64(x)           ((x) & ~(int64_t)PAGE_MASK)
220 #define round_page64(x)           (((x) + PAGE_MASK) & ~(int64_t)PAGE_MASK)
221 
222 /* Macros for min/max. */
223 #define MIN(a,b) (((a)<(b))?(a):(b))
224 #define MAX(a,b) (((a)>(b))?(a):(b))
225 
226 /*
227  * Constants for setting the parameters of the kernel memory allocator.
228  *
229  * 2 ** MINBUCKET is the smallest unit of memory that will be
230  * allocated. It must be at least large enough to hold a pointer.
231  *
232  * Units of memory less or equal to MAXALLOCSAVE will permanently
233  * allocate physical memory; requests for these size pieces of
234  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
235  * always allocate and free physical memory; requests for these
236  * size allocations should be done infrequently as they will be slow.
237  *
238  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
239  * MAXALLOCSIZE must be a power of two.
240  */
241 #define MINBUCKET	4		/* 4 => min allocation of 16 bytes */
242 #define MAXALLOCSAVE	(2 * PAGE_SIZE)
243 
244 /*
245  * Scale factor for scaled integers used to count %cpu time and load avgs.
246  *
247  * The number of CPU `tick's that map to a unique `%age' can be expressed
248  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
249  * can be calculated (assuming 32 bits) can be closely approximated using
250  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
251  *
252  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
253  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
254  */
255 #define FSHIFT	11		/* bits to right of fixed binary point */
256 #define FSCALE	(1<<FSHIFT)
257 
258 #define dbtoc(db)			/* calculates devblks to pages */ \
259 	((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
260 
261 #define ctodb(db)			/* calculates pages to devblks */ \
262 	((db) << (PAGE_SHIFT - DEV_BSHIFT))
263 
264 #define MJUMPAGESIZE	PAGE_SIZE	/* jumbo cluster 4k */
265 #define MJUM9BYTES	(9 * 1024)	/* jumbo cluster 9k */
266 #define MJUM16BYTES	(16 * 1024)	/* jumbo cluster 16k */
267 /*
268  * Make this available for most of the kernel.  There were too many
269  * things that included sys/systm.h just for panic().
270  */
271 #ifdef _KERNEL
272 void	panic (const char *, ...) __dead2 __printflike(1, 2);
273 #endif
274 
275 #ifndef htonl
276 #define	htonl(x)	__htonl(x)
277 #endif
278 #ifndef htons
279 #define	htons(x)	__htons(x)
280 #endif
281 #ifndef ntohl
282 #define	ntohl(x)	__ntohl(x)
283 #endif
284 #ifndef ntohs
285 #define	ntohs(x)	__ntohs(x)
286 #endif
287 
288 #endif	/* _SYS_PARAM_H_ */
289