sys/cpu/amd64/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/cpu/amd64/include/param.h,v 1.3 2007/09/23 04:29:30 yanyh Exp $
  39  */
  40
  41 #ifndef _CPU_PARAM_H_
  42
  43 /*
  44  * Do not prevent re-includes of <machine/param.h> if the file was included
  45  * with NO_NAMESPACE_POLLUTION, or expected macros will not exist.
  46  */
  47 #ifndef _NO_NAMESPACE_POLLUTION
  48 #define _CPU_PARAM_H_
  49 #endif
  50
  51 /*
  52  * Machine dependent constants for x86_64.
  53  */
  54 #ifndef _CPU_PARAM_H1_
  55 #define _CPU_PARAM_H1_
  56
  57 /*
  58  * Round p (pointer or byte index) up to a correctly-aligned value
  59  * for all data types (int, long, ...).   The result is unsigned int
  60  * and must be cast to any desired pointer type.
  61  */
  62 #ifndef _ALIGNBYTES
  63 #define _ALIGNBYTES     (sizeof(long) - 1)
  64 #endif
  65 #ifndef _ALIGN
  66 #define _ALIGN(p)       (((unsigned long)(p) + _ALIGNBYTES) & ~_ALIGNBYTES)
  67 #endif
  68
  69 #ifndef _MACHINE
  70 #define _MACHINE        amd64
  71 #endif
  72 #ifndef _MACHINE_ARCH
  73 #define _MACHINE_ARCH   amd64
  74 #endif
  75
  76 #endif  /* _CPU_PARAM_H1_ */
  77
  78 #ifndef _NO_NAMESPACE_POLLUTION
  79
  80 #ifndef MACHINE
  81 #define MACHINE         "amd64"
  82 #endif
  83 #ifndef MACHINE_ARCH
  84 #define MACHINE_ARCH    "amd64"
  85 #endif
  86
  87 /*
  88  * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
  89  * remain compatible between UP and SMP builds.
  90  */
  91 #define SMP_MAXCPU      16
  92 #ifdef SMP
  93 #define MAXCPU          SMP_MAXCPU
  94 #else
  95 #define MAXCPU          1
  96 #endif /* SMP */
  97
  98 #define ALIGNBYTES      _ALIGNBYTES
  99 #define ALIGN(p)        _ALIGN(p)
 100
 101 /* level 1 == page table */
 102 #define PAGE_SHIFT      12              /* LOG2(PAGE_SIZE) */
 103 #define PAGE_SIZE       (1<<PAGE_SHIFT) /* bytes/page */
 104 #define PAGE_MASK       (PAGE_SIZE-1)
 105 #define NPTEPG          (PAGE_SIZE/(sizeof (pt_entry_t)))
 106
 107 /* level 2 == page directory */
 108 #define PDRSHIFT        21              /* LOG2(NBPDR) */
 109 #define NBPDR           (1<<PDRSHIFT)   /* bytes/page dir */
 110 #define PDRMASK         (NBPDR-1)
 111 #define NPDEPG          (PAGE_SIZE/(sizeof (pd_entry_t)))
 112
 113 /* level 3 == page directory pointer table */
 114 #define PDPSHIFT        30              /* LOG2(NBPDP) */
 115 #define NBPDP           (1<<PDPSHIFT)   /* bytes/page dir ptr table */
 116 #define PDPMASK         (NBPDP-1)
 117 #define NPDPEPG         (PAGE_SIZE/(sizeof (pdp_entry_t)))
 118
 119 /* level 4 */
 120 #define PML4SHIFT       39              /* LOG2(NPML4) */
 121 #define NPML4           (1UL<<PML4SHIFT)/* bytes/page map level4 table */
 122 #define PML4MASK        (NPML4-1)
 123 #define NPML4EPG        (PAGE_SIZE/(sizeof (pml4_entry_t)))
 124
 125 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 126 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 127 #define DEV_BMASK       (DEV_BSIZE - 1)
 128
 129 #ifndef BLKDEV_IOSIZE
 130 #define BLKDEV_IOSIZE   PAGE_SIZE       /* default block device I/O size */
 131 #endif
 132 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 133 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
 134 #define MAXDUMPPGS      (DFLTPHYS/PAGE_SIZE)
 135
 136 #define IOPAGES 2               /* pages of i/o permission bitmap */
 137 #define UPAGES  3               /* pages of u-area */
 138
 139 /*
 140  * Ceiling on amount of swblock kva space, can be changed via
 141  * kern.maxswzone /boot/loader.conf variable.
 142  */
 143 #ifndef VM_SWZONE_SIZE_MAX
 144 #define VM_SWZONE_SIZE_MAX      (32 * 1024 * 1024)
 145 #endif
 146
 147 /*
 148  * Ceiling on size of buffer cache (really only effects write queueing,
 149  * the VM page cache is not effected), can be changed via
 150  * kern.maxbcache /boot/loader.conf variable.
 151  */
 152 #ifndef VM_BCACHE_SIZE_MAX
 153 #define VM_BCACHE_SIZE_MAX      (200 * 1024 * 1024)
 154 #endif
 155
 156
 157 /*
 158  * Constants related to network buffer management.
 159  * MCLBYTES must be no larger than CLBYTES (the software page size), and,
 160  * on machines that exchange pages of input or output buffers with mbuf
 161  * clusters (MAPPED_MBUFS), MCLBYTES must also be an integral multiple
 162  * of the hardware page size.
 163  */
 164 #ifndef MSIZE
 165 #define MSIZE           256             /* size of an mbuf */
 166 #endif  /* MSIZE */
 167
 168 #ifndef MCLSHIFT
 169 #define MCLSHIFT        11              /* convert bytes to m_buf clusters */
 170 #endif  /* MCLSHIFT */
 171 #define MCLBYTES        (1 << MCLSHIFT) /* size of an m_buf cluster */
 172 #define MCLOFSET        (MCLBYTES - 1)  /* offset within an m_buf cluster */
 173
 174 /*
 175  * Some macros for units conversion
 176  */
 177
 178 /* clicks to bytes */
 179 #define ctob(x) ((x)<<PAGE_SHIFT)
 180
 181 /* bytes to clicks */
 182 #define btoc(x) (((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
 183
 184 /*
 185  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 186  * want to shift an unsigned type to avoid sign extension and we don't
 187  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 188  * a daddr_t.
 189  */
 190 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 191         (sizeof (bytes) > sizeof(long) \
 192          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 193          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 194
 195 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 196         ((off_t)(db) << DEV_BSHIFT)
 197
 198 /*
 199  * Mach derived conversion macros
 200  */
 201 #define trunc_page(x)           ((x) & ~PAGE_MASK)
 202 #define round_page(x)           (((x) + PAGE_MASK) & ~PAGE_MASK)
 203 #define trunc_4mpage(x)         ((x) & ~PDRMASK)
 204 #define round_4mpage(x)         ((((x)) + PDRMASK) & ~PDRMASK)
 205
 206 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 207 #define atop(x)                 ((x) >> PAGE_SHIFT)
 208 #endif
 209 #define ptoa(x)                 ((x) << PAGE_SHIFT)
 210
 211 #define i386_btop(x)            ((x) >> PAGE_SHIFT)
 212 #define i386_ptob(x)            ((x) << PAGE_SHIFT)
 213
 214 #define pgtok(x)                ((x) * (PAGE_SIZE / 1024))
 215
 216 #ifdef _KERNEL
 217
 218 /*
 219  * We put here the definition of two debugging macros/function which
 220  * are very convenient to have available.
 221  * The macro is called TSTMP() and is used to timestamp events in the
 222  * kernel using the TSC register, and export them to userland through
 223  * the sysctl variable debug.timestamp, which is a circular buffer
 224  * holding pairs of u_int32_t variables <timestamp, argument> .
 225  * They can be retrieved with something like
 226  *
 227  *      sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
 228  *
 229  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
 230  * try to grab any locks or block interrupts or identify which CPU it
 231  * is running on. You are supposed to know what to do if you use it.
 232  *
 233  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
 234  * config file, otherwise they default to an empty block.
 235  */
 236
 237 #ifdef KERN_TIMESTAMP
 238 extern void _TSTMP(u_int32_t argument);
 239 #define TSTMP(class, unit, event, par)  _TSTMP( \
 240         (((class) &   0x0f) << 28 ) |           \
 241         (((unit)  &   0x0f) << 24 ) |           \
 242         (((event) &   0xff) << 16 ) |           \
 243         (((par)   & 0xffff)       )   )
 244
 245 #else /* !KERN_TIMESTAMP */
 246 #define        _TSTMP(x)                       {}
 247 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
 248 #endif /* !KERN_TIMESTAMP */
 249 #endif /* _KERNEL */
 250
 251 #endif /* !_NO_NAMESPACE_POLLUTION */
 252 #endif /* !_CPU_PARAM_H_ */