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