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  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)param.h     8.3 (Berkeley) 4/4/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _SYS_PARAM_H_
  39 #define _SYS_PARAM_H_
  40
  41 #include <sys/_null.h>
  42
  43 #define BSD     199506          /* System version (year & month). */
  44 #define BSD4_3  1
  45 #define BSD4_4  1
  46
  47 /*
  48  * __FreeBSD_version numbers are documented in the Porter's Handbook.
  49  * If you bump the version for any reason, you should update the documentation
  50  * there.
  51  * Currently this lives here:
  52  *
  53  *      doc/en_US.ISO8859-1/books/porters-handbook/book.sgml
  54  *
  55  * scheme is:  <major><two digit minor>Rxx
  56  *              'R' is in the range 0 to 4 if this is a release branch or
  57  *              x.0-CURRENT before RELENG_*_0 is created, otherwise 'R' is
  58  *              in the range 5 to 9.
  59  */
  60 #undef __FreeBSD_version
  61 #define __FreeBSD_version 801000        /* Master, propagated to newvers */
  62
  63 #ifndef LOCORE
  64 #include <sys/types.h>
  65 #endif
  66
  67 /*
  68  * Machine-independent constants (some used in following include files).
  69  * Redefined constants are from POSIX 1003.1 limits file.
  70  *
  71  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
  72  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
  73  */
  74 #include <sys/syslimits.h>
  75
  76 #define MAXCOMLEN       19              /* max command name remembered */
  77 #define MAXINTERP       32              /* max interpreter file name length */
  78 #define MAXLOGNAME      17              /* max login name length (incl. NUL) */
  79 #define MAXUPRC         CHILD_MAX       /* max simultaneous processes */
  80 #define NCARGS          ARG_MAX         /* max bytes for an exec function */
  81 #define NGROUPS         (NGROUPS_MAX+1) /* max number groups */
  82 #define NOFILE          OPEN_MAX        /* max open files per process */
  83 #define NOGROUP         65535           /* marker for empty group set member */
  84 #define MAXHOSTNAMELEN  256             /* max hostname size */
  85 #define SPECNAMELEN     63              /* max length of devicename */
  86
  87 /* More types and definitions used throughout the kernel. */
  88 #ifdef _KERNEL
  89 #include <sys/cdefs.h>
  90 #include <sys/errno.h>
  91 #ifndef LOCORE
  92 #include <sys/time.h>
  93 #include <sys/priority.h>
  94 #endif
  95
  96 #ifndef FALSE
  97 #define FALSE   0
  98 #endif
  99 #ifndef TRUE
 100 #define TRUE    1
 101 #endif
 102 #endif
 103
 104 #ifndef _KERNEL
 105 /* Signals. */
 106 #include <sys/signal.h>
 107 #endif
 108
 109 /* Machine type dependent parameters. */
 110 #include <machine/param.h>
 111 #ifndef _KERNEL
 112 #include <sys/limits.h>
 113 #endif
 114
 115 #ifndef _NO_NAMESPACE_POLLUTION
 116
 117 #ifndef DEV_BSHIFT
 118 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 119 #endif
 120 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 121
 122 #ifndef BLKDEV_IOSIZE
 123 #define BLKDEV_IOSIZE  PAGE_SIZE        /* default block device I/O size */
 124 #endif
 125 #ifndef DFLTPHYS
 126 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 127 #endif
 128 #ifndef MAXPHYS
 129 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
 130 #endif
 131 #ifndef MAXDUMPPGS
 132 #define MAXDUMPPGS      (DFLTPHYS/PAGE_SIZE)
 133 #endif
 134
 135 /*
 136  * Constants related to network buffer management.
 137  * MCLBYTES must be no larger than PAGE_SIZE.
 138  */
 139 #ifndef MSIZE
 140 #define MSIZE           256             /* size of an mbuf */
 141 #endif  /* MSIZE */
 142
 143 #ifndef MCLSHIFT
 144 #define MCLSHIFT        11              /* convert bytes to mbuf clusters */
 145 #endif  /* MCLSHIFT */
 146
 147 #define MCLBYTES        (1 << MCLSHIFT) /* size of an mbuf cluster */
 148
 149 #define MJUMPAGESIZE    PAGE_SIZE       /* jumbo cluster 4k */
 150 #define MJUM9BYTES      (9 * 1024)      /* jumbo cluster 9k */
 151 #define MJUM16BYTES     (16 * 1024)     /* jumbo cluster 16k */
 152
 153 /*
 154  * Some macros for units conversion
 155  */
 156
 157 /* clicks to bytes */
 158 #ifndef ctob
 159 #define ctob(x) ((x)<<PAGE_SHIFT)
 160 #endif
 161
 162 /* bytes to clicks */
 163 #ifndef btoc
 164 #define btoc(x) (((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT)
 165 #endif
 166
 167 /*
 168  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 169  * want to shift an unsigned type to avoid sign extension and we don't
 170  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 171  * a daddr_t.
 172  */
 173 #ifndef btodb
 174 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 175         (sizeof (bytes) > sizeof(long) \
 176          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 177          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 178 #endif
 179
 180 #ifndef dbtob
 181 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 182         ((off_t)(db) << DEV_BSHIFT)
 183 #endif
 184
 185 #endif /* _NO_NAMESPACE_POLLUTION */
 186
 187 #define PRIMASK 0x0ff
 188 #define PCATCH  0x100           /* OR'd with pri for tsleep to check signals */
 189 #define PDROP   0x200   /* OR'd with pri to stop re-entry of interlock mutex */
 190 #define PBDRY   0x400   /* for PCATCH stop is done on the user boundary */
 191
 192 #define NZERO   0               /* default "nice" */
 193
 194 #define NBBY    8               /* number of bits in a byte */
 195 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
 196
 197 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
 198
 199 #define NODEV   (dev_t)(-1)     /* non-existent device */
 200
 201 /*
 202  * File system parameters and macros.
 203  *
 204  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
 205  *              per block.  MAXBSIZE may be made larger without effecting
 206  *              any existing filesystems as long as it does not exceed MAXPHYS,
 207  *              and may be made smaller at the risk of not being able to use
 208  *              filesystems which require a block size exceeding MAXBSIZE.
 209  *
 210  * BKVASIZE -   Nominal buffer space per buffer, in bytes.  BKVASIZE is the
 211  *              minimum KVM memory reservation the kernel is willing to make.
 212  *              Filesystems can of course request smaller chunks.  Actual
 213  *              backing memory uses a chunk size of a page (PAGE_SIZE).
 214  *
 215  *              If you make BKVASIZE too small you risk seriously fragmenting
 216  *              the buffer KVM map which may slow things down a bit.  If you
 217  *              make it too big the kernel will not be able to optimally use
 218  *              the KVM memory reserved for the buffer cache and will wind
 219  *              up with too-few buffers.
 220  *
 221  *              The default is 16384, roughly 2x the block size used by a
 222  *              normal UFS filesystem.
 223  */
 224 #define MAXBSIZE        65536   /* must be power of 2 */
 225 #define BKVASIZE        16384   /* must be power of 2 */
 226 #define BKVAMASK        (BKVASIZE-1)
 227
 228 /*
 229  * MAXPATHLEN defines the longest permissible path length after expanding
 230  * symbolic links. It is used to allocate a temporary buffer from the buffer
 231  * pool in which to do the name expansion, hence should be a power of two,
 232  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
 233  * maximum number of symbolic links that may be expanded in a path name.
 234  * It should be set high enough to allow all legitimate uses, but halt
 235  * infinite loops reasonably quickly.
 236  */
 237 #define MAXPATHLEN      PATH_MAX
 238 #define MAXSYMLINKS     32
 239
 240 /* Bit map related macros. */
 241 #define setbit(a,i)     (((unsigned char *)(a))[(i)/NBBY] |= 1<<((i)%NBBY))
 242 #define clrbit(a,i)     (((unsigned char *)(a))[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 243 #define isset(a,i)                                                      \
 244         (((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY)))
 245 #define isclr(a,i)                                                      \
 246         ((((const unsigned char *)(a))[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 247
 248 /* Macros for counting and rounding. */
 249 #ifndef howmany
 250 #define howmany(x, y)   (((x)+((y)-1))/(y))
 251 #endif
 252 #define rounddown(x, y) (((x)/(y))*(y))
 253 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
 254 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
 255 #define powerof2(x)     ((((x)-1)&(x))==0)
 256
 257 /* Macros for min/max. */
 258 #define MIN(a,b) (((a)<(b))?(a):(b))
 259 #define MAX(a,b) (((a)>(b))?(a):(b))
 260
 261 #ifdef _KERNEL
 262 /*
 263  * Basic byte order function prototypes for non-inline functions.
 264  */
 265 #ifndef LOCORE
 266 #ifndef _BYTEORDER_PROTOTYPED
 267 #define _BYTEORDER_PROTOTYPED
 268 __BEGIN_DECLS
 269 __uint32_t       htonl(__uint32_t);
 270 __uint16_t       htons(__uint16_t);
 271 __uint32_t       ntohl(__uint32_t);
 272 __uint16_t       ntohs(__uint16_t);
 273 __END_DECLS
 274 #endif
 275 #endif
 276
 277 #ifndef lint
 278 #ifndef _BYTEORDER_FUNC_DEFINED
 279 #define _BYTEORDER_FUNC_DEFINED
 280 #define htonl(x)        __htonl(x)
 281 #define htons(x)        __htons(x)
 282 #define ntohl(x)        __ntohl(x)
 283 #define ntohs(x)        __ntohs(x)
 284 #endif /* !_BYTEORDER_FUNC_DEFINED */
 285 #endif /* lint */
 286 #endif /* _KERNEL */
 287
 288 /*
 289  * Scale factor for scaled integers used to count %cpu time and load avgs.
 290  *
 291  * The number of CPU `tick's that map to a unique `%age' can be expressed
 292  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
 293  * can be calculated (assuming 32 bits) can be closely approximated using
 294  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
 295  *
 296  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
 297  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
 298  */
 299 #define FSHIFT  11              /* bits to right of fixed binary point */
 300 #define FSCALE  (1<<FSHIFT)
 301
 302 #define dbtoc(db)                       /* calculates devblks to pages */ \
 303         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
 304
 305 #define ctodb(db)                       /* calculates pages to devblks */ \
 306         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
 307
 308 /*
 309  * Given the pointer x to the member m of the struct s, return
 310  * a pointer to the containing structure.
 311  */
 312 #define member2struct(s, m, x)                                          \
 313         ((struct s *)(void *)((char *)(x) - offsetof(struct s, m)))
 314
 315 #endif  /* _SYS_PARAM_H_ */