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