sys/uvm/uvm_param.h

   1 /*      $NetBSD: uvm_param.h,v 1.21 2006/08/04 22:42:36 he Exp $        */
   2
   3 /*
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * The Mach Operating System project at Carnegie-Mellon University.
   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. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)vm_param.h  8.2 (Berkeley) 1/9/95
  35  *
  36  *
  37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  38  * All rights reserved.
  39  *
  40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  41  *
  42  * Permission to use, copy, modify and distribute this software and
  43  * its documentation is hereby granted, provided that both the copyright
  44  * notice and this permission notice appear in all copies of the
  45  * software, derivative works or modified versions, and any portions
  46  * thereof, and that both notices appear in supporting documentation.
  47  *
  48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  51  *
  52  * Carnegie Mellon requests users of this software to return to
  53  *
  54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  55  *  School of Computer Science
  56  *  Carnegie Mellon University
  57  *  Pittsburgh PA 15213-3890
  58  *
  59  * any improvements or extensions that they make and grant Carnegie the
  60  * rights to redistribute these changes.
  61  */
  62
  63 /*
  64  *      Machine independent virtual memory parameters.
  65  */
  66
  67 #ifndef _VM_PARAM_
  68 #define _VM_PARAM_
  69
  70 #ifdef _KERNEL_OPT
  71 #include "opt_uvm.h"
  72 #endif
  73 #ifdef _KERNEL
  74 #include <sys/types.h>
  75 #include <sys/lock.h>
  76 #include <machine/vmparam.h>
  77 #include <sys/resourcevar.h>
  78 #endif
  79
  80 #if defined(_KERNEL)
  81
  82 #if defined(PAGE_SIZE)
  83
  84 /*
  85  * If PAGE_SIZE is defined at this stage, it must be a constant.
  86  */
  87
  88 #if PAGE_SIZE == 0
  89 #error Invalid PAGE_SIZE definition
  90 #endif
  91
  92 /*
  93  * If the platform does not need to support a variable PAGE_SIZE,
  94  * then provide default values for MIN_PAGE_SIZE and MAX_PAGE_SIZE.
  95  */
  96
  97 #if !defined(MIN_PAGE_SIZE)
  98 #define MIN_PAGE_SIZE   PAGE_SIZE
  99 #endif /* ! MIN_PAGE_SIZE */
 100
 101 #if !defined(MAX_PAGE_SIZE)
 102 #define MAX_PAGE_SIZE   PAGE_SIZE
 103 #endif /* ! MAX_PAGE_SIZE */
 104
 105 #else /* ! PAGE_SIZE */
 106
 107 /*
 108  * PAGE_SIZE is not a constant; MIN_PAGE_SIZE and MAX_PAGE_SIZE must
 109  * be defined.
 110  */
 111
 112 #if !defined(MIN_PAGE_SIZE)
 113 #error MIN_PAGE_SIZE not defined
 114 #endif
 115
 116 #if !defined(MAX_PAGE_SIZE)
 117 #error MAX_PAGE_SIZE not defined
 118 #endif
 119
 120 #endif /* PAGE_SIZE */
 121
 122 /*
 123  * MIN_PAGE_SIZE and MAX_PAGE_SIZE must be constants.
 124  */
 125
 126 #if MIN_PAGE_SIZE == 0
 127 #error Invalid MIN_PAGE_SIZE definition
 128 #endif
 129
 130 #if MAX_PAGE_SIZE == 0
 131 #error Invalid MAX_PAGE_SIZE definition
 132 #endif
 133
 134 /*
 135  * If MIN_PAGE_SIZE and MAX_PAGE_SIZE are not equal, then we must use
 136  * non-constant PAGE_SIZE, et al for LKMs.
 137  */
 138 #if (MIN_PAGE_SIZE != MAX_PAGE_SIZE) && defined(_LKM)
 139 #undef PAGE_SIZE
 140 #undef PAGE_MASK
 141 #undef PAGE_SHIFT
 142 #endif
 143
 144 /*
 145  * Now provide PAGE_SIZE, PAGE_MASK, and PAGE_SHIFT if we do not
 146  * have ones that are compile-time constants.
 147  */
 148 #if !defined(PAGE_SIZE)
 149 #define PAGE_SIZE       uvmexp.pagesize         /* size of page */
 150 #define PAGE_MASK       uvmexp.pagemask         /* size of page - 1 */
 151 #define PAGE_SHIFT      uvmexp.pageshift        /* bits to shift for pages */
 152 #endif /* PAGE_SIZE */
 153
 154 #endif /* _KERNEL */
 155
 156 /*
 157  * CTL_VM identifiers
 158  */
 159 #define VM_METER        1               /* struct vmmeter */
 160 #define VM_LOADAVG      2               /* struct loadavg */
 161 #define VM_UVMEXP       3               /* struct uvmexp */
 162 #define VM_NKMEMPAGES   4               /* kmem_map pages */
 163 #define VM_UVMEXP2      5               /* struct uvmexp_sysctl */
 164 #define VM_ANONMIN      6
 165 #define VM_EXECMIN      7
 166 #define VM_FILEMIN      8
 167 #define VM_MAXSLP       9
 168 #define VM_USPACE       10
 169 #define VM_ANONMAX      11
 170 #define VM_EXECMAX      12
 171 #define VM_FILEMAX      13
 172
 173 #define VM_MAXID        14              /* number of valid vm ids */
 174
 175 #define CTL_VM_NAMES { \
 176         { 0, 0 }, \
 177         { "vmmeter", CTLTYPE_STRUCT }, \
 178         { "loadavg", CTLTYPE_STRUCT }, \
 179         { "uvmexp", CTLTYPE_STRUCT }, \
 180         { "nkmempages", CTLTYPE_INT }, \
 181         { "uvmexp2", CTLTYPE_STRUCT }, \
 182         { "anonmin", CTLTYPE_INT }, \
 183         { "execmin", CTLTYPE_INT }, \
 184         { "filemin", CTLTYPE_INT }, \
 185         { "maxslp", CTLTYPE_INT }, \
 186         { "uspace", CTLTYPE_INT }, \
 187         { "anonmax", CTLTYPE_INT }, \
 188         { "execmax", CTLTYPE_INT }, \
 189         { "filemax", CTLTYPE_INT }, \
 190 }
 191
 192 #ifndef ASSEMBLER
 193 /*
 194  *      Convert addresses to pages and vice versa.
 195  *      No rounding is used.
 196  */
 197 #ifdef _KERNEL
 198 #define atop(x)         (((paddr_t)(x)) >> PAGE_SHIFT)
 199 #define ptoa(x)         ((vaddr_t)((vaddr_t)(x) << PAGE_SHIFT))
 200
 201 /*
 202  * Round off or truncate to the nearest page.  These will work
 203  * for either addresses or counts (i.e., 1 byte rounds to 1 page).
 204  */
 205 #define round_page(x)   (((x) + PAGE_MASK) & ~PAGE_MASK)
 206 #define trunc_page(x)   ((x) & ~PAGE_MASK)
 207
 208 /*
 209  * Set up the default mapping address (VM_DEFAULT_ADDRESS) according to:
 210  *
 211  * USE_TOPDOWN_VM:      a kernel option to enable on a per-kernel basis
 212  *                      which only be used on ports that define...
 213  * __HAVE_TOPDOWN_VM:   a per-port option to offer the topdown option
 214  *
 215  * __USE_TOPDOWN_VM:    a per-port option to unconditionally use it
 216  *
 217  * if __USE_TOPDOWN_VM is defined, the port can specify a default vm
 218  * address, or we will use the topdown default from below.  If it is
 219  * NOT defined, then the port can offer topdown as an option, but it
 220  * MUST define the VM_DEFAULT_ADDRESS macro itself.
 221  */
 222 #if defined(USE_TOPDOWN_VM) || defined(__USE_TOPDOWN_VM)
 223 # if !defined(__HAVE_TOPDOWN_VM) && !defined(__USE_TOPDOWN_VM)
 224 #  error "Top down memory allocation not enabled for this system"
 225 # else /* !__HAVE_TOPDOWN_VM && !__USE_TOPDOWN_VM */
 226 #  define __USING_TOPDOWN_VM
 227 #  if !defined(VM_DEFAULT_ADDRESS)
 228 #   if !defined(__USE_TOPDOWN_VM)
 229 #    error "Top down memory allocation not configured for this system"
 230 #   else /* !__USE_TOPDOWN_VM */
 231 #    define VM_DEFAULT_ADDRESS(da, sz) \
 232         trunc_page(VM_MAXUSER_ADDRESS - MAXSSIZ - (sz))
 233 #   endif /* !__USE_TOPDOWN_VM */
 234 #  endif /* !VM_DEFAULT_ADDRESS */
 235 # endif /* !__HAVE_TOPDOWN_VM && !__USE_TOPDOWN_VM */
 236 #endif /* USE_TOPDOWN_VM || __USE_TOPDOWN_VM */
 237
 238 #if !defined(__USING_TOPDOWN_VM)
 239 # if defined(VM_DEFAULT_ADDRESS)
 240 #  error "Default vm address should not be defined here"
 241 # else /* VM_DEFAULT_ADDRESS */
 242 #  define VM_DEFAULT_ADDRESS(da, sz) round_page((vaddr_t)(da) + (vsize_t)maxdmap)
 243 # endif /* VM_DEFAULT_ADDRESS */
 244 #endif /* !__USING_TOPDOWN_VM */
 245
 246 extern int              ubc_nwins;      /* number of UBC mapping windows */
 247 extern int              ubc_winshift;   /* shift for a UBC mapping window */
 248 extern u_int            uvm_emap_size;  /* size of emap */
 249
 250 #else
 251 /* out-of-kernel versions of round_page and trunc_page */
 252 #define round_page(x) \
 253         ((((vaddr_t)(x) + (vm_page_size - 1)) / vm_page_size) * \
 254             vm_page_size)
 255 #define trunc_page(x) \
 256         ((((vaddr_t)(x)) / vm_page_size) * vm_page_size)
 257
 258 #endif /* _KERNEL */
 259 #endif /* ASSEMBLER */
 260 #endif /* _VM_PARAM_ */