VFS messaging/interfacing work stage 7e/99: More firming up of stage 7.
[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.18 2004/10/06 23:03:50 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 110000      /* 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 /*
119  * Priorities.  Note that with 32 run queues, differences less than 4 are
120  * insignificant.
121  */
122 #define MAXPRI  127             /* Priorities range from 0 through MAXPRI. */
123 #define PPAUSE                  40
124 #define PRIMASK 127
125 #define PRIBASE_REALTIME        0
126 #define PRIBASE_NORMAL          128
127 #define PRIBASE_IDLE            256
128 #define PRIBASE_THREAD          384     /* huh? */
129 #define PRIBASE_NULL            512
130
131 #define PCATCH          0x0100  /* OR'd with pri for tsleep to check signals */
132 #define PUSRFLAG1       0x0200  /* Subsystem specific flag */
133 #define PNORESCHED      0x0400  /* Do not force a reschedule on wakeup */
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 #ifdef _KERNEL
141 #define NODEV   (dev_t)(-1)     /* non-existent device */
142 #define NOUDEV  (udev_t)(-1)    /* non-existent device */
143 #define NOMAJ   256             /* non-existent device */
144 #else
145 #define NODEV   (dev_t)(-1)     /* non-existent device */
146 #endif
147
148 /*
149  * File system parameters and macros.
150  *
151  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
152  *              per block.  MAXBSIZE may be made larger without effecting
153  *              any existing filesystems as long as it does not exceed MAXPHYS,
154  *              and may be made smaller at the risk of not being able to use
155  *              filesystems which require a block size exceeding MAXBSIZE.
156  *
157  * BKVASIZE -   Nominal buffer space per buffer, in bytes.  BKVASIZE is the
158  *              minimum KVM memory reservation the kernel is willing to make.
159  *              Filesystems can of course request smaller chunks.  Actual 
160  *              backing memory uses a chunk size of a page (PAGE_SIZE).
161  *
162  *              If you make BKVASIZE too small you risk seriously fragmenting
163  *              the buffer KVM map which may slow things down a bit.  If you
164  *              make it too big the kernel will not be able to optimally use 
165  *              the KVM memory reserved for the buffer cache and will wind 
166  *              up with too-few buffers.
167  *
168  *              The default is 16384, roughly 2x the block size used by a
169  *              normal UFS filesystem.
170  */
171 #define MAXBSIZE        65536   /* must be power of 2 */
172 #define BKVASIZE        16384   /* must be power of 2 */
173 #define BKVAMASK        (BKVASIZE-1)
174 #define MAXFRAG         8
175
176 /*
177  * MAXPATHLEN defines the longest permissible path length after expanding
178  * symbolic links. It is used to allocate a temporary buffer from the buffer
179  * pool in which to do the name expansion, hence should be a power of two,
180  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
181  * maximum number of symbolic links that may be expanded in a path name.
182  * It should be set high enough to allow all legitimate uses, but halt
183  * infinite loops reasonably quickly.
184  */
185 #define MAXPATHLEN      PATH_MAX
186 #define MAXSYMLINKS     32
187
188 /* Bit map related macros. */
189 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
190 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
191 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
192 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
193
194 /* Macros for counting and rounding. */
195 #ifndef howmany
196 #define howmany(x, y)   (((x)+((y)-1))/(y))
197 #endif
198 #define rounddown(x, y) (((x)/(y))*(y))
199 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
200 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
201 #define powerof2(x)     ((((x)-1)&(x))==0)
202
203 /* Macros for min/max. */
204 #define MIN(a,b) (((a)<(b))?(a):(b))
205 #define MAX(a,b) (((a)>(b))?(a):(b))
206
207 /*
208  * Constants for setting the parameters of the kernel memory allocator.
209  *
210  * 2 ** MINBUCKET is the smallest unit of memory that will be
211  * allocated. It must be at least large enough to hold a pointer.
212  *
213  * Units of memory less or equal to MAXALLOCSAVE will permanently
214  * allocate physical memory; requests for these size pieces of
215  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
216  * always allocate and free physical memory; requests for these
217  * size allocations should be done infrequently as they will be slow.
218  *
219  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
220  * MAXALLOCSIZE must be a power of two.
221  */
222 #if defined(__alpha__)
223 #define MINBUCKET       5               /* 5 => min allocation of 32 bytes */
224 #else
225 #define MINBUCKET       4               /* 4 => min allocation of 16 bytes */
226 #endif
227 #define MAXALLOCSAVE    (2 * PAGE_SIZE)
228
229 /*
230  * Scale factor for scaled integers used to count %cpu time and load avgs.
231  *
232  * The number of CPU `tick's that map to a unique `%age' can be expressed
233  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
234  * can be calculated (assuming 32 bits) can be closely approximated using
235  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
236  *
237  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
238  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
239  */
240 #define FSHIFT  11              /* bits to right of fixed binary point */
241 #define FSCALE  (1<<FSHIFT)
242
243 #define dbtoc(db)                       /* calculates devblks to pages */ \
244         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
245  
246 #define ctodb(db)                       /* calculates pages to devblks */ \
247         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
248
249
250 /*
251  * Make this available for most of the kernel.  There were too many
252  * things that included sys/systm.h just for panic().
253  */
254 #ifdef _KERNEL
255 void    panic (const char *, ...) __dead2 __printflike(1, 2);
256 #endif
257
258 #ifndef htonl
259 #define htonl(x)        __htonl(x)
260 #endif
261 #ifndef htons
262 #define htons(x)        __htons(x)
263 #endif
264 #ifndef ntohl
265 #define ntohl(x)        __ntohl(x)
266 #endif
267 #ifndef ntohs
268 #define ntohs(x)        __ntohs(x)
269 #endif
270
271 #endif  /* _SYS_PARAM_H_ */