<sys/param.h>: Fix wrongly merged comments on the release branch.
[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 89 * 300000 - 3.0 release
2c987160 90 * 300003 - bugfix release
984263bc 91 */
e9ddd87b 92#undef __DragonFly_version
2c987160 93#define __DragonFly_version 300003 /* propagated to newvers */
d77e8324 94
e4dcda4d 95#include <sys/_null.h>
984263bc
MD
96
97#ifndef LOCORE
98#include <sys/types.h>
99#endif
100
101/*
102 * Machine-independent constants (some used in following include files).
103 * Redefined constants are from POSIX 1003.1 limits file.
104 *
105 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
106 * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
107 */
108#include <sys/syslimits.h>
109
6bb39c45
DR
110#define MAXCOMLEN 16 /* max command name remembered */
111#define MAXINTERP 32 /* max interpreter file name length */
112#define MAXLOGNAME 17 /* max login name length (incl. NUL) */
113#define MAXUPRC CHILD_MAX /* max simultaneous processes */
114#define NCARGS ARG_MAX /* max bytes for an exec function */
115#define NGROUPS NGROUPS_MAX /* max number groups */
116#define NOFILE OPEN_MAX /* max open files per process */
117#define NOGROUP 65535 /* marker for empty group set member */
984263bc
MD
118#define MAXHOSTNAMELEN 256 /* max hostname size */
119
120/* More types and definitions used throughout the kernel. */
121#ifdef _KERNEL
122#include <sys/cdefs.h>
123#include <sys/errno.h>
124#include <sys/time.h>
125
6bb39c45
DR
126#define FALSE 0
127#define TRUE 1
984263bc
MD
128#endif
129
130#ifndef _KERNEL
131/* Signals. */
805f91d4 132#include <sys/select.h>
984263bc
MD
133#include <sys/signal.h>
134#endif
135
136/* Machine type dependent parameters. */
137#include <machine/param.h>
138#ifndef _KERNEL
139#include <machine/limits.h>
140#endif
141
da5fb9ef
MD
142#define PCATCH 0x00000100 /* tsleep checks signals */
143#define PUSRFLAG1 0x00000200 /* Subsystem specific flag */
d9345d3a 144#define PINTERLOCKED 0x00000400 /* Interlocked tsleep */
b336a9b1
MD
145#define PWAKEUP_CPUMASK 0x00003FFF /* start cpu for chained wakeups */
146#define PWAKEUP_MYCPU 0x00004000 /* wakeup on current cpu only */
fc17ad60 147#define PWAKEUP_ONE 0x00008000 /* argument to wakeup: only one */
da5fb9ef
MD
148#define PDOMAIN_MASK 0xFFFF0000 /* address domains for wakeup */
149#define PDOMAIN_UMTX 0x00010000 /* independant domain for UMTX */
b12defdc 150#define PDOMAIN_XLOCK 0x00020000 /* independant domain for fifo_lock */
fc17ad60
MD
151#define PWAKEUP_ENCODE(domain, cpu) ((domain) | (cpu))
152#define PWAKEUP_DECODE(domain) ((domain) & PWAKEUP_CPUMASK)
984263bc 153
6bb39c45 154#define NZERO 0 /* default "nice" */
984263bc 155
6bb39c45 156#define NBPW sizeof(int) /* number of bytes per word (integer) */
984263bc 157
6bb39c45 158#define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */
b13267a5 159#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
6bb39c45
DR
160#define NOUDEV (udev_t)(-1) /* non-existent device */
161#define NOMAJ 256 /* non-existent device */
b13267a5
MD
162#endif
163
164#ifndef _KERNEL
6bb39c45 165#define NODEV (dev_t)(-1) /* non-existent device */
984263bc
MD
166#endif
167
168/*
d87e79b9
MD
169 * cpu_mi_feature bits
170 */
171#define CPU_MI_BZERONT 0x00000001
2a06bc07 172#define CPU_MI_MONITOR 0x00000010
d87e79b9
MD
173
174/*
984263bc
MD
175 * File system parameters and macros.
176 *
177 * MAXBSIZE - Filesystems are made out of blocks of at most MAXBSIZE bytes
178 * per block. MAXBSIZE may be made larger without effecting
179 * any existing filesystems as long as it does not exceed MAXPHYS,
180 * and may be made smaller at the risk of not being able to use
181 * filesystems which require a block size exceeding MAXBSIZE.
182 *
183 * BKVASIZE - Nominal buffer space per buffer, in bytes. BKVASIZE is the
184 * minimum KVM memory reservation the kernel is willing to make.
185 * Filesystems can of course request smaller chunks. Actual
186 * backing memory uses a chunk size of a page (PAGE_SIZE).
187 *
188 * If you make BKVASIZE too small you risk seriously fragmenting
189 * the buffer KVM map which may slow things down a bit. If you
190 * make it too big the kernel will not be able to optimally use
191 * the KVM memory reserved for the buffer cache and will wind
192 * up with too-few buffers.
193 *
194 * The default is 16384, roughly 2x the block size used by a
195 * normal UFS filesystem.
196 */
197#define MAXBSIZE 65536 /* must be power of 2 */
198#define BKVASIZE 16384 /* must be power of 2 */
199#define BKVAMASK (BKVASIZE-1)
200#define MAXFRAG 8
201
202/*
203 * MAXPATHLEN defines the longest permissible path length after expanding
204 * symbolic links. It is used to allocate a temporary buffer from the buffer
205 * pool in which to do the name expansion, hence should be a power of two,
206 * and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the
207 * maximum number of symbolic links that may be expanded in a path name.
208 * It should be set high enough to allow all legitimate uses, but halt
209 * infinite loops reasonably quickly.
210 */
6bb39c45 211#define MAXPATHLEN PATH_MAX
984263bc
MD
212#define MAXSYMLINKS 32
213
214/* Bit map related macros. */
6bb39c45
DR
215#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
216#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
217#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
218#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
984263bc
MD
219
220/* Macros for counting and rounding. */
221#ifndef howmany
6bb39c45 222#define howmany(x, y) (((x)+((y)-1))/(y))
984263bc 223#endif
6bb39c45 224#define rounddown(x, y) (((x)/(y))*(y))
a8cf2878 225#define rounddown2(x, y) ((x) & ~((y) - 1)) /* y power of two */
6bb39c45
DR
226#define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */
227#define roundup2(x, y) (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
984263bc
MD
228#define powerof2(x) ((((x)-1)&(x))==0)
229
aecf2182
MD
230/*
231 * VM objects can be larger than the virtual address space, make sure
232 * we don't cut-off the mask.
233 */
234#define trunc_page64(x) ((x) & ~(int64_t)PAGE_MASK)
235#define round_page64(x) (((x) + PAGE_MASK) & ~(int64_t)PAGE_MASK)
236
984263bc 237/* Macros for min/max. */
6bb39c45
DR
238#define MIN(a,b) (((a)<(b))?(a):(b))
239#define MAX(a,b) (((a)>(b))?(a):(b))
984263bc 240
a3034532 241/* Macro for array size */
fa8f7852 242#define NELEM(ary) (sizeof(ary) / sizeof((ary)[0]))
a3034532 243
984263bc
MD
244/*
245 * Constants for setting the parameters of the kernel memory allocator.
246 *
247 * 2 ** MINBUCKET is the smallest unit of memory that will be
248 * allocated. It must be at least large enough to hold a pointer.
249 *
250 * Units of memory less or equal to MAXALLOCSAVE will permanently
251 * allocate physical memory; requests for these size pieces of
252 * memory are quite fast. Allocations greater than MAXALLOCSAVE must
253 * always allocate and free physical memory; requests for these
254 * size allocations should be done infrequently as they will be slow.
255 *
256 * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
257 * MAXALLOCSIZE must be a power of two.
258 */
984263bc 259#define MINBUCKET 4 /* 4 => min allocation of 16 bytes */
984263bc
MD
260#define MAXALLOCSAVE (2 * PAGE_SIZE)
261
262/*
263 * Scale factor for scaled integers used to count %cpu time and load avgs.
264 *
265 * The number of CPU `tick's that map to a unique `%age' can be expressed
266 * by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that
267 * can be calculated (assuming 32 bits) can be closely approximated using
268 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
269 *
270 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
271 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
272 */
6bb39c45 273#define FSHIFT 11 /* bits to right of fixed binary point */
984263bc
MD
274#define FSCALE (1<<FSHIFT)
275
276#define dbtoc(db) /* calculates devblks to pages */ \
277 ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
278
279#define ctodb(db) /* calculates pages to devblks */ \
280 ((db) << (PAGE_SHIFT - DEV_BSHIFT))
281
26a135b9
AE
282#define MJUMPAGESIZE PAGE_SIZE /* jumbo cluster 4k */
283#define MJUM9BYTES (9 * 1024) /* jumbo cluster 9k */
284#define MJUM16BYTES (16 * 1024) /* jumbo cluster 16k */
ff9e829d
MD
285
286/*
287 * MBUF Management.
288 *
ee9d7228
MD
289 * Because many drivers can't deal with multiple DMA segments all mbufs
290 * must avoid crossing a page boundary. While we can accomodate mbufs
291 * which are not a power-of-2 sized kmalloc() will only guarantee
292 * non-crossing alignment if we use a power-of-2. 256 is no longer large
293 * enough due to m_hdr and m_pkthdr bloat.
ff9e829d
MD
294 *
295 * MCLBYTES must be a power of 2 and is typically significantly larger
296 * than MSIZE, sufficient to hold a standard-mtu packet. 2K is considered
297 * reasonable.
298 */
299#ifndef MSIZE
ee9d7228 300#define MSIZE 512 /* size of an mbuf */
ff9e829d
MD
301#endif
302
303#ifndef MCLSHIFT
94eaee9a 304#define MCLSHIFT 11 /* convert bytes to m_buf clusters */
ff9e829d
MD
305#endif
306#define MCLBYTES (1 << MCLSHIFT) /* size of an m_buf cluster */
307#define MCLOFSET (MCLBYTES - 1) /* offset within an m_buf cluster */
308
984263bc
MD
309/*
310 * Make this available for most of the kernel. There were too many
311 * things that included sys/systm.h just for panic().
312 */
313#ifdef _KERNEL
b153f746 314void panic (const char *, ...) __dead2 __printflike(1, 2);
984263bc
MD
315#endif
316
465a99ae
JS
317#ifndef htonl
318#define htonl(x) __htonl(x)
319#endif
320#ifndef htons
321#define htons(x) __htons(x)
322#endif
323#ifndef ntohl
324#define ntohl(x) __ntohl(x)
325#endif
326#ifndef ntohs
327#define ntohs(x) __ntohs(x)
328#endif
329
984263bc 330#endif /* _SYS_PARAM_H_ */