zx_vmo_op_range

NAME

vmo_op_range - perform an operation on a range of a VMO

SYNOPSIS

#include <zircon/syscalls.h>

zx_status_t zx_vmo_op_range(zx_handle_t handle, uint32_t op,
                            uint64_t offset, uint64_t size,
                            void* buffer, size_t buffer_size);

DESCRIPTION

vmo_op_range() performs cache and memory operations against pages held by the VMO.

offset byte offset specifying the starting location for op in the VMO's held memory.

size length, in bytes, to perform the operation on.

op the operation to perform:

buffer and buffer_size are used to store the addresses returned by ZX_VMO_OP_LOOKUP.

ZX_VMO_OP_COMMIT - Commit size bytes worth of pages starting at byte offset for the VMO. More information can be found in the vm object documentation.

ZX_VMO_OP_DECOMMIT - Release a range of pages previously commited to the VMO from offset to offset+size.

ZX_VMO_OP_LOCK - Presently unsupported.

ZX_VMO_OP_UNLOCK - Presently unsupported.

ZX_VMO_OP_LOOKUP - Returns a list of physical addresses (paddr_t) corresponding to the pages held by the VMO from offset to offset+size. The result is stored in buffer, up to buffer_size bytes. The returned physical addresses are aligned to page boundaries. So if the provided offset is not page aligned, the first physical address returned will match the beginning of the page containing the offset, not the actual physical address corresponding to the offset.

ZX_VMO_OP_CACHE_SYNC - Performs a cache sync operation.

ZX_VMO_OP_CACHE_INVALIDATE - Performs a cache invalidation operation.

ZX_VMO_OP_CACHE_CLEAN - Performs a cache clean operation.

ZX_VMO_OP_CACHE_CLEAN_INVALIDATE - Performs cache clean and invalidate operations together.

RETURN VALUE

vmo_op_range() returns ZX_OK on success. In the event of failure, a negative error value is returned.

ERRORS

ZX_ERR_BAD_HANDLE handle is not a valid handle.

ZX_ERR_OUT_OF_RANGE An invalid memory range specified by offset and size.

ZX_ERR_NO_MEMORY Allocations to commit pages for ZX_VMO_OP_COMMIT failed.

ZX_ERR_WRONG_TYPE handle is not a VMO handle.

ZX_ERR_INVALID_ARGS out is an invalid pointer, op is not a valid operation, op is ZX_VMO_LOOPUP and buffer is an invalid pointer, or size is zero and op is a cache operation.