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 37 #ifndef _SYS_PARAM_H_ 38 #define _SYS_PARAM_H_ 39 40 #include <sys/_null.h> 41 42 #define BSD 199506 /* System version (year & month). */ 43 #define BSD4_3 1 44 #define BSD4_4 1 45 46 /* 47 * __FreeBSD_version numbers are documented in the Porter's Handbook. 48 * If you bump the version for any reason, you should update the documentation 49 * there. 50 * Currently this lives here in the doc/ repository: 51 * 52 * documentation/content/en/books/porters-handbook/versions/_index.adoc 53 * 54 * Encoding: <major><two digit minor>Rxx 55 * 'R' is in the range 0 to 4 if this is a release branch or 56 * X.0-CURRENT before releng/X.0 is created, otherwise 'R' is 57 * in the range 5 to 9. 58 * Short hand: MMmmXXX 59 * 60 * __FreeBSD_version is bumped every time there's a change in the base system 61 * that's noteworthy. A noteworthy change is any change which changes the 62 * kernel's KBI in -CURRENT, one that changes some detail about the system that 63 * external software (or the ports system) would want to know about, one that 64 * adds a system call, one that adds or deletes a shipped library, a security 65 * fix, or similar change not specifically noted here. Bumps should be limited 66 * to one per day / a couple per week except for security fixes. 67 * 68 * The approved way to obtain this from a shell script is: 69 * awk '/^\#define[[:space:]]*__FreeBSD_version/ {print $3}' 70 * Other methods to parse this file may work, but are not guaranteed against 71 * future changes. The above script works back to FreeBSD 3.x when this macro 72 * was introduced. This number is propagated to other places needing it that 73 * cannot include sys/param.h and should only be updated here. 74 */ 75 #undef __FreeBSD_version 76 #define __FreeBSD_version 1500018 77 78 /* 79 * __FreeBSD_kernel__ indicates that this system uses the kernel of FreeBSD, 80 * which by definition is always true on FreeBSD. This macro is also defined 81 * on other systems that use the kernel of FreeBSD, such as GNU/kFreeBSD. 82 * 83 * It is tempting to use this macro in userland code when we want to enable 84 * kernel-specific routines, and in fact it's fine to do this in code that 85 * is part of FreeBSD itself. However, be aware that as presence of this 86 * macro is still not widespread (e.g. older FreeBSD versions, 3rd party 87 * compilers, etc), it is STRONGLY DISCOURAGED to check for this macro in 88 * external applications without also checking for __FreeBSD__ as an 89 * alternative. 90 */ 91 #undef __FreeBSD_kernel__ 92 #define __FreeBSD_kernel__ 93 94 #if defined(_KERNEL) || defined(_WANT_P_OSREL) 95 #define P_OSREL_SIGWAIT 700000 96 #define P_OSREL_SIGSEGV 700004 97 #define P_OSREL_MAP_ANON 800104 98 #define P_OSREL_MAP_FSTRICT 1100036 99 #define P_OSREL_SHUTDOWN_ENOTCONN 1100077 100 #define P_OSREL_MAP_GUARD 1200035 101 #define P_OSREL_WRFSBASE 1200041 102 #define P_OSREL_CK_CYLGRP 1200046 103 #define P_OSREL_VMTOTAL64 1200054 104 #define P_OSREL_CK_SUPERBLOCK 1300000 105 #define P_OSREL_CK_INODE 1300005 106 #define P_OSREL_POWERPC_NEW_AUX_ARGS 1300070 107 #define P_OSREL_TIDPID 1400079 108 #define P_OSREL_ARM64_SPSR 1400084 109 110 #define P_OSREL_MAJOR(x) ((x) / 100000) 111 #endif 112 113 #ifndef LOCORE 114 #include <sys/types.h> 115 #endif 116 117 /* 118 * Machine-independent constants (some used in following include files). 119 * Redefined constants are from POSIX 1003.1 limits file. 120 * 121 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>) 122 */ 123 #include <sys/syslimits.h> 124 125 #define MAXCOMLEN 19 /* max command name remembered */ 126 #define MAXINTERP PATH_MAX /* max interpreter file name length */ 127 #define MAXLOGNAME 33 /* max login name length (incl. NUL) */ 128 #define MAXUPRC CHILD_MAX /* max simultaneous processes */ 129 #define NCARGS ARG_MAX /* max bytes for an exec function */ 130 #define NGROUPS (NGROUPS_MAX+1) /* max number groups */ 131 #define NOFILE OPEN_MAX /* max open files per process */ 132 #define NOGROUP 65535 /* marker for empty group set member */ 133 #define MAXHOSTNAMELEN 256 /* max hostname size */ 134 #define SPECNAMELEN 255 /* max length of devicename */ 135 136 /* More types and definitions used throughout the kernel. */ 137 #ifdef _KERNEL 138 #include <sys/cdefs.h> 139 #include <sys/errno.h> 140 #ifndef LOCORE 141 #include <sys/time.h> 142 #include <sys/priority.h> 143 #endif 144 145 #ifndef FALSE 146 #define FALSE 0 147 #endif 148 #ifndef TRUE 149 #define TRUE 1 150 #endif 151 #endif 152 153 #ifndef _KERNEL 154 #ifndef LOCORE 155 /* Signals. */ 156 #include <sys/signal.h> 157 #endif 158 #endif 159 160 /* Machine type dependent parameters. */ 161 #include <machine/param.h> 162 #ifndef _KERNEL 163 #include <sys/limits.h> 164 #include <sys/_maxphys.h> 165 #endif 166 167 #ifndef DEV_BSHIFT 168 #define DEV_BSHIFT 9 /* log2(DEV_BSIZE) */ 169 #endif 170 #define DEV_BSIZE (1<<DEV_BSHIFT) 171 172 #ifndef BLKDEV_IOSIZE 173 #define BLKDEV_IOSIZE PAGE_SIZE /* default block device I/O size */ 174 #endif 175 #ifndef DFLTPHYS 176 #define DFLTPHYS (64 * 1024) /* default max raw I/O transfer size */ 177 #endif 178 #ifndef MAXDUMPPGS 179 #define MAXDUMPPGS (DFLTPHYS/PAGE_SIZE) 180 #endif 181 182 /* 183 * Constants related to network buffer management. 184 * MCLBYTES must be no larger than PAGE_SIZE. 185 */ 186 #ifndef MSIZE 187 #define MSIZE 256 /* size of an mbuf */ 188 #endif 189 190 #ifndef MCLSHIFT 191 #define MCLSHIFT 11 /* convert bytes to mbuf clusters */ 192 #endif /* MCLSHIFT */ 193 194 #define MCLBYTES (1 << MCLSHIFT) /* size of an mbuf cluster */ 195 196 #if PAGE_SIZE <= 8192 197 #define MJUMPAGESIZE PAGE_SIZE 198 #else 199 #define MJUMPAGESIZE (8 * 1024) 200 #endif 201 202 #define MJUM9BYTES (9 * 1024) /* jumbo cluster 9k */ 203 #define MJUM16BYTES (16 * 1024) /* jumbo cluster 16k */ 204 205 /* 206 * Some macros for units conversion 207 */ 208 209 /* clicks to bytes */ 210 #ifndef ctob 211 #define ctob(x) ((x)<<PAGE_SHIFT) 212 #endif 213 214 /* bytes to clicks */ 215 #ifndef btoc 216 #define btoc(x) (((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT) 217 #endif 218 219 /* 220 * btodb() is messy and perhaps slow because `bytes' may be an off_t. We 221 * want to shift an unsigned type to avoid sign extension and we don't 222 * want to widen `bytes' unnecessarily. Assume that the result fits in 223 * a daddr_t. 224 */ 225 #ifndef btodb 226 #define btodb(bytes) /* calculates (bytes / DEV_BSIZE) */ \ 227 (sizeof (bytes) > sizeof(long) \ 228 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \ 229 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT)) 230 #endif 231 232 #ifndef dbtob 233 #define dbtob(db) /* calculates (db * DEV_BSIZE) */ \ 234 ((off_t)(db) << DEV_BSHIFT) 235 #endif 236 237 #define PRIMASK 0x0ff 238 #define PCATCH 0x100 /* OR'd with pri for tsleep to check signals */ 239 #define PDROP 0x200 /* OR'd with pri to stop re-entry of interlock mutex */ 240 #define PNOLOCK 0x400 /* OR'd with pri to allow sleeping w/o a lock */ 241 #define PRILASTFLAG 0x400 /* Last flag defined above */ 242 243 #define NZERO 0 /* default "nice" */ 244 245 #define NBBY 8 /* number of bits in a byte */ 246 #define NBPW sizeof(int) /* number of bytes per word (integer) */ 247 248 #define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */ 249 250 #define NODEV (dev_t)(-1) /* non-existent device */ 251 252 /* 253 * File system parameters and macros. 254 * 255 * MAXBSIZE - Filesystems are made out of blocks of at most MAXBSIZE bytes 256 * per block. MAXBSIZE may be made larger without effecting 257 * any existing filesystems as long as it does not exceed MAXPHYS, 258 * and may be made smaller at the risk of not being able to use 259 * filesystems which require a block size exceeding MAXBSIZE. 260 * 261 * MAXBCACHEBUF - Maximum size of a buffer in the buffer cache. This must 262 * be >= MAXBSIZE and can be set differently for different 263 * architectures by defining it in <machine/param.h>. 264 * Making this larger allows NFS to do larger reads/writes. 265 * 266 * BKVASIZE - Nominal buffer space per buffer, in bytes. BKVASIZE is the 267 * minimum KVM memory reservation the kernel is willing to make. 268 * Filesystems can of course request smaller chunks. Actual 269 * backing memory uses a chunk size of a page (PAGE_SIZE). 270 * The default value here can be overridden on a per-architecture 271 * basis by defining it in <machine/param.h>. 272 * 273 * If you make BKVASIZE too small you risk seriously fragmenting 274 * the buffer KVM map which may slow things down a bit. If you 275 * make it too big the kernel will not be able to optimally use 276 * the KVM memory reserved for the buffer cache and will wind 277 * up with too-few buffers. 278 * 279 * The default is 16384, roughly 2x the block size used by a 280 * normal UFS filesystem. 281 */ 282 #define MAXBSIZE 65536 /* must be power of 2 */ 283 #ifndef MAXBCACHEBUF 284 #define MAXBCACHEBUF MAXBSIZE /* must be a power of 2 >= MAXBSIZE */ 285 #endif 286 #ifndef BKVASIZE 287 #define BKVASIZE 16384 /* must be power of 2 */ 288 #endif 289 #define BKVAMASK (BKVASIZE-1) 290 291 /* 292 * MAXPATHLEN defines the longest permissible path length after expanding 293 * symbolic links. It is used to allocate a temporary buffer from the buffer 294 * pool in which to do the name expansion, hence should be a power of two, 295 * and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the 296 * maximum number of symbolic links that may be expanded in a path name. 297 * It should be set high enough to allow all legitimate uses, but halt 298 * infinite loops reasonably quickly. 299 */ 300 #define MAXPATHLEN PATH_MAX 301 #define MAXSYMLINKS 32 302 303 /* Bit map related macros. */ 304 #define setbit(a,i) (((unsigned char *)(a))[(i)/NBBY] |= 1<<((i)%NBBY)) 305 #define clrbit(a,i) (((unsigned char *)(a))[(i)/NBBY] &= ~(1<<((i)%NBBY))) 306 #define isset(a,i) \ 307 (((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) 308 #define isclr(a,i) \ 309 ((((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) == 0) 310 311 /* Macros for counting and rounding. */ 312 #ifndef howmany 313 #define howmany(x, y) (((x)+((y)-1))/(y)) 314 #endif 315 #define nitems(x) (sizeof((x)) / sizeof((x)[0])) 316 #define rounddown(x, y) (((x)/(y))*(y)) 317 #define rounddown2(x, y) __align_down(x, y) /* if y is power of two */ 318 #define roundup(x, y) ((((x)+((y)-1))/(y))*(y)) /* to any y */ 319 #define roundup2(x, y) __align_up(x, y) /* if y is powers of two */ 320 #define powerof2(x) ((((x)-1)&(x))==0) 321 322 /* Macros for min/max. */ 323 #define MIN(a,b) (((a)<(b))?(a):(b)) 324 #define MAX(a,b) (((a)>(b))?(a):(b)) 325 326 #ifdef _KERNEL 327 /* 328 * Basic byte order function prototypes for non-inline functions. 329 */ 330 #ifndef LOCORE 331 #ifndef _BYTEORDER_PROTOTYPED 332 #define _BYTEORDER_PROTOTYPED 333 __BEGIN_DECLS 334 __uint32_t htonl(__uint32_t); 335 __uint16_t htons(__uint16_t); 336 __uint32_t ntohl(__uint32_t); 337 __uint16_t ntohs(__uint16_t); 338 __END_DECLS 339 #endif 340 #endif 341 342 #ifndef _BYTEORDER_FUNC_DEFINED 343 #define _BYTEORDER_FUNC_DEFINED 344 #define htonl(x) __htonl(x) 345 #define htons(x) __htons(x) 346 #define ntohl(x) __ntohl(x) 347 #define ntohs(x) __ntohs(x) 348 #endif /* !_BYTEORDER_FUNC_DEFINED */ 349 #endif /* _KERNEL */ 350 351 /* 352 * Scale factor for scaled integers used to count %cpu time and load avgs. 353 * 354 * The number of CPU `tick's that map to a unique `%age' can be expressed 355 * by the formula (1 / (2 ^ (FSHIFT - 11))). Since the intermediate 356 * calculation is done with 64-bit precision, the maximum load average that can 357 * be calculated is approximately 2^32 / FSCALE. 358 * 359 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age', 360 * FSHIFT must be at least 11. This gives a maximum load avg of 2 million. 361 */ 362 #define FSHIFT 11 /* bits to right of fixed binary point */ 363 #define FSCALE (1<<FSHIFT) 364 365 #define dbtoc(db) /* calculates devblks to pages */ \ 366 ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT)) 367 368 #define ctodb(db) /* calculates pages to devblks */ \ 369 ((db) << (PAGE_SHIFT - DEV_BSHIFT)) 370 371 /* 372 * Old spelling of __containerof(). 373 */ 374 #define member2struct(s, m, x) \ 375 ((struct s *)(void *)((char *)(x) - offsetof(struct s, m))) 376 377 /* 378 * Access a variable length array that has been declared as a fixed 379 * length array. 380 */ 381 #define __PAST_END(array, offset) (((__typeof__(*(array)) *)(array))[offset]) 382 383 #endif /* _SYS_PARAM_H_ */ 384