xref: /openbsd/sys/uvm/uvm_fault.h (revision 404b540a)
1 /*	$OpenBSD: uvm_fault.h,v 1.13 2009/03/25 20:00:18 oga Exp $	*/
2 /*	$NetBSD: uvm_fault.h,v 1.14 2000/06/26 14:21:17 mrg Exp $	*/
3 
4 /*
5  *
6  * Copyright (c) 1997 Charles D. Cranor and Washington University.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by Charles D. Cranor and
20  *      Washington University.
21  * 4. The name of the author may not be used to endorse or promote products
22  *    derived from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  * from: Id: uvm_fault.h,v 1.1.2.2 1997/12/08 16:07:12 chuck Exp
36  */
37 
38 #ifndef _UVM_UVM_FAULT_H_
39 #define _UVM_UVM_FAULT_H_
40 
41 /*
42  * fault types
43  */
44 
45 #define VM_FAULT_INVALID ((vm_fault_t) 0x0)	/* invalid mapping */
46 #define VM_FAULT_PROTECT ((vm_fault_t) 0x1)	/* protection */
47 #define VM_FAULT_WIRE	 ((vm_fault_t) 0x2)	/* wire mapping */
48 
49 /*
50  * fault data structures
51  */
52 
53 /*
54  * uvm_faultinfo: to load one of these fill in all orig_* fields and
55  * then call uvmfault_lookup on it.
56  */
57 
58 
59 struct uvm_faultinfo {
60 	vm_map_t orig_map;		/* IN: original map */
61 	vaddr_t orig_rvaddr;		/* IN: original rounded VA */
62 	vsize_t orig_size;		/* IN: original size of interest */
63 	vm_map_t map;			/* map (could be a submap) */
64 	unsigned int mapv;		/* map's version number */
65 	vm_map_entry_t entry;		/* map entry (from 'map') */
66 	vsize_t size;			/* size of interest */
67 };
68 
69 #ifdef _KERNEL
70 
71 /*
72  * fault prototypes
73  */
74 
75 
76 boolean_t	uvmfault_lookup(struct uvm_faultinfo *, boolean_t);
77 boolean_t	uvmfault_relock(struct uvm_faultinfo *);
78 void		uvmfault_unlockall(struct uvm_faultinfo *, struct vm_amap *,
79 		    struct uvm_object *, struct vm_anon *);
80 int		uvmfault_anonget(struct uvm_faultinfo *, struct vm_amap *,
81 		    struct vm_anon *);
82 
83 int		uvm_fault_wire(vm_map_t, vaddr_t, vaddr_t, vm_prot_t);
84 void		uvm_fault_unwire(vm_map_t, vaddr_t, vaddr_t);
85 void		uvm_fault_unwire_locked(vm_map_t, vaddr_t, vaddr_t);
86 
87 #endif /* _KERNEL */
88 
89 #endif /* _UVM_UVM_FAULT_H_ */
90