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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)param.h     8.3 (Berkeley) 4/4/95
  39  * $FreeBSD$
  40  */
  41
  42 #ifndef _SYS_PARAM_H_
  43 #define _SYS_PARAM_H_
  44
  45 #define BSD     199506          /* System version (year & month). */
  46 #define BSD4_3  1
  47 #define BSD4_4  1
  48 #undef __FreeBSD_version
  49 #define __FreeBSD_version 500013        /* Master, propagated to newvers */
  50
  51 #ifndef NULL
  52 #define NULL    0
  53 #endif
  54
  55 #ifndef LOCORE
  56 #include <sys/types.h>
  57 #endif
  58
  59 /*
  60  * Machine-independent constants (some used in following include files).
  61  * Redefined constants are from POSIX 1003.1 limits file.
  62  *
  63  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
  64  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
  65  */
  66 #include <sys/syslimits.h>
  67
  68 #define MAXCOMLEN       16              /* max command name remembered */
  69 #define MAXINTERP       32              /* max interpreter file name length */
  70 #define MAXLOGNAME      17              /* max login name length (incl. NUL) */
  71 #define MAXUPRC         CHILD_MAX       /* max simultaneous processes */
  72 #define NCARGS          ARG_MAX         /* max bytes for an exec function */
  73 #define NGROUPS         NGROUPS_MAX     /* max number groups */
  74 #define NOFILE          OPEN_MAX        /* max open files per process */
  75 #define NOGROUP         65535           /* marker for empty group set member */
  76 #define MAXHOSTNAMELEN  256             /* max hostname size */
  77 #define SPECNAMELEN     15              /* max length of devicename */
  78
  79 /* More types and definitions used throughout the kernel. */
  80 #ifdef _KERNEL
  81 #include <sys/cdefs.h>
  82 #include <sys/errno.h>
  83 #include <sys/time.h>
  84
  85 #define FALSE   0
  86 #define TRUE    1
  87 #endif
  88
  89 #ifndef _KERNEL
  90 /* Signals. */
  91 #include <sys/signal.h>
  92 #endif
  93
  94 /* Machine type dependent parameters. */
  95 #include <machine/param.h>
  96 #ifndef _KERNEL
  97 #include <machine/limits.h>
  98 #endif
  99
 100 /*
 101  * Priorities.  Note that with 32 run queues, differences less than 4 are
 102  * insignificant.
 103  */
 104 #define PSWP    0
 105 #define PVM     4
 106 #define PINOD   8
 107 #define PRIBIO  16
 108 #define PVFS    20
 109 #define PZERO   22              /* No longer magic, shouldn't be here.  XXX */
 110 #define PSOCK   24
 111 #define PWAIT   32
 112 #define PCONFIG 32
 113 #define PLOCK   36
 114 #define PPAUSE  40
 115 #define PUSER   48
 116 #define MAXPRI  127             /* Priorities range from 0 through MAXPRI. */
 117
 118 #define PRIMASK 0x0ff
 119 #define PCATCH  0x100           /* OR'd with pri for tsleep to check signals */
 120 #define PDROP   0x200   /* OR'd with pri to stop re-entry of interlock mutex */
 121
 122 #define NZERO   0               /* default "nice" */
 123
 124 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
 125
 126 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
 127 #ifdef _KERNEL
 128 #define NODEV   (dev_t)(-1)     /* non-existent device */
 129 #define NOUDEV  (udev_t)(-1)    /* non-existent device */
 130 #define NOMAJ   256             /* non-existent device */
 131 #else
 132 #define NODEV   (dev_t)(-1)     /* non-existent device */
 133 #endif
 134
 135 #define CBLOCK  128             /* Clist block size, must be a power of 2. */
 136 #define CBQSIZE (CBLOCK/NBBY)   /* Quote bytes/cblock - can do better. */
 137                                 /* Data chars/clist. */
 138 #define CBSIZE  (CBLOCK - sizeof(struct cblock *) - CBQSIZE)
 139 #define CROUND  (CBLOCK - 1)    /* Clist rounding. */
 140
 141 /*
 142  * File system parameters and macros.
 143  *
 144  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
 145  *              per block.  MAXBSIZE may be made larger without effecting
 146  *              any existing filesystems as long as it does not exceed MAXPHYS,
 147  *              and may be made smaller at the risk of not being able to use
 148  *              filesystems which require a block size exceeding MAXBSIZE.
 149  *
 150  * BKVASIZE -   Nominal buffer space per buffer, in bytes.  BKVASIZE is the
 151  *              minimum KVM memory reservation the kernel is willing to make.
 152  *              Filesystems can of course request smaller chunks.  Actual
 153  *              backing memory uses a chunk size of a page (PAGE_SIZE).
 154  *
 155  *              If you make BKVASIZE too small you risk seriously fragmenting
 156  *              the buffer KVM map which may slow things down a bit.  If you
 157  *              make it too big the kernel will not be able to optimally use
 158  *              the KVM memory reserved for the buffer cache and will wind
 159  *              up with too-few buffers.
 160  *
 161  *              The default is 16384, roughly 2x the block size used by a
 162  *              normal UFS filesystem.
 163  */
 164 #define MAXBSIZE        65536   /* must be power of 2 */
 165 #define BKVASIZE        16384   /* must be power of 2 */
 166 #define BKVAMASK        (BKVASIZE-1)
 167 #define MAXFRAG         8
 168
 169 /*
 170  * MAXPATHLEN defines the longest permissible path length after expanding
 171  * symbolic links. It is used to allocate a temporary buffer from the buffer
 172  * pool in which to do the name expansion, hence should be a power of two,
 173  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
 174  * maximum number of symbolic links that may be expanded in a path name.
 175  * It should be set high enough to allow all legitimate uses, but halt
 176  * infinite loops reasonably quickly.
 177  */
 178 #define MAXPATHLEN      PATH_MAX
 179 #define MAXSYMLINKS     32
 180
 181 /* Bit map related macros. */
 182 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
 183 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 184 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
 185 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 186
 187 /* Macros for counting and rounding. */
 188 #ifndef howmany
 189 #define howmany(x, y)   (((x)+((y)-1))/(y))
 190 #endif
 191 #define rounddown(x, y) (((x)/(y))*(y))
 192 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
 193 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
 194 #define powerof2(x)     ((((x)-1)&(x))==0)
 195
 196 /* Macros for min/max. */
 197 #ifndef _KERNEL
 198 #define MIN(a,b) (((a)<(b))?(a):(b))
 199 #define MAX(a,b) (((a)>(b))?(a):(b))
 200 #endif
 201
 202 /*
 203  * Constants for setting the parameters of the kernel memory allocator.
 204  *
 205  * 2 ** MINBUCKET is the smallest unit of memory that will be
 206  * allocated. It must be at least large enough to hold a pointer.
 207  *
 208  * Units of memory less or equal to MAXALLOCSAVE will permanently
 209  * allocate physical memory; requests for these size pieces of
 210  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
 211  * always allocate and free physical memory; requests for these
 212  * size allocations should be done infrequently as they will be slow.
 213  *
 214  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
 215  * MAXALLOCSIZE must be a power of two.
 216  */
 217 #if defined(__alpha__) || defined(__ia64__)
 218 #define MINBUCKET       5               /* 5 => min allocation of 32 bytes */
 219 #else
 220 #define MINBUCKET       4               /* 4 => min allocation of 16 bytes */
 221 #endif
 222 #define MAXALLOCSAVE    (2 * PAGE_SIZE)
 223
 224 /*
 225  * Scale factor for scaled integers used to count %cpu time and load avgs.
 226  *
 227  * The number of CPU `tick's that map to a unique `%age' can be expressed
 228  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
 229  * can be calculated (assuming 32 bits) can be closely approximated using
 230  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
 231  *
 232  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
 233  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
 234  */
 235 #define FSHIFT  11              /* bits to right of fixed binary point */
 236 #define FSCALE  (1<<FSHIFT)
 237
 238 #define dbtoc(db)                       /* calculates devblks to pages */ \
 239         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
 240
 241 #define ctodb(db)                       /* calculates pages to devblks */ \
 242         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
 243
 244
 245 /*
 246  * Make this available for most of the kernel.  There were too many
 247  * things that included sys/systm.h just for panic().
 248  */
 249 #ifdef _KERNEL
 250 void    panic __P((const char *, ...)) __dead2 __printflike(1, 2);
 251 #endif
 252 #endif  /* _SYS_PARAM_H_ */