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