Deleted Added
full compact
vm_object.h (98824) vm_object.h (98849)
1/*
2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94
37 *
38 *
39 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40 * All rights reserved.
41 *
42 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43 *
44 * Permission to use, copy, modify and distribute this software and
45 * its documentation is hereby granted, provided that both the copyright
46 * notice and this permission notice appear in all copies of the
47 * software, derivative works or modified versions, and any portions
48 * thereof, and that both notices appear in supporting documentation.
49 *
50 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53 *
54 * Carnegie Mellon requests users of this software to return to
55 *
56 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
57 * School of Computer Science
58 * Carnegie Mellon University
59 * Pittsburgh PA 15213-3890
60 *
61 * any improvements or extensions that they make and grant Carnegie the
62 * rights to redistribute these changes.
63 *
1/*
2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * from: @(#)vm_object.h 8.3 (Berkeley) 1/12/94
37 *
38 *
39 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40 * All rights reserved.
41 *
42 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43 *
44 * Permission to use, copy, modify and distribute this software and
45 * its documentation is hereby granted, provided that both the copyright
46 * notice and this permission notice appear in all copies of the
47 * software, derivative works or modified versions, and any portions
48 * thereof, and that both notices appear in supporting documentation.
49 *
50 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53 *
54 * Carnegie Mellon requests users of this software to return to
55 *
56 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
57 * School of Computer Science
58 * Carnegie Mellon University
59 * Pittsburgh PA 15213-3890
60 *
61 * any improvements or extensions that they make and grant Carnegie the
62 * rights to redistribute these changes.
63 *
64 * $FreeBSD: head/sys/vm/vm_object.h 98824 2002-06-25 22:14:06Z iedowse $
64 * $FreeBSD: head/sys/vm/vm_object.h 98849 2002-06-26 03:37:47Z ken $
65 */
66
67/*
68 * Virtual memory object module definitions.
69 */
70
71#ifndef _VM_OBJECT_
72#define _VM_OBJECT_
73
74#include <sys/queue.h>
75
76enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
77 OBJT_DEAD };
78typedef u_char objtype_t;
79
80/*
81 * Types defined:
82 *
83 * vm_object_t Virtual memory object.
84 *
85 * List of locks
86 * (c) const until freed
87 *
88 */
89
90struct vm_object {
91 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
92 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
93 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
94 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */
95 int generation; /* generation ID */
96 vm_pindex_t size; /* Object size */
97 int ref_count; /* How many refs?? */
98 int shadow_count; /* how many objects that this is a shadow for */
99 int hash_rand; /* (c) hash table randomizer */
100 objtype_t type; /* type of pager */
101 u_short flags; /* see below */
102 u_short pg_color; /* (c) color of first page in obj */
103 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
104 int resident_page_count; /* number of resident pages */
105 struct vm_object *backing_object; /* object that I'm a shadow of */
106 vm_ooffset_t backing_object_offset;/* Offset in backing object */
107 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
108 void *handle;
109 union {
110 /*
111 * VNode pager
112 *
113 * vnp_size - current size of file
114 */
115 struct {
116 off_t vnp_size;
117 } vnp;
118
119 /*
120 * Device pager
121 *
122 * devp_pglist - list of allocated pages
123 */
124 struct {
125 TAILQ_HEAD(, vm_page) devp_pglist;
126 } devp;
127
128 /*
129 * Swap pager
130 *
131 * swp_bcount - number of swap 'swblock' metablocks, each
132 * contains up to 16 swapblk assignments.
133 * see vm/swap_pager.h
134 */
135 struct {
136 int swp_bcount;
137 } swp;
138 } un_pager;
139};
140
141/*
142 * Flags
143 */
144#define OBJ_ACTIVE 0x0004 /* active objects */
145#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
146#define OBJ_NOSPLIT 0x0010 /* dont split this object */
147#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
148#define OBJ_WRITEABLE 0x0080 /* object has been made writable */
149#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
150#define OBJ_CLEANING 0x0200
151#define OBJ_OPT 0x1000 /* I/O optimization */
152#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */
153
154#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
155#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
156
157#ifdef _KERNEL
158
159#define OBJPC_SYNC 0x1 /* sync I/O */
160#define OBJPC_INVAL 0x2 /* invalidate */
161#define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
162
163TAILQ_HEAD(object_q, vm_object);
164
165extern struct object_q vm_object_list; /* list of allocated objects */
166extern struct mtx vm_object_list_mtx; /* lock for object list and count */
167
168extern vm_object_t kernel_object; /* the single kernel object */
169extern vm_object_t kmem_object;
170
171#endif /* _KERNEL */
172
173#ifdef _KERNEL
174void vm_freeze_copyopts(vm_object_t, vm_pindex_t, vm_pindex_t);
175
176void vm_object_set_flag(vm_object_t object, u_short bits);
177void vm_object_clear_flag(vm_object_t object, u_short bits);
178void vm_object_pip_add(vm_object_t object, short i);
179void vm_object_pip_subtract(vm_object_t object, short i);
180void vm_object_pip_wakeup(vm_object_t object);
181void vm_object_pip_wakeupn(vm_object_t object, short i);
182void vm_object_pip_sleep(vm_object_t object, char *waitid);
183void vm_object_pip_wait(vm_object_t object, char *waitid);
184
185vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
65 */
66
67/*
68 * Virtual memory object module definitions.
69 */
70
71#ifndef _VM_OBJECT_
72#define _VM_OBJECT_
73
74#include <sys/queue.h>
75
76enum obj_type { OBJT_DEFAULT, OBJT_SWAP, OBJT_VNODE, OBJT_DEVICE, OBJT_PHYS,
77 OBJT_DEAD };
78typedef u_char objtype_t;
79
80/*
81 * Types defined:
82 *
83 * vm_object_t Virtual memory object.
84 *
85 * List of locks
86 * (c) const until freed
87 *
88 */
89
90struct vm_object {
91 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
92 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
93 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
94 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */
95 int generation; /* generation ID */
96 vm_pindex_t size; /* Object size */
97 int ref_count; /* How many refs?? */
98 int shadow_count; /* how many objects that this is a shadow for */
99 int hash_rand; /* (c) hash table randomizer */
100 objtype_t type; /* type of pager */
101 u_short flags; /* see below */
102 u_short pg_color; /* (c) color of first page in obj */
103 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
104 int resident_page_count; /* number of resident pages */
105 struct vm_object *backing_object; /* object that I'm a shadow of */
106 vm_ooffset_t backing_object_offset;/* Offset in backing object */
107 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
108 void *handle;
109 union {
110 /*
111 * VNode pager
112 *
113 * vnp_size - current size of file
114 */
115 struct {
116 off_t vnp_size;
117 } vnp;
118
119 /*
120 * Device pager
121 *
122 * devp_pglist - list of allocated pages
123 */
124 struct {
125 TAILQ_HEAD(, vm_page) devp_pglist;
126 } devp;
127
128 /*
129 * Swap pager
130 *
131 * swp_bcount - number of swap 'swblock' metablocks, each
132 * contains up to 16 swapblk assignments.
133 * see vm/swap_pager.h
134 */
135 struct {
136 int swp_bcount;
137 } swp;
138 } un_pager;
139};
140
141/*
142 * Flags
143 */
144#define OBJ_ACTIVE 0x0004 /* active objects */
145#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
146#define OBJ_NOSPLIT 0x0010 /* dont split this object */
147#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
148#define OBJ_WRITEABLE 0x0080 /* object has been made writable */
149#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
150#define OBJ_CLEANING 0x0200
151#define OBJ_OPT 0x1000 /* I/O optimization */
152#define OBJ_ONEMAPPING 0x2000 /* One USE (a single, non-forked) mapping flag */
153
154#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
155#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
156
157#ifdef _KERNEL
158
159#define OBJPC_SYNC 0x1 /* sync I/O */
160#define OBJPC_INVAL 0x2 /* invalidate */
161#define OBJPC_NOSYNC 0x4 /* skip if PG_NOSYNC */
162
163TAILQ_HEAD(object_q, vm_object);
164
165extern struct object_q vm_object_list; /* list of allocated objects */
166extern struct mtx vm_object_list_mtx; /* lock for object list and count */
167
168extern vm_object_t kernel_object; /* the single kernel object */
169extern vm_object_t kmem_object;
170
171#endif /* _KERNEL */
172
173#ifdef _KERNEL
174void vm_freeze_copyopts(vm_object_t, vm_pindex_t, vm_pindex_t);
175
176void vm_object_set_flag(vm_object_t object, u_short bits);
177void vm_object_clear_flag(vm_object_t object, u_short bits);
178void vm_object_pip_add(vm_object_t object, short i);
179void vm_object_pip_subtract(vm_object_t object, short i);
180void vm_object_pip_wakeup(vm_object_t object);
181void vm_object_pip_wakeupn(vm_object_t object, short i);
182void vm_object_pip_sleep(vm_object_t object, char *waitid);
183void vm_object_pip_wait(vm_object_t object, char *waitid);
184
185vm_object_t vm_object_allocate (objtype_t, vm_pindex_t);
186vm_object_t vm_object_allocate_wait (objtype_t, vm_pindex_t, int);
186void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
187boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
188void vm_object_collapse (vm_object_t);
189void vm_object_deallocate (vm_object_t);
190void vm_object_terminate (vm_object_t);
191void vm_object_vndeallocate (vm_object_t);
192void vm_object_set_writeable_dirty (vm_object_t);
193void vm_object_init (void);
194void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
195void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
196void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
197void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
198void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
199void vm_object_reference (vm_object_t);
200void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
201void vm_object_split(vm_map_entry_t);
202void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
203void vm_object_init2 (void);
204#endif /* _KERNEL */
205
206#endif /* _VM_OBJECT_ */
187void _vm_object_allocate (objtype_t, vm_pindex_t, vm_object_t);
188boolean_t vm_object_coalesce (vm_object_t, vm_pindex_t, vm_size_t, vm_size_t);
189void vm_object_collapse (vm_object_t);
190void vm_object_deallocate (vm_object_t);
191void vm_object_terminate (vm_object_t);
192void vm_object_vndeallocate (vm_object_t);
193void vm_object_set_writeable_dirty (vm_object_t);
194void vm_object_init (void);
195void vm_object_page_clean (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
196void vm_object_page_remove (vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t);
197void vm_object_pmap_copy (vm_object_t, vm_pindex_t, vm_pindex_t);
198void vm_object_pmap_copy_1 (vm_object_t, vm_pindex_t, vm_pindex_t);
199void vm_object_pmap_remove (vm_object_t, vm_pindex_t, vm_pindex_t);
200void vm_object_reference (vm_object_t);
201void vm_object_shadow (vm_object_t *, vm_ooffset_t *, vm_size_t);
202void vm_object_split(vm_map_entry_t);
203void vm_object_madvise (vm_object_t, vm_pindex_t, int, int);
204void vm_object_init2 (void);
205#endif /* _KERNEL */
206
207#endif /* _VM_OBJECT_ */