sys/vm/vm.h

   1 /*-
   2  * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU)
   3  *
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)vm.h        8.2 (Berkeley) 12/13/93
  32  *      @(#)vm_prot.h   8.1 (Berkeley) 6/11/93
  33  *      @(#)vm_inherit.h        8.1 (Berkeley) 6/11/93
  34  *
  35  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  36  * All rights reserved.
  37  *
  38  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  39  *
  40  * Permission to use, copy, modify and distribute this software and
  41  * its documentation is hereby granted, provided that both the copyright
  42  * notice and this permission notice appear in all copies of the
  43  * software, derivative works or modified versions, and any portions
  44  * thereof, and that both notices appear in supporting documentation.
  45  *
  46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  48  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  49  *
  50  * Carnegie Mellon requests users of this software to return to
  51  *
  52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  53  *  School of Computer Science
  54  *  Carnegie Mellon University
  55  *  Pittsburgh PA 15213-3890
  56  *
  57  * any improvements or extensions that they make and grant Carnegie the
  58  * rights to redistribute these changes.
  59  */
  60
  61 #ifndef VM_H
  62 #define VM_H
  63
  64 #include <machine/vm.h>
  65
  66 typedef char vm_inherit_t;      /* inheritance codes */
  67
  68 #define VM_INHERIT_SHARE        ((vm_inherit_t) 0)
  69 #define VM_INHERIT_COPY         ((vm_inherit_t) 1)
  70 #define VM_INHERIT_NONE         ((vm_inherit_t) 2)
  71 #define VM_INHERIT_ZERO         ((vm_inherit_t) 3)
  72 #define VM_INHERIT_DEFAULT      VM_INHERIT_COPY
  73
  74 typedef u_char vm_prot_t;       /* protection codes */
  75
  76 #define VM_PROT_NONE            ((vm_prot_t) 0x00)
  77 #define VM_PROT_READ            ((vm_prot_t) 0x01)
  78 #define VM_PROT_WRITE           ((vm_prot_t) 0x02)
  79 #define VM_PROT_EXECUTE         ((vm_prot_t) 0x04)
  80 #define VM_PROT_COPY            ((vm_prot_t) 0x08)      /* copy-on-read */
  81 #define VM_PROT_PRIV_FLAG       ((vm_prot_t) 0x10)
  82 #define VM_PROT_FAULT_LOOKUP    VM_PROT_PRIV_FLAG
  83 #define VM_PROT_QUICK_NOFAULT   VM_PROT_PRIV_FLAG       /* same to save bits */
  84
  85 #define VM_PROT_ALL             (VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
  86 #define VM_PROT_RW              (VM_PROT_READ|VM_PROT_WRITE)
  87 #define VM_PROT_DEFAULT         VM_PROT_ALL
  88
  89 enum obj_type {
  90         OBJT_DEFAULT,
  91         OBJT_SWAP,
  92         OBJT_VNODE,
  93         OBJT_DEVICE,
  94         OBJT_PHYS,
  95         OBJT_DEAD,
  96         OBJT_SG,
  97         OBJT_MGTDEVICE,
  98         OBJT_FIRST_DYN,
  99 };
 100 typedef u_char objtype_t;
 101
 102 union vm_map_object;
 103 typedef union vm_map_object vm_map_object_t;
 104
 105 struct vm_map_entry;
 106 typedef struct vm_map_entry *vm_map_entry_t;
 107
 108 struct vm_map;
 109 typedef struct vm_map *vm_map_t;
 110
 111 struct vm_object;
 112 typedef struct vm_object *vm_object_t;
 113
 114 #ifndef _KERNEL
 115 /*
 116  * This is defined in <sys/types.h> for the kernel so that non-vm kernel
 117  * sources (mainly Mach-derived ones such as ddb) don't have to include
 118  * vm stuff.  Defining it there for applications might break things.
 119  * Define it here for "applications" that include vm headers (e.g.,
 120  * genassym).
 121  */
 122 #ifndef HAVE_BOOLEAN
 123 typedef int boolean_t;
 124 #endif
 125
 126 /*
 127  * The exact set of memory attributes is machine dependent.  However,
 128  * every machine is required to define VM_MEMATTR_DEFAULT and
 129  * VM_MEMATTR_UNCACHEABLE.
 130  */
 131 typedef char vm_memattr_t;      /* memory attribute codes */
 132
 133 /*
 134  * This is defined in <sys/types.h> for the kernel so that vnode_if.h
 135  * doesn't have to include <vm/vm.h>.
 136  */
 137 struct vm_page;
 138 typedef struct vm_page *vm_page_t;
 139 #endif                          /* _KERNEL */
 140
 141 struct vm_reserv;
 142 typedef struct vm_reserv *vm_reserv_t;
 143
 144 /*
 145  * Information passed from the machine-independent VM initialization code
 146  * for use by machine-dependant code (mainly for MMU support)
 147  */
 148 struct kva_md_info {
 149         vm_offset_t     buffer_sva;
 150         vm_offset_t     buffer_eva;
 151         vm_offset_t     clean_sva;
 152         vm_offset_t     clean_eva;
 153 };
 154
 155 /* bits from overcommit */
 156 #define SWAP_RESERVE_FORCE_ON           (1 << 0)
 157 #define SWAP_RESERVE_RLIMIT_ON          (1 << 1)
 158 #define SWAP_RESERVE_ALLOW_NONWIRED     (1 << 2)
 159
 160 #ifdef _KERNEL
 161 struct ucred;
 162
 163 void vm_ksubmap_init(struct kva_md_info *);
 164 bool swap_reserve(vm_ooffset_t incr);
 165 bool swap_reserve_by_cred(vm_ooffset_t incr, struct ucred *cred);
 166 void swap_reserve_force(vm_ooffset_t incr);
 167 void swap_release(vm_ooffset_t decr);
 168 void swap_release_by_cred(vm_ooffset_t decr, struct ucred *cred);
 169 void swapper(void);
 170
 171 extern struct kva_md_info       kmi;
 172 #define VA_IS_CLEANMAP(va)                                      \
 173         ((va) >= kmi.clean_sva && (va) < kmi.clean_eva)
 174
 175 extern int old_mlock;
 176 extern int vm_ndomains;
 177 extern int vm_overcommit;
 178 #endif                          /* _KERNEL */
 179
 180 #endif                          /* VM_H */