/*      $OpenBSD: uvm_fault.h,v 1.16 2020/11/06 11:52:39 mpi Exp $      */
/*      $NetBSD: uvm_fault.h,v 1.14 2000/06/26 14:21:17 mrg Exp $       */

/*
 * Copyright (c) 1997 Charles D. Cranor and Washington University.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * from: Id: uvm_fault.h,v 1.1.2.2 1997/12/08 16:07:12 chuck Exp
 */

#ifndef _UVM_UVM_FAULT_H_
#define _UVM_UVM_FAULT_H_

/*
 * fault types
 */

#define VM_FAULT_INVALID ((vm_fault_t) 0x0)     /* invalid mapping */
#define VM_FAULT_PROTECT ((vm_fault_t) 0x1)     /* protection */
#define VM_FAULT_WIRE    ((vm_fault_t) 0x2)     /* wire mapping */

/*
 * fault data structures
 */

/*
 * uvm_faultinfo: to load one of these fill in all orig_* fields and
 * then call uvmfault_lookup on it.
 */


struct uvm_faultinfo {
        vm_map_t orig_map;              /* IN: original map */
        vaddr_t orig_rvaddr;            /* IN: original rounded VA */
        vsize_t orig_size;              /* IN: original size of interest */
        vm_map_t map;                   /* map (could be a submap) */
        unsigned int mapv;              /* map's version number */
        vm_map_entry_t entry;           /* map entry (from 'map') */
        vsize_t size;                   /* size of interest */
};

#ifdef _KERNEL

/*
 * fault prototypes
 */

void            uvmfault_init(void);

boolean_t       uvmfault_lookup(struct uvm_faultinfo *, boolean_t);
boolean_t       uvmfault_relock(struct uvm_faultinfo *);
void            uvmfault_unlockall(struct uvm_faultinfo *, struct vm_amap *,
                    struct uvm_object *);
int             uvmfault_anonget(struct uvm_faultinfo *, struct vm_amap *,
                    struct vm_anon *);

int             uvm_fault_wire(vm_map_t, vaddr_t, vaddr_t, vm_prot_t);
void            uvm_fault_unwire(vm_map_t, vaddr_t, vaddr_t);
void            uvm_fault_unwire_locked(vm_map_t, vaddr_t, vaddr_t);

#endif /* _KERNEL */

#endif /* _UVM_UVM_FAULT_H_ */