386BSD 0.1 development
[unix-history] / usr / src / sys.386bsd / vm / vm_pager.h
CommitLineData
b688fc87
WJ
1/*
2 * Copyright (c) 1990 University of Utah.
3 * Copyright (c) 1991 The Regents of the University of California.
4 * 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 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 * @(#)vm_pager.h 7.2 (Berkeley) 4/20/91
39 */
40
41/*
42 * Pager routine interface definition.
43 * For BSD we use a cleaner version of the internal pager interface.
44 */
45
46#ifndef _VM_PAGER_
47#define _VM_PAGER_
48
49struct pager_struct {
50 queue_head_t pg_list; /* links for list management */
51 caddr_t pg_handle; /* external handle (vp, dev, fp) */
52 int pg_type; /* type of pager */
53 struct pagerops *pg_ops; /* pager operations */
54 caddr_t pg_data; /* private pager data */
55};
56typedef struct pager_struct *vm_pager_t;
57
58/* pager types */
59#define PG_DFLT -1
60#define PG_SWAP 0
61#define PG_VNODE 1
62#define PG_DEVICE 2
63
64struct pagerops {
65 void (*pgo_init)(); /* initialize pager */
66 vm_pager_t (*pgo_alloc)(); /* allocate pager */
67 void (*pgo_dealloc)(); /* disassociate */
68 int (*pgo_getpage)(); /* get (read) page */
69 int (*pgo_putpage)(); /* put (write) page */
70 boolean_t (*pgo_haspage)(); /* does pager have page? */
71};
72
73/*
74 * get/put return values
75 * OK operation was successful
76 * BAD specified data was out of the accepted range
77 * FAIL specified data was in range, but doesn't exist
78 * PEND operations was initiated but not completed
79 */
80#define VM_PAGER_OK 0
81#define VM_PAGER_BAD 1
82#define VM_PAGER_FAIL 2
83#define VM_PAGER_PEND 3
84
85#define VM_PAGER_ALLOC(h, s, p) (*(pg)->pg_ops->pgo_alloc)(h, s, p)
86#define VM_PAGER_DEALLOC(pg) (*(pg)->pg_ops->pgo_dealloc)(pg)
87#define VM_PAGER_GET(pg, m, s) (*(pg)->pg_ops->pgo_getpage)(pg, m, s)
88#define VM_PAGER_PUT(pg, m, s) (*(pg)->pg_ops->pgo_putpage)(pg, m, s)
89#define VM_PAGER_HASPAGE(pg, o) (*(pg)->pg_ops->pgo_haspage)(pg, o)
90
91#ifdef KERNEL
92vm_pager_t vm_pager_allocate();
93void vm_pager_deallocate();
94int vm_pager_get();
95int vm_pager_put();
96boolean_t vm_pager_has_page();
97
98vm_offset_t vm_pager_map_page();
99void vm_pager_unmap_page();
100vm_pager_t vm_pager_lookup();
101void vm_pager_sync();
102
103extern struct pagerops *dfltpagerops;
104#endif
105
106#endif /* _VM_PAGER_ */