#ifndef _VM_VM_OBJECT_H_
#define _VM_VM_OBJECT_H_
#include <mach_pagemap.h>
#include <task_swapper.h>
#include <mach/kern_return.h>
#include <mach/boolean.h>
#include <mach/memory_object_types.h>
#include <mach/port.h>
#include <mach/vm_prot.h>
#include <mach/machine/vm_types.h>
#include <kern/queue.h>
#include <kern/lock.h>
#include <kern/assert.h>
#include <kern/ipc_mig.h>
#include <kern/misc_protos.h>
#include <kern/macro_help.h>
#include <ipc/ipc_types.h>
#include <vm/pmap.h>
#if MACH_PAGEMAP
#include <vm/vm_external.h>
#endif
typedef memory_object_control_t pager_request_t;
#define PAGER_REQUEST_NULL ((pager_request_t) 0)
typedef unsigned long long vm_object_size_t;
struct vm_object {
queue_head_t memq;
decl_mutex_data(, Lock)
vm_object_size_t size;
vm_object_size_t frozen_size;
int ref_count;
#if TASK_SWAPPER
int res_count;
#endif
unsigned int resident_page_count;
struct vm_object *copy;
struct vm_object *shadow;
vm_object_offset_t shadow_offset;
memory_object_t pager;
vm_object_offset_t paging_offset;
pager_request_t pager_request;
memory_object_copy_strategy_t
copy_strategy;
unsigned int absent_count;
unsigned int paging_in_progress;
unsigned int
all_wanted:11,
pager_created:1,
pager_initialized:1,
pager_ready:1,
pager_trusted:1,
can_persist:1,
internal:1,
temporary:1,
private:1,
pageout:1,
alive:1,
lock_in_progress:1,
lock_restart:1,
shadowed:1,
silent_overwrite:1,
advisory_pageout:1,
true_share:1,
terminating:1,
named:1,
shadow_severed:1,
phys_contiguous:1,
nophyscache:1;
queue_chain_t cached_list;
queue_head_t msr_q;
vm_object_offset_t last_alloc;
vm_size_t cluster_size;
#if MACH_PAGEMAP
vm_external_map_t existence_map;
#endif
int cow_hint;
#if MACH_ASSERT
struct vm_object *paging_object;
#endif
unsigned int
wimg_bits:8,
not_in_use:24;
#ifdef UBC_DEBUG
queue_head_t uplq;
#endif
};
__private_extern__
vm_object_t kernel_object;
__private_extern__
int vm_object_absent_max;
# define VM_MSYNC_INITIALIZED 0
# define VM_MSYNC_SYNCHRONIZING 1
# define VM_MSYNC_DONE 2
struct msync_req {
queue_chain_t msr_q;
queue_chain_t req_q;
unsigned int flag;
vm_object_offset_t offset;
vm_object_size_t length;
vm_object_t object;
decl_mutex_data(, msync_req_lock)
};
typedef struct msync_req *msync_req_t;
#define MSYNC_REQ_NULL ((msync_req_t) 0)
#define msync_req_alloc(msr) \
MACRO_BEGIN \
(msr) = (msync_req_t)kalloc(sizeof(struct msync_req)); \
mutex_init(&(msr)->msync_req_lock, ETAP_VM_MSYNC); \
msr->flag = VM_MSYNC_INITIALIZED; \
MACRO_END
#define msync_req_free(msr) \
(kfree((vm_offset_t)(msr), sizeof(struct msync_req)))
#define msr_lock(msr) mutex_lock(&(msr)->msync_req_lock)
#define msr_unlock(msr) mutex_unlock(&(msr)->msync_req_lock)
__private_extern__ void vm_object_bootstrap(void);
__private_extern__ void vm_object_init(void);
__private_extern__ vm_object_t vm_object_allocate(
vm_object_size_t size);
#if TASK_SWAPPER
__private_extern__ void vm_object_res_reference(
vm_object_t object);
__private_extern__ void vm_object_res_deallocate(
vm_object_t object);
#define VM_OBJ_RES_INCR(object) (object)->res_count++
#define VM_OBJ_RES_DECR(object) (object)->res_count--
#else
#define VM_OBJ_RES_INCR(object)
#define VM_OBJ_RES_DECR(object)
#define vm_object_res_reference(object)
#define vm_object_res_deallocate(object)
#endif
#define vm_object_reference_locked(object) \
MACRO_BEGIN \
vm_object_t RLObject = (object); \
assert((RLObject)->ref_count > 0); \
(RLObject)->ref_count++; \
vm_object_res_reference(RLObject); \
MACRO_END
#if MACH_ASSERT
__private_extern__ void vm_object_reference(
vm_object_t object);
#else
#define vm_object_reference(object) \
MACRO_BEGIN \
vm_object_t RObject = (object); \
if (RObject) { \
vm_object_lock(RObject); \
vm_object_reference_locked(RObject); \
vm_object_unlock(RObject); \
} \
MACRO_END
#endif
__private_extern__ void vm_object_deallocate(
vm_object_t object);
__private_extern__ kern_return_t vm_object_release_name(
vm_object_t object,
int flags);
__private_extern__ void vm_object_pmap_protect(
vm_object_t object,
vm_object_offset_t offset,
vm_size_t size,
pmap_t pmap,
vm_offset_t pmap_start,
vm_prot_t prot);
__private_extern__ void vm_object_page_remove(
vm_object_t object,
vm_object_offset_t start,
vm_object_offset_t end);
__private_extern__ void vm_object_deactivate_pages(
vm_object_t object,
vm_object_offset_t offset,
vm_object_size_t size,
boolean_t kill_page);
__private_extern__ boolean_t vm_object_coalesce(
vm_object_t prev_object,
vm_object_t next_object,
vm_object_offset_t prev_offset,
vm_object_offset_t next_offset,
vm_object_size_t prev_size,
vm_object_size_t next_size);
__private_extern__ boolean_t vm_object_shadow(
vm_object_t *object,
vm_object_offset_t *offset,
vm_object_size_t length);
__private_extern__ void vm_object_collapse(
vm_object_t object);
__private_extern__ boolean_t vm_object_copy_quickly(
vm_object_t *_object,
vm_object_offset_t src_offset,
vm_object_size_t size,
boolean_t *_src_needs_copy,
boolean_t *_dst_needs_copy);
__private_extern__ kern_return_t vm_object_copy_strategically(
vm_object_t src_object,
vm_object_offset_t src_offset,
vm_object_size_t size,
vm_object_t *dst_object,
vm_object_offset_t *dst_offset,
boolean_t *dst_needs_copy);
__private_extern__ kern_return_t vm_object_copy_slowly(
vm_object_t src_object,
vm_object_offset_t src_offset,
vm_object_size_t size,
int interruptible,
vm_object_t *_result_object);
__private_extern__ vm_object_t vm_object_copy_delayed(
vm_object_t src_object,
vm_object_offset_t src_offset,
vm_object_size_t size);
__private_extern__ kern_return_t vm_object_destroy(
vm_object_t object,
kern_return_t reason);
__private_extern__ void vm_object_pager_create(
vm_object_t object);
__private_extern__ void vm_object_page_map(
vm_object_t object,
vm_object_offset_t offset,
vm_object_size_t size,
vm_object_offset_t (*map_fn)
(void *, vm_object_offset_t),
void *map_fn_data);
__private_extern__ kern_return_t vm_object_upl_request(
vm_object_t object,
vm_object_offset_t offset,
vm_size_t size,
upl_t *upl,
upl_page_info_t *page_info,
unsigned int *count,
int flags);
__private_extern__ boolean_t vm_object_sync(
vm_object_t object,
vm_object_offset_t offset,
vm_size_t size,
boolean_t should_flush,
boolean_t should_return);
__private_extern__ kern_return_t vm_object_update(
vm_object_t object,
vm_object_offset_t offset,
vm_size_t size,
memory_object_return_t should_return,
int flags,
vm_prot_t prot);
__private_extern__ kern_return_t vm_object_lock_request(
vm_object_t object,
vm_object_offset_t offset,
vm_object_size_t size,
memory_object_return_t should_return,
int flags,
vm_prot_t prot);
__private_extern__ vm_object_t vm_object_enter(
memory_object_t pager,
vm_object_size_t size,
boolean_t internal,
boolean_t init,
boolean_t check_named);
#define VM_OBJECT_EVENT_INITIALIZED 0
#define VM_OBJECT_EVENT_PAGER_READY 1
#define VM_OBJECT_EVENT_PAGING_IN_PROGRESS 2
#define VM_OBJECT_EVENT_ABSENT_COUNT 3
#define VM_OBJECT_EVENT_LOCK_IN_PROGRESS 4
#define VM_OBJECT_EVENT_UNCACHING 5
#define VM_OBJECT_EVENT_COPY_CALL 6
#define VM_OBJECT_EVENT_CACHING 7
#define vm_object_assert_wait(object, event, interruptible) \
(((object)->all_wanted |= 1 << (event)), \
assert_wait((event_t)((vm_offset_t)(object)+(event)),(interruptible)))
#define vm_object_wait(object, event, interruptible) \
(vm_object_assert_wait((object),(event),(interruptible)), \
vm_object_unlock(object), \
thread_block(THREAD_CONTINUE_NULL)) \
#define thread_sleep_vm_object(object, event, interruptible) \
thread_sleep_mutex((event_t)(event), &(object)->Lock, (interruptible))
#define vm_object_sleep(object, event, interruptible) \
(((object)->all_wanted |= 1 << (event)), \
thread_sleep_vm_object((object), \
((vm_offset_t)(object)+(event)), (interruptible)))
#define vm_object_wakeup(object, event) \
MACRO_BEGIN \
if ((object)->all_wanted & (1 << (event))) \
thread_wakeup((event_t)((vm_offset_t)(object) + (event))); \
(object)->all_wanted &= ~(1 << (event)); \
MACRO_END
#define vm_object_set_wanted(object, event) \
MACRO_BEGIN \
((object)->all_wanted |= (1 << (event))); \
MACRO_END
#define vm_object_wanted(object, event) \
((object)->all_wanted & (1 << (event)))
#define vm_object_paging_begin(object) \
MACRO_BEGIN \
(object)->paging_in_progress++; \
MACRO_END
#define vm_object_paging_end(object) \
MACRO_BEGIN \
assert((object)->paging_in_progress != 0); \
if (--(object)->paging_in_progress == 0) { \
vm_object_wakeup(object, \
VM_OBJECT_EVENT_PAGING_IN_PROGRESS); \
} \
MACRO_END
#define vm_object_paging_wait(object, interruptible) \
MACRO_BEGIN \
while ((object)->paging_in_progress != 0) { \
wait_result_t _wr; \
\
_wr = vm_object_sleep((object), \
VM_OBJECT_EVENT_PAGING_IN_PROGRESS, \
(interruptible)); \
\
\
\
} \
MACRO_END
#define vm_object_absent_assert_wait(object, interruptible) \
MACRO_BEGIN \
vm_object_assert_wait( (object), \
VM_OBJECT_EVENT_ABSENT_COUNT, \
(interruptible)); \
MACRO_END
#define vm_object_absent_release(object) \
MACRO_BEGIN \
(object)->absent_count--; \
vm_object_wakeup((object), \
VM_OBJECT_EVENT_ABSENT_COUNT); \
MACRO_END
#define vm_object_lock_init(object) mutex_init(&(object)->Lock, ETAP_VM_OBJ)
#define vm_object_lock(object) mutex_lock(&(object)->Lock)
#define vm_object_unlock(object) mutex_unlock(&(object)->Lock)
#define vm_object_lock_try(object) mutex_try(&(object)->Lock)
#endif