Home | History | Annotate | Line # | Download | only in uvm
uvm_map.h revision 1.13
      1 /*	$NetBSD: uvm_map.h,v 1.13 1999/05/23 06:27:13 mrg Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1997 Charles D. Cranor and Washington University.
      5  * Copyright (c) 1991, 1993, The Regents of the University of California.
      6  *
      7  * All rights reserved.
      8  *
      9  * This code is derived from software contributed to Berkeley by
     10  * The Mach Operating System project at Carnegie-Mellon University.
     11  *
     12  * Redistribution and use in source and binary forms, with or without
     13  * modification, are permitted provided that the following conditions
     14  * are met:
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice, this list of conditions and the following disclaimer.
     17  * 2. Redistributions in binary form must reproduce the above copyright
     18  *    notice, this list of conditions and the following disclaimer in the
     19  *    documentation and/or other materials provided with the distribution.
     20  * 3. All advertising materials mentioning features or use of this software
     21  *    must display the following acknowledgement:
     22  *	This product includes software developed by Charles D. Cranor,
     23  *      Washington University, the University of California, Berkeley and
     24  *      its contributors.
     25  * 4. Neither the name of the University nor the names of its contributors
     26  *    may be used to endorse or promote products derived from this software
     27  *    without specific prior written permission.
     28  *
     29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     39  * SUCH DAMAGE.
     40  *
     41  *	@(#)vm_map.h    8.3 (Berkeley) 3/15/94
     42  * from: Id: uvm_map.h,v 1.1.2.3 1998/02/07 01:16:55 chs Exp
     43  *
     44  *
     45  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
     46  * All rights reserved.
     47  *
     48  * Permission to use, copy, modify and distribute this software and
     49  * its documentation is hereby granted, provided that both the copyright
     50  * notice and this permission notice appear in all copies of the
     51  * software, derivative works or modified versions, and any portions
     52  * thereof, and that both notices appear in supporting documentation.
     53  *
     54  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
     55  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
     56  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
     57  *
     58  * Carnegie Mellon requests users of this software to return to
     59  *
     60  *  Software Distribution Coordinator  or  Software.Distribution (at) CS.CMU.EDU
     61  *  School of Computer Science
     62  *  Carnegie Mellon University
     63  *  Pittsburgh PA 15213-3890
     64  *
     65  * any improvements or extensions that they make and grant Carnegie the
     66  * rights to redistribute these changes.
     67  */
     68 
     69 #ifndef _UVM_UVM_MAP_H_
     70 #define _UVM_UVM_MAP_H_
     71 
     72 /*
     73  * uvm_map.h
     74  */
     75 
     76 /*
     77  * macros
     78  */
     79 
     80 /*
     81  * UVM_MAP_CLIP_START: ensure that the entry begins at or after
     82  * the starting address, if it doesn't we split the entry.
     83  *
     84  * => map must be locked by caller
     85  */
     86 
     87 #define UVM_MAP_CLIP_START(MAP,ENTRY,VA) { \
     88 	if ((VA) > (ENTRY)->start) uvm_map_clip_start(MAP,ENTRY,VA); }
     89 
     90 /*
     91  * UVM_MAP_CLIP_END: ensure that the entry ends at or before
     92  *      the ending address, if it does't we split the entry.
     93  *
     94  * => map must be locked by caller
     95  */
     96 
     97 #define UVM_MAP_CLIP_END(MAP,ENTRY,VA) { \
     98 	if ((VA) < (ENTRY)->end) uvm_map_clip_end(MAP,ENTRY,VA); }
     99 
    100 /*
    101  * extract flags
    102  */
    103 #define UVM_EXTRACT_REMOVE	0x1	/* remove mapping from old map */
    104 #define UVM_EXTRACT_CONTIG	0x2	/* try to keep it contig */
    105 #define UVM_EXTRACT_QREF	0x4	/* use quick refs */
    106 #define UVM_EXTRACT_FIXPROT	0x8	/* set prot to maxprot as we go */
    107 
    108 
    109 /*
    110  * handle inline options
    111  */
    112 
    113 #ifdef UVM_MAP_INLINE
    114 #define MAP_INLINE static __inline
    115 #else
    116 #define MAP_INLINE /* nothing */
    117 #endif /* UVM_MAP_INLINE */
    118 
    119 /*
    120  * globals:
    121  */
    122 
    123 #ifdef PMAP_GROWKERNEL
    124 extern vaddr_t	uvm_maxkaddr;
    125 #endif
    126 
    127 /*
    128  * protos: the following prototypes define the interface to vm_map
    129  */
    130 
    131 MAP_INLINE
    132 void		uvm_map_deallocate __P((vm_map_t));
    133 
    134 int		uvm_map_clean __P((vm_map_t, vaddr_t, vaddr_t, int));
    135 void		uvm_map_clip_start __P((vm_map_t,
    136 				vm_map_entry_t, vaddr_t));
    137 void		uvm_map_clip_end __P((vm_map_t, vm_map_entry_t,
    138 				vaddr_t));
    139 MAP_INLINE
    140 vm_map_t	uvm_map_create __P((pmap_t, vaddr_t,
    141 			vaddr_t, boolean_t));
    142 int		uvm_map_extract __P((vm_map_t, vaddr_t, vsize_t,
    143 			vm_map_t, vaddr_t *, int));
    144 vm_map_entry_t	uvm_map_findspace __P((vm_map_t, vaddr_t, vsize_t,
    145 			vaddr_t *, struct uvm_object *, vaddr_t,
    146 			boolean_t));
    147 int		uvm_map_inherit __P((vm_map_t, vaddr_t, vaddr_t,
    148 			vm_inherit_t));
    149 int		uvm_map_advice __P((vm_map_t, vaddr_t, vaddr_t, int));
    150 void		uvm_map_init __P((void));
    151 boolean_t	uvm_map_lookup_entry __P((vm_map_t, vaddr_t,
    152 			vm_map_entry_t *));
    153 MAP_INLINE
    154 void		uvm_map_reference __P((vm_map_t));
    155 int		uvm_map_replace __P((vm_map_t, vaddr_t, vaddr_t,
    156 			vm_map_entry_t, int));
    157 int		uvm_map_reserve __P((vm_map_t, vsize_t, vaddr_t,
    158 			vaddr_t *));
    159 void		uvm_map_setup __P((vm_map_t, vaddr_t,
    160 			vaddr_t, boolean_t));
    161 int		uvm_map_submap __P((vm_map_t, vaddr_t,
    162 			vaddr_t, vm_map_t));
    163 MAP_INLINE
    164 int		uvm_unmap __P((vm_map_t, vaddr_t, vaddr_t));
    165 void		uvm_unmap_detach __P((vm_map_entry_t,int));
    166 int		uvm_unmap_remove __P((vm_map_t, vaddr_t, vaddr_t,
    167 				      vm_map_entry_t *));
    168 
    169 struct vmspace *uvmspace_fork __P((struct vmspace *));
    170 
    171 #endif /* _UVM_UVM_MAP_H_ */
    172