| // Copyright 2019 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| // TODO(fxb/39732): This should be read as "library zx". |
| library zz; |
| |
| using VmOption = uint32; |
| |
| // TODO(scottmg): bits for ZX_VM_xyz flags, and const for ZX_VM_ALIGN_xyz. |
| |
| [Transport = "Syscall"] |
| protocol vmar { |
| /// Allocate a new subregion. |
| /// Rights: If options & ZX_VM_CAN_MAP_READ, parent_vmar must be of type ZX_OBJ_TYPE_VMAR and have ZX_RIGHT_READ. |
| /// Rights: If options & ZX_VM_CAN_MAP_WRITE, parent_vmar must be of type ZX_OBJ_TYPE_VMAR and have ZX_RIGHT_WRITE. |
| /// Rights: If options & ZX_VM_CAN_MAP_EXECUTE, parent_vmar must be of type ZX_OBJ_TYPE_VMAR and have ZX_RIGHT_EXECUTE. |
| vmar_allocate(handle<vmar> parent_vmar, VmOption options, uint64 offset, uint64 size) |
| -> (status status, handle<vmar> child_vmar, vaddr child_addr); |
| |
| // TODO(ZX-2967): handle No rights required? |
| /// Destroy a virtual memory address region. |
| vmar_destroy(handle<vmar> handle) -> (status status); |
| |
| // TODO(ZX-2399): TODO handle and vmo and options must all match, and options can't specify them. |
| /// Add a memory mapping. |
| /// Rights: handle must be of type ZX_OBJ_TYPE_VMAR. |
| /// Rights: vmo must be of type ZX_OBJ_TYPE_VMO. |
| vmar_map(handle<vmar> handle, VmOption options, uint64 vmar_offset, |
| handle<vmo> vmo, uint64 vmo_offset, |
| uint64 len) |
| -> (status status, vaddr mapped_addr); |
| |
| // TODO(ZX-2967): handle No rights required? |
| /// Unmap virtual memory pages. |
| vmar_unmap(handle<vmo> handle, vaddr addr, uint64 len) -> (status status); |
| |
| /// Set protection of virtual memory pages. |
| /// Rights: If options & ZX_VM_PERM_READ, handle must be of type ZX_OBJ_TYPE_VMAR and have ZX_RIGHT_READ. |
| /// Rights: If options & ZX_VM_PERM_WRITE, handle must be of type ZX_OBJ_TYPE_VMAR and have ZX_RIGHT_WRITE. |
| /// Rights: If options & ZX_VM_PERM_EXECUTE, handle must be of type ZX_OBJ_TYPE_VMAR and have ZX_RIGHT_EXECUTE. |
| vmar_protect(handle<vmo> handle, VmOption options, vaddr addr, uint64 len) -> (status status); |
| |
| /// Perform an operation on VMOs mapped into this VMAR. |
| /// Rights: If op is ZX_VMO_OP_DECOMMIT, affected mappings must be writable. |
| [Blocking] |
| vmar_op_range(handle<vmar> handle, |
| uint32 op, |
| uint64 offset, |
| uint64 size, |
| mutable_vector_void buffer) |
| -> (status status); |
| }; |