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 400015        /* 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
  78 /* More types and definitions used throughout the kernel. */
  79 #ifdef _KERNEL
  80 #include <sys/cdefs.h>
  81 #include <sys/errno.h>
  82 #include <sys/time.h>
  83
  84 #define FALSE   0
  85 #define TRUE    1
  86 #endif
  87
  88 #ifndef _KERNEL
  89 /* Signals. */
  90 #include <sys/signal.h>
  91 #endif
  92
  93 /* Machine type dependent parameters. */
  94 #include <machine/param.h>
  95 #ifndef _KERNEL
  96 #include <machine/limits.h>
  97 #endif
  98
  99 /*
 100  * Priorities.  Note that with 32 run queues, differences less than 4 are
 101  * insignificant.
 102  */
 103 #define PSWP    0
 104 #define PVM     4
 105 #define PINOD   8
 106 #define PRIBIO  16
 107 #define PVFS    20
 108 #define PZERO   22              /* No longer magic, shouldn't be here.  XXX */
 109 #define PSOCK   24
 110 #define PWAIT   32
 111 #define PCONFIG 32
 112 #define PLOCK   36
 113 #define PPAUSE  40
 114 #define PUSER   50
 115 #define MAXPRI  127             /* Priorities range from 0 through MAXPRI. */
 116
 117 #define PRIMASK 0x0ff
 118 #define PCATCH  0x100           /* OR'd with pri for tsleep to check signals */
 119
 120 #define NZERO   0               /* default "nice" */
 121
 122 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
 123
 124 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
 125 #ifdef _KERNEL
 126 #define NODEV   (dev_t)(-1)     /* non-existent device */
 127 #define NOUDEV  (udev_t)(-1)    /* non-existent device */
 128 #define NOMAJ   256             /* non-existent device */
 129 #else
 130 #define NODEV   (dev_t)(-1)     /* non-existent device */
 131 #endif
 132
 133 /*
 134  * Clustering of hardware pages on machines with ridiculously small
 135  * page sizes is done here.  The paging subsystem deals with units of
 136  * CLSIZE pte's describing PAGE_SIZE (from machine/machparam.h) pages each.
 137  */
 138 #if 0
 139 #define CLBYTES         (CLSIZE*PAGE_SIZE)
 140 #endif
 141
 142 #define CBLOCK  128             /* Clist block size, must be a power of 2. */
 143 #define CBQSIZE (CBLOCK/NBBY)   /* Quote bytes/cblock - can do better. */
 144                                 /* Data chars/clist. */
 145 #define CBSIZE  (CBLOCK - sizeof(struct cblock *) - CBQSIZE)
 146 #define CROUND  (CBLOCK - 1)    /* Clist rounding. */
 147
 148 /*
 149  * File system parameters and macros.
 150  *
 151  * The file system is made out of blocks of at most MAXBSIZE units, with
 152  * smaller units (fragments) only in the last direct block.  MAXBSIZE
 153  * primarily determines the size of buffers in the buffer pool.  It may be
 154  * made larger without any effect on existing file systems; however making
 155  * it smaller make make some file systems unmountable.  Also, MAXBSIZE
 156  * must be less than MAXPHYS!!!  DFLTBSIZE is the average amount of
 157  * memory allocated by vfs_bio per nbuf.  BKVASIZE is the average amount
 158  * of kernel virtual space allocated per nbuf.  BKVASIZE should be >=
 159  * DFLTBSIZE.  If it is significantly bigger than DFLTBSIZE, then
 160  * kva fragmentation causes fewer performance problems.
 161  */
 162 #define MAXBSIZE        65536
 163 #define BKVASIZE        8192
 164 #define DFLTBSIZE       4096
 165 #define MAXFRAG         8
 166
 167 /*
 168  * MAXPATHLEN defines the longest permissible path length after expanding
 169  * symbolic links. It is used to allocate a temporary buffer from the buffer
 170  * pool in which to do the name expansion, hence should be a power of two,
 171  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
 172  * maximum number of symbolic links that may be expanded in a path name.
 173  * It should be set high enough to allow all legitimate uses, but halt
 174  * infinite loops reasonably quickly.
 175  */
 176 #define MAXPATHLEN      PATH_MAX
 177 #define MAXSYMLINKS     32
 178
 179 /* Bit map related macros. */
 180 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
 181 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 182 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
 183 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 184
 185 /* Macros for counting and rounding. */
 186 #ifndef howmany
 187 #define howmany(x, y)   (((x)+((y)-1))/(y))
 188 #endif
 189 #define rounddown(x, y) (((x)/(y))*(y))
 190 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
 191 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
 192 #define powerof2(x)     ((((x)-1)&(x))==0)
 193
 194 /* Macros for min/max. */
 195 #ifndef _KERNEL
 196 #define MIN(a,b) (((a)<(b))?(a):(b))
 197 #define MAX(a,b) (((a)>(b))?(a):(b))
 198 #endif
 199
 200 /*
 201  * Constants for setting the parameters of the kernel memory allocator.
 202  *
 203  * 2 ** MINBUCKET is the smallest unit of memory that will be
 204  * allocated. It must be at least large enough to hold a pointer.
 205  *
 206  * Units of memory less or equal to MAXALLOCSAVE will permanently
 207  * allocate physical memory; requests for these size pieces of
 208  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
 209  * always allocate and free physical memory; requests for these
 210  * size allocations should be done infrequently as they will be slow.
 211  *
 212  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
 213  * MAXALLOCSIZE must be a power of two.
 214  */
 215 #if defined(__alpha__)
 216 #define MINBUCKET       5               /* 5 => min allocation of 32 bytes */
 217 #else
 218 #define MINBUCKET       4               /* 4 => min allocation of 16 bytes */
 219 #endif
 220 #define MAXALLOCSAVE    (2 * PAGE_SIZE)
 221
 222 /*
 223  * Scale factor for scaled integers used to count %cpu time and load avgs.
 224  *
 225  * The number of CPU `tick's that map to a unique `%age' can be expressed
 226  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
 227  * can be calculated (assuming 32 bits) can be closely approximated using
 228  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
 229  *
 230  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
 231  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
 232  */
 233 #define FSHIFT  11              /* bits to right of fixed binary point */
 234 #define FSCALE  (1<<FSHIFT)
 235
 236 #define dbtoc(db)                       /* calculates devblks to pages */ \
 237         ((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
 238
 239 #define ctodb(db)                       /* calculates pages to devblks */ \
 240         ((db) << (PAGE_SHIFT - DEV_BSHIFT))
 241
 242
 243 /*
 244  * Make this available for most of the kernel.  There were too many
 245  * things that included sys/systm.h just for panic().
 246  */
 247 #ifdef _KERNEL
 248 void    panic __P((const char *, ...)) __dead2 __printflike(1, 2);
 249 #endif
 250
 251 #endif  /* _SYS_PARAM_H_ */