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. 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: src/sys/vm/vm.h,v 1.16.2.1 2002/12/28 19:49:41 dillon Exp $
  59  */
  60
  61 #ifndef _VM_VM_H_
  62 #define _VM_VM_H_
  63
  64 #ifndef _SYS_TYPES_H_
  65 #include <sys/types.h>
  66 #endif
  67 #include <machine/specialreg.h>
  68
  69 typedef char vm_inherit_t;      /* inheritance codes */
  70
  71 #define VM_INHERIT_SHARE        ((vm_inherit_t) 0)
  72 #define VM_INHERIT_COPY         ((vm_inherit_t) 1)
  73 #define VM_INHERIT_NONE         ((vm_inherit_t) 2)
  74 #define VM_INHERIT_DEFAULT      VM_INHERIT_COPY
  75
  76 typedef u_char vm_prot_t;       /* protection codes */
  77
  78 #define VM_PROT_NONE            ((vm_prot_t) 0x00)
  79 #define VM_PROT_READ            ((vm_prot_t) 0x01)
  80 #define VM_PROT_WRITE           ((vm_prot_t) 0x02)
  81 #define VM_PROT_EXECUTE         ((vm_prot_t) 0x04)
  82 #define VM_PROT_OVERRIDE_WRITE  ((vm_prot_t) 0x08)      /* copy-on-write */
  83 #define VM_PROT_NOSYNC          ((vm_prot_t) 0x10)
  84
  85 #define VM_PROT_RW              (VM_PROT_READ|VM_PROT_WRITE)
  86 #define VM_PROT_ALL             (VM_PROT_READ|VM_PROT_WRITE|VM_PROT_EXECUTE)
  87 #define VM_PROT_DEFAULT         VM_PROT_ALL
  88
  89 typedef u_char vm_maptype_t;    /* type of vm_map_entry */
  90
  91 /*
  92  * NOTE: UKSMAPs are unmanaged.  The underlying kernel memory must not be
  93  *       freed until all related mappings are gone.  There is no object.
  94  *       The device can map different things for the same UKS mapping even
  95  *       when inherited via fork().
  96  */
  97 #define VM_MAPTYPE_UNSPECIFIED  0
  98 #define VM_MAPTYPE_NORMAL       1
  99 #define VM_MAPTYPE_VPAGETABLE   2
 100 #define VM_MAPTYPE_SUBMAP       3
 101 #define VM_MAPTYPE_UKSMAP       4       /* user-kernel shared memory */
 102
 103 union vm_map_object;
 104 typedef union vm_map_object vm_map_object_t;
 105
 106 struct vm_map_entry;
 107 typedef struct vm_map_entry *vm_map_entry_t;
 108
 109 struct vm_map;
 110 typedef struct vm_map *vm_map_t;
 111
 112 struct vm_object;
 113 typedef struct vm_object *vm_object_t;
 114
 115 /*
 116  * This is also defined in vm/vm_page.h.
 117  */
 118 #ifndef __VM_PAGE_T_DEFINED__
 119 #define __VM_PAGE_T_DEFINED__
 120 struct vm_page;
 121 typedef struct vm_page *vm_page_t;
 122 #endif
 123
 124
 125 /* Memory attributes. */
 126
 127 #ifndef __VM_MEMATTR_T_DEFINED__
 128 #define __VM_MEMATTR_T_DEFINED__
 129 typedef char vm_memattr_t;
 130 #endif
 131
 132 #define VM_MEMATTR_UNCACHEABLE          ((vm_memattr_t)PAT_UNCACHEABLE)
 133 #define VM_MEMATTR_WRITE_COMBINING      ((vm_memattr_t)PAT_WRITE_COMBINING)
 134 #define VM_MEMATTR_WRITE_THROUGH        ((vm_memattr_t)PAT_WRITE_THROUGH)
 135 #define VM_MEMATTR_WRITE_PROTECTED      ((vm_memattr_t)PAT_WRITE_PROTECTED)
 136 #define VM_MEMATTR_WRITE_BACK           ((vm_memattr_t)PAT_WRITE_BACK)
 137 #define VM_MEMATTR_WEAK_UNCACHEABLE     ((vm_memattr_t)PAT_UNCACHED)
 138
 139 #define VM_MEMATTR_DEFAULT      VM_MEMATTR_WRITE_BACK
 140
 141 #endif                          /* _VM_VM_H_ */