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