sys/sys/param.h

   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 1500017
  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 #endif
 165
 166 #ifndef DEV_BSHIFT
 167 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 168 #endif
 169 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 170
 171 #ifndef BLKDEV_IOSIZE
 172 #define BLKDEV_IOSIZE  PAGE_SIZE        /* default block device I/O size */
 173 #endif
 174 #ifndef DFLTPHYS
 175 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 176 #endif
 177 #ifndef MAXPHYS                         /* max raw I/O transfer size */
 178 #ifdef __ILP32__
 179 #define MAXPHYS         (128 * 1024)
 180 #else
 181 #define MAXPHYS         (1024 * 1024)
 182 #endif
 183 #endif
 184 #ifndef MAXDUMPPGS
 185 #define MAXDUMPPGS      (DFLTPHYS/PAGE_SIZE)
 186 #endif
 187
 188 /*
 189  * Constants related to network buffer management.
 190  * MCLBYTES must be no larger than PAGE_SIZE.
 191  */
 192 #ifndef MSIZE
 193 #define MSIZE           256             /* size of an mbuf */
 194 #endif
 195
 196 #ifndef MCLSHIFT
 197 #define MCLSHIFT        11              /* convert bytes to mbuf clusters */
 198 #endif  /* MCLSHIFT */
 199
 200 #define MCLBYTES        (1 << MCLSHIFT) /* size of an mbuf cluster */
 201
 202 #if PAGE_SIZE <= 8192
 203 #define MJUMPAGESIZE    PAGE_SIZE
 204 #else
 205 #define MJUMPAGESIZE    (8 * 1024)
 206 #endif
 207
 208 #define MJUM9BYTES      (9 * 1024)      /* jumbo cluster 9k */
 209 #define MJUM16BYTES     (16 * 1024)     /* jumbo cluster 16k */
 210
 211 /*
 212  * Some macros for units conversion
 213  */
 214
 215 /* clicks to bytes */
 216 #ifndef ctob
 217 #define ctob(x) ((x)<<PAGE_SHIFT)
 218 #endif
 219
 220 /* bytes to clicks */
 221 #ifndef btoc
 222 #define btoc(x) (((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT)
 223 #endif
 224
 225 /*
 226  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 227  * want to shift an unsigned type to avoid sign extension and we don't
 228  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 229  * a daddr_t.
 230  */
 231 #ifndef btodb
 232 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 233         (sizeof (bytes) > sizeof(long) \
 234          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 235          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 236 #endif
 237
 238 #ifndef dbtob
 239 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 240         ((off_t)(db) << DEV_BSHIFT)
 241 #endif
 242
 243 #define PRIMASK         0x0ff
 244 #define PCATCH          0x100   /* OR'd with pri for tsleep to check signals */
 245 #define PDROP           0x200   /* OR'd with pri to stop re-entry of interlock mutex */
 246 #define PNOLOCK         0x400   /* OR'd with pri to allow sleeping w/o a lock */
 247 #define PRILASTFLAG     0x400   /* Last flag defined above */
 248
 249 #define NZERO   0               /* default "nice" */
 250
 251 #define NBBY    8               /* number of bits in a byte */
 252 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
 253
 254 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
 255
 256 #define NODEV   (dev_t)(-1)     /* non-existent device */
 257
 258 /*
 259  * File system parameters and macros.
 260  *
 261  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
 262  *              per block.  MAXBSIZE may be made larger without effecting
 263  *              any existing filesystems as long as it does not exceed MAXPHYS,
 264  *              and may be made smaller at the risk of not being able to use
 265  *              filesystems which require a block size exceeding MAXBSIZE.
 266  *
 267  * MAXBCACHEBUF - Maximum size of a buffer in the buffer cache.  This must
 268  *              be >= MAXBSIZE and can be set differently for different
 269  *              architectures by defining it in <machine/param.h>.
 270  *              Making this larger allows NFS to do larger reads/writes.
 271  *
 272  * BKVASIZE -   Nominal buffer space per buffer, in bytes.  BKVASIZE is the
 273  *              minimum KVM memory reservation the kernel is willing to make.
 274  *              Filesystems can of course request smaller chunks.  Actual
 275  *              backing memory uses a chunk size of a page (PAGE_SIZE).
 276  *              The default value here can be overridden on a per-architecture
 277  *              basis by defining it in <machine/param.h>.
 278  *
 279  *              If you make BKVASIZE too small you risk seriously fragmenting
 280  *              the buffer KVM map which may slow things down a bit.  If you
 281  *              make it too big the kernel will not be able to optimally use
 282  *              the KVM memory reserved for the buffer cache and will wind
 283  *              up with too-few buffers.
 284  *
 285  *              The default is 16384, roughly 2x the block size used by a
 286  *              normal UFS filesystem.
 287  */
 288 #define MAXBSIZE        65536   /* must be power of 2 */
 289 #ifndef MAXBCACHEBUF
 290 #define MAXBCACHEBUF    MAXBSIZE /* must be a power of 2 >= MAXBSIZE */
 291 #endif
 292 #ifndef BKVASIZE
 293 #define BKVASIZE        16384   /* must be power of 2 */
 294 #endif
 295 #define BKVAMASK        (BKVASIZE-1)
 296
 297 /*
 298  * MAXPATHLEN defines the longest permissible path length after expanding
 299  * symbolic links. It is used to allocate a temporary buffer from the buffer
 300  * pool in which to do the name expansion, hence should be a power of two,
 301  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
 302  * maximum number of symbolic links that may be expanded in a path name.
 303  * It should be set high enough to allow all legitimate uses, but halt
 304  * infinite loops reasonably quickly.
 305  */
 306 #define MAXPATHLEN      PATH_MAX
 307 #define MAXSYMLINKS     32
 308
 309 /* Bit map related macros. */
 310 #define setbit(a,i)     (((unsigned char *)(a))[(i)/NBBY] |= 1<<((i)%NBBY))
 311 #define clrbit(a,i)     (((unsigned char *)(a))[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 312 #define isset(a,i)                                                      \
 313         (((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY)))
 314 #define isclr(a,i)                                                      \
 315         ((((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 316
 317 /* Macros for counting and rounding. */
 318 #ifndef howmany
 319 #define howmany(x, y)   (((x)+((y)-1))/(y))
 320 #endif
 321 #define nitems(x)       (sizeof((x)) / sizeof((x)[0]))
 322 #define rounddown(x, y) (((x)/(y))*(y))
 323 #define rounddown2(x, y) __align_down(x, y) /* if y is power of two */
 324 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
 325 #define roundup2(x, y)  __align_up(x, y) /* if y is powers of two */
 326 #define powerof2(x)     ((((x)-1)&(x))==0)
 327
 328 /* Macros for min/max. */
 329 #define MIN(a,b) (((a)<(b))?(a):(b))
 330 #define MAX(a,b) (((a)>(b))?(a):(b))
 331
 332 #ifdef _KERNEL
 333 /*
 334  * Basic byte order function prototypes for non-inline functions.
 335  */
 336 #ifndef LOCORE
 337 #ifndef _BYTEORDER_PROTOTYPED
 338 #define _BYTEORDER_PROTOTYPED
 339 __BEGIN_DECLS
 340 __uint32_t       htonl(__uint32_t);
 341 __uint16_t       htons(__uint16_t);
 342 __uint32_t       ntohl(__uint32_t);
 343 __uint16_t       ntohs(__uint16_t);
 344 __END_DECLS
 345 #endif
 346 #endif
 347
 348 #ifndef _BYTEORDER_FUNC_DEFINED
 349 #define _BYTEORDER_FUNC_DEFINED
 350 #define htonl(x)        __htonl(x)
 351 #define htons(x)        __htons(x)
 352 #define ntohl(x)        __ntohl(x)
 353 #define ntohs(x)        __ntohs(x)
 354 #endif /* !_BYTEORDER_FUNC_DEFINED */
 355 #endif /* _KERNEL */
 356
 357 /*
 358  * Scale factor for scaled integers used to count %cpu time and load avgs.
 359  *
 360  * The number of CPU `tick's that map to a unique `%age' can be expressed
 361  * by the formula (1 / (2 ^ (FSHIFT - 11))).  Since the intermediate
 362  * calculation is done with 64-bit precision, the maximum load average that can
 363  * be calculated is approximately 2^32 / FSCALE.
 364  *
 365  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
 366  * FSHIFT must be at least 11.  This gives a maximum load avg of 2 million.
 367  */
 368 #define FSHIFT  11              /* bits to right of fixed binary point */
 369 #define FSCALE  (1<<FSHIFT)
 370
 371 #define dbtoc(db)                       /* calculates devblks to pages */ \
 372         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
 373
 374 #define ctodb(db)                       /* calculates pages to devblks */ \
 375         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
 376
 377 /*
 378  * Old spelling of __containerof().
 379  */
 380 #define member2struct(s, m, x)                                          \
 381         ((struct s *)(void *)((char *)(x) - offsetof(struct s, m)))
 382
 383 /*
 384  * Access a variable length array that has been declared as a fixed
 385  * length array.
 386  */
 387 #define __PAST_END(array, offset) (((__typeof__(*(array)) *)(array))[offset])
 388
 389 #endif  /* _SYS_PARAM_H_ */