release engineering - Bump master to 2.9
[dragonfly.git] / sys / sys / param.h
CommitLineData
984263bc
MD
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 $
91fdc001 40 * $DragonFly: src/sys/sys/param.h,v 1.53 2008/11/11 00:55:49 pavalos Exp $
984263bc
MD
41 */
42
43#ifndef _SYS_PARAM_H_
44#define _SYS_PARAM_H_
45
f0ae1834 46#define BSD 200708 /* XXX kern.osrevision */
d77e8324
MD
47#define BSD4_3 1 /* XXX obsolete */
48#define BSD4_4 1 /* XXX obsolete */
984263bc 49
d77e8324 50/*
eab38af1
MD
51 * __DragonFly_version number. The number doesn't really meaningfully
52 * translate to a version number.
9ba76b73 53 *
02d4667d 54 * 170000 - base development version after 1.6 branch
aefcf6d5 55 * 170001 - base development version before 1.8 branch
677f984f 56 * 190000 - base development version after 1.8 branch
3ae3ada0 57 * 195000 - base development version after 1.10 branch
eab38af1 58 * 197500 - base development version before 1.12 branch
0cf13ba1
MD
59 * 197600 - 1.12 branch
60 * 197700 - base development version after 1.12 branch
ce9d787d
MD
61 * 199900 - base development version before 2.0 branch
62 * 200000 - 2.0 branch
3b7b6af7 63 * 200100 - base development version after 2.0 branch
91fdc001 64 * 200101 - lchflags syscall
d8e83bc2
MD
65 * 200200 - 2.2 branch
66 * 200201 - base development version after 2.2 branch
64cc0b46 67 * 200202 - major changes to libc
b8f055be 68 * 200203 - introduce PCI domain
809dc6e6 69 * 200204 - suser() & suser_cred() removal
e12edcbc 70 * 200205 - devfs import
f464e11c 71 * 200206 - *sleep() renames
68dc98df 72 * 200400 - 2.4 release
7317bb64 73 * 200500 - 2.5 master
68dc98df 74 * 200600 - 2.6 release
40eb8ea1 75 * 200700 - 2.7 master
68dc98df
MD
76 * 200800 - 2.8 release October 2010
77 * 200900 - 2.9 master
984263bc 78 */
e9ddd87b 79#undef __DragonFly_version
68dc98df 80#define __DragonFly_version 200900 /* propagated to newvers */
d77e8324 81
e4dcda4d 82#include <sys/_null.h>
984263bc
MD
83
84#ifndef LOCORE
85#include <sys/types.h>
86#endif
87
88/*
89 * Machine-independent constants (some used in following include files).
90 * Redefined constants are from POSIX 1003.1 limits file.
91 *
92 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
93 * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
94 */
95#include <sys/syslimits.h>
96
6bb39c45
DR
97#define MAXCOMLEN 16 /* max command name remembered */
98#define MAXINTERP 32 /* max interpreter file name length */
99#define MAXLOGNAME 17 /* max login name length (incl. NUL) */
100#define MAXUPRC CHILD_MAX /* max simultaneous processes */
101#define NCARGS ARG_MAX /* max bytes for an exec function */
102#define NGROUPS NGROUPS_MAX /* max number groups */
103#define NOFILE OPEN_MAX /* max open files per process */
104#define NOGROUP 65535 /* marker for empty group set member */
984263bc
MD
105#define MAXHOSTNAMELEN 256 /* max hostname size */
106
107/* More types and definitions used throughout the kernel. */
108#ifdef _KERNEL
109#include <sys/cdefs.h>
110#include <sys/errno.h>
111#include <sys/time.h>
112
6bb39c45
DR
113#define FALSE 0
114#define TRUE 1
984263bc
MD
115#endif
116
117#ifndef _KERNEL
118/* Signals. */
805f91d4 119#include <sys/select.h>
984263bc
MD
120#include <sys/signal.h>
121#endif
122
123/* Machine type dependent parameters. */
124#include <machine/param.h>
125#ifndef _KERNEL
126#include <machine/limits.h>
127#endif
128
da5fb9ef
MD
129#define PCATCH 0x00000100 /* tsleep checks signals */
130#define PUSRFLAG1 0x00000200 /* Subsystem specific flag */
d9345d3a 131#define PINTERLOCKED 0x00000400 /* Interlocked tsleep */
b336a9b1
MD
132#define PWAKEUP_CPUMASK 0x00003FFF /* start cpu for chained wakeups */
133#define PWAKEUP_MYCPU 0x00004000 /* wakeup on current cpu only */
fc17ad60 134#define PWAKEUP_ONE 0x00008000 /* argument to wakeup: only one */
da5fb9ef
MD
135#define PDOMAIN_MASK 0xFFFF0000 /* address domains for wakeup */
136#define PDOMAIN_UMTX 0x00010000 /* independant domain for UMTX */
fc17ad60
MD
137#define PWAKEUP_ENCODE(domain, cpu) ((domain) | (cpu))
138#define PWAKEUP_DECODE(domain) ((domain) & PWAKEUP_CPUMASK)
984263bc 139
6bb39c45 140#define NZERO 0 /* default "nice" */
984263bc 141
6bb39c45 142#define NBPW sizeof(int) /* number of bytes per word (integer) */
984263bc 143
6bb39c45 144#define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */
b13267a5 145#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
6bb39c45
DR
146#define NOUDEV (udev_t)(-1) /* non-existent device */
147#define NOMAJ 256 /* non-existent device */
b13267a5
MD
148#endif
149
150#ifndef _KERNEL
6bb39c45 151#define NODEV (dev_t)(-1) /* non-existent device */
984263bc
MD
152#endif
153
154/*
984263bc
MD
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 */
6bb39c45 191#define MAXPATHLEN PATH_MAX
984263bc
MD
192#define MAXSYMLINKS 32
193
194/* Bit map related macros. */
6bb39c45
DR
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)
984263bc
MD
199
200/* Macros for counting and rounding. */
201#ifndef howmany
6bb39c45 202#define howmany(x, y) (((x)+((y)-1))/(y))
984263bc 203#endif
6bb39c45 204#define rounddown(x, y) (((x)/(y))*(y))
a8cf2878 205#define rounddown2(x, y) ((x) & ~((y) - 1)) /* y power of two */
6bb39c45
DR
206#define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */
207#define roundup2(x, y) (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
984263bc
MD
208#define powerof2(x) ((((x)-1)&(x))==0)
209
aecf2182
MD
210/*
211 * VM objects can be larger than the virtual address space, make sure
212 * we don't cut-off the mask.
213 */
214#define trunc_page64(x) ((x) & ~(int64_t)PAGE_MASK)
215#define round_page64(x) (((x) + PAGE_MASK) & ~(int64_t)PAGE_MASK)
216
984263bc 217/* Macros for min/max. */
6bb39c45
DR
218#define MIN(a,b) (((a)<(b))?(a):(b))
219#define MAX(a,b) (((a)>(b))?(a):(b))
984263bc
MD
220
221/*
222 * Constants for setting the parameters of the kernel memory allocator.
223 *
224 * 2 ** MINBUCKET is the smallest unit of memory that will be
225 * allocated. It must be at least large enough to hold a pointer.
226 *
227 * Units of memory less or equal to MAXALLOCSAVE will permanently
228 * allocate physical memory; requests for these size pieces of
229 * memory are quite fast. Allocations greater than MAXALLOCSAVE must
230 * always allocate and free physical memory; requests for these
231 * size allocations should be done infrequently as they will be slow.
232 *
233 * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
234 * MAXALLOCSIZE must be a power of two.
235 */
984263bc 236#define MINBUCKET 4 /* 4 => min allocation of 16 bytes */
984263bc
MD
237#define MAXALLOCSAVE (2 * PAGE_SIZE)
238
239/*
240 * Scale factor for scaled integers used to count %cpu time and load avgs.
241 *
242 * The number of CPU `tick's that map to a unique `%age' can be expressed
243 * by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that
244 * can be calculated (assuming 32 bits) can be closely approximated using
245 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
246 *
247 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
248 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
249 */
6bb39c45 250#define FSHIFT 11 /* bits to right of fixed binary point */
984263bc
MD
251#define FSCALE (1<<FSHIFT)
252
253#define dbtoc(db) /* calculates devblks to pages */ \
254 ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
255
256#define ctodb(db) /* calculates pages to devblks */ \
257 ((db) << (PAGE_SHIFT - DEV_BSHIFT))
258
26a135b9
AE
259#define MJUMPAGESIZE PAGE_SIZE /* jumbo cluster 4k */
260#define MJUM9BYTES (9 * 1024) /* jumbo cluster 9k */
261#define MJUM16BYTES (16 * 1024) /* jumbo cluster 16k */
ff9e829d
MD
262
263/*
264 * MBUF Management.
265 *
ee9d7228
MD
266 * Because many drivers can't deal with multiple DMA segments all mbufs
267 * must avoid crossing a page boundary. While we can accomodate mbufs
268 * which are not a power-of-2 sized kmalloc() will only guarantee
269 * non-crossing alignment if we use a power-of-2. 256 is no longer large
270 * enough due to m_hdr and m_pkthdr bloat.
ff9e829d
MD
271 *
272 * MCLBYTES must be a power of 2 and is typically significantly larger
273 * than MSIZE, sufficient to hold a standard-mtu packet. 2K is considered
274 * reasonable.
275 */
276#ifndef MSIZE
ee9d7228 277#define MSIZE 512 /* size of an mbuf */
ff9e829d
MD
278#endif
279
280#ifndef MCLSHIFT
281#define MCLSHIFT 11 /* convert bytes to m_buf clusters */
282#endif
283#define MCLBYTES (1 << MCLSHIFT) /* size of an m_buf cluster */
284#define MCLOFSET (MCLBYTES - 1) /* offset within an m_buf cluster */
285
984263bc
MD
286/*
287 * Make this available for most of the kernel. There were too many
288 * things that included sys/systm.h just for panic().
289 */
290#ifdef _KERNEL
b153f746 291void panic (const char *, ...) __dead2 __printflike(1, 2);
984263bc
MD
292#endif
293
465a99ae
JS
294#ifndef htonl
295#define htonl(x) __htonl(x)
296#endif
297#ifndef htons
298#define htons(x) __htons(x)
299#endif
300#ifndef ntohl
301#define ntohl(x) __ntohl(x)
302#endif
303#ifndef ntohs
304#define ntohs(x) __ntohs(x)
305#endif
306
984263bc 307#endif /* _SYS_PARAM_H_ */