xref: /original-bsd/sys/vm/vm_pager.h (revision a5993585)
1 /*
2  * Copyright (c) 1990 University of Utah.
3  * Copyright (c) 1991, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * the Systems Programming Group of the University of Utah Computer
8  * Science Department.
9  *
10  * %sccs.include.redist.c%
11  *
12  *	@(#)vm_pager.h	8.3 (Berkeley) 12/13/93
13  */
14 
15 /*
16  * Pager routine interface definition.
17  * For BSD we use a cleaner version of the internal pager interface.
18  */
19 
20 #ifndef	_VM_PAGER_
21 #define	_VM_PAGER_
22 
23 TAILQ_HEAD(pagerlst, pager_struct);
24 
25 struct	pager_struct {
26 	TAILQ_ENTRY(pager_struct) pg_list;	/* links for list management */
27 	caddr_t			  pg_handle;	/* ext. handle (vp, dev, fp) */
28 	int			  pg_type;	/* type of pager */
29 	struct pagerops		  *pg_ops;	/* pager operations */
30 	void			  *pg_data;	/* private pager data */
31 };
32 
33 /* pager types */
34 #define PG_DFLT		-1
35 #define	PG_SWAP		0
36 #define	PG_VNODE	1
37 #define PG_DEVICE	2
38 
39 struct	pagerops {
40 	void		(*pgo_init)		/* Initialize pager. */
41 			    __P((void));
42 	vm_pager_t	(*pgo_alloc)		/* Allocate pager. */
43 			    __P((caddr_t, vm_size_t, vm_prot_t, vm_offset_t));
44 	void		(*pgo_dealloc)		/* Disassociate. */
45 			    __P((vm_pager_t));
46 	int		(*pgo_getpage)		/* Get (read) page. */
47 			    __P((vm_pager_t, vm_page_t, boolean_t));
48 	int		(*pgo_putpage)		/* Put (write) page. */
49 			    __P((vm_pager_t, vm_page_t, boolean_t));
50 	boolean_t  	(*pgo_haspage)		/* Does pager have page? */
51 			    __P((vm_pager_t, vm_offset_t));
52 };
53 
54 /*
55  * get/put return values
56  * OK	 operation was successful
57  * BAD	 specified data was out of the accepted range
58  * FAIL	 specified data was in range, but doesn't exist
59  * PEND	 operations was initiated but not completed
60  * ERROR error while accessing data that is in range and exists
61  */
62 #define	VM_PAGER_OK	0
63 #define	VM_PAGER_BAD	1
64 #define	VM_PAGER_FAIL	2
65 #define	VM_PAGER_PEND	3
66 #define	VM_PAGER_ERROR	4
67 
68 #define	VM_PAGER_ALLOC(h, s, p, o)	(*(pg)->pg_ops->pgo_alloc)(h, s, p, o)
69 #define	VM_PAGER_DEALLOC(pg)		(*(pg)->pg_ops->pgo_dealloc)(pg)
70 #define	VM_PAGER_GET(pg, m, s)		(*(pg)->pg_ops->pgo_getpage)(pg, m, s)
71 #define	VM_PAGER_PUT(pg, m, s)		(*(pg)->pg_ops->pgo_putpage)(pg, m, s)
72 #define	VM_PAGER_HASPAGE(pg, o)		(*(pg)->pg_ops->pgo_haspage)(pg, o)
73 
74 #ifdef KERNEL
75 extern struct pagerops *dfltpagerops;
76 
77 vm_pager_t	 vm_pager_allocate
78 		    __P((int, caddr_t, vm_size_t, vm_prot_t, vm_offset_t));
79 void		 vm_pager_deallocate __P((vm_pager_t));
80 int		 vm_pager_get __P((vm_pager_t, vm_page_t, boolean_t));
81 boolean_t	 vm_pager_has_page __P((vm_pager_t, vm_offset_t));
82 void		 vm_pager_init __P((void));
83 vm_pager_t	 vm_pager_lookup __P((struct pagerlst *, caddr_t));
84 vm_offset_t	 vm_pager_map_page __P((vm_page_t));
85 int		 vm_pager_put __P((vm_pager_t, vm_page_t, boolean_t));
86 void		 vm_pager_sync __P((void));
87 void		 vm_pager_unmap_page __P((vm_offset_t));
88 #endif
89 
90 #endif	/* _VM_PAGER_ */
91