]> git.saurik.com Git - apple/xnu.git/blob - osfmk/vm/vm_object.h
projects / apple / xnu.git / blob
? search:


dbfc2a85ec3a91b82acbe68be64bb57b0e8b16a8
[apple/xnu.git] / osfmk / vm / vm_object.h
1 /*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
7 *
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * file.
14 *
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
22 *
23 * @APPLE_LICENSE_HEADER_END@
24 */
25 /*
26 * @OSF_COPYRIGHT@
27 */
28 /*
29 * Mach Operating System
30 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
31 * All Rights Reserved.
32 *
33 * Permission to use, copy, modify and distribute this software and its
34 * documentation is hereby granted, provided that both the copyright
35 * notice and this permission notice appear in all copies of the
36 * software, derivative works or modified versions, and any portions
37 * thereof, and that both notices appear in supporting documentation.
38 *
39 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
40 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
41 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
42 *
43 * Carnegie Mellon requests users of this software to return to
44 *
45 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
46 * School of Computer Science
47 * Carnegie Mellon University
48 * Pittsburgh PA 15213-3890
49 *
50 * any improvements or extensions that they make and grant Carnegie Mellon
51 * the rights to redistribute these changes.
52 */
53 /*
54 */
55 /*
56 * File: vm_object.h
57 * Author: Avadis Tevanian, Jr., Michael Wayne Young
58 * Date: 1985
59 *
60 * Virtual memory object module definitions.
61 */
62
63 #ifndef _VM_VM_OBJECT_H_
64 #define _VM_VM_OBJECT_H_
65
66 #include <mach_pagemap.h>
67 #include <task_swapper.h>
68
69 #include <mach/kern_return.h>
70 #include <mach/boolean.h>
71 #include <mach/memory_object_types.h>
72 #include <mach/port.h>
73 #include <mach/vm_prot.h>
74 #include <mach/machine/vm_types.h>
75 #include <kern/queue.h>
76 #include <kern/lock.h>
77 #include <kern/assert.h>
78 #include <kern/ipc_mig.h>
79 #include <kern/misc_protos.h>
80 #include <kern/macro_help.h>
81 #include <ipc/ipc_types.h>
82 #include <vm/pmap.h>
83
84 #if MACH_PAGEMAP
85 #include <vm/vm_external.h>
86 #endif /* MACH_PAGEMAP */
87
88 typedef memory_object_control_t pager_request_t;
89 #define PAGER_REQUEST_NULL ((pager_request_t) 0)
90
91 /*
92 * Types defined:
93 *
94 * vm_object_t Virtual memory object.
95 */
96
97 typedef unsigned long long vm_object_size_t;
98
99
100 struct vm_object {
101 queue_head_t memq; /* Resident memory */
102 decl_mutex_data(, Lock) /* Synchronization */
103
104 vm_object_size_t size; /* Object size (only valid
105 * if internal)
106 */
107 vm_object_size_t frozen_size; /* How much has been marked
108 * copy-on-write (only
109 * valid if copy_symmetric)
110 */
111 int ref_count; /* Number of references */
112 #if TASK_SWAPPER
113 int res_count; /* Residency references (swap)*/
114 #endif /* TASK_SWAPPER */
115 unsigned int resident_page_count;
116 /* number of resident pages */
117
118 struct vm_object *copy; /* Object that should receive
119 * a copy of my changed pages,
120 * for copy_delay, or just the
121 * temporary object that
122 * shadows this object, for
123 * copy_call.
124 */
125 struct vm_object *shadow; /* My shadow */
126 vm_object_offset_t shadow_offset; /* Offset into shadow */
127
128 memory_object_t pager; /* Where to get data */
129 vm_object_offset_t paging_offset; /* Offset into memory object */
130 pager_request_t pager_request; /* Where data comes back */
131
132 memory_object_copy_strategy_t
133 copy_strategy; /* How to handle data copy */
134
135 unsigned int absent_count; /* The number of pages that
136 * have been requested but
137 * not filled. That is, the
138 * number of pages for which
139 * the "absent" attribute is
140 * asserted.
141 */
142
143 unsigned int paging_in_progress;
144 /* The memory object ports are
145 * being used (e.g., for pagein
146 * or pageout) -- don't change
147 * any of these fields (i.e.,
148 * don't collapse, destroy or
149 * terminate)
150 */
151 unsigned int
152 /* boolean_t array */ all_wanted:11, /* Bit array of "want to be
153 * awakened" notations. See
154 * VM_OBJECT_EVENT_* items
155 * below */
156 /* boolean_t */ pager_created:1, /* Has pager been created? */
157 /* boolean_t */ pager_initialized:1, /* Are fields ready to use? */
158 /* boolean_t */ pager_ready:1, /* Will pager take requests? */
159
160 /* boolean_t */ pager_trusted:1,/* The pager for this object
161 * is trusted. This is true for
162 * all internal objects (backed
163 * by the default pager)
164 */
165 /* boolean_t */ can_persist:1, /* The kernel may keep the data
166 * for this object (and rights
167 * to the memory object) after
168 * all address map references
169 * are deallocated?
170 */
171 /* boolean_t */ internal:1, /* Created by the kernel (and
172 * therefore, managed by the
173 * default memory manger)
174 */
175 /* boolean_t */ temporary:1, /* Permanent objects may be
176 * changed externally by the
177 * memory manager, and changes
178 * made in memory must be
179 * reflected back to the memory
180 * manager. Temporary objects
181 * lack both of these
182 * characteristics.
183 */
184 /* boolean_t */ private:1, /* magic device_pager object,
185 * holds private pages only */
186 /* boolean_t */ pageout:1, /* pageout object. contains
187 * private pages that refer to
188 * a real memory object. */
189 /* boolean_t */ alive:1, /* Not yet terminated */
190
191 /* boolean_t */ lock_in_progress:1,
192 /* Is a multi-page lock
193 * request in progress?
194 */
195 /* boolean_t */ lock_restart:1,
196 /* Should lock request in
197 * progress restart search?
198 */
199 /* boolean_t */ shadowed:1, /* Shadow may exist */
200 /* boolean_t */ silent_overwrite:1,
201 /* Allow full page overwrite
202 * without data_request if
203 * page is absent */
204 /* boolean_t */ advisory_pageout:1,
205 /* Instead of sending page
206 * via OOL, just notify
207 * pager that the kernel
208 * wants to discard it, page
209 * remains in object */
210 /* boolean_t */ true_share:1,
211 /* This object is mapped
212 * in more than one place
213 * and hence cannot be
214 * coalesced */
215 /* boolean_t */ terminating:1,
216 /* Allows vm_object_lookup
217 * and vm_object_deallocate
218 * to special case their
219 * behavior when they are
220 * called as a result of
221 * page cleaning during
222 * object termination
223 */
224 /* boolean_t */ named:1, /* An enforces an internal
225 * naming convention, by
226 * calling the right routines
227 * for allocation and
228 * destruction, UBC references
229 * against the vm_object are
230 * checked.
231 */
232 /* boolean_t */ shadow_severed:1,
233 /* When a permanent object
234 * backing a COW goes away
235 * unexpectedly. This bit
236 * allows vm_fault to return
237 * an error rather than a
238 * zero filled page.
239 */
240 /* boolean_t */ phys_contiguous:1,
241 /* Memory is wired and
242 * guaranteed physically
243 * contiguous. However
244 * it is not device memory
245 * and obeys normal virtual
246 * memory rules w.r.t pmap
247 * access bits.
248 */
249 /* boolean_t */ nophyscache:1;
250 /* When mapped at the
251 * pmap level, don't allow
252 * primary caching. (for
253 * I/O)
254 */
255
256
257
258 queue_chain_t cached_list; /* Attachment point for the
259 * list of objects cached as a
260 * result of their can_persist
261 * value
262 */
263
264 queue_head_t msr_q; /* memory object synchronise
265 request queue */
266
267 vm_object_offset_t last_alloc; /* last allocation offset */
268 vm_size_t cluster_size; /* size of paging cluster */
269 #if MACH_PAGEMAP
270 vm_external_map_t existence_map; /* bitmap of pages written to
271 * backing storage */
272 #endif /* MACH_PAGEMAP */
273 int cow_hint; /* last page present in */
274 /* shadow but not in object */
275 #if MACH_ASSERT
276 struct vm_object *paging_object; /* object which pages to be
277 * swapped out are temporary
278 * put in current object
279 */
280 #endif
281 /* hold object lock when altering */
282 unsigned int /* cache WIMG bits */
283 wimg_bits:8, /* wimg plus some expansion*/
284 not_in_use:24;
285 #ifdef UBC_DEBUG
286 queue_head_t uplq; /* List of outstanding upls */
287 #endif /* UBC_DEBUG */
288 };
289
290 __private_extern__
291 vm_object_t kernel_object; /* the single kernel object */
292
293 __private_extern__
294 int vm_object_absent_max; /* maximum number of absent pages
295 at a time for each object */
296
297 # define VM_MSYNC_INITIALIZED 0
298 # define VM_MSYNC_SYNCHRONIZING 1
299 # define VM_MSYNC_DONE 2
300
301 struct msync_req {
302 queue_chain_t msr_q; /* object request queue */
303 queue_chain_t req_q; /* vm_msync request queue */
304 unsigned int flag;
305 vm_object_offset_t offset;
306 vm_object_size_t length;
307 vm_object_t object; /* back pointer */
308 decl_mutex_data(, msync_req_lock) /* Lock for this structure */
309 };
310
311 typedef struct msync_req *msync_req_t;
312 #define MSYNC_REQ_NULL ((msync_req_t) 0)
313
314 /*
315 * Macros to allocate and free msync_reqs
316 */
317 #define msync_req_alloc(msr) \
318 MACRO_BEGIN \
319 (msr) = (msync_req_t)kalloc(sizeof(struct msync_req)); \
320 mutex_init(&(msr)->msync_req_lock, ETAP_VM_MSYNC); \
321 msr->flag = VM_MSYNC_INITIALIZED; \
322 MACRO_END
323
324 #define msync_req_free(msr) \
325 (kfree((vm_offset_t)(msr), sizeof(struct msync_req)))
326
327 #define msr_lock(msr) mutex_lock(&(msr)->msync_req_lock)
328 #define msr_unlock(msr) mutex_unlock(&(msr)->msync_req_lock)
329
330 /*
331 * Declare procedures that operate on VM objects.
332 */
333
334 __private_extern__ void vm_object_bootstrap(void);
335
336 __private_extern__ void vm_object_init(void);
337
338 __private_extern__ vm_object_t vm_object_allocate(
339 vm_object_size_t size);
340
341 #if TASK_SWAPPER
342
343 __private_extern__ void vm_object_res_reference(
344 vm_object_t object);
345 __private_extern__ void vm_object_res_deallocate(
346 vm_object_t object);
347 #define VM_OBJ_RES_INCR(object) (object)->res_count++
348 #define VM_OBJ_RES_DECR(object) (object)->res_count--
349
350 #else /* TASK_SWAPPER */
351
352 #define VM_OBJ_RES_INCR(object)
353 #define VM_OBJ_RES_DECR(object)
354 #define vm_object_res_reference(object)
355 #define vm_object_res_deallocate(object)
356
357 #endif /* TASK_SWAPPER */
358
359 #define vm_object_reference_locked(object) \
360 MACRO_BEGIN \
361 vm_object_t RLObject = (object); \
362 assert((RLObject)->ref_count > 0); \
363 (RLObject)->ref_count++; \
364 vm_object_res_reference(RLObject); \
365 MACRO_END
366
367
368 #if MACH_ASSERT
369
370 __private_extern__ void vm_object_reference(
371 vm_object_t object);
372
373 #else /* MACH_ASSERT */
374
375 #define vm_object_reference(object) \
376 MACRO_BEGIN \
377 vm_object_t RObject = (object); \
378 if (RObject) { \
379 vm_object_lock(RObject); \
380 vm_object_reference_locked(RObject); \
381 vm_object_unlock(RObject); \
382 } \
383 MACRO_END
384
385 #endif /* MACH_ASSERT */
386
387 __private_extern__ void vm_object_deallocate(
388 vm_object_t object);
389
390 __private_extern__ kern_return_t vm_object_release_name(
391 vm_object_t object,
392 int flags);
393
394 __private_extern__ void vm_object_pmap_protect(
395 vm_object_t object,
396 vm_object_offset_t offset,
397 vm_size_t size,
398 pmap_t pmap,
399 vm_offset_t pmap_start,
400 vm_prot_t prot);
401
402 __private_extern__ void vm_object_page_remove(
403 vm_object_t object,
404 vm_object_offset_t start,
405 vm_object_offset_t end);
406
407 __private_extern__ void vm_object_deactivate_pages(
408 vm_object_t object,
409 vm_object_offset_t offset,
410 vm_object_size_t size,
411 boolean_t kill_page);
412
413 __private_extern__ boolean_t vm_object_coalesce(
414 vm_object_t prev_object,
415 vm_object_t next_object,
416 vm_object_offset_t prev_offset,
417 vm_object_offset_t next_offset,
418 vm_object_size_t prev_size,
419 vm_object_size_t next_size);
420
421 __private_extern__ boolean_t vm_object_shadow(
422 vm_object_t *object,
423 vm_object_offset_t *offset,
424 vm_object_size_t length);
425
426 __private_extern__ void vm_object_collapse(
427 vm_object_t object);
428
429 __private_extern__ boolean_t vm_object_copy_quickly(
430 vm_object_t *_object,
431 vm_object_offset_t src_offset,
432 vm_object_size_t size,
433 boolean_t *_src_needs_copy,
434 boolean_t *_dst_needs_copy);
435
436 __private_extern__ kern_return_t vm_object_copy_strategically(
437 vm_object_t src_object,
438 vm_object_offset_t src_offset,
439 vm_object_size_t size,
440 vm_object_t *dst_object,
441 vm_object_offset_t *dst_offset,
442 boolean_t *dst_needs_copy);
443
444 __private_extern__ kern_return_t vm_object_copy_slowly(
445 vm_object_t src_object,
446 vm_object_offset_t src_offset,
447 vm_object_size_t size,
448 int interruptible,
449 vm_object_t *_result_object);
450
451 __private_extern__ vm_object_t vm_object_copy_delayed(
452 vm_object_t src_object,
453 vm_object_offset_t src_offset,
454 vm_object_size_t size);
455
456
457
458 __private_extern__ kern_return_t vm_object_destroy(
459 vm_object_t object,
460 kern_return_t reason);
461
462 __private_extern__ void vm_object_pager_create(
463 vm_object_t object);
464
465 __private_extern__ void vm_object_page_map(
466 vm_object_t object,
467 vm_object_offset_t offset,
468 vm_object_size_t size,
469 vm_object_offset_t (*map_fn)
470 (void *, vm_object_offset_t),
471 void *map_fn_data);
472
473 __private_extern__ kern_return_t vm_object_upl_request(
474 vm_object_t object,
475 vm_object_offset_t offset,
476 vm_size_t size,
477 upl_t *upl,
478 upl_page_info_t *page_info,
479 unsigned int *count,
480 int flags);
481
482 __private_extern__ boolean_t vm_object_sync(
483 vm_object_t object,
484 vm_object_offset_t offset,
485 vm_size_t size,
486 boolean_t should_flush,
487 boolean_t should_return);
488
489 __private_extern__ kern_return_t vm_object_update(
490 vm_object_t object,
491 vm_object_offset_t offset,
492 vm_size_t size, /* should be 64 */
493 memory_object_return_t should_return,
494 int flags,
495 vm_prot_t prot);
496
497 __private_extern__ kern_return_t vm_object_lock_request(
498 vm_object_t object,
499 vm_object_offset_t offset,
500 vm_object_size_t size,
501 memory_object_return_t should_return,
502 int flags,
503 vm_prot_t prot);
504
505
506
507 __private_extern__ vm_object_t vm_object_enter(
508 memory_object_t pager,
509 vm_object_size_t size,
510 boolean_t internal,
511 boolean_t init,
512 boolean_t check_named);
513
514
515 /*
516 * Event waiting handling
517 */
518
519 #define VM_OBJECT_EVENT_INITIALIZED 0
520 #define VM_OBJECT_EVENT_PAGER_READY 1
521 #define VM_OBJECT_EVENT_PAGING_IN_PROGRESS 2
522 #define VM_OBJECT_EVENT_ABSENT_COUNT 3
523 #define VM_OBJECT_EVENT_LOCK_IN_PROGRESS 4
524 #define VM_OBJECT_EVENT_UNCACHING 5
525 #define VM_OBJECT_EVENT_COPY_CALL 6
526 #define VM_OBJECT_EVENT_CACHING 7
527
528 #define vm_object_assert_wait(object, event, interruptible) \
529 (((object)->all_wanted |= 1 << (event)), \
530 assert_wait((event_t)((vm_offset_t)(object)+(event)),(interruptible)))
531
532 #define vm_object_wait(object, event, interruptible) \
533 (vm_object_assert_wait((object),(event),(interruptible)), \
534 vm_object_unlock(object), \
535 thread_block(THREAD_CONTINUE_NULL)) \
536
537 #define thread_sleep_vm_object(object, event, interruptible) \
538 thread_sleep_mutex((event_t)(event), &(object)->Lock, (interruptible))
539
540 #define vm_object_sleep(object, event, interruptible) \
541 (((object)->all_wanted |= 1 << (event)), \
542 thread_sleep_vm_object((object), \
543 ((vm_offset_t)(object)+(event)), (interruptible)))
544
545 #define vm_object_wakeup(object, event) \
546 MACRO_BEGIN \
547 if ((object)->all_wanted & (1 << (event))) \
548 thread_wakeup((event_t)((vm_offset_t)(object) + (event))); \
549 (object)->all_wanted &= ~(1 << (event)); \
550 MACRO_END
551
552 #define vm_object_set_wanted(object, event) \
553 MACRO_BEGIN \
554 ((object)->all_wanted |= (1 << (event))); \
555 MACRO_END
556
557 #define vm_object_wanted(object, event) \
558 ((object)->all_wanted & (1 << (event)))
559
560 /*
561 * Routines implemented as macros
562 */
563
564 #define vm_object_paging_begin(object) \
565 MACRO_BEGIN \
566 (object)->paging_in_progress++; \
567 MACRO_END
568
569 #define vm_object_paging_end(object) \
570 MACRO_BEGIN \
571 assert((object)->paging_in_progress != 0); \
572 if (--(object)->paging_in_progress == 0) { \
573 vm_object_wakeup(object, \
574 VM_OBJECT_EVENT_PAGING_IN_PROGRESS); \
575 } \
576 MACRO_END
577
578 #define vm_object_paging_wait(object, interruptible) \
579 MACRO_BEGIN \
580 while ((object)->paging_in_progress != 0) { \
581 wait_result_t _wr; \
582 \
583 _wr = vm_object_sleep((object), \
584 VM_OBJECT_EVENT_PAGING_IN_PROGRESS, \
585 (interruptible)); \
586 \
587 /*XXX if ((interruptible) && (_wr != THREAD_AWAKENED))*/\
588 /*XXX break; */ \
589 } \
590 MACRO_END
591
592 #define vm_object_absent_assert_wait(object, interruptible) \
593 MACRO_BEGIN \
594 vm_object_assert_wait( (object), \
595 VM_OBJECT_EVENT_ABSENT_COUNT, \
596 (interruptible)); \
597 MACRO_END
598
599
600 #define vm_object_absent_release(object) \
601 MACRO_BEGIN \
602 (object)->absent_count--; \
603 vm_object_wakeup((object), \
604 VM_OBJECT_EVENT_ABSENT_COUNT); \
605 MACRO_END
606
607 /*
608 * Object locking macros
609 */
610
611 #define vm_object_lock_init(object) mutex_init(&(object)->Lock, ETAP_VM_OBJ)
612 #define vm_object_lock(object) mutex_lock(&(object)->Lock)
613 #define vm_object_unlock(object) mutex_unlock(&(object)->Lock)
614 #define vm_object_lock_try(object) mutex_try(&(object)->Lock)
615
616 #endif /* _VM_VM_OBJECT_H_ */
mirror of XNU