memory_object_types.h [plain text]
#ifndef _MACH_MEMORY_OBJECT_TYPES_H_
#define _MACH_MEMORY_OBJECT_TYPES_H_
#include <mach/port.h>
#include <mach/message.h>
#include <mach/vm_prot.h>
#include <mach/vm_sync.h>
#include <mach/vm_types.h>
#include <mach/machine/vm_types.h>
#include <sys/cdefs.h>
#define VM_64_BIT_DATA_OBJECTS
typedef unsigned long long memory_object_offset_t;
typedef unsigned long long memory_object_size_t;
typedef natural_t memory_object_cluster_size_t;
typedef natural_t * memory_object_fault_info_t;
typedef unsigned long long vm_object_id_t;
#ifdef KERNEL_PRIVATE
struct memory_object_pager_ops;
typedef struct memory_object {
unsigned int _pad1;
#ifdef __LP64__
unsigned int _pad2;
#endif
const struct memory_object_pager_ops *mo_pager_ops;
} *memory_object_t;
typedef struct memory_object_control {
unsigned int moc_ikot;
#ifdef __LP64__
unsigned int _pad;
#endif
struct vm_object *moc_object;
} *memory_object_control_t;
typedef const struct memory_object_pager_ops {
void (*memory_object_reference)(
memory_object_t mem_obj);
void (*memory_object_deallocate)(
memory_object_t mem_obj);
kern_return_t (*memory_object_init)(
memory_object_t mem_obj,
memory_object_control_t mem_control,
memory_object_cluster_size_t size);
kern_return_t (*memory_object_terminate)(
memory_object_t mem_obj);
kern_return_t (*memory_object_data_request)(
memory_object_t mem_obj,
memory_object_offset_t offset,
memory_object_cluster_size_t length,
vm_prot_t desired_access,
memory_object_fault_info_t fault_info);
kern_return_t (*memory_object_data_return)(
memory_object_t mem_obj,
memory_object_offset_t offset,
memory_object_cluster_size_t size,
memory_object_offset_t *resid_offset,
int *io_error,
boolean_t dirty,
boolean_t kernel_copy,
int upl_flags);
kern_return_t (*memory_object_data_initialize)(
memory_object_t mem_obj,
memory_object_offset_t offset,
memory_object_cluster_size_t size);
kern_return_t (*memory_object_data_unlock)(
memory_object_t mem_obj,
memory_object_offset_t offset,
memory_object_size_t size,
vm_prot_t desired_access);
kern_return_t (*memory_object_synchronize)(
memory_object_t mem_obj,
memory_object_offset_t offset,
memory_object_size_t size,
vm_sync_t sync_flags);
kern_return_t (*memory_object_map)(
memory_object_t mem_obj,
vm_prot_t prot);
kern_return_t (*memory_object_last_unmap)(
memory_object_t mem_obj);
kern_return_t (*memory_object_data_reclaim)(
memory_object_t mem_obj,
boolean_t reclaim_backing_store);
const char *memory_object_pager_name;
} * memory_object_pager_ops_t;
#else
typedef mach_port_t memory_object_t;
typedef mach_port_t memory_object_control_t;
#endif
typedef memory_object_t *memory_object_array_t;
typedef mach_port_t memory_object_name_t;
typedef mach_port_t memory_object_default_t;
#define MEMORY_OBJECT_NULL ((memory_object_t) 0)
#define MEMORY_OBJECT_CONTROL_NULL ((memory_object_control_t) 0)
#define MEMORY_OBJECT_NAME_NULL ((memory_object_name_t) 0)
#define MEMORY_OBJECT_DEFAULT_NULL ((memory_object_default_t) 0)
typedef int memory_object_copy_strategy_t;
#define MEMORY_OBJECT_COPY_NONE 0
#define MEMORY_OBJECT_COPY_CALL 1
#define MEMORY_OBJECT_COPY_DELAY 2
#define MEMORY_OBJECT_COPY_TEMPORARY 3
#define MEMORY_OBJECT_COPY_SYMMETRIC 4
#define MEMORY_OBJECT_COPY_INVALID 5
typedef int memory_object_return_t;
#define MEMORY_OBJECT_RETURN_NONE 0
#define MEMORY_OBJECT_RETURN_DIRTY 1
#define MEMORY_OBJECT_RETURN_ALL 2
#define MEMORY_OBJECT_RETURN_ANYTHING 3
#define MEMORY_OBJECT_DATA_FLUSH 0x1
#define MEMORY_OBJECT_DATA_NO_CHANGE 0x2
#define MEMORY_OBJECT_DATA_PURGE 0x4
#define MEMORY_OBJECT_COPY_SYNC 0x8
#define MEMORY_OBJECT_DATA_SYNC 0x10
#define MEMORY_OBJECT_IO_SYNC 0x20
#define MEMORY_OBJECT_DATA_FLUSH_ALL 0x40
#define MEMORY_OBJECT_INFO_MAX (1024)
typedef int *memory_object_info_t;
typedef int memory_object_flavor_t;
typedef int memory_object_info_data_t[MEMORY_OBJECT_INFO_MAX];
#define MEMORY_OBJECT_PERFORMANCE_INFO 11
#define MEMORY_OBJECT_ATTRIBUTE_INFO 14
#define MEMORY_OBJECT_BEHAVIOR_INFO 15
#ifdef PRIVATE
#define OLD_MEMORY_OBJECT_BEHAVIOR_INFO 10
#define OLD_MEMORY_OBJECT_ATTRIBUTE_INFO 12
struct old_memory_object_behave_info {
memory_object_copy_strategy_t copy_strategy;
boolean_t temporary;
boolean_t invalidate;
};
struct old_memory_object_attr_info {
boolean_t object_ready;
boolean_t may_cache;
memory_object_copy_strategy_t copy_strategy;
};
typedef struct old_memory_object_behave_info *old_memory_object_behave_info_t;
typedef struct old_memory_object_behave_info old_memory_object_behave_info_data_t;
typedef struct old_memory_object_attr_info *old_memory_object_attr_info_t;
typedef struct old_memory_object_attr_info old_memory_object_attr_info_data_t;
#define OLD_MEMORY_OBJECT_BEHAVE_INFO_COUNT ((mach_msg_type_number_t) \
(sizeof(old_memory_object_behave_info_data_t)/sizeof(int)))
#define OLD_MEMORY_OBJECT_ATTR_INFO_COUNT ((mach_msg_type_number_t) \
(sizeof(old_memory_object_attr_info_data_t)/sizeof(int)))
#ifdef KERNEL
__BEGIN_DECLS
extern void memory_object_reference(memory_object_t object);
extern void memory_object_deallocate(memory_object_t object);
extern void memory_object_default_reference(memory_object_default_t);
extern void memory_object_default_deallocate(memory_object_default_t);
extern void memory_object_control_reference(memory_object_control_t control);
extern void memory_object_control_deallocate(memory_object_control_t control);
extern int memory_object_control_uiomove(memory_object_control_t, memory_object_offset_t, void *, int, int, int, int);
__END_DECLS
#endif
#endif
struct memory_object_perf_info {
memory_object_cluster_size_t cluster_size;
boolean_t may_cache;
};
struct memory_object_attr_info {
memory_object_copy_strategy_t copy_strategy;
memory_object_cluster_size_t cluster_size;
boolean_t may_cache_object;
boolean_t temporary;
};
struct memory_object_behave_info {
memory_object_copy_strategy_t copy_strategy;
boolean_t temporary;
boolean_t invalidate;
boolean_t silent_overwrite;
boolean_t advisory_pageout;
};
typedef struct memory_object_behave_info *memory_object_behave_info_t;
typedef struct memory_object_behave_info memory_object_behave_info_data_t;
typedef struct memory_object_perf_info *memory_object_perf_info_t;
typedef struct memory_object_perf_info memory_object_perf_info_data_t;
typedef struct memory_object_attr_info *memory_object_attr_info_t;
typedef struct memory_object_attr_info memory_object_attr_info_data_t;
#define MEMORY_OBJECT_BEHAVE_INFO_COUNT ((mach_msg_type_number_t) \
(sizeof(memory_object_behave_info_data_t)/sizeof(int)))
#define MEMORY_OBJECT_PERF_INFO_COUNT ((mach_msg_type_number_t) \
(sizeof(memory_object_perf_info_data_t)/sizeof(int)))
#define MEMORY_OBJECT_ATTR_INFO_COUNT ((mach_msg_type_number_t) \
(sizeof(memory_object_attr_info_data_t)/sizeof(int)))
#define invalid_memory_object_flavor(f) \
(f != MEMORY_OBJECT_ATTRIBUTE_INFO && \
f != MEMORY_OBJECT_PERFORMANCE_INFO && \
f != OLD_MEMORY_OBJECT_BEHAVIOR_INFO && \
f != MEMORY_OBJECT_BEHAVIOR_INFO && \
f != OLD_MEMORY_OBJECT_ATTRIBUTE_INFO)
#define MEMORY_OBJECT_TERMINATE_IDLE 0x1
#define MEMORY_OBJECT_RESPECT_CACHE 0x2
#define MEMORY_OBJECT_RELEASE_NO_OP 0x4
#define MAP_MEM_NOOP 0
#define MAP_MEM_COPYBACK 1
#define MAP_MEM_IO 2
#define MAP_MEM_WTHRU 3
#define MAP_MEM_WCOMB 4
#define MAP_MEM_INNERWBACK 5
#define GET_MAP_MEM(flags) \
((((unsigned int)(flags)) >> 24) & 0xFF)
#define SET_MAP_MEM(caching, flags) \
((flags) = ((((unsigned int)(caching)) << 24) \
& 0xFF000000) | ((flags) & 0xFFFFFF));
#define MAP_MEM_ONLY 0x010000
#define MAP_MEM_NAMED_CREATE 0x020000
#define MAP_MEM_PURGABLE 0x040000
#define MAP_MEM_NAMED_REUSE 0x080000
#ifdef KERNEL
#ifdef PRIVATE
#define MAX_UPL_TRANSFER 256
#define MAX_UPL_SIZE 8192
struct upl_page_info {
ppnum_t phys_addr;
unsigned int
#ifdef XNU_KERNEL_PRIVATE
pageout:1,
absent:1,
dirty:1,
precious:1,
device:1,
speculative:1,
cs_validated:1,
cs_tainted:1,
needed:1,
:0;
#else
opaque;
#endif
};
#else
struct upl_page_info {
unsigned int opaque[2];
};
#endif
typedef struct upl_page_info upl_page_info_t;
typedef upl_page_info_t *upl_page_info_array_t;
typedef upl_page_info_array_t upl_page_list_ptr_t;
typedef uint32_t upl_offset_t;
typedef uint32_t upl_size_t;
#define UPL_FLAGS_NONE 0x00000000
#define UPL_COPYOUT_FROM 0x00000001
#define UPL_PRECIOUS 0x00000002
#define UPL_NO_SYNC 0x00000004
#define UPL_CLEAN_IN_PLACE 0x00000008
#define UPL_NOBLOCK 0x00000010
#define UPL_RET_ONLY_DIRTY 0x00000020
#define UPL_SET_INTERNAL 0x00000040
#define UPL_QUERY_OBJECT_TYPE 0x00000080
#define UPL_RET_ONLY_ABSENT 0x00000100
#define UPL_FILE_IO 0x00000200
#define UPL_SET_LITE 0x00000400
#define UPL_SET_INTERRUPTIBLE 0x00000800
#define UPL_SET_IO_WIRE 0x00001000
#define UPL_FOR_PAGEOUT 0x00002000
#define UPL_WILL_BE_DUMPED 0x00004000
#define UPL_FORCE_DATA_SYNC 0x00008000
#define UPL_PAGE_TICKET_MASK 0x000F0000
#define UPL_PAGE_TICKET_SHIFT 16
#define UPL_BLOCK_ACCESS 0x00100000
#define UPL_ENCRYPT 0x00200000
#define UPL_NOZEROFILL 0x00400000
#define UPL_WILL_MODIFY 0x00800000
#define UPL_NEED_32BIT_ADDR 0x01000000
#define UPL_UBC_MSYNC 0x02000000
#define UPL_UBC_PAGEOUT 0x04000000
#define UPL_UBC_PAGEIN 0x08000000
#define UPL_REQUEST_SET_DIRTY 0x10000000
#define UPL_VALID_FLAGS 0x1FFFFFFF
#define UPL_ABORT_RESTART 0x1
#define UPL_ABORT_UNAVAILABLE 0x2
#define UPL_ABORT_ERROR 0x4
#define UPL_ABORT_FREE_ON_EMPTY 0x8
#define UPL_ABORT_DUMP_PAGES 0x10
#define UPL_ABORT_NOTIFY_EMPTY 0x20
#define UPL_ABORT_REFERENCE 0x80
#define UPL_CHECK_DIRTY 0x1
#define UPL_IOSYNC 0x1
#define UPL_NOCOMMIT 0x2
#define UPL_NORDAHEAD 0x4
#define UPL_VNODE_PAGER 0x8
#define UPL_MSYNC 0x10
#define UPL_PAGING_ENCRYPTED 0x20
#define UPL_KEEPCACHED 0x40
#define UPL_NESTED_PAGEOUT 0x80
#define UPL_IOSTREAMING 0x100
#define UPL_COMMIT_FREE_ON_EMPTY 0x1
#define UPL_COMMIT_CLEAR_DIRTY 0x2
#define UPL_COMMIT_SET_DIRTY 0x4
#define UPL_COMMIT_INACTIVATE 0x8
#define UPL_COMMIT_NOTIFY_EMPTY 0x10
#define UPL_COMMIT_CS_VALIDATED 0x40
#define UPL_COMMIT_CLEAR_PRECIOUS 0x80
#define UPL_COMMIT_SPECULATE 0x100
#define UPL_COMMIT_FREE_ABSENT 0x200
#define UPL_COMMIT_KERNEL_ONLY_FLAGS (UPL_COMMIT_CS_VALIDATED | UPL_COMMIT_FREE_ABSENT)
#define UPL_DEV_MEMORY 0x1
#define UPL_PHYS_CONTIG 0x2
#define UPL_POP_DIRTY 0x1
#define UPL_POP_PAGEOUT 0x2
#define UPL_POP_PRECIOUS 0x4
#define UPL_POP_ABSENT 0x8
#define UPL_POP_BUSY 0x10
#define UPL_POP_PHYSICAL 0x10000000
#define UPL_POP_DUMP 0x20000000
#define UPL_POP_SET 0x40000000
#define UPL_POP_CLR 0x80000000
#define UPL_ROP_ABSENT 0x01
#define UPL_ROP_PRESENT 0x02
#define UPL_ROP_DUMP 0x04
#ifdef PRIVATE
#define UPL_DEVICE_PAGE(upl) \
(((upl)[0].phys_addr != 0) ? ((upl)[0].device) : FALSE)
#define UPL_PAGE_PRESENT(upl, index) \
((upl)[(index)].phys_addr != 0)
#define UPL_PHYS_PAGE(upl, index) \
((upl)[(index)].phys_addr)
#define UPL_SPECULATIVE_PAGE(upl, index) \
(((upl)[(index)].phys_addr != 0) ? ((upl)[(index)].speculative) : FALSE)
#define UPL_DIRTY_PAGE(upl, index) \
(((upl)[(index)].phys_addr != 0) ? ((upl)[(index)].dirty) : FALSE)
#define UPL_PRECIOUS_PAGE(upl, index) \
(((upl)[(index)].phys_addr != 0) ? ((upl)[(index)].precious) : FALSE)
#define UPL_VALID_PAGE(upl, index) \
(((upl)[(index)].phys_addr != 0) ? (!((upl)[(index)].absent)) : FALSE)
#define UPL_PAGEOUT_PAGE(upl, index) \
(((upl)[(index)].phys_addr != 0) ? ((upl)[(index)].pageout) : FALSE)
#define UPL_SET_PAGE_FREE_ON_COMMIT(upl, index) \
(((upl)[(index)].phys_addr != 0) ? \
((upl)[(index)].pageout = TRUE) : FALSE)
#define UPL_CLR_PAGE_FREE_ON_COMMIT(upl, index) \
(((upl)[(index)].phys_addr != 0) ? \
((upl)[(index)].pageout = FALSE) : FALSE)
#define UPL_SET_CS_VALIDATED(upl, index, value) \
((upl)[(index)].cs_validated = ((value) ? TRUE : FALSE))
#define UPL_SET_CS_TAINTED(upl, index, value) \
((upl)[(index)].cs_tainted = ((value) ? TRUE : FALSE))
extern vm_size_t upl_offset_to_pagelist;
extern vm_size_t upl_get_internal_pagelist_offset(void);
extern void* upl_get_internal_vectorupl(upl_t);
extern upl_page_info_t* upl_get_internal_vectorupl_pagelist(upl_t);
#define UPL_GET_INTERNAL_PAGE_LIST_SIMPLE(upl) \
((upl_page_info_t *)((upl_offset_to_pagelist == 0) ? \
(uintptr_t)upl + (unsigned int)(upl_offset_to_pagelist = upl_get_internal_pagelist_offset()): \
(uintptr_t)upl + (unsigned int)upl_offset_to_pagelist))
#define UPL_GET_INTERNAL_PAGE_LIST(upl) \
((upl_get_internal_vectorupl(upl) != NULL ) ? (upl_get_internal_vectorupl_pagelist(upl)) : \
((upl_page_info_t *)((upl_offset_to_pagelist == 0) ? \
(uintptr_t)upl + (unsigned int)(upl_offset_to_pagelist = upl_get_internal_pagelist_offset()): \
(uintptr_t)upl + (unsigned int)upl_offset_to_pagelist)))
__BEGIN_DECLS
extern ppnum_t upl_phys_page(upl_page_info_t *upl, int index);
extern boolean_t upl_device_page(upl_page_info_t *upl);
extern boolean_t upl_speculative_page(upl_page_info_t *upl, int index);
extern void upl_clear_dirty(upl_t upl, boolean_t value);
extern void upl_set_referenced(upl_t upl, boolean_t value);
extern void upl_range_needed(upl_t upl, int index, int count);
__END_DECLS
#endif
__BEGIN_DECLS
extern boolean_t upl_page_present(upl_page_info_t *upl, int index);
extern boolean_t upl_dirty_page(upl_page_info_t *upl, int index);
extern boolean_t upl_valid_page(upl_page_info_t *upl, int index);
extern void upl_deallocate(upl_t upl);
__END_DECLS
#endif
#endif