Home | History | Annotate | Line # | Download | only in uvm
uvm_pager.h revision 1.1
      1 /*	$Id: uvm_pager.h,v 1.1 1998/02/05 06:25:09 mrg Exp $	*/
      2 
      3 /*
      4  * XXXCDC: "ROUGH DRAFT" QUALITY UVM PRE-RELEASE FILE!
      5  *	   >>>USE AT YOUR OWN RISK, WORK IS NOT FINISHED<<<
      6  */
      7 /*
      8  *
      9  * Copyright (c) 1997 Charles D. Cranor and Washington University.
     10  * All rights reserved.
     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 and
     23  *      Washington University.
     24  * 4. The name of the author may not be used to endorse or promote products
     25  *    derived from this software without specific prior written permission.
     26  *
     27  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     28  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     29  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     30  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     32  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     36  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * uvm_pager.h
     41  */
     42 
     43 UVMHIST_DECL(maphist);
     44 
     45 
     46 /*
     47  * async pager i/o descriptor structure
     48  */
     49 
     50 TAILQ_HEAD(uvm_aiohead, uvm_aiodesc);
     51 
     52 struct uvm_aiodesc {
     53   void (*aiodone) __P((struct uvm_aiodesc *));
     54 					/* aio done function */
     55   vm_offset_t kva;			/* KVA of mapped page(s) */
     56   int npages;				/* # of pages in I/O req */
     57   void *pd_ptr;				/* pager-dependent pointer */
     58   TAILQ_ENTRY(uvm_aiodesc) aioq;	/* linked list of aio's */
     59 };
     60 
     61 /*
     62  * pager ops
     63  */
     64 
     65 struct uvm_pagerops {
     66   void			(*pgo_init) __P((void));	/* init pager */
     67   struct uvm_object *	(*pgo_attach) 		/* get uvm_object */
     68 			    __P((void *, vm_prot_t));
     69   void			(*pgo_reference)	/* add reference to obj */
     70 			    __P((struct uvm_object *));
     71   void			(*pgo_detach)		/* drop reference to obj */
     72 			    __P((struct uvm_object *));
     73   int			(*pgo_fault)		/* special nonstd fault fn */
     74   			    __P((struct uvm_faultinfo *, vm_offset_t,
     75 				 vm_page_t *, int, int, vm_fault_t,
     76 				 vm_prot_t, int));
     77   boolean_t		(*pgo_flush)		/* flush pages out of obj */
     78 			    __P((struct uvm_object *, vm_offset_t,
     79 				vm_offset_t, int));
     80   int			(*pgo_get)		/* get/read page */
     81 			    __P((struct uvm_object *, vm_offset_t,
     82 				 vm_page_t *, int *, int, vm_prot_t, int, int));
     83   int			(*pgo_asyncget)		/* start async get */
     84        			    __P((struct uvm_object *, vm_offset_t, int));
     85   int			(*pgo_put)		/* put/write page */
     86        			    __P((struct uvm_object *, vm_page_t *,
     87 				 int, boolean_t));
     88   void			(*pgo_cluster)          /* return range of cluster */
     89                             __P((struct uvm_object *, vm_offset_t,
     90                                  vm_offset_t *, vm_offset_t *));
     91   struct vm_page **	(*pgo_mk_pcluster)	/* make "put" cluster */
     92        			    __P((struct uvm_object *, struct vm_page **,
     93 				 int *, struct vm_page *, int, vm_offset_t,
     94 				 vm_offset_t));
     95   void			(*pgo_shareprot)	/* share protect */
     96 			    __P((vm_map_entry_t, vm_prot_t));
     97   void			(*pgo_aiodone)		/* async iodone */
     98 			    __P((struct uvm_aiodesc *));
     99   boolean_t		(*pgo_releasepg)	/* release page */
    100 			    __P((struct vm_page *, struct vm_page **));
    101 };
    102 
    103 /* pager flags [mostly for flush] */
    104 
    105 #define PGO_CLEANIT	0x001	/* write dirty pages to backing store */
    106 #define PGO_SYNCIO	0x002	/* if PGO_CLEAN: use sync I/O? */
    107 /*
    108  * obviously if neither PGO_INVALIDATE or PGO_FREE are set then the pages
    109  * stay where they are.
    110  */
    111 #define PGO_DEACTIVATE	0x004	/* deactivate flushed pages */
    112 #define PGO_FREE	0x008	/* free flushed pages */
    113 
    114 #define PGO_ALLPAGES	0x010	/* flush whole object/get all pages */
    115 #define PGO_DOACTCLUST	0x020	/* flag to mk_pcluster to include active */
    116 #define PGO_LOCKED	0x040	/* fault data structures are locked [get] */
    117 #define PGO_PDFREECLUST	0x080	/* daemon's free cluster flag [uvm_pager_put] */
    118 #define PGO_REALLOCSWAP	0x100	/* reallocate swap area [pager_dropcluster] */
    119 
    120 /* page we are not interested in getting */
    121 #define PGO_DONTCARE ((struct vm_page *) -1)	/* [get only] */
    122 
    123 /*
    124  * handle inline options
    125  */
    126 
    127 #ifdef UVM_PAGER_INLINE
    128 #define PAGER_INLINE static __inline
    129 #else
    130 #define PAGER_INLINE /* nothing */
    131 #endif /* UVM_PAGER_INLINE */
    132 
    133 /*
    134  * prototypes
    135  */
    136 
    137 void		uvm_pager_dropcluster __P((struct uvm_object *,
    138 					struct vm_page *, struct vm_page **,
    139 					int *, int, int));
    140 void		uvm_pager_init __P((void));
    141 int		uvm_pager_put __P((struct uvm_object *, struct vm_page *,
    142 				   struct vm_page ***, int *, int,
    143 				   vm_offset_t, vm_offset_t));
    144 
    145 PAGER_INLINE struct vm_page *uvm_pageratop __P((vm_offset_t));
    146 
    147 vm_offset_t	uvm_pagermapin __P((struct vm_page **, int,
    148 				    struct uvm_aiodesc **, int));
    149 void		uvm_pagermapout __P((vm_offset_t, int));
    150 struct vm_page **uvm_mk_pcluster  __P((struct uvm_object *, struct vm_page **,
    151 				       int *, struct vm_page *, int,
    152 				       vm_offset_t, vm_offset_t));
    153 void		uvm_shareprot __P((vm_map_entry_t, vm_prot_t));
    154 
    155