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: src/sys/sys/param.h,v 1.61.2.38 2003/05/22 17:12:01 fjoe Exp $
  40  * $DragonFly: src/sys/sys/param.h,v 1.49 2008/06/05 17:53:10 swildner Exp $
  41  */
  42
  43 #ifndef _SYS_PARAM_H_
  44 #define _SYS_PARAM_H_
  45
  46 #define BSD     200708          /* XXX kern.osrevision */
  47 #define BSD4_3  1               /* XXX obsolete */
  48 #define BSD4_4  1               /* XXX obsolete */
  49
  50 /*
  51  * __DragonFly_version number.  The number doesn't really meaningfully
  52  * translate to a version number.
  53  *
  54  * 170000 - base development version after 1.6 branch
  55  * 170001 - base development version before 1.8 branch
  56  * 190000 - base development version after 1.8 branch
  57  * 195000 - base development version after 1.10 branch
  58  * 197500 - base development version before 1.12 branch
  59  * 197600 - 1.12 branch
  60  * 197700 - base development version after 1.12 branch
  61  */
  62 #undef __DragonFly_version
  63 #define __DragonFly_version 197700      /* Master, propagated to newvers */
  64
  65 #ifdef __FreeBSD__
  66 /*
  67  * __FreeBSD_version numbers for source compatibility.  This is temporary
  68  * along with the __FreeBSD__ define in gcc2.  Note that gcc3 does not
  69  * define __FreeBSD__ by default, only __DragonFly__.
  70  */
  71 #undef __FreeBSD_version
  72 #define __FreeBSD_version 480101
  73 #endif
  74
  75 #include <sys/_null.h>
  76
  77 #ifndef LOCORE
  78 #include <sys/types.h>
  79 #endif
  80
  81 /*
  82  * Machine-independent constants (some used in following include files).
  83  * Redefined constants are from POSIX 1003.1 limits file.
  84  *
  85  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
  86  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
  87  */
  88 #include <sys/syslimits.h>
  89
  90 #define MAXCOMLEN       16              /* max command name remembered */
  91 #define MAXINTERP       32              /* max interpreter file name length */
  92 #define MAXLOGNAME      17              /* max login name length (incl. NUL) */
  93 #define MAXUPRC         CHILD_MAX       /* max simultaneous processes */
  94 #define NCARGS          ARG_MAX         /* max bytes for an exec function */
  95 #define NGROUPS         NGROUPS_MAX     /* max number groups */
  96 #define NOFILE          OPEN_MAX        /* max open files per process */
  97 #define NOGROUP         65535           /* marker for empty group set member */
  98 #define MAXHOSTNAMELEN  256             /* max hostname size */
  99
 100 /* More types and definitions used throughout the kernel. */
 101 #ifdef _KERNEL
 102 #include <sys/cdefs.h>
 103 #include <sys/errno.h>
 104 #include <sys/time.h>
 105
 106 #define FALSE   0
 107 #define TRUE    1
 108 #endif
 109
 110 #ifndef _KERNEL
 111 /* Signals. */
 112 #include <sys/select.h>
 113 #include <sys/signal.h>
 114 #endif
 115
 116 /* Machine type dependent parameters. */
 117 #include <machine/param.h>
 118 #ifndef _KERNEL
 119 #include <machine/limits.h>
 120 #endif
 121
 122 #define PCATCH          0x00000100      /* tsleep checks signals */
 123 #define PUSRFLAG1       0x00000200      /* Subsystem specific flag */
 124 #define PNORESCHED      0x00000400      /* No reschedule on wakeup */
 125 #define PWAKEUP_CPUMASK 0x00003FFF      /* start cpu for chained wakeups */
 126 #define PWAKEUP_MYCPU   0x00004000      /* wakeup on current cpu only */
 127 #define PWAKEUP_ONE     0x00008000      /* argument to wakeup: only one */
 128 #define PDOMAIN_MASK    0xFFFF0000      /* address domains for wakeup */
 129 #define PDOMAIN_UMTX    0x00010000      /* independant domain for UMTX */
 130 #define PWAKEUP_ENCODE(domain, cpu)     ((domain) | (cpu))
 131 #define PWAKEUP_DECODE(domain)          ((domain) & PWAKEUP_CPUMASK)
 132
 133 #define NZERO   0               /* default "nice" */
 134
 135 #define NBPW    sizeof(int)     /* number of bytes per word (integer) */
 136
 137 #define CMASK   022             /* default file mask: S_IWGRP|S_IWOTH */
 138 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 139 #define NOUDEV  (udev_t)(-1)    /* non-existent device */
 140 #define NOMAJ   256             /* non-existent device */
 141 #endif
 142
 143 #ifndef _KERNEL
 144 #define NODEV   (dev_t)(-1)     /* non-existent device */
 145 #endif
 146
 147 /*
 148  * File system parameters and macros.
 149  *
 150  * MAXBSIZE -   Filesystems are made out of blocks of at most MAXBSIZE bytes
 151  *              per block.  MAXBSIZE may be made larger without effecting
 152  *              any existing filesystems as long as it does not exceed MAXPHYS,
 153  *              and may be made smaller at the risk of not being able to use
 154  *              filesystems which require a block size exceeding MAXBSIZE.
 155  *
 156  * BKVASIZE -   Nominal buffer space per buffer, in bytes.  BKVASIZE is the
 157  *              minimum KVM memory reservation the kernel is willing to make.
 158  *              Filesystems can of course request smaller chunks.  Actual
 159  *              backing memory uses a chunk size of a page (PAGE_SIZE).
 160  *
 161  *              If you make BKVASIZE too small you risk seriously fragmenting
 162  *              the buffer KVM map which may slow things down a bit.  If you
 163  *              make it too big the kernel will not be able to optimally use
 164  *              the KVM memory reserved for the buffer cache and will wind
 165  *              up with too-few buffers.
 166  *
 167  *              The default is 16384, roughly 2x the block size used by a
 168  *              normal UFS filesystem.
 169  */
 170 #define MAXBSIZE        65536   /* must be power of 2 */
 171 #define BKVASIZE        16384   /* must be power of 2 */
 172 #define BKVAMASK        (BKVASIZE-1)
 173 #define MAXFRAG         8
 174
 175 /*
 176  * MAXPATHLEN defines the longest permissible path length after expanding
 177  * symbolic links. It is used to allocate a temporary buffer from the buffer
 178  * pool in which to do the name expansion, hence should be a power of two,
 179  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
 180  * maximum number of symbolic links that may be expanded in a path name.
 181  * It should be set high enough to allow all legitimate uses, but halt
 182  * infinite loops reasonably quickly.
 183  */
 184 #define MAXPATHLEN      PATH_MAX
 185 #define MAXSYMLINKS     32
 186
 187 /* Bit map related macros. */
 188 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
 189 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 190 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
 191 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 192
 193 /* Macros for counting and rounding. */
 194 #ifndef howmany
 195 #define howmany(x, y)   (((x)+((y)-1))/(y))
 196 #endif
 197 #define rounddown(x, y) (((x)/(y))*(y))
 198 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))  /* to any y */
 199 #define roundup2(x, y)  (((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
 200 #define powerof2(x)     ((((x)-1)&(x))==0)
 201
 202 /* Macros for min/max. */
 203 #define MIN(a,b) (((a)<(b))?(a):(b))
 204 #define MAX(a,b) (((a)>(b))?(a):(b))
 205
 206 /*
 207  * Constants for setting the parameters of the kernel memory allocator.
 208  *
 209  * 2 ** MINBUCKET is the smallest unit of memory that will be
 210  * allocated. It must be at least large enough to hold a pointer.
 211  *
 212  * Units of memory less or equal to MAXALLOCSAVE will permanently
 213  * allocate physical memory; requests for these size pieces of
 214  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
 215  * always allocate and free physical memory; requests for these
 216  * size allocations should be done infrequently as they will be slow.
 217  *
 218  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
 219  * MAXALLOCSIZE must be a power of two.
 220  */
 221 #define MINBUCKET       4               /* 4 => min allocation of 16 bytes */
 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 (const char *, ...) __dead2 __printflike(1, 2);
 251 #endif
 252
 253 #ifndef htonl
 254 #define htonl(x)        __htonl(x)
 255 #endif
 256 #ifndef htons
 257 #define htons(x)        __htons(x)
 258 #endif
 259 #ifndef ntohl
 260 #define ntohl(x)        __ntohl(x)
 261 #endif
 262 #ifndef ntohs
 263 #define ntohs(x)        __ntohs(x)
 264 #endif
 265
 266 #endif  /* _SYS_PARAM_H_ */