Tag for 3.0.3.
[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 $
40 */
41
42#ifndef _SYS_PARAM_H_
43#define _SYS_PARAM_H_
44
f0ae1834 45#define BSD 200708 /* XXX kern.osrevision */
d77e8324
MD
46#define BSD4_3 1 /* XXX obsolete */
47#define BSD4_4 1 /* XXX obsolete */
984263bc 48
d77e8324 49/*
eab38af1
MD
50 * __DragonFly_version number. The number doesn't really meaningfully
51 * translate to a version number.
9ba76b73 52 *
02d4667d 53 * 170000 - base development version after 1.6 branch
aefcf6d5 54 * 170001 - base development version before 1.8 branch
677f984f 55 * 190000 - base development version after 1.8 branch
3ae3ada0 56 * 195000 - base development version after 1.10 branch
eab38af1 57 * 197500 - base development version before 1.12 branch
0cf13ba1
MD
58 * 197600 - 1.12 branch
59 * 197700 - base development version after 1.12 branch
ce9d787d
MD
60 * 199900 - base development version before 2.0 branch
61 * 200000 - 2.0 branch
3b7b6af7 62 * 200100 - base development version after 2.0 branch
91fdc001 63 * 200101 - lchflags syscall
d8e83bc2
MD
64 * 200200 - 2.2 branch
65 * 200201 - base development version after 2.2 branch
64cc0b46 66 * 200202 - major changes to libc
b8f055be 67 * 200203 - introduce PCI domain
809dc6e6 68 * 200204 - suser() & suser_cred() removal
e12edcbc 69 * 200205 - devfs import
f464e11c 70 * 200206 - *sleep() renames
68dc98df 71 * 200400 - 2.4 release
7317bb64 72 * 200500 - 2.5 master
68dc98df 73 * 200600 - 2.6 release
40eb8ea1 74 * 200700 - 2.7 master
68dc98df
MD
75 * 200800 - 2.8 release October 2010
76 * 200900 - 2.9 master
55cc754d 77 * 200901 - prototype changes for alphasort(3) and scandir(3)
62b5ec1d 78 * 200902 - Xerox NS protocol removal
8b70659c
MD
79 * 201000 - 2.10 release
80 * 201100 - 2.11 master
693b2d64
JS
81 * 201200 - 2.12 release
82 * 201300 - 2.13 master
b993bb87 83 * 201301 - header rename: <vfs/gnu/ext2fs/...> -> <gnu/vfs/ext2fs/...>
e96bff60 84 * 201302 - header <crypt.h> is gone
d22a69a4 85 * 201303 - <netatalk/...> and <netproto/atalk/...> are gone
7c426b5f 86 * 201304 - Added wcscasecmp, wcsncasecmp to libc
373b1e4d 87 * 201305 - Sync libm with NetBSD-current libm (new functions added)
ae23f131 88 * 201306 - Sync libm with FreeBSD-current libm (~50 new functions)
e6e83d07
JS
89 * 300000 - 3.0 release
90 * 300100 - 3.1 master
b8aacf5e
MR
91 * 300101 - i4b (ISDN) removal
92 * 300102 - <sys/ata.h> is now just a link of <sys/nata.h>
93 * 300103 - if SIG_IGN is set on SIGCHLD, do not keep zombie children
2c987160 94 * 300003 - bugfix release
984263bc 95 */
e9ddd87b 96#undef __DragonFly_version
2c987160 97#define __DragonFly_version 300003 /* propagated to newvers */
d77e8324 98
e4dcda4d 99#include <sys/_null.h>
984263bc
MD
100
101#ifndef LOCORE
102#include <sys/types.h>
103#endif
104
105/*
106 * Machine-independent constants (some used in following include files).
107 * Redefined constants are from POSIX 1003.1 limits file.
108 *
109 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
110 * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
111 */
112#include <sys/syslimits.h>
113
6bb39c45
DR
114#define MAXCOMLEN 16 /* max command name remembered */
115#define MAXINTERP 32 /* max interpreter file name length */
116#define MAXLOGNAME 17 /* max login name length (incl. NUL) */
117#define MAXUPRC CHILD_MAX /* max simultaneous processes */
118#define NCARGS ARG_MAX /* max bytes for an exec function */
119#define NGROUPS NGROUPS_MAX /* max number groups */
120#define NOFILE OPEN_MAX /* max open files per process */
121#define NOGROUP 65535 /* marker for empty group set member */
984263bc
MD
122#define MAXHOSTNAMELEN 256 /* max hostname size */
123
124/* More types and definitions used throughout the kernel. */
125#ifdef _KERNEL
126#include <sys/cdefs.h>
127#include <sys/errno.h>
128#include <sys/time.h>
129
6bb39c45
DR
130#define FALSE 0
131#define TRUE 1
984263bc
MD
132#endif
133
134#ifndef _KERNEL
135/* Signals. */
805f91d4 136#include <sys/select.h>
984263bc
MD
137#include <sys/signal.h>
138#endif
139
140/* Machine type dependent parameters. */
141#include <machine/param.h>
142#ifndef _KERNEL
143#include <machine/limits.h>
144#endif
145
da5fb9ef
MD
146#define PCATCH 0x00000100 /* tsleep checks signals */
147#define PUSRFLAG1 0x00000200 /* Subsystem specific flag */
d9345d3a 148#define PINTERLOCKED 0x00000400 /* Interlocked tsleep */
b336a9b1
MD
149#define PWAKEUP_CPUMASK 0x00003FFF /* start cpu for chained wakeups */
150#define PWAKEUP_MYCPU 0x00004000 /* wakeup on current cpu only */
fc17ad60 151#define PWAKEUP_ONE 0x00008000 /* argument to wakeup: only one */
da5fb9ef
MD
152#define PDOMAIN_MASK 0xFFFF0000 /* address domains for wakeup */
153#define PDOMAIN_UMTX 0x00010000 /* independant domain for UMTX */
b12defdc 154#define PDOMAIN_XLOCK 0x00020000 /* independant domain for fifo_lock */
fc17ad60
MD
155#define PWAKEUP_ENCODE(domain, cpu) ((domain) | (cpu))
156#define PWAKEUP_DECODE(domain) ((domain) & PWAKEUP_CPUMASK)
984263bc 157
6bb39c45 158#define NZERO 0 /* default "nice" */
984263bc 159
6bb39c45 160#define NBPW sizeof(int) /* number of bytes per word (integer) */
984263bc 161
6bb39c45 162#define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */
b13267a5 163#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
6bb39c45
DR
164#define NOUDEV (udev_t)(-1) /* non-existent device */
165#define NOMAJ 256 /* non-existent device */
b13267a5
MD
166#endif
167
168#ifndef _KERNEL
6bb39c45 169#define NODEV (dev_t)(-1) /* non-existent device */
984263bc
MD
170#endif
171
172/*
d87e79b9
MD
173 * cpu_mi_feature bits
174 */
175#define CPU_MI_BZERONT 0x00000001
2a06bc07 176#define CPU_MI_MONITOR 0x00000010
d87e79b9
MD
177
178/*
984263bc
MD
179 * File system parameters and macros.
180 *
181 * MAXBSIZE - Filesystems are made out of blocks of at most MAXBSIZE bytes
182 * per block. MAXBSIZE may be made larger without effecting
183 * any existing filesystems as long as it does not exceed MAXPHYS,
184 * and may be made smaller at the risk of not being able to use
185 * filesystems which require a block size exceeding MAXBSIZE.
186 *
187 * BKVASIZE - Nominal buffer space per buffer, in bytes. BKVASIZE is the
188 * minimum KVM memory reservation the kernel is willing to make.
189 * Filesystems can of course request smaller chunks. Actual
190 * backing memory uses a chunk size of a page (PAGE_SIZE).
191 *
192 * If you make BKVASIZE too small you risk seriously fragmenting
193 * the buffer KVM map which may slow things down a bit. If you
194 * make it too big the kernel will not be able to optimally use
195 * the KVM memory reserved for the buffer cache and will wind
196 * up with too-few buffers.
197 *
198 * The default is 16384, roughly 2x the block size used by a
199 * normal UFS filesystem.
200 */
201#define MAXBSIZE 65536 /* must be power of 2 */
202#define BKVASIZE 16384 /* must be power of 2 */
203#define BKVAMASK (BKVASIZE-1)
204#define MAXFRAG 8
205
206/*
207 * MAXPATHLEN defines the longest permissible path length after expanding
208 * symbolic links. It is used to allocate a temporary buffer from the buffer
209 * pool in which to do the name expansion, hence should be a power of two,
210 * and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the
211 * maximum number of symbolic links that may be expanded in a path name.
212 * It should be set high enough to allow all legitimate uses, but halt
213 * infinite loops reasonably quickly.
214 */
6bb39c45 215#define MAXPATHLEN PATH_MAX
984263bc
MD
216#define MAXSYMLINKS 32
217
218/* Bit map related macros. */
6bb39c45
DR
219#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
220#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
221#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
222#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
984263bc
MD
223
224/* Macros for counting and rounding. */
225#ifndef howmany
6bb39c45 226#define howmany(x, y) (((x)+((y)-1))/(y))
984263bc 227#endif
6bb39c45 228#define rounddown(x, y) (((x)/(y))*(y))
a8cf2878 229#define rounddown2(x, y) ((x) & ~((y) - 1)) /* y power of two */
6bb39c45
DR
230#define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */
231#define roundup2(x, y) (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
984263bc
MD
232#define powerof2(x) ((((x)-1)&(x))==0)
233
aecf2182
MD
234/*
235 * VM objects can be larger than the virtual address space, make sure
236 * we don't cut-off the mask.
237 */
238#define trunc_page64(x) ((x) & ~(int64_t)PAGE_MASK)
239#define round_page64(x) (((x) + PAGE_MASK) & ~(int64_t)PAGE_MASK)
240
984263bc 241/* Macros for min/max. */
6bb39c45
DR
242#define MIN(a,b) (((a)<(b))?(a):(b))
243#define MAX(a,b) (((a)>(b))?(a):(b))
984263bc 244
a3034532 245/* Macro for array size */
fa8f7852 246#define NELEM(ary) (sizeof(ary) / sizeof((ary)[0]))
a3034532 247
984263bc
MD
248/*
249 * Constants for setting the parameters of the kernel memory allocator.
250 *
251 * 2 ** MINBUCKET is the smallest unit of memory that will be
252 * allocated. It must be at least large enough to hold a pointer.
253 *
254 * Units of memory less or equal to MAXALLOCSAVE will permanently
255 * allocate physical memory; requests for these size pieces of
256 * memory are quite fast. Allocations greater than MAXALLOCSAVE must
257 * always allocate and free physical memory; requests for these
258 * size allocations should be done infrequently as they will be slow.
259 *
260 * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
261 * MAXALLOCSIZE must be a power of two.
262 */
984263bc 263#define MINBUCKET 4 /* 4 => min allocation of 16 bytes */
984263bc
MD
264#define MAXALLOCSAVE (2 * PAGE_SIZE)
265
266/*
267 * Scale factor for scaled integers used to count %cpu time and load avgs.
268 *
269 * The number of CPU `tick's that map to a unique `%age' can be expressed
270 * by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that
271 * can be calculated (assuming 32 bits) can be closely approximated using
272 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
273 *
274 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
275 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
276 */
6bb39c45 277#define FSHIFT 11 /* bits to right of fixed binary point */
984263bc
MD
278#define FSCALE (1<<FSHIFT)
279
280#define dbtoc(db) /* calculates devblks to pages */ \
281 ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
282
283#define ctodb(db) /* calculates pages to devblks */ \
284 ((db) << (PAGE_SHIFT - DEV_BSHIFT))
285
26a135b9
AE
286#define MJUMPAGESIZE PAGE_SIZE /* jumbo cluster 4k */
287#define MJUM9BYTES (9 * 1024) /* jumbo cluster 9k */
288#define MJUM16BYTES (16 * 1024) /* jumbo cluster 16k */
ff9e829d
MD
289
290/*
291 * MBUF Management.
292 *
ee9d7228
MD
293 * Because many drivers can't deal with multiple DMA segments all mbufs
294 * must avoid crossing a page boundary. While we can accomodate mbufs
295 * which are not a power-of-2 sized kmalloc() will only guarantee
296 * non-crossing alignment if we use a power-of-2. 256 is no longer large
297 * enough due to m_hdr and m_pkthdr bloat.
ff9e829d
MD
298 *
299 * MCLBYTES must be a power of 2 and is typically significantly larger
300 * than MSIZE, sufficient to hold a standard-mtu packet. 2K is considered
301 * reasonable.
302 */
303#ifndef MSIZE
ee9d7228 304#define MSIZE 512 /* size of an mbuf */
ff9e829d
MD
305#endif
306
307#ifndef MCLSHIFT
94eaee9a 308#define MCLSHIFT 11 /* convert bytes to m_buf clusters */
ff9e829d
MD
309#endif
310#define MCLBYTES (1 << MCLSHIFT) /* size of an m_buf cluster */
311#define MCLOFSET (MCLBYTES - 1) /* offset within an m_buf cluster */
312
984263bc
MD
313/*
314 * Make this available for most of the kernel. There were too many
315 * things that included sys/systm.h just for panic().
316 */
317#ifdef _KERNEL
b153f746 318void panic (const char *, ...) __dead2 __printflike(1, 2);
984263bc
MD
319#endif
320
465a99ae
JS
321#ifndef htonl
322#define htonl(x) __htonl(x)
323#endif
324#ifndef htons
325#define htons(x) __htons(x)
326#endif
327#ifndef ntohl
328#define ntohl(x) __ntohl(x)
329#endif
330#ifndef ntohs
331#define ntohs(x) __ntohs(x)
332#endif
333
984263bc 334#endif /* _SYS_PARAM_H_ */