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