Deleted Added
full compact
vm_object.h (33817) vm_object.h (34206)
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 * $Id: vm_object.h,v 1.45 1998/02/05 03:32:45 dyson Exp $
64 * $Id: vm_object.h,v 1.46 1998/02/25 03:55:52 dyson Exp $
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_DEAD };
77typedef enum obj_type objtype_t;
78
79/*
80 * Types defined:
81 *
82 * vm_object_t Virtual memory object.
83 */
84
85struct vm_object {
86 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
87 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
88 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
89 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */
90 int generation; /* generation ID */
91 objtype_t type; /* type of pager */
92 vm_size_t size; /* Object size */
93 int ref_count; /* How many refs?? */
94 int shadow_count; /* how many objects that this is a shadow for */
95 int pg_color; /* color of first page in obj */
96 u_short flags; /* see below */
97 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
98 u_short behavior; /* see below */
99 int resident_page_count; /* number of resident pages */
100 int cache_count; /* number of cached pages */
101 int wire_count; /* number of wired pages */
102 vm_ooffset_t paging_offset; /* Offset into paging space */
103 struct vm_object *backing_object; /* object that I'm a shadow of */
104 vm_ooffset_t backing_object_offset;/* Offset in backing object */
105 vm_offset_t last_read; /* last read in object -- detect seq behavior */
106 vm_page_t page_hint; /* hint for last looked-up or allocated page */
107 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
108 void *handle;
109 union {
110 struct {
111 off_t vnp_size; /* Current size of file */
112 } vnp;
113 struct {
114 TAILQ_HEAD(, vm_page) devp_pglist; /* list of pages allocated */
115 } devp;
116 struct {
117 int swp_nblocks;
118 int swp_allocsize;
119 struct swblock *swp_blocks;
120 short swp_poip;
121 } swp;
122 } un_pager;
123};
124
125/*
126 * Flags
127 */
128#define OBJ_ACTIVE 0x0004 /* active objects */
129#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
130#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
131#define OBJ_WRITEABLE 0x0080 /* object has been made writable */
132#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
133#define OBJ_CLEANING 0x0200
134#define OBJ_OPT 0x1000 /* I/O optimization */
135
136#define OBJ_NORMAL 0x0 /* default behavior */
137#define OBJ_SEQUENTIAL 0x1 /* expect sequential accesses */
138#define OBJ_RANDOM 0x2 /* expect random accesses */
139
140#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
141#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
142
143#ifdef KERNEL
144
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_DEAD };
77typedef enum obj_type objtype_t;
78
79/*
80 * Types defined:
81 *
82 * vm_object_t Virtual memory object.
83 */
84
85struct vm_object {
86 TAILQ_ENTRY(vm_object) object_list; /* list of all objects */
87 TAILQ_HEAD(, vm_object) shadow_head; /* objects that this is a shadow for */
88 TAILQ_ENTRY(vm_object) shadow_list; /* chain of shadow objects */
89 TAILQ_HEAD(, vm_page) memq; /* list of resident pages */
90 int generation; /* generation ID */
91 objtype_t type; /* type of pager */
92 vm_size_t size; /* Object size */
93 int ref_count; /* How many refs?? */
94 int shadow_count; /* how many objects that this is a shadow for */
95 int pg_color; /* color of first page in obj */
96 u_short flags; /* see below */
97 u_short paging_in_progress; /* Paging (in or out) so don't collapse or destroy */
98 u_short behavior; /* see below */
99 int resident_page_count; /* number of resident pages */
100 int cache_count; /* number of cached pages */
101 int wire_count; /* number of wired pages */
102 vm_ooffset_t paging_offset; /* Offset into paging space */
103 struct vm_object *backing_object; /* object that I'm a shadow of */
104 vm_ooffset_t backing_object_offset;/* Offset in backing object */
105 vm_offset_t last_read; /* last read in object -- detect seq behavior */
106 vm_page_t page_hint; /* hint for last looked-up or allocated page */
107 TAILQ_ENTRY(vm_object) pager_object_list; /* list of all objects of this pager type */
108 void *handle;
109 union {
110 struct {
111 off_t vnp_size; /* Current size of file */
112 } vnp;
113 struct {
114 TAILQ_HEAD(, vm_page) devp_pglist; /* list of pages allocated */
115 } devp;
116 struct {
117 int swp_nblocks;
118 int swp_allocsize;
119 struct swblock *swp_blocks;
120 short swp_poip;
121 } swp;
122 } un_pager;
123};
124
125/*
126 * Flags
127 */
128#define OBJ_ACTIVE 0x0004 /* active objects */
129#define OBJ_DEAD 0x0008 /* dead objects (during rundown) */
130#define OBJ_PIPWNT 0x0040 /* paging in progress wanted */
131#define OBJ_WRITEABLE 0x0080 /* object has been made writable */
132#define OBJ_MIGHTBEDIRTY 0x0100 /* object might be dirty */
133#define OBJ_CLEANING 0x0200
134#define OBJ_OPT 0x1000 /* I/O optimization */
135
136#define OBJ_NORMAL 0x0 /* default behavior */
137#define OBJ_SEQUENTIAL 0x1 /* expect sequential accesses */
138#define OBJ_RANDOM 0x2 /* expect random accesses */
139
140#define IDX_TO_OFF(idx) (((vm_ooffset_t)(idx)) << PAGE_SHIFT)
141#define OFF_TO_IDX(off) ((vm_pindex_t)(((vm_ooffset_t)(off)) >> PAGE_SHIFT))
142
143#ifdef KERNEL
144
145#define OBJPC_SYNC 0x1 /* sync I/O */
146#define OBJPC_INVAL 0x2 /* invalidate */
147
145TAILQ_HEAD(object_q, vm_object);
146
147extern struct object_q vm_object_list; /* list of allocated objects */
148
149 /* lock for object list and count */
150
151extern vm_object_t kernel_object; /* the single kernel object */
152extern vm_object_t kmem_object;
153
154#endif /* KERNEL */
155
156#ifdef KERNEL
157static __inline void
158vm_object_pip_wakeup(vm_object_t object)
159{
160 object->paging_in_progress--;
161 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
162 object->flags &= ~OBJ_PIPWNT;
163 wakeup(object);
164 }
165}
166
167static __inline void
168vm_object_pip_sleep(vm_object_t object, char *waitid)
169{
170 int s;
171
172 if (object->paging_in_progress) {
173 s = splvm();
174 if (object->paging_in_progress) {
175 object->flags |= OBJ_PIPWNT;
176 tsleep(object, PVM, waitid, 0);
177 }
178 splx(s);
179 }
180}
181
182static __inline void
183vm_object_pip_wait(vm_object_t object, char *waitid)
184{
185 while (object->paging_in_progress)
186 vm_object_pip_sleep(object, waitid);
187}
188
189vm_object_t vm_object_allocate __P((objtype_t, vm_size_t));
190void _vm_object_allocate __P((objtype_t, vm_size_t, vm_object_t));
191boolean_t vm_object_coalesce __P((vm_object_t, vm_pindex_t, vm_size_t, vm_size_t));
192void vm_object_collapse __P((vm_object_t));
193void vm_object_copy __P((vm_object_t, vm_pindex_t, vm_object_t *, vm_pindex_t *, boolean_t *));
194void vm_object_deallocate __P((vm_object_t));
195void vm_object_terminate __P((vm_object_t));
196void vm_object_vndeallocate __P((vm_object_t));
197void vm_object_init __P((void));
198void vm_object_page_clean __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t));
199void vm_object_page_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t));
200void vm_object_pmap_copy __P((vm_object_t, vm_pindex_t, vm_pindex_t));
201void vm_object_pmap_copy_1 __P((vm_object_t, vm_pindex_t, vm_pindex_t));
202void vm_object_pmap_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t));
203void vm_object_reference __P((vm_object_t));
204void vm_object_shadow __P((vm_object_t *, vm_ooffset_t *, vm_size_t));
205void vm_object_madvise __P((vm_object_t, vm_pindex_t, int, int));
206void vm_object_init2 __P((void));
207#endif /* KERNEL */
208
209#endif /* _VM_OBJECT_ */
148TAILQ_HEAD(object_q, vm_object);
149
150extern struct object_q vm_object_list; /* list of allocated objects */
151
152 /* lock for object list and count */
153
154extern vm_object_t kernel_object; /* the single kernel object */
155extern vm_object_t kmem_object;
156
157#endif /* KERNEL */
158
159#ifdef KERNEL
160static __inline void
161vm_object_pip_wakeup(vm_object_t object)
162{
163 object->paging_in_progress--;
164 if ((object->flags & OBJ_PIPWNT) && object->paging_in_progress == 0) {
165 object->flags &= ~OBJ_PIPWNT;
166 wakeup(object);
167 }
168}
169
170static __inline void
171vm_object_pip_sleep(vm_object_t object, char *waitid)
172{
173 int s;
174
175 if (object->paging_in_progress) {
176 s = splvm();
177 if (object->paging_in_progress) {
178 object->flags |= OBJ_PIPWNT;
179 tsleep(object, PVM, waitid, 0);
180 }
181 splx(s);
182 }
183}
184
185static __inline void
186vm_object_pip_wait(vm_object_t object, char *waitid)
187{
188 while (object->paging_in_progress)
189 vm_object_pip_sleep(object, waitid);
190}
191
192vm_object_t vm_object_allocate __P((objtype_t, vm_size_t));
193void _vm_object_allocate __P((objtype_t, vm_size_t, vm_object_t));
194boolean_t vm_object_coalesce __P((vm_object_t, vm_pindex_t, vm_size_t, vm_size_t));
195void vm_object_collapse __P((vm_object_t));
196void vm_object_copy __P((vm_object_t, vm_pindex_t, vm_object_t *, vm_pindex_t *, boolean_t *));
197void vm_object_deallocate __P((vm_object_t));
198void vm_object_terminate __P((vm_object_t));
199void vm_object_vndeallocate __P((vm_object_t));
200void vm_object_init __P((void));
201void vm_object_page_clean __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t));
202void vm_object_page_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t, boolean_t));
203void vm_object_pmap_copy __P((vm_object_t, vm_pindex_t, vm_pindex_t));
204void vm_object_pmap_copy_1 __P((vm_object_t, vm_pindex_t, vm_pindex_t));
205void vm_object_pmap_remove __P((vm_object_t, vm_pindex_t, vm_pindex_t));
206void vm_object_reference __P((vm_object_t));
207void vm_object_shadow __P((vm_object_t *, vm_ooffset_t *, vm_size_t));
208void vm_object_madvise __P((vm_object_t, vm_pindex_t, int, int));
209void vm_object_init2 __P((void));
210#endif /* KERNEL */
211
212#endif /* _VM_OBJECT_ */