sys/i386/include/param.h

   1 /*-
   2  * Copyright (c) 1990 The Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * William Jolitz.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      from: @(#)param.h       5.8 (Berkeley) 6/28/91
  37  * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 dillon Exp $
  38  * $DragonFly: src/sys/i386/include/Attic/param.h,v 1.3 2003/06/28 04:16:03 dillon Exp $
  39  */
  40
  41 #ifndef _MACHINE_PARAM_H_
  42 #define _MACHINE_PARAM_H_
  43
  44 /*
  45  * Machine dependent constants for Intel 386.
  46  */
  47
  48 /*
  49  * Round p (pointer or byte index) up to a correctly-aligned value
  50  * for all data types (int, long, ...).   The result is unsigned int
  51  * and must be cast to any desired pointer type.
  52  */
  53 #ifndef _ALIGNBYTES
  54 #define _ALIGNBYTES     (sizeof(int) - 1)
  55 #endif
  56 #ifndef _ALIGN
  57 #define _ALIGN(p)       (((unsigned)(p) + _ALIGNBYTES) & ~_ALIGNBYTES)
  58 #endif
  59
  60 #ifndef _MACHINE
  61 #define _MACHINE        i386
  62 #endif
  63 #ifndef _MACHINE_ARCH
  64 #define _MACHINE_ARCH   i386
  65 #endif
  66
  67 #ifndef _NO_NAMESPACE_POLLUTION
  68
  69 #ifndef MACHINE
  70 #define MACHINE         "i386"
  71 #endif
  72 #ifndef MACHINE_ARCH
  73 #define MACHINE_ARCH    "i386"
  74 #endif
  75 #define MID_MACHINE     MID_I386
  76
  77 /*
  78  * OBJFORMAT_NAMES is a comma-separated list of the object formats
  79  * that are supported on the architecture.
  80  */
  81 #define OBJFORMAT_NAMES         "elf", "aout"
  82 #define OBJFORMAT_DEFAULT       "elf"
  83
  84 #ifdef SMP
  85 #define MAXCPU          16
  86 #else
  87 #define MAXCPU          1
  88 #endif /* SMP */
  89
  90 #define ALIGNBYTES      _ALIGNBYTES
  91 #define ALIGN(p)        _ALIGN(p)
  92
  93 #define PAGE_SHIFT      12              /* LOG2(PAGE_SIZE) */
  94 #define PAGE_SIZE       (1<<PAGE_SHIFT) /* bytes/page */
  95 #define PAGE_MASK       (PAGE_SIZE-1)
  96 #define NPTEPG          (PAGE_SIZE/(sizeof (pt_entry_t)))
  97
  98 #define NPDEPG          (PAGE_SIZE/(sizeof (pd_entry_t)))
  99 #define PDRSHIFT        22              /* LOG2(NBPDR) */
 100 #define NBPDR           (1<<PDRSHIFT)   /* bytes/page dir */
 101 #define PDRMASK         (NBPDR-1)
 102
 103 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 104 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 105
 106 #ifndef BLKDEV_IOSIZE
 107 #define BLKDEV_IOSIZE   PAGE_SIZE       /* default block device I/O size */
 108 #endif
 109 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 110 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
 111 #define MAXDUMPPGS      (DFLTPHYS/PAGE_SIZE)
 112
 113 #define IOPAGES 2               /* pages of i/o permission bitmap */
 114 #define UPAGES  3               /* pages of u-area */
 115
 116 /*
 117  * Ceiling on amount of swblock kva space, can be changed via
 118  * kern.maxswzone /boot/loader.conf variable.
 119  */
 120 #ifndef VM_SWZONE_SIZE_MAX
 121 #define VM_SWZONE_SIZE_MAX      (32 * 1024 * 1024)
 122 #endif
 123
 124 /*
 125  * Ceiling on size of buffer cache (really only effects write queueing,
 126  * the VM page cache is not effected), can be changed via
 127  * kern.maxbcache /boot/loader.conf variable.
 128  */
 129 #ifndef VM_BCACHE_SIZE_MAX
 130 #define VM_BCACHE_SIZE_MAX      (200 * 1024 * 1024)
 131 #endif
 132
 133
 134 /*
 135  * Constants related to network buffer management.
 136  * MCLBYTES must be no larger than CLBYTES (the software page size), and,
 137  * on machines that exchange pages of input or output buffers with mbuf
 138  * clusters (MAPPED_MBUFS), MCLBYTES must also be an integral multiple
 139  * of the hardware page size.
 140  */
 141 #ifndef MSIZE
 142 #define MSIZE           256             /* size of an mbuf */
 143 #endif  /* MSIZE */
 144
 145 #ifndef MCLSHIFT
 146 #define MCLSHIFT        11              /* convert bytes to m_buf clusters */
 147 #endif  /* MCLSHIFT */
 148 #define MCLBYTES        (1 << MCLSHIFT) /* size of an m_buf cluster */
 149 #define MCLOFSET        (MCLBYTES - 1)  /* offset within an m_buf cluster */
 150
 151 /*
 152  * Some macros for units conversion
 153  */
 154
 155 /* clicks to bytes */
 156 #define ctob(x) ((x)<<PAGE_SHIFT)
 157
 158 /* bytes to clicks */
 159 #define btoc(x) (((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
 160
 161 /*
 162  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 163  * want to shift an unsigned type to avoid sign extension and we don't
 164  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 165  * a daddr_t.
 166  */
 167 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 168         (sizeof (bytes) > sizeof(long) \
 169          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 170          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 171
 172 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 173         ((off_t)(db) << DEV_BSHIFT)
 174
 175 /*
 176  * Mach derived conversion macros
 177  */
 178 #define trunc_page(x)           ((x) & ~PAGE_MASK)
 179 #define round_page(x)           (((x) + PAGE_MASK) & ~PAGE_MASK)
 180 #define trunc_4mpage(x)         ((unsigned)(x) & ~PDRMASK)
 181 #define round_4mpage(x)         ((((unsigned)(x)) + PDRMASK) & ~PDRMASK)
 182
 183 #define atop(x)                 ((unsigned)(x) >> PAGE_SHIFT)
 184 #define ptoa(x)                 ((unsigned)(x) << PAGE_SHIFT)
 185
 186 #define i386_btop(x)            ((unsigned)(x) >> PAGE_SHIFT)
 187 #define i386_ptob(x)            ((unsigned)(x) << PAGE_SHIFT)
 188
 189 #define pgtok(x)                ((x) * (PAGE_SIZE / 1024))
 190
 191 #ifdef _KERNEL
 192
 193 /*
 194  * We put here the definition of two debugging macros/function which
 195  * are very convenient to have available.
 196  * The macro is called TSTMP() and is used to timestamp events in the
 197  * kernel using the TSC register, and export them to userland through
 198  * the sysctl variable debug.timestamp, which is a circular buffer
 199  * holding pairs of u_int32_t variables <timestamp, argument> .
 200  * They can be retrieved with something like
 201  *
 202  *      sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
 203  *
 204  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
 205  * try to grab any locks or block interrupts or identify which CPU it
 206  * is running on. You are supposed to know what to do if you use it.
 207  *
 208  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
 209  * config file, otherwise they default to an empty block.
 210  */
 211
 212 #ifdef KERN_TIMESTAMP
 213 extern void _TSTMP(u_int32_t argument);
 214 #define TSTMP(class, unit, event, par)  _TSTMP( \
 215         (((class) &   0x0f) << 28 ) |           \
 216         (((unit)  &   0x0f) << 24 ) |           \
 217         (((event) &   0xff) << 16 ) |           \
 218         (((par)   & 0xffff)       )   )
 219
 220 #else /* !KERN_TIMESTAMP */
 221 #define        _TSTMP(x)                       {}
 222 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
 223 #endif /* !KERN_TIMESTAMP */
 224 #endif /* _KERNEL */
 225
 226 #endif /* !_NO_NAMESPACE_POLLUTION */
 227 #endif /* !_MACHINE_PARAM_H_ */