docs/reference/syscalls/_toc.yaml

# Copyright 2020 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.

# Please, read https://fuchsia.dev/fuchsia-src/contribute/docs/documentation-navigation-toc
# before making changes to this file, and add a member of the fuchsia.dev
# team as reviewer.
toc:
- title: "Overview"
  path: /docs/reference/syscalls/README.md
- title: "Handles"
  section:
  - title: "zx_handle_close_many"
    path: /docs/reference/syscalls/handle_close_many.md
  - title: "zx_handle_close"
    path: /docs/reference/syscalls/handle_close.md
  - title: "zx_handle_duplicate"
    path: /docs/reference/syscalls/handle_duplicate.md
  - title: "zx_handle_replace"
    path: /docs/reference/syscalls/handle_replace.md
- title: "Objects"
  section:
  - title: "zx_object_get_child"
    path: /docs/reference/syscalls/object_get_child.md
  - title: "zx_object_get_info"
    path: /docs/reference/syscalls/object_get_info.md
  - title: "zx_object_get_property"
    path: /docs/reference/syscalls/object_get_property.md
  - title: "zx_object_set_profile"
    path: /docs/reference/syscalls/object_set_profile.md
  - title: "zx_object_set_property"
    path: /docs/reference/syscalls/object_set_property.md
  - title: "zx_object_signal"
    path: /docs/reference/syscalls/object_signal.md
  - title: "zx_object_signal_peer"
    path: /docs/reference/syscalls/object_signal_peer.md
  - title: "zx_object_wait_async"
    path: /docs/reference/syscalls/object_wait_async.md
  - title: "zx_object_wait_many"
    path: /docs/reference/syscalls/object_wait_many.md
  - title: "zx_object_wait_one"
    path: /docs/reference/syscalls/object_wait_one.md
- title: "Threads"
  section:
  - title: "zx_thread_create"
    path: /docs/reference/syscalls/thread_create.md
  - title: "zx_thread_exit"
    path: /docs/reference/syscalls/thread_exit.md
  - title: "zx_thread_read_state"
    path: /docs/reference/syscalls/thread_read_state.md
  - title: "zx_thread_start"
    path: /docs/reference/syscalls/thread_start.md
  - title: "zx_thread_write_state"
    path: /docs/reference/syscalls/thread_write_state.md
  - title: "zx_thread_legacy_yield"
    path: /docs/reference/syscalls/thread_legacy_yield.md
- title: "Processes"
  section:
  - title: "zx_process_create"
    path: /docs/reference/syscalls/process_create.md
  - title: "zx_process_exit"
    path: /docs/reference/syscalls/process_exit.md
  - title: "zx_process_read_memory"
    path: /docs/reference/syscalls/process_read_memory.md
  - title: "zx_process_start"
    path: /docs/reference/syscalls/process_start.md
  - title: "zx_process_write_memory"
    path: /docs/reference/syscalls/process_write_memory.md
- title: "Jobs"
  section:
  - title: "zx_job_create"
    path: /docs/reference/syscalls/job_create.md
  - title: "zx_job_set_critical"
    path: /docs/reference/syscalls/job_set_critical.md
  - title: "zx_job_set_policy"
    path: /docs/reference/syscalls/job_set_policy.md
- title: "Tasks"
  section:
  - title: "zx_task_create_exception_channel"
    path: /docs/reference/syscalls/task_create_exception_channel.md
  - title: "zx_task_kill"
    path: /docs/reference/syscalls/task_kill.md
  - title: "zx_task_suspend"
    path: /docs/reference/syscalls/task_suspend.md
  - title: "zx_task_suspend_token"
    path: /docs/reference/syscalls/task_suspend_token.md
- title: "Profiles"
  section:
  - title: "zx_profile_create"
    path: /docs/reference/syscalls/profile_create.md
- title: "Exceptions"
  section:
  - title: "zx_exception_get_process"
    path: /docs/reference/syscalls/exception_get_process.md
  - title: "zx_exception_get_thread"
    path: /docs/reference/syscalls/exception_get_thread.md
- title: "Channels"
  section:
  - title: "zx_channel_call"
    path: /docs/reference/syscalls/channel_call.md
  - title: "zx_channel_call_etc"
    path: /docs/reference/syscalls/channel_call_etc.md
  - title: "zx_channel_create"
    path: /docs/reference/syscalls/channel_create.md
  - title: "zx_channel_read_etc"
    path: /docs/reference/syscalls/channel_read_etc.md
  - title: "zx_channel_read"
    path: /docs/reference/syscalls/channel_read.md
  - title: "zx_channel_write_etc"
    path: /docs/reference/syscalls/channel_write_etc.md
  - title: "zx_channel_write"
    path: /docs/reference/syscalls/channel_write.md
- title: "Sockets"
  section:
  - title: "zx_socket_create"
    path: /docs/reference/syscalls/socket_create.md
  - title: "zx_socket_read"
    path: /docs/reference/syscalls/socket_read.md
  - title: "zx_socket_set_disposition"
    path: /docs/reference/syscalls/socket_set_disposition.md
  - title: "zx_socket_write"
    path: /docs/reference/syscalls/socket_write.md
- title: "Stream"
  section:
  - title: "zx_stream_create"
    path: /docs/reference/syscalls/stream_create.md
  - title: "zx_stream_readv"
    path: /docs/reference/syscalls/stream_readv.md
  - title: "zx_stream_readv_at"
    path: /docs/reference/syscalls/stream_readv_at.md
  - title: "zx_stream_seek"
    path: /docs/reference/syscalls/stream_seek.md
  - title: "zx_stream_writev"
    path: /docs/reference/syscalls/stream_writev.md
  - title: "zx_stream_writev_at"
    path: /docs/reference/syscalls/stream_writev_at.md
- title: "Fifos"
  section:
  - title: "zx_fifo_create"
    path: /docs/reference/syscalls/fifo_create.md
  - title: "zx_fifo_read"
    path: /docs/reference/syscalls/fifo_read.md
  - title: "zx_fifo_write"
    path: /docs/reference/syscalls/fifo_write.md
- title: "Events and event pairs"
  section:
  - title: "zx_event_create"
    path: /docs/reference/syscalls/event_create.md
  - title: "zx_eventpair_create"
    path: /docs/reference/syscalls/eventpair_create.md
  - title: "zx_system_get_event"
    path: /docs/reference/syscalls/system_get_event.md
- title: "Ports"
  section:
  - title: "zx_port_cancel"
    path: /docs/reference/syscalls/port_cancel.md
  - title: "zx_port_create"
    path: /docs/reference/syscalls/port_create.md
  - title: "zx_port_queue"
    path: /docs/reference/syscalls/port_queue.md
  - title: "zx_port_wait"
    path: /docs/reference/syscalls/port_wait.md
- title: "Futexes"
  section:
  - title: "zx_futex_get_owner"
    path: /docs/reference/syscalls/futex_get_owner.md
  - title: "zx_futex_requeue"
    path: /docs/reference/syscalls/futex_requeue.md
  - title: "zx_futex_requeue_single_owner"
    path: /docs/reference/syscalls/futex_requeue_single_owner.md
  - title: "zx_futex_wait"
    path: /docs/reference/syscalls/futex_wait.md
  - title: "zx_futex_wake"
    path: /docs/reference/syscalls/futex_wake.md
  - title: "zx_futex_wake_single_owner"
    path: /docs/reference/syscalls/futex_wake_single_owner.md
- title: "Virtual memory objects"
  section:
  - title: "zx_vmo_create_contiguous"
    path: /docs/reference/syscalls/vmo_create_contiguous.md
  - title: "zx_vmo_create"
    path: /docs/reference/syscalls/vmo_create.md
  - title: "zx_vmo_create_child"
    path: /docs/reference/syscalls/vmo_create_child.md
  - title: "zx_vmo_create_physical"
    path: /docs/reference/syscalls/vmo_create_physical.md
  - title: "zx_vmo_get_size"
    path: /docs/reference/syscalls/vmo_get_size.md
  - title: "zx_vmo_op_range"
    path: /docs/reference/syscalls/vmo_op_range.md
  - title: "zx_vmo_read"
    path: /docs/reference/syscalls/vmo_read.md
  - title: "zx_vmo_replace_as_executable"
    path: /docs/reference/syscalls/vmo_replace_as_executable.md
  - title: "zx_vmo_set_cache_policy"
    path: /docs/reference/syscalls/vmo_set_cache_policy.md
  - title: "zx_vmo_set_size"
    path: /docs/reference/syscalls/vmo_set_size.md
  - title: "zx_vmo_write"
    path: /docs/reference/syscalls/vmo_write.md
- title: "Virtual memory address regions"
  section:
  - title: "zx_vmar_allocate"
    path: /docs/reference/syscalls/vmar_allocate.md
  - title: "zx_vmar_destroy"
    path: /docs/reference/syscalls/vmar_destroy.md
  - title: "zx_vmar_map"
    path: /docs/reference/syscalls/vmar_map.md
  - title: "zx_vmar_op_range"
    path: /docs/reference/syscalls/vmar_op_range.md
  - title: "zx_vmar_protect"
    path: /docs/reference/syscalls/vmar_protect.md
  - title: "zx_vmar_unmap"
    path: /docs/reference/syscalls/vmar_unmap.md
- title: "Userspace pagers"
  section:
  - title: "zx_pager_create"
    path: /docs/reference/syscalls/pager_create.md
  - title: "zx_pager_create_vmo"
    path: /docs/reference/syscalls/pager_create_vmo.md
  - title: "zx_pager_detach_vmo"
    path: /docs/reference/syscalls/pager_detach_vmo.md
  - title: "zx_pager_supply_pages"
    path: /docs/reference/syscalls/pager_supply_pages.md
  - title: "zx_pager_op_range"
    path: /docs/reference/syscalls/pager_op_range.md
  - title: "zx_pager_query_dirty_ranges"
    path: /docs/reference/syscalls/pager_query_dirty_ranges.md
- title: "Cryptographically secure RNG"
  section:
  - title: "zx_cprng_add_entropy"
    path: /docs/reference/syscalls/cprng_add_entropy.md
  - title: "zx_cprng_draw"
    path: /docs/reference/syscalls/cprng_draw.md
- title: "Time"
  section:
  - title: "zx_nanosleep"
    path: /docs/reference/syscalls/nanosleep.md
  - title: "zx_clock_create"
    path: /docs/reference/syscalls/clock_create.md
  - title: "zx_clock_get_details"
    path: /docs/reference/syscalls/clock_get_details.md
  - title: "zx_clock_get_monotonic"
    path: /docs/reference/syscalls/clock_get_monotonic.md
  - title: "zx_clock_read"
    path: /docs/reference/syscalls/clock_read.md
  - title: "zx_clock_update"
    path: /docs/reference/syscalls/clock_update.md
  - title: "zx_ticks_get"
    path: /docs/reference/syscalls/ticks_get.md
  - title: "zx_ticks_per_second"
    path: /docs/reference/syscalls/ticks_per_second.md
  - title: "zx_deadline_after"
    path: /docs/reference/syscalls/deadline_after.md
- title: "Timer"
  section:
  - title: "zx_timer_cancel"
    path: /docs/reference/syscalls/timer_cancel.md
  - title: "zx_timer_create"
    path: /docs/reference/syscalls/timer_create.md
  - title: "zx_timer_set"
    path: /docs/reference/syscalls/timer_set.md
- title: "Hypervisor guests"
  section:
  - title: "zx_guest_create"
    path: /docs/reference/syscalls/guest_create.md
  - title: "zx_guest_set_trap"
    path: /docs/reference/syscalls/guest_set_trap.md
- title: "Virtual CPUs"
  section:
  - title: "zx_vcpu_create"
    path: /docs/reference/syscalls/vcpu_create.md
  - title: "zx_vcpu_enter"
    path: /docs/reference/syscalls/vcpu_enter.md
  - title: "zx_vcpu_kick"
    path: /docs/reference/syscalls/vcpu_kick.md
  - title: "zx_vcpu_interrupt"
    path: /docs/reference/syscalls/vcpu_interrupt.md
  - title: "zx_vcpu_read_state"
    path: /docs/reference/syscalls/vcpu_read_state.md
  - title: "zx_vcpu_write_state"
    path: /docs/reference/syscalls/vcpu_write_state.md
- title: "Global system information"
  section:
  - title: "zx_system_get_dcache_line_size"
    path: /docs/reference/syscalls/system_get_dcache_line_size.md
  - title: "zx_system_get_features"
    path: /docs/reference/syscalls/system_get_features.md
  - title: "zx_system_get_num_cpus"
    path: /docs/reference/syscalls/system_get_num_cpus.md
  - title: "zx_system_get_page_size"
    path: /docs/reference/syscalls/system_get_page_size.md
  - title: "zx_system_get_physmem"
    path: /docs/reference/syscalls/system_get_physmem.md
  - title: "zx_system_get_version_string"
    path: /docs/reference/syscalls/system_get_version_string.md
- title: "Debug logging"
  section:
  - title: "zx_debuglog_create"
    path: /docs/reference/syscalls/debuglog_create.md
  - title: "zx_debuglog_read"
    path: /docs/reference/syscalls/debuglog_read.md
  - title: "zx_debuglog_write"
    path: /docs/reference/syscalls/debuglog_write.md
  - title: "zx_debug_read"
    path: /docs/reference/syscalls/debug_read.md
  - title: "zx_debug_send_command"
    path: /docs/reference/syscalls/debug_send_command.md
  - title: "zx_debug_write"
    path: /docs/reference/syscalls/debug_write.md
- title: "Multi-function"
  section:
  - title: "zx_vmar_unmap_handle_close_thread_exit"
    path: /docs/reference/syscalls/vmar_unmap_handle_close_thread_exit.md
  - title: "zx_futex_wake_handle_close_thread_exit"
    path: /docs/reference/syscalls/futex_wake_handle_close_thread_exit.md
- title: "System"
  section:
  - title: "zx_system_mexec"
    path: /docs/reference/syscalls/system_mexec.md
  - title: "zx_system_mexec_payload_get"
    path: /docs/reference/syscalls/system_mexec_payload_get.md
  - title: "zx_system_powerctl"
    path: /docs/reference/syscalls/system_powerctl.md
  - title: "zx_system_get_performance_info"
    path: /docs/reference/syscalls/system_get_performance_info.md
  - title: "zx_system_set_performance_info"
    path: /docs/reference/syscalls/system_set_performance_info.md
- title: "DDK"
  section:
  - title: "zx_bti_create"
    path: /docs/reference/syscalls/bti_create.md
  - title: "zx_bti_pin"
    path: /docs/reference/syscalls/bti_pin.md
  - title: "zx_bti_release_quarantine"
    path: /docs/reference/syscalls/bti_release_quarantine.md
  - title: "zx_cache_flush"
    path: /docs/reference/syscalls/cache_flush.md
  - title: "zx_interrupt_ack"
    path: /docs/reference/syscalls/interrupt_ack.md
  - title: "zx_interrupt_bind"
    path: /docs/reference/syscalls/interrupt_bind.md
  - title: "zx_interrupt_bind_vcpu"
    path: /docs/reference/syscalls/interrupt_bind_vcpu.md
  - title: "zx_interrupt_create"
    path: /docs/reference/syscalls/interrupt_create.md
  - title: "zx_interrupt_destroy"
    path: /docs/reference/syscalls/interrupt_destroy.md
  - title: "zx_interrupt_trigger"
    path: /docs/reference/syscalls/interrupt_trigger.md
  - title: "zx_interrupt_wait"
    path: /docs/reference/syscalls/interrupt_wait.md
  - title: "zx_msi_allocate"
    path: /docs/reference/syscalls/msi_allocate.md
  - title: "zx_msi_create"
    path: /docs/reference/syscalls/msi_create.md
  - title: "zx_iommu_create"
    path: /docs/reference/syscalls/iommu_create.md
  - title: "zx_pmt_unpin"
    path: /docs/reference/syscalls/pmt_unpin.md
  - title: "zx_resource_create"
    path: /docs/reference/syscalls/resource_create.md
  - title: "zx_smc_call"
    path: /docs/reference/syscalls/smc_call.md
- title: "Display drivers"
  section:
  - title: "zx_framebuffer_get_info"
    path: /docs/reference/syscalls/framebuffer_get_info.md
  - title: "zx_framebuffer_set_range"
    path: /docs/reference/syscalls/framebuffer_set_range.md
- title: "Tracing"
  section:
  - title: "zx_ktrace_control"
    path: /docs/reference/syscalls/ktrace_control.md
  - title: "zx_ktrace_read"
    path: /docs/reference/syscalls/ktrace_read.md
  - title: "zx_ktrace_write"
    path: /docs/reference/syscalls/ktrace_write.md
  - title: "zx_mtrace_control"
    path: /docs/reference/syscalls/mtrace_control.md
- title: "Others"
  section:
  - title: "zx_ioports_release"
    path: /docs/reference/syscalls/ioports_release.md
  - title: "zx_ioports_request"
    path: /docs/reference/syscalls/ioports_request.md
  - title: "zx_pc_firmware_tables"
    path: /docs/reference/syscalls/pc_firmware_tables.md
  - title: "zx_pci_add_subtract_io_range"
    path: /docs/reference/syscalls/pci_add_subtract_io_range.md
  - title: "zx_pci_cfg_pio_rw"
    path: /docs/reference/syscalls/pci_cfg_pio_rw.md
  - title: "zx_pci_config_read"
    path: /docs/reference/syscalls/pci_config_read.md
  - title: "zx_pci_config_write"
    path: /docs/reference/syscalls/pci_config_write.md
  - title: "zx_pci_enable_bus_master"
    path: /docs/reference/syscalls/pci_enable_bus_master.md
  - title: "zx_pci_get_bar"
    path: /docs/reference/syscalls/pci_get_bar.md
  - title: "zx_pci_get_nth_device"
    path: /docs/reference/syscalls/pci_get_nth_device.md
  - title: "zx_pci_init"
    path: /docs/reference/syscalls/pci_init.md
  - title: "zx_pci_map_interrupt"
    path: /docs/reference/syscalls/pci_map_interrupt.md
  - title: "zx_pci_query_irq_mode"
    path: /docs/reference/syscalls/pci_query_irq_mode.md
  - title: "zx_pci_reset_device"
    path: /docs/reference/syscalls/pci_reset_device.md
  - title: "zx_pci_set_irq_mode"
    path: /docs/reference/syscalls/pci_set_irq_mode.md
  - title: "zx_syscall_test_0"
    path: /docs/reference/syscalls/syscall_test_0.md
  - title: "zx_syscall_test_1"
    path: /docs/reference/syscalls/syscall_test_1.md
  - title: "zx_syscall_test_2"
    path: /docs/reference/syscalls/syscall_test_2.md
  - title: "zx_syscall_test_3"
    path: /docs/reference/syscalls/syscall_test_3.md
  - title: "zx_syscall_test_4"
    path: /docs/reference/syscalls/syscall_test_4.md
  - title: "zx_syscall_test_5"
    path: /docs/reference/syscalls/syscall_test_5.md
  - title: "zx_syscall_test_6"
    path: /docs/reference/syscalls/syscall_test_6.md
  - title: "zx_syscall_test_7"
    path: /docs/reference/syscalls/syscall_test_7.md
  - title: "zx_syscall_test_8"
    path: /docs/reference/syscalls/syscall_test_8.md
  - title: "zx_syscall_test_wrapper"
    path: /docs/reference/syscalls/syscall_test_wrapper.md
  - title: "zx_syscall_test_handle_create"
    path: /docs/reference/syscalls/syscall_test_handle_create.md