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