blob: 58d5454fc3dd64e9a3d6160e16525d618d2cc890 [file] [log] [blame] [view]
# zx_vmar_unmap
## NAME
<!-- Updated by update-docs-from-abigen, do not edit. -->
Unmap virtual memory pages.
## SYNOPSIS
<!-- Updated by update-docs-from-abigen, do not edit. -->
```c
#include <zircon/syscalls.h>
zx_status_t zx_vmar_unmap(zx_handle_t handle, zx_vaddr_t addr, uint64_t len);
```
## DESCRIPTION
`zx_vmar_unmap()` unmaps all VMO mappings and destroys (as if [`zx_vmar_destroy()`]
were called) all sub-regions within the absolute range including *addr* and ending
before exclusively at `addr + len`. Any sub-region that is in the range must
be fully in the range (i.e. partial overlaps are an error). If a mapping is
only partially in the range, the mapping is split and the requested portion is
unmapped.
*len* must be page-aligned.
## RIGHTS
<!-- Updated by update-docs-from-abigen, do not edit. -->
TODO(ZX-2399)
## RETURN VALUE
`zx_vmar_unmap()` returns **ZX_OK** on success.
## ERRORS
**ZX_ERR_BAD_HANDLE** *handle* is not a valid handle.
**ZX_ERR_WRONG_TYPE** *handle* is not a VMAR handle.
**ZX_ERR_INVALID_ARGS** *addr* is not page-aligned, *len* is 0 or not page-aligned,
or the requested range partially overlaps a sub-region.
**ZX_ERR_BAD_STATE** *handle* refers to a destroyed handle.
**ZX_ERR_NOT_FOUND** Could not find the requested mapping.
## NOTES
## SEE ALSO
- [`zx_vmar_allocate()`]
- [`zx_vmar_destroy()`]
- [`zx_vmar_map()`]
- [`zx_vmar_protect()`]
<!-- References updated by update-docs-from-abigen, do not edit. -->
[`zx_vmar_allocate()`]: vmar_allocate.md
[`zx_vmar_destroy()`]: vmar_destroy.md
[`zx_vmar_map()`]: vmar_map.md
[`zx_vmar_protect()`]: vmar_protect.md