sys/cpu/x86_64/include/param.h

   1 /*-
   2  * Copyright (c) 1990 The Regents of the University of California.
   3  * Copyright (c) 2008 The DragonFly Project.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * William Jolitz.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the University of
  20  *      California, Berkeley and its contributors.
  21  * 4. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  *      from: @(#)param.h       5.8 (Berkeley) 6/28/91
  38  * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 dillon 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        x86_64
  71 #endif
  72 #ifndef _MACHINE_ARCH
  73 #define _MACHINE_ARCH   x86_64
  74 #endif
  75
  76 #endif  /* _CPU_PARAM_H1_ */
  77
  78 #ifndef _NO_NAMESPACE_POLLUTION
  79
  80 #ifndef MACHINE
  81 #define MACHINE         "x86_64"
  82 #endif
  83 #ifndef MACHINE_ARCH
  84 #define MACHINE_ARCH    "x86_64"
  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      64
  92 #define MAXCPU          SMP_MAXCPU
  93
  94 #define ALIGNBYTES      _ALIGNBYTES
  95 #define ALIGN(p)        _ALIGN(p)
  96
  97 /* JG license? from fbsd/src/sys/amd64/include/param.h */
  98 /* level 1 == page table */
  99 #define NPTEPGSHIFT     9               /* LOG2(NPTEPG) */
 100 #define PAGE_SHIFT      12              /* LOG2(PAGE_SIZE) */
 101 #define PAGE_SIZE       (1<<PAGE_SHIFT) /* bytes/page */
 102 #define PAGE_MASK       (PAGE_SIZE-1)
 103 #define NPTEPG          (PAGE_SIZE/(sizeof (pt_entry_t)))
 104
 105 /* level 2 == page directory */
 106 #define NPDEPGSHIFT     9               /* LOG2(NPDEPG) */
 107 #define PDRSHIFT        21              /* LOG2(NBPDR) */
 108 #define NBPDR           (1<<PDRSHIFT)   /* bytes/page dir */
 109 #define PDRMASK         (NBPDR-1)
 110 #define NPDEPG          (PAGE_SIZE/(sizeof (pd_entry_t)))
 111
 112 /* level 3 == page directory pointer table */
 113 #define NPDPEPGSHIFT    9               /* LOG2(NPDPEPG) */
 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 NPML4EPGSHIFT   9               /* LOG2(NPML4EPG) */
 121 #define PML4SHIFT       39              /* LOG2(NPML4) */
 122 #define NPML4           (1UL<<PML4SHIFT)/* bytes/page map level4 table */
 123 #define NBPML4          (1ul<<PML4SHIFT)/* bytes/page map lev4 table */
 124 #define PML4MASK        (NPML4-1)
 125 #define NPML4EPG        (PAGE_SIZE/(sizeof (pml4_entry_t)))
 126
 127 /*
 128  * Virtual address sign-extension and mask.  If bit 47 is set then
 129  * set all higher bits.
 130  */
 131 #define PML4_SIGNMASK  0xFFFF800000000000LU
 132
 133 /* for vkernel */
 134 #define SEG_SHIFT       21
 135 #define SEG_SIZE        (1<<SEG_SHIFT)  /* bytes per mmu segment (level 1) */
 136 #define SEG_MASK        (SEG_SIZE-1)
 137
 138 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 139 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 140 #define DEV_BMASK       (DEV_BSIZE - 1)
 141
 142 #ifndef BLKDEV_IOSIZE
 143 #define BLKDEV_IOSIZE   PAGE_SIZE       /* default block device I/O size */
 144 #endif
 145 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 146 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
 147 #define MAXDUMPPGS      (MAXPHYS/PAGE_SIZE)
 148
 149 #define IOPAGES         2               /* pages of i/o permission bitmap */
 150 #define UPAGES          4               /* pages of u-area */
 151
 152 /*
 153  * Ceiling on amount of swblock kva space, can be changed via
 154  * kern.maxswzone /boot/loader.conf variable.  On 64 bit machines
 155  * the kernel has a 512G address space so reserving 512M of KVM
 156  * is not a big deal.
 157  *
 158  * Approximately (size / 160 x 32 x PAGE_SIZE) bytes of swap.  This
 159  * comes to approximately 1GB of swap space per 1MB of kernel memory.
 160  * Actually using 512G of swap will tie up a big chunk (512M) of physical
 161  * memory.
 162  */
 163 #ifndef VM_SWZONE_SIZE_MAX
 164 #define VM_SWZONE_SIZE_MAX      (512L * 1024 * 1024)
 165 #endif
 166
 167 /*
 168  * Ceiling on size of buffer cache (really only effects write queueing,
 169  * the VM page cache is not effected), can be changed via
 170  * kern.maxbcache /boot/loader.conf variable.
 171  *
 172  * This value is unbounded on 64-bit boxes, boot code will limit the
 173  * buffer cache size to a portion of available physical memory.
 174  */
 175 #ifndef VM_BCACHE_SIZE_MAX
 176 #define VM_BCACHE_SIZE_MAX      0
 177 #endif
 178
 179 /*
 180  * Some macros for units conversion
 181  */
 182
 183 /* clicks to bytes */
 184 #define ctob(x) ((x)<<PAGE_SHIFT)
 185
 186 /* bytes to clicks */
 187 #define btoc(x) (((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
 188
 189 /*
 190  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 191  * want to shift an unsigned type to avoid sign extension and we don't
 192  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 193  * a daddr_t.
 194  */
 195 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 196         (sizeof (bytes) > sizeof(long) \
 197          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 198          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 199
 200 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 201         ((off_t)(db) << DEV_BSHIFT)
 202
 203 /*
 204  * Mach derived conversion macros
 205  */
 206 #define round_page(x)   ((((unsigned long)(x)) + PAGE_MASK) & ~(unsigned long)(PAGE_MASK))
 207 #define trunc_page(x)   ((unsigned long)(x) & ~(unsigned long)(PAGE_MASK))
 208 #define trunc_2mpage(x) ((unsigned long)(x) & ~(unsigned long)PDRMASK)
 209 #define round_2mpage(x) ((((unsigned long)(x)) + PDRMASK) & ~(unsigned long)PDRMASK)
 210
 211 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 212 #define atop(x)         ((vm_pindex_t)((x) >> PAGE_SHIFT))
 213 #endif
 214 #define ptoa(x)         ((vm_paddr_t)(x) << PAGE_SHIFT)
 215
 216 #define x86_64_btop(x)  ((vm_pindex_t)((x) >> PAGE_SHIFT))
 217 #define x86_64_ptob(x)  ((vm_paddr_t)(x) << PAGE_SHIFT)
 218
 219 #define pgtok(x)                ((x) * (PAGE_SIZE / 1024))
 220
 221 #ifdef _KERNEL
 222
 223 /*
 224  * We put here the definition of two debugging macros/function which
 225  * are very convenient to have available.
 226  * The macro is called TSTMP() and is used to timestamp events in the
 227  * kernel using the TSC register, and export them to userland through
 228  * the sysctl variable debug.timestamp, which is a circular buffer
 229  * holding pairs of u_int32_t variables <timestamp, argument> .
 230  * They can be retrieved with something like
 231  *
 232  *      sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
 233  *
 234  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
 235  * try to grab any locks or block interrupts or identify which CPU it
 236  * is running on. You are supposed to know what to do if you use it.
 237  *
 238  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
 239  * config file, otherwise they default to an empty block.
 240  */
 241
 242 #ifdef KERN_TIMESTAMP
 243 extern void _TSTMP(u_int32_t argument);
 244 #define TSTMP(class, unit, event, par)  _TSTMP( \
 245         (((class) &   0x0f) << 28 ) |           \
 246         (((unit)  &   0x0f) << 24 ) |           \
 247         (((event) &   0xff) << 16 ) |           \
 248         (((par)   & 0xffff)       )   )
 249
 250 #else /* !KERN_TIMESTAMP */
 251 #define        _TSTMP(x)                       {}
 252 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
 253 #endif /* !KERN_TIMESTAMP */
 254 #endif /* _KERNEL */
 255
 256 #endif /* !_NO_NAMESPACE_POLLUTION */
 257 #endif /* !_CPU_PARAM_H_ */