1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * (c) UNIX System Laboratories, Inc. 7 * All or some portions of this file are derived from material licensed 8 * to the University of California by American Telephone and Telegraph 9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 10 * the permission of UNIX System Laboratories, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)param.h 8.3 (Berkeley) 4/4/95 37 * $FreeBSD$ 38 */ 39 40 #ifndef _SYS_PARAM_H_ 41 #define _SYS_PARAM_H_ 42 43 #include <sys/_null.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 in the doc/ repository: 54 * 55 * head/en_US.ISO8859-1/books/porters-handbook/versions/chapter.xml 56 * 57 * scheme is: <major><two digit minor>Rxx 58 * 'R' is in the range 0 to 4 if this is a release branch or 59 * X.0-CURRENT before releng/X.0 is created, otherwise 'R' is 60 * in the range 5 to 9. 61 */ 62 #undef __FreeBSD_version 63 #define __FreeBSD_version 1300097 /* Master, propagated to newvers */ 64 65 /* 66 * __FreeBSD_kernel__ indicates that this system uses the kernel of FreeBSD, 67 * which by definition is always true on FreeBSD. This macro is also defined 68 * on other systems that use the kernel of FreeBSD, such as GNU/kFreeBSD. 69 * 70 * It is tempting to use this macro in userland code when we want to enable 71 * kernel-specific routines, and in fact it's fine to do this in code that 72 * is part of FreeBSD itself. However, be aware that as presence of this 73 * macro is still not widespread (e.g. older FreeBSD versions, 3rd party 74 * compilers, etc), it is STRONGLY DISCOURAGED to check for this macro in 75 * external applications without also checking for __FreeBSD__ as an 76 * alternative. 77 */ 78 #undef __FreeBSD_kernel__ 79 #define __FreeBSD_kernel__ 80 81 #if defined(_KERNEL) || defined(IN_RTLD) 82 #define P_OSREL_SIGWAIT 700000 83 #define P_OSREL_SIGSEGV 700004 84 #define P_OSREL_MAP_ANON 800104 85 #define P_OSREL_MAP_FSTRICT 1100036 86 #define P_OSREL_SHUTDOWN_ENOTCONN 1100077 87 #define P_OSREL_MAP_GUARD 1200035 88 #define P_OSREL_WRFSBASE 1200041 89 #define P_OSREL_CK_CYLGRP 1200046 90 #define P_OSREL_VMTOTAL64 1200054 91 #define P_OSREL_CK_SUPERBLOCK 1300000 92 #define P_OSREL_CK_INODE 1300005 93 #define P_OSREL_POWERPC_NEW_AUX_ARGS 1300070 94 95 #define P_OSREL_MAJOR(x) ((x) / 100000) 96 #endif 97 98 #ifndef LOCORE 99 #include <sys/types.h> 100 #endif 101 102 /* 103 * Machine-independent constants (some used in following include files). 104 * Redefined constants are from POSIX 1003.1 limits file. 105 * 106 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>) 107 */ 108 #include <sys/syslimits.h> 109 110 #define MAXCOMLEN 19 /* max command name remembered */ 111 #define MAXINTERP PATH_MAX /* max interpreter file name length */ 112 #define MAXLOGNAME 33 /* 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+1) /* max number groups */ 116 #define NOFILE OPEN_MAX /* max open files per process */ 117 #define NOGROUP 65535 /* marker for empty group set member */ 118 #define MAXHOSTNAMELEN 256 /* max hostname size */ 119 #define SPECNAMELEN 255 /* max length of devicename */ 120 121 /* More types and definitions used throughout the kernel. */ 122 #ifdef _KERNEL 123 #include <sys/cdefs.h> 124 #include <sys/errno.h> 125 #ifndef LOCORE 126 #include <sys/time.h> 127 #include <sys/priority.h> 128 #endif 129 130 #ifndef FALSE 131 #define FALSE 0 132 #endif 133 #ifndef TRUE 134 #define TRUE 1 135 #endif 136 #endif 137 138 #ifndef _KERNEL 139 /* Signals. */ 140 #include <sys/signal.h> 141 #endif 142 143 /* Machine type dependent parameters. */ 144 #include <machine/param.h> 145 #ifndef _KERNEL 146 #include <sys/limits.h> 147 #endif 148 149 #ifndef DEV_BSHIFT 150 #define DEV_BSHIFT 9 /* log2(DEV_BSIZE) */ 151 #endif 152 #define DEV_BSIZE (1<<DEV_BSHIFT) 153 154 #ifndef BLKDEV_IOSIZE 155 #define BLKDEV_IOSIZE PAGE_SIZE /* default block device I/O size */ 156 #endif 157 #ifndef DFLTPHYS 158 #define DFLTPHYS (64 * 1024) /* default max raw I/O transfer size */ 159 #endif 160 #ifndef MAXPHYS 161 #define MAXPHYS (128 * 1024) /* max raw I/O transfer size */ 162 #endif 163 #ifndef MAXDUMPPGS 164 #define MAXDUMPPGS (DFLTPHYS/PAGE_SIZE) 165 #endif 166 167 /* 168 * Constants related to network buffer management. 169 * MCLBYTES must be no larger than PAGE_SIZE. 170 */ 171 #ifndef MSIZE 172 #define MSIZE 256 /* size of an mbuf */ 173 #endif 174 175 #ifndef MCLSHIFT 176 #define MCLSHIFT 11 /* convert bytes to mbuf clusters */ 177 #endif /* MCLSHIFT */ 178 179 #define MCLBYTES (1 << MCLSHIFT) /* size of an mbuf cluster */ 180 181 #if PAGE_SIZE < 2048 182 #define MJUMPAGESIZE MCLBYTES 183 #elif PAGE_SIZE <= 8192 184 #define MJUMPAGESIZE PAGE_SIZE 185 #else 186 #define MJUMPAGESIZE (8 * 1024) 187 #endif 188 189 #define MJUM9BYTES (9 * 1024) /* jumbo cluster 9k */ 190 #define MJUM16BYTES (16 * 1024) /* jumbo cluster 16k */ 191 192 /* 193 * Some macros for units conversion 194 */ 195 196 /* clicks to bytes */ 197 #ifndef ctob 198 #define ctob(x) ((x)<<PAGE_SHIFT) 199 #endif 200 201 /* bytes to clicks */ 202 #ifndef btoc 203 #define btoc(x) (((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT) 204 #endif 205 206 /* 207 * btodb() is messy and perhaps slow because `bytes' may be an off_t. We 208 * want to shift an unsigned type to avoid sign extension and we don't 209 * want to widen `bytes' unnecessarily. Assume that the result fits in 210 * a daddr_t. 211 */ 212 #ifndef btodb 213 #define btodb(bytes) /* calculates (bytes / DEV_BSIZE) */ \ 214 (sizeof (bytes) > sizeof(long) \ 215 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \ 216 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT)) 217 #endif 218 219 #ifndef dbtob 220 #define dbtob(db) /* calculates (db * DEV_BSIZE) */ \ 221 ((off_t)(db) << DEV_BSHIFT) 222 #endif 223 224 #define PRIMASK 0x0ff 225 #define PCATCH 0x100 /* OR'd with pri for tsleep to check signals */ 226 #define PDROP 0x200 /* OR'd with pri to stop re-entry of interlock mutex */ 227 228 #define NZERO 0 /* default "nice" */ 229 230 #define NBBY 8 /* number of bits in a byte */ 231 #define NBPW sizeof(int) /* number of bytes per word (integer) */ 232 233 #define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */ 234 235 #define NODEV (dev_t)(-1) /* non-existent device */ 236 237 /* 238 * File system parameters and macros. 239 * 240 * MAXBSIZE - Filesystems are made out of blocks of at most MAXBSIZE bytes 241 * per block. MAXBSIZE may be made larger without effecting 242 * any existing filesystems as long as it does not exceed MAXPHYS, 243 * and may be made smaller at the risk of not being able to use 244 * filesystems which require a block size exceeding MAXBSIZE. 245 * 246 * MAXBCACHEBUF - Maximum size of a buffer in the buffer cache. This must 247 * be >= MAXBSIZE and can be set differently for different 248 * architectures by defining it in <machine/param.h>. 249 * Making this larger allows NFS to do larger reads/writes. 250 * 251 * BKVASIZE - Nominal buffer space per buffer, in bytes. BKVASIZE is the 252 * minimum KVM memory reservation the kernel is willing to make. 253 * Filesystems can of course request smaller chunks. Actual 254 * backing memory uses a chunk size of a page (PAGE_SIZE). 255 * The default value here can be overridden on a per-architecture 256 * basis by defining it in <machine/param.h>. 257 * 258 * If you make BKVASIZE too small you risk seriously fragmenting 259 * the buffer KVM map which may slow things down a bit. If you 260 * make it too big the kernel will not be able to optimally use 261 * the KVM memory reserved for the buffer cache and will wind 262 * up with too-few buffers. 263 * 264 * The default is 16384, roughly 2x the block size used by a 265 * normal UFS filesystem. 266 */ 267 #define MAXBSIZE 65536 /* must be power of 2 */ 268 #ifndef MAXBCACHEBUF 269 #define MAXBCACHEBUF MAXBSIZE /* must be a power of 2 >= MAXBSIZE */ 270 #endif 271 #ifndef BKVASIZE 272 #define BKVASIZE 16384 /* must be power of 2 */ 273 #endif 274 #define BKVAMASK (BKVASIZE-1) 275 276 /* 277 * MAXPATHLEN defines the longest permissible path length after expanding 278 * symbolic links. It is used to allocate a temporary buffer from the buffer 279 * pool in which to do the name expansion, hence should be a power of two, 280 * and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the 281 * maximum number of symbolic links that may be expanded in a path name. 282 * It should be set high enough to allow all legitimate uses, but halt 283 * infinite loops reasonably quickly. 284 */ 285 #define MAXPATHLEN PATH_MAX 286 #define MAXSYMLINKS 32 287 288 /* Bit map related macros. */ 289 #define setbit(a,i) (((unsigned char *)(a))[(i)/NBBY] |= 1<<((i)%NBBY)) 290 #define clrbit(a,i) (((unsigned char *)(a))[(i)/NBBY] &= ~(1<<((i)%NBBY))) 291 #define isset(a,i) \ 292 (((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) 293 #define isclr(a,i) \ 294 ((((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) == 0) 295 296 /* Macros for counting and rounding. */ 297 #ifndef howmany 298 #define howmany(x, y) (((x)+((y)-1))/(y)) 299 #endif 300 #define nitems(x) (sizeof((x)) / sizeof((x)[0])) 301 #define rounddown(x, y) (((x)/(y))*(y)) 302 #define rounddown2(x, y) ((x)&(~((y)-1))) /* if y is power of two */ 303 #define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */ 304 #define roundup2(x, y) (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */ 305 #define powerof2(x) ((((x)-1)&(x))==0) 306 307 /* Macros for min/max. */ 308 #define MIN(a,b) (((a)<(b))?(a):(b)) 309 #define MAX(a,b) (((a)>(b))?(a):(b)) 310 311 #ifdef _KERNEL 312 /* 313 * Basic byte order function prototypes for non-inline functions. 314 */ 315 #ifndef LOCORE 316 #ifndef _BYTEORDER_PROTOTYPED 317 #define _BYTEORDER_PROTOTYPED 318 __BEGIN_DECLS 319 __uint32_t htonl(__uint32_t); 320 __uint16_t htons(__uint16_t); 321 __uint32_t ntohl(__uint32_t); 322 __uint16_t ntohs(__uint16_t); 323 __END_DECLS 324 #endif 325 #endif 326 327 #ifndef _BYTEORDER_FUNC_DEFINED 328 #define _BYTEORDER_FUNC_DEFINED 329 #define htonl(x) __htonl(x) 330 #define htons(x) __htons(x) 331 #define ntohl(x) __ntohl(x) 332 #define ntohs(x) __ntohs(x) 333 #endif /* !_BYTEORDER_FUNC_DEFINED */ 334 #endif /* _KERNEL */ 335 336 /* 337 * Scale factor for scaled integers used to count %cpu time and load avgs. 338 * 339 * The number of CPU `tick's that map to a unique `%age' can be expressed 340 * by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that 341 * can be calculated (assuming 32 bits) can be closely approximated using 342 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15). 343 * 344 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age', 345 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024. 346 */ 347 #define FSHIFT 11 /* bits to right of fixed binary point */ 348 #define FSCALE (1<<FSHIFT) 349 350 #define dbtoc(db) /* calculates devblks to pages */ \ 351 ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT)) 352 353 #define ctodb(db) /* calculates pages to devblks */ \ 354 ((db) << (PAGE_SHIFT - DEV_BSHIFT)) 355 356 /* 357 * Old spelling of __containerof(). 358 */ 359 #define member2struct(s, m, x) \ 360 ((struct s *)(void *)((char *)(x) - offsetof(struct s, m))) 361 362 /* 363 * Access a variable length array that has been declared as a fixed 364 * length array. 365 */ 366 #define __PAST_END(array, offset) (((__typeof__(*(array)) *)(array))[offset]) 367 368 #endif /* _SYS_PARAM_H_ */ 369