mach/mach_vm.h

extern kern_return_t mach_vm_allocate(
	vm_map_t target,
	mach_vm_address_t *address, /* inout */
	mach_vm_size_t size,
	int flags
)

If building for Sandbox, keep NAME unchanged Allocate zero-filled memory in the address space of the target task, either at the specified address, or wherever space can be found (controlled by flags), of the specified size. The address at which the allocation actually took place is returned.

extern kern_return_t mach_vm_deallocate(
	vm_map_t target,
	mach_vm_address_t address,
	mach_vm_size_t size
)

Deallocate the specified range from the virtual address space of the target virtual memory map.

extern kern_return_t mach_vm_protect(
	vm_map_t target_task,
	mach_vm_address_t address,
	mach_vm_size_t size,
	boolean_t set_maximum,
	vm_prot_t new_protection
)

Set the current or maximum protection attribute for the specified range of the virtual address space of the target virtual memory map. The current protection limits the memory access rights of threads within the map; the maximum protection limits the accesses that may be given in the current protection. Protections are specified as a set of {read, write, execute} *permissions*.

extern kern_return_t mach_vm_inherit(
	vm_map_t target_task,
	mach_vm_address_t address,
	mach_vm_size_t size,
	vm_inherit_t new_inheritance
)

Set the inheritance attribute for the specified range of the virtual address space of the target address space. The inheritance value is one of {none, copy, share}, and specifies how the child address space should acquire this memory at the time of a task_create call.

extern kern_return_t mach_vm_read(
	vm_map_read_t target_task,
	mach_vm_address_t address,
	mach_vm_size_t size,
	vm_offset_t *data, /* out */
	mach_msg_type_number_t *dataCnt
)

Returns the contents of the specified range of the virtual address space of the target task. [The range must be aligned on a virtual page boundary, and must be a multiple of pages in extent. The protection on the specified range must permit reading.]

extern kern_return_t mach_vm_read_list(
	vm_map_read_t target_task,
	mach_vm_read_entry_t data_list, /* inout */
	natural_t count
)

List corrollary to vm_read, returns mapped contents of specified ranges within target address space.

extern kern_return_t mach_vm_write(
	vm_map_t target_task,
	mach_vm_address_t address,
	vm_offset_t data,
	mach_msg_type_number_t dataCnt
)

Writes the contents of the specified range of the virtual address space of the target task. [The range must be aligned on a virtual page boundary, and must be a multiple of pages in extent. The protection on the specified range must permit writing.]

extern kern_return_t mach_vm_copy(
	vm_map_t target_task,
	mach_vm_address_t source_address,
	mach_vm_size_t size,
	mach_vm_address_t dest_address
)

Copy the contents of the source range of the virtual address space of the target task to the destination range in that same address space. [Both of the ranges must be aligned on a virtual page boundary, and must be multiples of pages in extent. The protection on the source range must permit reading, and the protection on the destination range must permit writing.]

extern kern_return_t mach_vm_read_overwrite(
	vm_map_read_t target_task,
	mach_vm_address_t address,
	mach_vm_size_t size,
	mach_vm_address_t data,
	mach_vm_size_t *outsize /* out */
)

Returns the contents of the specified range of the virtual address space of the target task. [There are no alignment restrictions, and the results will overwrite the area pointed to by data - which must already exist. The protection on the specified range must permit reading.]

extern kern_return_t mach_vm_behavior_set(
	vm_map_t target_task,
	mach_vm_address_t address,
	mach_vm_size_t size,
	vm_behavior_t new_behavior
)

Set the paging behavior attribute for the specified range of the virtual address space of the target task. The behavior value is one of {default, random, forward sequential, reverse sequential} and indicates the expected page reference pattern for the specified range.

extern kern_return_t mach_vm_map(
	vm_map_t target_task,
	mach_vm_address_t *address, /* inout */
	mach_vm_size_t size,
	mach_vm_offset_t mask,
	int flags,
	mem_entry_name_port_t object,
	memory_object_offset_t offset,
	boolean_t copy,
	vm_prot_t cur_protection,
	vm_prot_t max_protection,
	vm_inherit_t inheritance
)

Map a user-supplie memory object into the virtual address space of the target task. If desired (anywhere is TRUE), the kernel will find a suitable address range of the specified size; else, the specific address will be allocated. The beginning address of the range will be aligned on a virtual page boundary, be at or beyond the address specified, and meet the mask requirements (bits turned on in the mask must not be turned on in the result); the size of the range, in bytes, will be rounded up to an integral number of virtual pages. The memory in the resulting range will be associated with the specified memory object, with the beginning of the memory range referring to the specified offset into the memory object. The mapping will take the current and maximum protections and the inheritance attributes specified; see the vm_protect and vm_inherit calls for a description of these attributes. If desired (copy is TRUE), the memory range will be filled with a copy of the data from the memory object; this copy will be private to this mapping in this target task. Otherwise, the memory in this mapping will be shared with other mappings of the same memory object at the same offset (in this task or in other tasks). [The Mach kernel only enforces shared memory consistency among mappings on one host with similar page alignments. The user-defined memory manager for this object is responsible for further consistency.]

extern kern_return_t mach_vm_machine_attribute(
	vm_map_t target_task,
	mach_vm_address_t address,
	mach_vm_size_t size,
	vm_machine_attribute_t attribute,
	vm_machine_attribute_val_t *value /* inout */
)

Set/Get special properties of memory associated to some virtual address range, such as cachability, migrability, replicability. Machine-dependent.

extern kern_return_t mach_vm_remap(
	vm_map_t target_task,
	mach_vm_address_t *target_address, /* inout */
	mach_vm_size_t size,
	mach_vm_offset_t mask,
	int flags,
	vm_map_t src_task,
	mach_vm_address_t src_address,
	boolean_t copy,
	vm_prot_t *cur_protection, /* out */
	vm_prot_t *max_protection, /* out */
	vm_inherit_t inheritance
)

Map portion of a task's address space.

extern kern_return_t mach_vm_page_query(
	vm_map_read_t target_map,
	mach_vm_offset_t offset,
	integer_t *disposition, /* out */
	integer_t *ref_count /* out */
)

Give the caller information on the given location in a virtual address space. If a page is mapped return ref and dirty info.

extern kern_return_t mach_vm_region(
	vm_map_read_t target_task,
	mach_vm_address_t *address, /* inout */
	mach_vm_size_t *size, /* out */
	vm_region_flavor_t flavor,
	vm_region_info_t info, /* out */
	mach_msg_type_number_t *infoCnt,
	mach_port_t *object_name /* out */
)

Returns information about the contents of the virtual address space of the target task at the specified address. The returned protection, inheritance, sharing and memory object values apply to the entire range described by the address range returned; the memory object offset corresponds to the beginning of the address range. [If the specified address is not allocated, the next highest address range is described. If no addresses beyond the one specified are allocated, the call returns KERN_NO_SPACE.]

extern kern_return_t mach_vm_purgable_control(
	vm_map_t target_task,
	mach_vm_address_t address,
	vm_purgable_t control,
	int *state /* inout */
)

Control behavior and investigate state of a "purgable" object in the virtual address space of the target task. A purgable object is created via a call to mach_vm_allocate() with VM_FLAGS_PURGABLE specified. See the routine implementation for a complete definition of the routine.

extern kern_return_t mach_vm_remap_new(
	vm_map_t target_task,
	mach_vm_address_t *target_address, /* inout */
	mach_vm_size_t size,
	mach_vm_offset_t mask,
	int flags,
	vm_map_read_t src_task,
	mach_vm_address_t src_address,
	boolean_t copy,
	vm_prot_t *cur_protection, /* inout */
	vm_prot_t *max_protection, /* inout */
	vm_inherit_t inheritance
)

Map portion of a task's address space, {max, cur}_protection is inout.

extern kern_return_t mach_vm_range_create(
	vm_map_t target_task,
	mach_vm_range_flavor_t flavor,
	mach_vm_range_recipes_raw_t recipes,
	mach_msg_type_number_t recipesCnt
)

was: mach_vm_deferred_reclamation_buffer_update_reclaimable_bytes()

extern kern_return_t mach_vm_reallocate(
	vm_map_t target_task,
	mach_vm_address_t src,
	mach_vm_size_t src_size,
	mach_vm_address_t *dst, /* inout */
	mach_vm_size_t dst_size,
	mach_vm_offset_t align_mask,
	int options,
	int flags
)

Relocate the pages of the source range of the specified map to a new range of the given size in bytes within the same map.