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. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      from: @(#)param.h       5.8 (Berkeley) 6/28/91
  34  * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 dillon Exp $
  35  */
  36
  37 #ifndef _CPU_PARAM_H_
  38 #define _CPU_PARAM_H_
  39
  40 /*
  41  * Machine dependent constants for x86_64.
  42  */
  43
  44 /*
  45  * Round p (pointer or byte index) up to a correctly-aligned value
  46  * for all data types (int, long, ...).   The result is unsigned int
  47  * and must be cast to any desired pointer type.
  48  */
  49 #ifndef _ALIGNBYTES
  50 #define _ALIGNBYTES     (sizeof(long) - 1)
  51 #endif
  52 #ifndef _ALIGN
  53 #define _ALIGN(p)       (((unsigned long)(p) + _ALIGNBYTES) & ~_ALIGNBYTES)
  54 #endif
  55
  56 #ifndef _MACHINE
  57 #define _MACHINE        x86_64
  58 #endif
  59 #ifndef _MACHINE_ARCH
  60 #define _MACHINE_ARCH   x86_64
  61 #endif
  62
  63 #ifndef MACHINE
  64 #define MACHINE         "x86_64"
  65 #endif
  66 #ifndef MACHINE_ARCH
  67 #define MACHINE_ARCH    "x86_64"
  68 #endif
  69
  70 /*
  71  * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
  72  * remain compatible between UP and SMP builds.
  73  *
  74  * WARNING!  CPUMASK macros in include/cpumask.h must also be adjusted,
  75  *           as well as any assembly.  Be sure that CPUMASK_ELEMENTS
  76  *           is always correct so incompatible assembly #error's out
  77  *           during the kernel compile.
  78  *
  79  * WARNING!  To raise SMP_MAXCPU further we probably need to reserve
  80  *           more KVM space via MPPTDI (platform/pc64/include/pmap.h),
  81  *           depends on SMP_MAXCPU * sizeof(struct privatedata).
  82  */
  83 #define SMP_MAXCPU      256
  84 #define MAXCPU          SMP_MAXCPU
  85
  86 #define ALIGNBYTES      _ALIGNBYTES
  87 #define ALIGN(p)        _ALIGN(p)
  88
  89 /* JG license? from fbsd/src/sys/amd64/include/param.h */
  90 /* level 1 == page table */
  91 #define NPTEPGSHIFT     9               /* LOG2(NPTEPG) */
  92 #define PAGE_SHIFT      12              /* LOG2(PAGE_SIZE) */
  93 #define PAGE_SIZE       (1<<PAGE_SHIFT) /* bytes/page */
  94 #define PAGE_MASK       (PAGE_SIZE-1)
  95 #define NPTEPG          (PAGE_SIZE/(sizeof (pt_entry_t)))
  96
  97 /* level 2 == page directory */
  98 #define NPDEPGSHIFT     9               /* LOG2(NPDEPG) */
  99 #define PDRSHIFT        21              /* LOG2(NBPDR) */
 100 #define NBPDR           (1<<PDRSHIFT)   /* bytes/page dir */
 101 #define PDRMASK         (NBPDR-1)
 102 #define NPDEPG          (PAGE_SIZE/(sizeof (pd_entry_t)))
 103
 104 /* level 3 == page directory pointer table */
 105 #define NPDPEPGSHIFT    9               /* LOG2(NPDPEPG) */
 106 #define PDPSHIFT        30              /* LOG2(NBPDP) */
 107 #define NBPDP           (1<<PDPSHIFT)   /* bytes/page dir ptr table */
 108 #define PDPMASK         (NBPDP-1)
 109 #define NPDPEPG         (PAGE_SIZE/(sizeof (pdp_entry_t)))
 110
 111 /* level 4 */
 112 #define NPML4EPGSHIFT   9               /* LOG2(NPML4EPG) */
 113 #define PML4SHIFT       39              /* LOG2(NPML4) */
 114 #define NPML4           (1UL<<PML4SHIFT)/* bytes/page map level4 table */
 115 #define NBPML4          (1ul<<PML4SHIFT)/* bytes/page map lev4 table */
 116 #define PML4MASK        (NPML4-1)
 117 #define NPML4EPG        (PAGE_SIZE/(sizeof (pml4_entry_t)))
 118
 119 /*
 120  * Virtual address sign-extension and mask.  If bit 47 is set then
 121  * set all higher bits.
 122  */
 123 #define PML4_SIGNMASK  0xFFFF800000000000LU
 124
 125 /* for vkernel */
 126 #define SEG_SHIFT       21
 127 #define SEG_SIZE        (1<<SEG_SHIFT)  /* bytes per mmu segment (level 1) */
 128 #define SEG_MASK        (SEG_SIZE-1)
 129
 130 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
 131 #define DEV_BSIZE       (1<<DEV_BSHIFT)
 132 #define DEV_BMASK       (DEV_BSIZE - 1)
 133
 134 #ifndef BLKDEV_IOSIZE
 135 #define BLKDEV_IOSIZE   PAGE_SIZE       /* default block device I/O size */
 136 #endif
 137 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
 138 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
 139 #define MAXDUMPPGS      (MAXPHYS/PAGE_SIZE)
 140
 141 #define IOPAGES         2               /* pages of i/o permission bitmap */
 142 #define UPAGES          4               /* pages of u-area */
 143
 144 /*
 145  * Ceiling on amount of swblock kva space, can be changed via
 146  * kern.maxswzone /boot/loader.conf variable.  On 64 bit machines
 147  * the kernel has a 512G address space so reserving 512M of KVM
 148  * is not a big deal.
 149  *
 150  * Approximately (size / 160 x 32 x PAGE_SIZE) bytes of swap.  This
 151  * comes to approximately 1GB of swap space per 1MB of kernel memory.
 152  * Actually using 512G of swap will tie up a big chunk (512M) of physical
 153  * memory.
 154  */
 155 #ifndef VM_SWZONE_SIZE_MAX
 156 #define VM_SWZONE_SIZE_MAX      (512L * 1024 * 1024)
 157 #endif
 158
 159 /*
 160  * Ceiling on size of buffer cache (really only effects write queueing,
 161  * the VM page cache is not effected), can be changed via
 162  * kern.maxbcache /boot/loader.conf variable.
 163  *
 164  * This value is unbounded on 64-bit boxes, boot code will limit the
 165  * buffer cache size to a portion of available physical memory.
 166  */
 167 #ifndef VM_BCACHE_SIZE_MAX
 168 #define VM_BCACHE_SIZE_MAX      0
 169 #endif
 170
 171 /*
 172  * Some macros for units conversion
 173  */
 174
 175 /* clicks to bytes */
 176 #define ctob(x) ((x)<<PAGE_SHIFT)
 177
 178 /* bytes to clicks */
 179 #define btoc(x) (((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
 180
 181 /*
 182  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 183  * want to shift an unsigned type to avoid sign extension and we don't
 184  * want to widen `bytes' unnecessarily.  Assume that the result fits in
 185  * a daddr_t.
 186  */
 187 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
 188         (sizeof (bytes) > sizeof(long) \
 189          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
 190          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
 191
 192 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
 193         ((off_t)(db) << DEV_BSHIFT)
 194
 195 /*
 196  * Mach derived conversion macros
 197  */
 198 #define round_page(x)   ((((unsigned long)(x)) + PAGE_MASK) & ~(unsigned long)(PAGE_MASK))
 199 #define trunc_page(x)   ((unsigned long)(x) & ~(unsigned long)(PAGE_MASK))
 200 #define trunc_2mpage(x) ((unsigned long)(x) & ~(unsigned long)PDRMASK)
 201 #define round_2mpage(x) ((((unsigned long)(x)) + PDRMASK) & ~(unsigned long)PDRMASK)
 202
 203 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 204 #define atop(x)         ((vm_pindex_t)((x) >> PAGE_SHIFT))
 205 #endif
 206 #define ptoa(x)         ((vm_paddr_t)(x) << PAGE_SHIFT)
 207
 208 #define x86_64_btop(x)  ((vm_pindex_t)((x) >> PAGE_SHIFT))
 209 #define x86_64_ptob(x)  ((vm_paddr_t)(x) << PAGE_SHIFT)
 210
 211 #define pgtok(x)                ((x) * (PAGE_SIZE / 1024))
 212
 213 #ifdef _KERNEL
 214
 215 /*
 216  * We put here the definition of two debugging macros/function which
 217  * are very convenient to have available.
 218  * The macro is called TSTMP() and is used to timestamp events in the
 219  * kernel using the TSC register, and export them to userland through
 220  * the sysctl variable debug.timestamp, which is a circular buffer
 221  * holding pairs of u_int32_t variables <timestamp, argument> .
 222  * They can be retrieved with something like
 223  *
 224  *      sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
 225  *
 226  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
 227  * try to grab any locks or block interrupts or identify which CPU it
 228  * is running on. You are supposed to know what to do if you use it.
 229  *
 230  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
 231  * config file, otherwise they default to an empty block.
 232  */
 233
 234 #ifdef KERN_TIMESTAMP
 235 extern void _TSTMP(u_int32_t argument);
 236 #define TSTMP(class, unit, event, par)  _TSTMP( \
 237         (((class) &   0x0f) << 28 ) |           \
 238         (((unit)  &   0x0f) << 24 ) |           \
 239         (((event) &   0xff) << 16 ) |           \
 240         (((par)   & 0xffff)       )   )
 241
 242 #else /* !KERN_TIMESTAMP */
 243 #define        _TSTMP(x)                       {}
 244 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
 245 #endif /* !KERN_TIMESTAMP */
 246 #endif /* _KERNEL */
 247
 248 #endif /* !_CPU_PARAM_H_ */