Summary
Create a new pager object.
Declaration
#include <zircon/syscalls.h>
zx_status_t zx_pager_create(uint32_t options, zx_handle_t* out);
Description
zx_pager_create() creates a new pager object.
When a pager object is destroyed, any accesses to its VMOs that would have required communicating
with the pager will fail as if zx_pager_detach_vmo() had been called. Furthermore, the kernel
will make an effort to ensure that the faults happen as quickly as possible (e.g. by evicting
present pages), but the precise behavior is implementation dependent.
The returned handle will have the following rights:
- ZX_RIGHT_TRANSFER - The handle may be transferred to another process.
- ZX_RIGHT_INSPECT - May be inspected with zx_object_get_info().
- ZX_RIGHT_ATTACH_VMO - May attach VMOs with zx_pager_create_vmo() and detach VMOs with
zx_pager_detach_vmo().
- ZX_RIGHT_MANAGE_VMO - May alter the contents or pager-related metadata of an owned VMO, e.g.
with zx_pager_supply_pages() or zx_pager_op_range().
Rights
Caller job policy must allow ZX_POL_NEW_PAGER.
Return value
zx_pager_create() returns ZX_OK on success, or one of the following error codes on failure.
Errors
ZX_ERR_INVALID_ARGS out is an invalid pointer or NULL or options is
any value other than 0.
ZX_ERR_NO_MEMORY Failure due to lack of memory.