FreeBSD/Linux Kernel Cross Reference
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: releng/5.1/sys/sys/param.h 115816 2003-06-04 05:55:09Z scottl $
40 */
41
42 #ifndef _SYS_PARAM_H_
43 #define _SYS_PARAM_H_
44
45 #define BSD 199506 /* System version (year & month). */
46 #define BSD4_3 1
47 #define BSD4_4 1
48
49 /*
50 * __FreeBSD_version numbers are documented in the Porter's Handbook.
51 * If you bump the version for any reason, you should update the documentation
52 * there.
53 * Currently this lives here:
54 *
55 * doc/en_US.ISO8859-1/books/porters-handbook/book.sgml
56 */
57 #undef __FreeBSD_version
58 #define __FreeBSD_version 501000 /* Master, propagated to newvers */
59
60 #ifndef NULL
61 #define NULL 0
62 #endif
63
64 #ifndef LOCORE
65 #include <sys/types.h>
66 #endif
67
68 /*
69 * Machine-independent constants (some used in following include files).
70 * Redefined constants are from POSIX 1003.1 limits file.
71 *
72 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
73 * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
74 */
75 #include <sys/syslimits.h>
76
77 #define MAXCOMLEN 19 /* max command name remembered */
78 #define MAXINTERP 32 /* max interpreter file name length */
79 #define MAXLOGNAME 17 /* max login name length (incl. NUL) */
80 #define MAXUPRC CHILD_MAX /* max simultaneous processes */
81 #define NCARGS ARG_MAX /* max bytes for an exec function */
82 #define NGROUPS NGROUPS_MAX /* max number groups */
83 #define NOFILE OPEN_MAX /* max open files per process */
84 #define NOGROUP 65535 /* marker for empty group set member */
85 #define MAXHOSTNAMELEN 256 /* max hostname size */
86 #define SPECNAMELEN 63 /* max length of devicename */
87
88 /* More types and definitions used throughout the kernel. */
89 #ifdef _KERNEL
90 #include <sys/cdefs.h>
91 #include <sys/errno.h>
92 #include <sys/time.h>
93 #include <sys/priority.h>
94
95 #define FALSE 0
96 #define TRUE 1
97 #endif
98
99 #ifndef _KERNEL
100 /* Signals. */
101 #include <sys/signal.h>
102 #endif
103
104 /* Machine type dependent parameters. */
105 #include <machine/param.h>
106 #ifndef _KERNEL
107 #include <sys/limits.h>
108 #endif
109
110 #ifndef _NO_NAMESPACE_POLLUTION
111
112 #ifndef DEV_BSHIFT
113 #define DEV_BSHIFT 9 /* log2(DEV_BSIZE) */
114 #endif
115 #define DEV_BSIZE (1<<DEV_BSHIFT)
116
117 #ifndef BLKDEV_IOSIZE
118 #define BLKDEV_IOSIZE PAGE_SIZE /* default block device I/O size */
119 #endif
120 #ifndef DFLTPHYS
121 #define DFLTPHYS (64 * 1024) /* default max raw I/O transfer size */
122 #endif
123 #ifndef MAXPHYS
124 #define MAXPHYS (128 * 1024) /* max raw I/O transfer size */
125 #endif
126 #ifndef MAXDUMPPGS
127 #define MAXDUMPPGS (DFLTPHYS/PAGE_SIZE)
128 #endif
129
130 /*
131 * Constants related to network buffer management.
132 * MCLBYTES must be no larger than PAGE_SIZE.
133 */
134 #ifndef MSIZE
135 #define MSIZE 256 /* size of an mbuf */
136 #endif /* MSIZE */
137
138 #ifndef MCLSHIFT
139 #define MCLSHIFT 11 /* convert bytes to mbuf clusters */
140 #endif /* MCLSHIFT */
141
142 #define MCLBYTES (1 << MCLSHIFT) /* size of an mbuf cluster */
143
144 /*
145 * Some macros for units conversion
146 */
147
148 /* clicks to bytes */
149 #ifndef ctob
150 #define ctob(x) ((x)<<PAGE_SHIFT)
151 #endif
152
153 /* bytes to clicks */
154 #ifndef btoc
155 #define btoc(x) (((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT)
156 #endif
157
158 /*
159 * btodb() is messy and perhaps slow because `bytes' may be an off_t. We
160 * want to shift an unsigned type to avoid sign extension and we don't
161 * want to widen `bytes' unnecessarily. Assume that the result fits in
162 * a daddr_t.
163 */
164 #ifndef btodb
165 #define btodb(bytes) /* calculates (bytes / DEV_BSIZE) */ \
166 (sizeof (bytes) > sizeof(long) \
167 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
168 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
169 #endif
170
171 #ifndef dbtob
172 #define dbtob(db) /* calculates (db * DEV_BSIZE) */ \
173 ((off_t)(db) << DEV_BSHIFT)
174 #endif
175
176 #endif /* _NO_NAMESPACE_POLLUTION */
177
178 #define PRIMASK 0x0ff
179 #define PCATCH 0x100 /* OR'd with pri for tsleep to check signals */
180 #define PDROP 0x200 /* OR'd with pri to stop re-entry of interlock mutex */
181
182 #define NZERO 0 /* default "nice" */
183
184 #define NBBY 8 /* number of bits in a byte */
185 #define NBPW sizeof(int) /* number of bytes per word (integer) */
186
187 #define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */
188 #define NODEV (dev_t)(-1) /* non-existent device */
189 #ifdef _KERNEL
190 #define NOUDEV (udev_t)(-1) /* non-existent device */
191 #define NOMAJ 256 /* non-existent device */
192 #endif
193
194 #define CBLOCK 128 /* Clist block size, must be a power of 2. */
195 #define CBQSIZE (CBLOCK/NBBY) /* Quote bytes/cblock - can do better. */
196 /* Data chars/clist. */
197 #define CBSIZE (CBLOCK - sizeof(struct cblock *) - CBQSIZE)
198 #define CROUND (CBLOCK - 1) /* Clist rounding. */
199
200 /*
201 * File system parameters and macros.
202 *
203 * MAXBSIZE - Filesystems are made out of blocks of at most MAXBSIZE bytes
204 * per block. MAXBSIZE may be made larger without effecting
205 * any existing filesystems as long as it does not exceed MAXPHYS,
206 * and may be made smaller at the risk of not being able to use
207 * filesystems which require a block size exceeding MAXBSIZE.
208 *
209 * BKVASIZE - Nominal buffer space per buffer, in bytes. BKVASIZE is the
210 * minimum KVM memory reservation the kernel is willing to make.
211 * Filesystems can of course request smaller chunks. Actual
212 * backing memory uses a chunk size of a page (PAGE_SIZE).
213 *
214 * If you make BKVASIZE too small you risk seriously fragmenting
215 * the buffer KVM map which may slow things down a bit. If you
216 * make it too big the kernel will not be able to optimally use
217 * the KVM memory reserved for the buffer cache and will wind
218 * up with too-few buffers.
219 *
220 * The default is 16384, roughly 2x the block size used by a
221 * normal UFS filesystem.
222 */
223 #define MAXBSIZE 65536 /* must be power of 2 */
224 #define BKVASIZE 16384 /* must be power of 2 */
225 #define BKVAMASK (BKVASIZE-1)
226
227 /*
228 * MAXPATHLEN defines the longest permissible path length after expanding
229 * symbolic links. It is used to allocate a temporary buffer from the buffer
230 * pool in which to do the name expansion, hence should be a power of two,
231 * and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the
232 * maximum number of symbolic links that may be expanded in a path name.
233 * It should be set high enough to allow all legitimate uses, but halt
234 * infinite loops reasonably quickly.
235 */
236 #define MAXPATHLEN PATH_MAX
237 #define MAXSYMLINKS 32
238
239 /* Bit map related macros. */
240 #define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
241 #define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
242 #define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
243 #define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
244
245 /* Macros for counting and rounding. */
246 #ifndef howmany
247 #define howmany(x, y) (((x)+((y)-1))/(y))
248 #endif
249 #define rounddown(x, y) (((x)/(y))*(y))
250 #define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */
251 #define roundup2(x, y) (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
252 #define powerof2(x) ((((x)-1)&(x))==0)
253
254 /* Macros for min/max. */
255 #define MIN(a,b) (((a)<(b))?(a):(b))
256 #define MAX(a,b) (((a)>(b))?(a):(b))
257
258 #ifdef _KERNEL
259 /*
260 * Basic byte order function prototypes for non-inline functions.
261 */
262 #ifndef _BYTEORDER_PROTOTYPED
263 #define _BYTEORDER_PROTOTYPED
264 __BEGIN_DECLS
265 __uint32_t htonl(__uint32_t);
266 __uint16_t htons(__uint16_t);
267 __uint32_t ntohl(__uint32_t);
268 __uint16_t ntohs(__uint16_t);
269 __END_DECLS
270 #endif
271
272 #ifndef lint
273 #ifndef _BYTEORDER_FUNC_DEFINED
274 #define _BYTEORDER_FUNC_DEFINED
275 #define htonl(x) __htonl(x)
276 #define htons(x) __htons(x)
277 #define ntohl(x) __ntohl(x)
278 #define ntohs(x) __ntohs(x)
279 #endif /* !_BYTEORDER_FUNC_DEFINED */
280 #endif /* lint */
281 #endif /* _KERNEL */
282
283 /*
284 * Constants for setting the parameters of the kernel memory allocator.
285 *
286 * 2 ** MINBUCKET is the smallest unit of memory that will be
287 * allocated. It must be at least large enough to hold a pointer.
288 *
289 * Units of memory less or equal to MAXALLOCSAVE will permanently
290 * allocate physical memory; requests for these size pieces of
291 * memory are quite fast. Allocations greater than MAXALLOCSAVE must
292 * always allocate and free physical memory; requests for these
293 * size allocations should be done infrequently as they will be slow.
294 *
295 * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
296 * MAXALLOCSIZE must be a power of two.
297 */
298 #if defined(__alpha__) || defined(__ia64__) || defined(__sparc64__)
299 #define MINBUCKET 5 /* 5 => min allocation of 32 bytes */
300 #else
301 #define MINBUCKET 4 /* 4 => min allocation of 16 bytes */
302 #endif
303 #define MAXALLOCSAVE (2 * PAGE_SIZE)
304
305 /*
306 * Scale factor for scaled integers used to count %cpu time and load avgs.
307 *
308 * The number of CPU `tick's that map to a unique `%age' can be expressed
309 * by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that
310 * can be calculated (assuming 32 bits) can be closely approximated using
311 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
312 *
313 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
314 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
315 */
316 #define FSHIFT 11 /* bits to right of fixed binary point */
317 #define FSCALE (1<<FSHIFT)
318
319 #define dbtoc(db) /* calculates devblks to pages */ \
320 ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
321
322 #define ctodb(db) /* calculates pages to devblks */ \
323 ((db) << (PAGE_SHIFT - DEV_BSHIFT))
324
325 #endif /* _SYS_PARAM_H_ */
Cache object: 6d9e1437735a584fb9826df0d30fe1d9
|