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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. 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  *      @(#)vm.h        8.2 (Berkeley) 12/13/93
  34  *      @(#)vm_prot.h   8.1 (Berkeley) 6/11/93
  35  *      @(#)vm_inherit.h        8.1 (Berkeley) 6/11/93
  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  * $FreeBSD$
  63  */
  64
  65 #ifndef VM_H
  66 #define VM_H
  67
  68 typedef char vm_inherit_t;      /* inheritance codes */
  69
  70 #define VM_INHERIT_SHARE        ((vm_inherit_t) 0)
  71 #define VM_INHERIT_COPY         ((vm_inherit_t) 1)
  72 #define VM_INHERIT_NONE         ((vm_inherit_t) 2)
  73 #define VM_INHERIT_DEFAULT      VM_INHERIT_COPY
  74
  75 typedef u_char vm_prot_t;       /* protection codes */
  76
  77 #define VM_PROT_NONE            ((vm_prot_t) 0x00)
  78 #define VM_PROT_READ            ((vm_prot_t) 0x01)
  79 #define VM_PROT_WRITE           ((vm_prot_t) 0x02)
  80 #define VM_PROT_EXECUTE         ((vm_prot_t) 0x04)
  81 #define VM_PROT_OVERRIDE_WRITE  ((vm_prot_t) 0x08)      /* copy-on-write */
  82
  83 #define VM_PROT_ALL             (VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
  84 #define VM_PROT_DEFAULT         VM_PROT_ALL
  85
  86 union vm_map_object;
  87 typedef union vm_map_object vm_map_object_t;
  88
  89 struct vm_map_entry;
  90 typedef struct vm_map_entry *vm_map_entry_t;
  91
  92 struct vm_map;
  93 typedef struct vm_map *vm_map_t;
  94
  95 struct vm_object;
  96 typedef struct vm_object *vm_object_t;
  97
  98 #ifndef _KERNEL
  99 /*
 100  * This is defined in <sys/types.h> for the kernel so that non-vm kernel
 101  * sources (mainly Mach-derived ones such as ddb) don't have to include
 102  * vm stuff.  Defining it there for applications might break things.
 103  * Define it here for "applications" that include vm headers (e.g.,
 104  * genassym).
 105  */
 106 typedef int boolean_t;
 107
 108 /*
 109  * This is defined in <sys/types.h> for the kernel so that vnode_if.h
 110  * doesn't have to include <vm/vm.h>.
 111  */
 112 struct vm_page;
 113 typedef struct vm_page *vm_page_t;
 114 #endif
 115
 116 /*
 117  * Information passed from the machine-independant VM initialization code
 118  * for use by machine-dependant code (mainly for MMU support)
 119  */
 120 struct kva_md_info {
 121         vm_offset_t     buffer_sva;
 122         vm_offset_t     buffer_eva;
 123         vm_offset_t     clean_sva;
 124         vm_offset_t     clean_eva;
 125         vm_offset_t     pager_sva;
 126         vm_offset_t     pager_eva;
 127 };
 128
 129 extern struct kva_md_info       kmi;
 130 extern void vm_ksubmap_init(struct kva_md_info *);
 131
 132 #endif                          /* VM_H */
 133