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