sys/vm/vm.h

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