2 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the
10 * License may not be used to create, or enable the creation or
11 * redistribution of, unlawful or unlicensed copies of an Apple operating
12 * system, or to circumvent, violate, or enable the circumvention or
13 * violation of, any terms of an Apple operating system software license
16 * Please obtain a copy of the License at
17 * http://www.opensource.apple.com/apsl/ and read it before using this
20 * The Original Code and all software distributed under the License are
21 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
22 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
23 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
25 * Please see the License for the specific language governing rights and
26 * limitations under the License.
28 * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
34 * Mach Operating System
35 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
36 * All Rights Reserved.
38 * Permission to use, copy, modify and distribute this software and its
39 * documentation is hereby granted, provided that both the copyright
40 * notice and this permission notice appear in all copies of the
41 * software, derivative works or modified versions, and any portions
42 * thereof, and that both notices appear in supporting documentation.
44 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
45 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
46 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
48 * Carnegie Mellon requests users of this software to return to
50 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
51 * School of Computer Science
52 * Carnegie Mellon University
53 * Pittsburgh PA 15213-3890
55 * any improvements or extensions that they make and grant Carnegie Mellon
56 * the rights to redistribute these changes.
62 * Author: Avadis Tevanian, Jr., Michael Wayne Young
65 * Virtual memory object module definitions.
68 #ifndef _VM_VM_OBJECT_H_
69 #define _VM_VM_OBJECT_H_
71 #include <mach_pagemap.h>
72 #include <task_swapper.h>
74 #include <mach/kern_return.h>
75 #include <mach/boolean.h>
76 #include <mach/memory_object_types.h>
77 #include <mach/port.h>
78 #include <mach/vm_prot.h>
79 #include <mach/vm_param.h>
80 #include <mach/machine/vm_types.h>
81 #include <kern/queue.h>
82 #include <kern/lock.h>
83 #include <kern/assert.h>
84 #include <kern/misc_protos.h>
85 #include <kern/macro_help.h>
86 #include <ipc/ipc_types.h>
90 #include <vm/vm_external.h>
91 #endif /* MACH_PAGEMAP */
98 * vm_object_t Virtual memory object.
102 queue_head_t memq
; /* Resident memory */
103 decl_mutex_data(, Lock
) /* Synchronization */
105 vm_object_size_t size
; /* Object size (only valid
108 struct vm_page
*memq_hint
;
109 int ref_count
; /* Number of references */
111 int res_count
; /* Residency references (swap)*/
112 #endif /* TASK_SWAPPER */
113 unsigned int resident_page_count
;
114 /* number of resident pages */
116 struct vm_object
*copy
; /* Object that should receive
117 * a copy of my changed pages,
118 * for copy_delay, or just the
119 * temporary object that
120 * shadows this object, for
123 struct vm_object
*shadow
; /* My shadow */
124 vm_object_offset_t shadow_offset
; /* Offset into shadow */
126 memory_object_t pager
; /* Where to get data */
127 vm_object_offset_t paging_offset
; /* Offset into memory object */
128 memory_object_control_t pager_control
; /* Where data comes back */
130 memory_object_copy_strategy_t
131 copy_strategy
; /* How to handle data copy */
133 unsigned int absent_count
; /* The number of pages that
134 * have been requested but
135 * not filled. That is, the
136 * number of pages for which
137 * the "absent" attribute is
141 int paging_in_progress
;
142 /* The memory object ports are
143 * being used (e.g., for pagein
144 * or pageout) -- don't change
145 * any of these fields (i.e.,
146 * don't collapse, destroy or
150 /* boolean_t array */ all_wanted
:11, /* Bit array of "want to be
151 * awakened" notations. See
152 * VM_OBJECT_EVENT_* items
154 /* boolean_t */ pager_created
:1, /* Has pager been created? */
155 /* boolean_t */ pager_initialized
:1, /* Are fields ready to use? */
156 /* boolean_t */ pager_ready
:1, /* Will pager take requests? */
158 /* boolean_t */ pager_trusted
:1,/* The pager for this object
159 * is trusted. This is true for
160 * all internal objects (backed
161 * by the default pager)
163 /* boolean_t */ can_persist
:1, /* The kernel may keep the data
164 * for this object (and rights
165 * to the memory object) after
166 * all address map references
169 /* boolean_t */ internal
:1, /* Created by the kernel (and
170 * therefore, managed by the
171 * default memory manger)
173 /* boolean_t */ temporary
:1, /* Permanent objects may be
174 * changed externally by the
175 * memory manager, and changes
176 * made in memory must be
177 * reflected back to the memory
178 * manager. Temporary objects
182 /* boolean_t */ private:1, /* magic device_pager object,
183 * holds private pages only */
184 /* boolean_t */ pageout
:1, /* pageout object. contains
185 * private pages that refer to
186 * a real memory object. */
187 /* boolean_t */ alive
:1, /* Not yet terminated */
189 /* boolean_t */ purgable
:2, /* Purgable state. See
190 * VM_OBJECT_PURGABLE_*
193 /* boolean_t */ shadowed
:1, /* Shadow may exist */
194 /* boolean_t */ silent_overwrite
:1,
195 /* Allow full page overwrite
196 * without data_request if
198 /* boolean_t */ advisory_pageout
:1,
199 /* Instead of sending page
200 * via OOL, just notify
201 * pager that the kernel
202 * wants to discard it, page
203 * remains in object */
204 /* boolean_t */ true_share
:1,
205 /* This object is mapped
206 * in more than one place
207 * and hence cannot be
209 /* boolean_t */ terminating
:1,
210 /* Allows vm_object_lookup
211 * and vm_object_deallocate
212 * to special case their
213 * behavior when they are
214 * called as a result of
215 * page cleaning during
218 /* boolean_t */ named
:1, /* An enforces an internal
219 * naming convention, by
220 * calling the right routines
222 * destruction, UBC references
223 * against the vm_object are
226 /* boolean_t */ shadow_severed
:1,
227 /* When a permanent object
228 * backing a COW goes away
229 * unexpectedly. This bit
230 * allows vm_fault to return
231 * an error rather than a
234 /* boolean_t */ phys_contiguous
:1,
235 /* Memory is wired and
236 * guaranteed physically
237 * contiguous. However
238 * it is not device memory
239 * and obeys normal virtual
240 * memory rules w.r.t pmap
243 /* boolean_t */ nophyscache
:1;
244 /* When mapped at the
245 * pmap level, don't allow
246 * primary caching. (for
252 queue_chain_t cached_list
; /* Attachment point for the
253 * list of objects cached as a
254 * result of their can_persist
258 queue_head_t msr_q
; /* memory object synchronise
261 vm_object_offset_t last_alloc
; /* last allocation offset */
262 vm_object_offset_t sequential
; /* sequential access size */
263 vm_size_t cluster_size
; /* size of paging cluster */
265 vm_external_map_t existence_map
; /* bitmap of pages written to
267 #endif /* MACH_PAGEMAP */
268 vm_offset_t cow_hint
; /* last page present in */
269 /* shadow but not in object */
271 struct vm_object
*paging_object
; /* object which pages to be
272 * swapped out are temporary
273 * put in current object
276 /* hold object lock when altering */
277 unsigned int /* cache WIMG bits */
278 wimg_bits
:8, /* wimg plus some expansion*/
281 queue_head_t uplq
; /* List of outstanding upls */
284 * Keep track of the stack traces for the first holders
285 * of a "paging_in_progress" reference for this VM object.
287 #define VM_PIP_DEBUG_STACK_FRAMES 25 /* depth of each stack trace */
288 #define VM_PIP_DEBUG_MAX_REFS 10 /* track that many references */
289 struct __pip_backtrace
{
290 void *pip_retaddr
[VM_PIP_DEBUG_STACK_FRAMES
];
291 } pip_holders
[VM_PIP_DEBUG_MAX_REFS
];
292 #endif /* VM_PIP_DEBUG */
293 #endif /* UPL_DEBUG */
296 #define VM_PAGE_REMOVE(page) \
298 vm_page_t __page = (page); \
299 vm_object_t __object = __page->object; \
300 if (__page == __object->memq_hint) { \
301 vm_page_t __new_hint; \
302 queue_entry_t __qe; \
303 __qe = queue_next(&__page->listq); \
304 if (queue_end(&__object->memq, __qe)) { \
305 __qe = queue_prev(&__page->listq); \
306 if (queue_end(&__object->memq, __qe)) { \
310 __new_hint = (vm_page_t) __qe; \
311 __object->memq_hint = __new_hint; \
313 queue_remove(&__object->memq, __page, vm_page_t, listq); \
316 #define VM_PAGE_INSERT(page, object) \
318 vm_page_t __page = (page); \
319 vm_object_t __object = (object); \
320 queue_enter(&__object->memq, __page, vm_page_t, listq); \
321 __object->memq_hint = __page; \
325 vm_object_t kernel_object
; /* the single kernel object */
328 unsigned int vm_object_absent_max
; /* maximum number of absent pages
329 at a time for each object */
331 # define VM_MSYNC_INITIALIZED 0
332 # define VM_MSYNC_SYNCHRONIZING 1
333 # define VM_MSYNC_DONE 2
336 queue_chain_t msr_q
; /* object request queue */
337 queue_chain_t req_q
; /* vm_msync request queue */
339 vm_object_offset_t offset
;
340 vm_object_size_t length
;
341 vm_object_t object
; /* back pointer */
342 decl_mutex_data(, msync_req_lock
) /* Lock for this structure */
345 typedef struct msync_req
*msync_req_t
;
346 #define MSYNC_REQ_NULL ((msync_req_t) 0)
349 * Macros to allocate and free msync_reqs
351 #define msync_req_alloc(msr) \
353 (msr) = (msync_req_t)kalloc(sizeof(struct msync_req)); \
354 mutex_init(&(msr)->msync_req_lock, 0); \
355 msr->flag = VM_MSYNC_INITIALIZED; \
358 #define msync_req_free(msr) \
359 (kfree((msr), sizeof(struct msync_req)))
361 #define msr_lock(msr) mutex_lock(&(msr)->msync_req_lock)
362 #define msr_unlock(msr) mutex_unlock(&(msr)->msync_req_lock)
365 * Declare procedures that operate on VM objects.
368 __private_extern__
void vm_object_bootstrap(void);
370 __private_extern__
void vm_object_init(void);
372 __private_extern__ vm_object_t
vm_object_allocate(
373 vm_object_size_t size
);
375 __private_extern__
void _vm_object_allocate(vm_object_size_t size
,
380 __private_extern__
void vm_object_res_reference(
382 __private_extern__
void vm_object_res_deallocate(
384 #define VM_OBJ_RES_INCR(object) (object)->res_count++
385 #define VM_OBJ_RES_DECR(object) (object)->res_count--
387 #else /* TASK_SWAPPER */
389 #define VM_OBJ_RES_INCR(object)
390 #define VM_OBJ_RES_DECR(object)
391 #define vm_object_res_reference(object)
392 #define vm_object_res_deallocate(object)
394 #endif /* TASK_SWAPPER */
396 #define vm_object_reference_locked(object) \
398 vm_object_t RLObject = (object); \
399 assert((RLObject)->ref_count > 0); \
400 (RLObject)->ref_count++; \
401 vm_object_res_reference(RLObject); \
405 __private_extern__
void vm_object_reference(
410 #define vm_object_reference(object) \
412 vm_object_t RObject = (object); \
414 vm_object_lock(RObject); \
415 vm_object_reference_locked(RObject); \
416 vm_object_unlock(RObject); \
420 #endif /* MACH_ASSERT */
422 __private_extern__
void vm_object_deallocate(
425 __private_extern__ kern_return_t
vm_object_release_name(
429 __private_extern__
void vm_object_pmap_protect(
431 vm_object_offset_t offset
,
432 vm_object_size_t size
,
434 vm_map_offset_t pmap_start
,
437 __private_extern__
void vm_object_page_remove(
439 vm_object_offset_t start
,
440 vm_object_offset_t end
);
442 __private_extern__
void vm_object_deactivate_pages(
444 vm_object_offset_t offset
,
445 vm_object_size_t size
,
446 boolean_t kill_page
);
448 __private_extern__
unsigned int vm_object_purge(
451 __private_extern__ kern_return_t
vm_object_purgable_control(
453 vm_purgable_t control
,
456 __private_extern__ boolean_t
vm_object_coalesce(
457 vm_object_t prev_object
,
458 vm_object_t next_object
,
459 vm_object_offset_t prev_offset
,
460 vm_object_offset_t next_offset
,
461 vm_object_size_t prev_size
,
462 vm_object_size_t next_size
);
464 __private_extern__ boolean_t
vm_object_shadow(
466 vm_object_offset_t
*offset
,
467 vm_object_size_t length
);
469 __private_extern__
void vm_object_collapse(
471 vm_object_offset_t offset
,
472 boolean_t can_bypass
);
474 __private_extern__ boolean_t
vm_object_copy_quickly(
475 vm_object_t
*_object
,
476 vm_object_offset_t src_offset
,
477 vm_object_size_t size
,
478 boolean_t
*_src_needs_copy
,
479 boolean_t
*_dst_needs_copy
);
481 __private_extern__ kern_return_t
vm_object_copy_strategically(
482 vm_object_t src_object
,
483 vm_object_offset_t src_offset
,
484 vm_object_size_t size
,
485 vm_object_t
*dst_object
,
486 vm_object_offset_t
*dst_offset
,
487 boolean_t
*dst_needs_copy
);
489 __private_extern__ kern_return_t
vm_object_copy_slowly(
490 vm_object_t src_object
,
491 vm_object_offset_t src_offset
,
492 vm_object_size_t size
,
494 vm_object_t
*_result_object
);
496 __private_extern__ vm_object_t
vm_object_copy_delayed(
497 vm_object_t src_object
,
498 vm_object_offset_t src_offset
,
499 vm_object_size_t size
);
503 __private_extern__ kern_return_t
vm_object_destroy(
505 kern_return_t reason
);
507 __private_extern__
void vm_object_pager_create(
510 __private_extern__
void vm_object_page_map(
512 vm_object_offset_t offset
,
513 vm_object_size_t size
,
514 vm_object_offset_t (*map_fn
)
515 (void *, vm_object_offset_t
),
518 __private_extern__ kern_return_t
vm_object_upl_request(
520 vm_object_offset_t offset
,
523 upl_page_info_t
*page_info
,
527 __private_extern__ kern_return_t
vm_object_transpose(
530 vm_object_size_t transpose_size
);
532 __private_extern__ boolean_t
vm_object_sync(
534 vm_object_offset_t offset
,
535 vm_object_size_t size
,
536 boolean_t should_flush
,
537 boolean_t should_return
,
538 boolean_t should_iosync
);
540 __private_extern__ kern_return_t
vm_object_update(
542 vm_object_offset_t offset
,
543 vm_object_size_t size
,
544 vm_object_offset_t
*error_offset
,
546 memory_object_return_t should_return
,
550 __private_extern__ kern_return_t
vm_object_lock_request(
552 vm_object_offset_t offset
,
553 vm_object_size_t size
,
554 memory_object_return_t should_return
,
560 __private_extern__ vm_object_t
vm_object_enter(
561 memory_object_t pager
,
562 vm_object_size_t size
,
565 boolean_t check_named
);
569 * Purgable object state.
572 #define VM_OBJECT_NONPURGABLE 0 /* not a purgable object */
573 #define VM_OBJECT_PURGABLE_NONVOLATILE 1 /* non-volatile purgable object */
574 #define VM_OBJECT_PURGABLE_VOLATILE 2 /* volatile (but intact) purgable object */
575 #define VM_OBJECT_PURGABLE_EMPTY 3 /* volatile purgable object that has been emptied */
577 __private_extern__ kern_return_t
vm_object_populate_with_private(
579 vm_object_offset_t offset
,
583 extern kern_return_t
adjust_vm_object_cache(
587 extern kern_return_t
vm_object_page_op(
589 vm_object_offset_t offset
,
594 extern kern_return_t
vm_object_range_op(
596 vm_object_offset_t offset_beg
,
597 vm_object_offset_t offset_end
,
602 * Event waiting handling
605 #define VM_OBJECT_EVENT_INITIALIZED 0
606 #define VM_OBJECT_EVENT_PAGER_READY 1
607 #define VM_OBJECT_EVENT_PAGING_IN_PROGRESS 2
608 #define VM_OBJECT_EVENT_ABSENT_COUNT 3
609 #define VM_OBJECT_EVENT_LOCK_IN_PROGRESS 4
610 #define VM_OBJECT_EVENT_UNCACHING 5
611 #define VM_OBJECT_EVENT_COPY_CALL 6
612 #define VM_OBJECT_EVENT_CACHING 7
614 #define vm_object_assert_wait(object, event, interruptible) \
615 (((object)->all_wanted |= 1 << (event)), \
616 assert_wait((event_t)((vm_offset_t)(object)+(event)),(interruptible)))
618 #define vm_object_wait(object, event, interruptible) \
619 (vm_object_assert_wait((object),(event),(interruptible)), \
620 vm_object_unlock(object), \
621 thread_block(THREAD_CONTINUE_NULL)) \
623 #define thread_sleep_vm_object(object, event, interruptible) \
624 thread_sleep_mutex((event_t)(event), &(object)->Lock, (interruptible))
626 #define vm_object_sleep(object, event, interruptible) \
627 (((object)->all_wanted |= 1 << (event)), \
628 thread_sleep_vm_object((object), \
629 ((vm_offset_t)(object)+(event)), (interruptible)))
631 #define vm_object_wakeup(object, event) \
633 if ((object)->all_wanted & (1 << (event))) \
634 thread_wakeup((event_t)((vm_offset_t)(object) + (event))); \
635 (object)->all_wanted &= ~(1 << (event)); \
638 #define vm_object_set_wanted(object, event) \
640 ((object)->all_wanted |= (1 << (event))); \
643 #define vm_object_wanted(object, event) \
644 ((object)->all_wanted & (1 << (event)))
647 * Routines implemented as macros
650 extern unsigned OSBacktrace(void **bt
, unsigned maxAddrs
);
651 #define VM_PIP_DEBUG_BEGIN(object) \
653 if ((object)->paging_in_progress < VM_PIP_DEBUG_MAX_REFS) { \
654 int pip = (object)->paging_in_progress; \
655 (void) OSBacktrace(&(object)->pip_holders[pip].retaddr[0], \
656 VM_PIP_DEBUG_STACK_FRAMES); \
659 #else /* VM_PIP_DEBUG */
660 #define VM_PIP_DEBUG_BEGIN(object)
661 #endif /* VM_PIP_DEBUG */
663 #define vm_object_paging_begin(object) \
665 assert((object)->paging_in_progress >= 0); \
666 VM_PIP_DEBUG_BEGIN((object)); \
667 (object)->paging_in_progress++; \
670 #define vm_object_paging_end(object) \
672 assert((object)->paging_in_progress > 0); \
673 if (--(object)->paging_in_progress == 0) { \
674 vm_object_wakeup(object, \
675 VM_OBJECT_EVENT_PAGING_IN_PROGRESS); \
679 #define vm_object_paging_wait(object, interruptible) \
681 while ((object)->paging_in_progress != 0) { \
684 _wr = vm_object_sleep((object), \
685 VM_OBJECT_EVENT_PAGING_IN_PROGRESS, \
688 /*XXX if ((interruptible) && (_wr != THREAD_AWAKENED))*/\
693 #define vm_object_absent_assert_wait(object, interruptible) \
695 vm_object_assert_wait( (object), \
696 VM_OBJECT_EVENT_ABSENT_COUNT, \
701 #define vm_object_absent_release(object) \
703 (object)->absent_count--; \
704 vm_object_wakeup((object), \
705 VM_OBJECT_EVENT_ABSENT_COUNT); \
709 * Object locking macros
712 #define vm_object_lock_init(object) mutex_init(&(object)->Lock, 0)
713 #define vm_object_lock(object) mutex_lock(&(object)->Lock)
714 #define vm_object_unlock(object) mutex_unlock(&(object)->Lock)
715 #define vm_object_lock_try(object) mutex_try(&(object)->Lock)
717 #define vm_object_round_page(x) (((vm_object_offset_t)(x) + PAGE_MASK) & ~((signed)PAGE_MASK))
718 #define vm_object_trunc_page(x) ((vm_object_offset_t)(x) & ~((signed)PAGE_MASK))
720 #endif /* _VM_VM_OBJECT_H_ */