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  *      @(#)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 1300000       /* 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
  93 #define P_OSREL_MAJOR(x)                ((x) / 100000)
  94 #endif
  95
  96 #ifndef LOCORE
  97 #include <sys/types.h>
  98 #endif
  99
 100 /*
 101  * Machine-independent constants (some used in following include files).
 102  * Redefined constants are from POSIX 1003.1 limits file.
 103  *
 104  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
 105  */
 106 #include <sys/syslimits.h>
 107
 108 #define MAXCOMLEN       19              /* max command name remembered */
 109 #define MAXINTERP       PATH_MAX        /* max interpreter file name length */
 110 #define MAXLOGNAME      33              /* max login name length (incl. NUL) */
 111 #define MAXUPRC         CHILD_MAX       /* max simultaneous processes */
 112 #define NCARGS          ARG_MAX         /* max bytes for an exec function */
 113 #define NGROUPS         (NGROUPS_MAX+1) /* max number groups */
 114 #define NOFILE          OPEN_MAX        /* max open files per process */
 115 #define NOGROUP         65535           /* marker for empty group set member */
 116 #define MAXHOSTNAMELEN  256             /* max hostname size */
 117 #define SPECNAMELEN     63              /* max length of devicename */
 118
 119 /* More types and definitions used throughout the kernel. */
 120 #ifdef _KERNEL
 121 #include <sys/cdefs.h>
 122 #include <sys/errno.h>
 123 #ifndef LOCORE
 124 #include <sys/time.h>
 125 #include <sys/priority.h>
 126 #endif
 127
 128 #ifndef FALSE
 129 #define FALSE   0
 130 #endif
 131 #ifndef TRUE
 132 #define TRUE    1
 133 #endif
 134 #endif
 135
 136 #ifndef _KERNEL
 137 /* Signals. */
 138 #include <sys/signal.h>
 139 #endif
 140
 141 /* Machine type dependent parameters. */
 142 #include <machine/param.h>
 143 #ifndef _KERNEL
 144 #include <sys/limits.h>
 145 #endif
 146
 147 #ifndef DEV_BSHIFT
 148 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 149 #endif
 150 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 151
 152 #ifndef BLKDEV_IOSIZE
 153 #define BLKDEV_IOSIZE  PAGE_SIZE        /* default block device I/O size */
 154 #endif
 155 #ifndef DFLTPHYS
 156 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 157 #endif
 158 #ifndef MAXPHYS
 159 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
 160 #endif
 161 #ifndef MAXDUMPPGS
 162 #define MAXDUMPPGS      (DFLTPHYS/PAGE_SIZE)
 163 #endif
 164
 165 /*
 166  * Constants related to network buffer management.
 167  * MCLBYTES must be no larger than PAGE_SIZE.
 168  */
 169 #ifndef MSIZE
 170 #define MSIZE           256             /* size of an mbuf */
 171 #endif
 172
 173 #ifndef MCLSHIFT
 174 #define MCLSHIFT        11              /* convert bytes to mbuf clusters */
 175 #endif  /* MCLSHIFT */
 176
 177 #define MCLBYTES        (1 << MCLSHIFT) /* size of an mbuf cluster */
 178
 179 #if PAGE_SIZE < 2048
 180 #define MJUMPAGESIZE    MCLBYTES
 181 #elif PAGE_SIZE <= 8192
 182 #define MJUMPAGESIZE    PAGE_SIZE
 183 #else
 184 #define MJUMPAGESIZE    (8 * 1024)
 185 #endif
 186
 187 #define MJUM9BYTES      (9 * 1024)      /* jumbo cluster 9k */
 188 #define MJUM16BYTES     (16 * 1024)     /* jumbo cluster 16k */
 189
 190 /*
 191  * Some macros for units conversion
 192  */
 193
 194 /* clicks to bytes */
 195 #ifndef ctob
 196 #define ctob(x) ((x)<<PAGE_SHIFT)
 197 #endif
 198
 199 /* bytes to clicks */
 200 #ifndef btoc
 201 #define btoc(x) (((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT)
 202 #endif
 203
 204 /*
 205  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 206  * want to shift an unsigned type to avoid sign extension and we don't
 207  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 208  * a daddr_t.
 209  */
 210 #ifndef btodb
 211 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 212         (sizeof (bytes) > sizeof(long) \
 213          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 214          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 215 #endif
 216
 217 #ifndef dbtob
 218 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 219         ((off_t)(db) << DEV_BSHIFT)
 220 #endif
 221
 222 #define PRIMASK 0x0ff
 223 #define PCATCH  0x100           /* OR'd with pri for tsleep to check signals */
 224 #define PDROP   0x200   /* OR'd with pri to stop re-entry of interlock mutex */
 225
 226 #define NZERO   0               /* default "nice" */
 227
 228 #define NBBY    8               /* number of bits in a byte */
 229 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
 230
 231 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
 232
 233 #define NODEV   (dev_t)(-1)     /* non-existent device */
 234
 235 /*
 236  * File system parameters and macros.
 237  *
 238  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
 239  *              per block.  MAXBSIZE may be made larger without effecting
 240  *              any existing filesystems as long as it does not exceed MAXPHYS,
 241  *              and may be made smaller at the risk of not being able to use
 242  *              filesystems which require a block size exceeding MAXBSIZE.
 243  *
 244  * MAXBCACHEBUF - Maximum size of a buffer in the buffer cache.  This must
 245  *              be >= MAXBSIZE and can be set differently for different
 246  *              architectures by defining it in <machine/param.h>.
 247  *              Making this larger allows NFS to do larger reads/writes.
 248  *
 249  * BKVASIZE -   Nominal buffer space per buffer, in bytes.  BKVASIZE is the
 250  *              minimum KVM memory reservation the kernel is willing to make.
 251  *              Filesystems can of course request smaller chunks.  Actual
 252  *              backing memory uses a chunk size of a page (PAGE_SIZE).
 253  *              The default value here can be overridden on a per-architecture
 254  *              basis by defining it in <machine/param.h>.
 255  *
 256  *              If you make BKVASIZE too small you risk seriously fragmenting
 257  *              the buffer KVM map which may slow things down a bit.  If you
 258  *              make it too big the kernel will not be able to optimally use
 259  *              the KVM memory reserved for the buffer cache and will wind
 260  *              up with too-few buffers.
 261  *
 262  *              The default is 16384, roughly 2x the block size used by a
 263  *              normal UFS filesystem.
 264  */
 265 #define MAXBSIZE        65536   /* must be power of 2 */
 266 #ifndef MAXBCACHEBUF
 267 #define MAXBCACHEBUF    MAXBSIZE /* must be a power of 2 >= MAXBSIZE */
 268 #endif
 269 #ifndef BKVASIZE
 270 #define BKVASIZE        16384   /* must be power of 2 */
 271 #endif
 272 #define BKVAMASK        (BKVASIZE-1)
 273
 274 /*
 275  * MAXPATHLEN defines the longest permissible path length after expanding
 276  * symbolic links. It is used to allocate a temporary buffer from the buffer
 277  * pool in which to do the name expansion, hence should be a power of two,
 278  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
 279  * maximum number of symbolic links that may be expanded in a path name.
 280  * It should be set high enough to allow all legitimate uses, but halt
 281  * infinite loops reasonably quickly.
 282  */
 283 #define MAXPATHLEN      PATH_MAX
 284 #define MAXSYMLINKS     32
 285
 286 /* Bit map related macros. */
 287 #define setbit(a,i)     (((unsigned char *)(a))[(i)/NBBY] |= 1<<((i)%NBBY))
 288 #define clrbit(a,i)     (((unsigned char *)(a))[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 289 #define isset(a,i)                                                      \
 290         (((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY)))
 291 #define isclr(a,i)                                                      \
 292         ((((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 293
 294 /* Macros for counting and rounding. */
 295 #ifndef howmany
 296 #define howmany(x, y)   (((x)+((y)-1))/(y))
 297 #endif
 298 #define nitems(x)       (sizeof((x)) / sizeof((x)[0]))
 299 #define rounddown(x, y) (((x)/(y))*(y))
 300 #define rounddown2(x, y) ((x)&(~((y)-1)))          /* if y is power of two */
 301 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
 302 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
 303 #define powerof2(x)     ((((x)-1)&(x))==0)
 304
 305 /* Macros for min/max. */
 306 #define MIN(a,b) (((a)<(b))?(a):(b))
 307 #define MAX(a,b) (((a)>(b))?(a):(b))
 308
 309 #ifdef _KERNEL
 310 /*
 311  * Basic byte order function prototypes for non-inline functions.
 312  */
 313 #ifndef LOCORE
 314 #ifndef _BYTEORDER_PROTOTYPED
 315 #define _BYTEORDER_PROTOTYPED
 316 __BEGIN_DECLS
 317 __uint32_t       htonl(__uint32_t);
 318 __uint16_t       htons(__uint16_t);
 319 __uint32_t       ntohl(__uint32_t);
 320 __uint16_t       ntohs(__uint16_t);
 321 __END_DECLS
 322 #endif
 323 #endif
 324
 325 #ifndef _BYTEORDER_FUNC_DEFINED
 326 #define _BYTEORDER_FUNC_DEFINED
 327 #define htonl(x)        __htonl(x)
 328 #define htons(x)        __htons(x)
 329 #define ntohl(x)        __ntohl(x)
 330 #define ntohs(x)        __ntohs(x)
 331 #endif /* !_BYTEORDER_FUNC_DEFINED */
 332 #endif /* _KERNEL */
 333
 334 /*
 335  * Scale factor for scaled integers used to count %cpu time and load avgs.
 336  *
 337  * The number of CPU `tick's that map to a unique `%age' can be expressed
 338  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
 339  * can be calculated (assuming 32 bits) can be closely approximated using
 340  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
 341  *
 342  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
 343  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
 344  */
 345 #define FSHIFT  11              /* bits to right of fixed binary point */
 346 #define FSCALE  (1<<FSHIFT)
 347
 348 #define dbtoc(db)                       /* calculates devblks to pages */ \
 349         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
 350
 351 #define ctodb(db)                       /* calculates pages to devblks */ \
 352         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
 353
 354 /*
 355  * Old spelling of __containerof().
 356  */
 357 #define member2struct(s, m, x)                                          \
 358         ((struct s *)(void *)((char *)(x) - offsetof(struct s, m)))
 359
 360 /*
 361  * Access a variable length array that has been declared as a fixed
 362  * length array.
 363  */
 364 #define __PAST_END(array, offset) (((__typeof__(*(array)) *)(array))[offset])
 365
 366 #endif  /* _SYS_PARAM_H_ */