[docs][kernel] Update _toc.yaml files to add accordions in the nav bar.
- Added accordions to the System calls tab in Reference.
- Added accordions to the Kernel objects tab in Reference.
- Added accordions to the Kernel section in Concepts.
- Moved Kernel objects docs to the Kernel section in Concepts.
- Merged the System calls, Kernel objects, and Kernel tabs in Reference.
- Updated the update-docs-from-fidl zircon script.
Bug: b/149479093
Change-Id: I200563d00a6f13aa87ca05bdfb15bd3c4c816426
diff --git a/docs/concepts/_toc.yaml b/docs/concepts/_toc.yaml
index 06d043f..b8f980e 100644
--- a/docs/concepts/_toc.yaml
+++ b/docs/concepts/_toc.yaml
@@ -34,9 +34,6 @@
- title: "Kernel"
section:
- include: /docs/concepts/kernel/_toc.yaml
-- title: "Kernel objects"
- section:
- - include: /docs/concepts/objects/_toc.yaml
- title: "Media"
section:
- include: /docs/concepts/media/_toc.yaml
diff --git a/docs/concepts/booting/program_loading.md b/docs/concepts/booting/program_loading.md
index b2b8a79..25285cd 100644
--- a/docs/concepts/booting/program_loading.md
+++ b/docs/concepts/booting/program_loading.md
@@ -97,7 +97,7 @@
`ZX_RIGHT_EXECUTE` rights are required)
* A list of argument strings (to become `argv[]` in a C/C++ program)
* A list of environment strings (to become `environ[]` in a C/C++ program)
- * A list of initial [handles](/docs/concepts/objects/handles.md), each with
+ * A list of initial [handles](/docs/concepts/kernel/handles.md), each with
a [*handle info entry*](#handle-info-entry)
Three types of file are handled:
@@ -251,7 +251,7 @@
A bootstrap message conveys:
- * a list of initial [handles](/docs/concepts/objects/handles.md)
+ * a list of initial [handles](/docs/concepts/kernel/handles.md)
* a 32-bit *handle info entry* corresponding to each handle
* a list of name strings that a *handle info entry* can refer to
* a list of argument strings (to become `argv[]` in a C/C++ program)
diff --git a/docs/concepts/components/life_of_a_protocol_open.md b/docs/concepts/components/life_of_a_protocol_open.md
index 1139b1b..0a79d9a 100644
--- a/docs/concepts/components/life_of_a_protocol_open.md
+++ b/docs/concepts/components/life_of_a_protocol_open.md
@@ -263,7 +263,7 @@
[protocol-open]: #a-component-opens-a-protocol
[cap-routing]: #the-open-triggers-capability-routing
[binding]: #binding-to-a-component-and-sending-a-protocol-channel
-[handle]: /docs/concepts/objects/handles.md
+[handle]: /docs/concepts/kernel/handles.md
[channel]: /docs/reference/kernel_objects/channel.md
[namespaces]: /docs/concepts/framework/namespaces.md
[component-manifests]: component_manifests.md
diff --git a/docs/concepts/kernel/README.md b/docs/concepts/kernel/README.md
index 08a382c..81915ce 100644
--- a/docs/concepts/kernel/README.md
+++ b/docs/concepts/kernel/README.md
@@ -35,13 +35,13 @@
+ [Kernel Scheduling](kernel_scheduling.md)
+ [Fair Scheduler](fair_scheduler.md)
+ [Errors](errors.md)
-+ [Time](/docs/reference/kernel_objects/time.md)
++ [Time](/docs/concepts/kernel/time.md)
+ [Process Objects](/docs/reference/kernel_objects/process.md)
+ [Thread Objects](/docs/reference/kernel_objects/thread.md)
+ [Thread local storage](/docs/development/threads/tls.md)
+ [Thread annotations](/docs/development/threads/thread_annotations.md)
-+ [Handles](/docs/concepts/objects/handles.md)
++ [Handles](/docs/concepts/kernel/handles.md)
+ [Lock validation](lockdep.md)
+ [System Calls](/docs/reference/syscalls/README.md)
+ [zxcrypt](/docs/concepts/filesystems/zxcrypt.md)
diff --git a/docs/concepts/kernel/_toc.yaml b/docs/concepts/kernel/_toc.yaml
index 00cac3ec9..6f94148 100644
--- a/docs/concepts/kernel/_toc.yaml
+++ b/docs/concepts/kernel/_toc.yaml
@@ -1,40 +1,64 @@
-# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# Please, read https://fuchsia.dev/docs/contribute/best-practices/documentation_navigation_toc
# before making changes to this file, and add a member of the fuchsia.dev
# team as reviewer.
toc:
-- title: "Zircon kernel overview"
+- title: "Overview"
path: /docs/concepts/kernel
-- title: "Zircon kernel concepts"
+- title: "Zircon concepts"
path: /docs/concepts/kernel/concepts.md
-- title: "Avoiding a problem with the SYSRET"
- path: /docs/concepts/kernel/sysret_problem.md
-- title: "Errors"
- path: /docs/concepts/kernel/errors.md
-- title: "Fair scheduling"
- path: /docs/concepts/kernel/fair_scheduler.md
-- title: "Exceptions"
- path: /docs/concepts/kernel/exceptions.md
-- title: "Kernel internal errors"
- path: /docs/concepts/kernel/kernel_internal_errors.md
-- title: "Kernel invariants"
- path: /docs/concepts/kernel/kernel_invariants.md
-- title: "Kernel scheduling"
- path: /docs/concepts/kernel/kernel_scheduling.md
-- title: "Rights"
- path: /docs/concepts/kernel/rights.md
-- title: "Safe stack"
- path: /docs/concepts/kernel/safestack.md
-- title: "Shadow call stack"
- path: /docs/concepts/kernel/shadow_call_stack.md
-- title: "Signals"
- path: /docs/concepts/kernel/signals.md
-- title: "Runtime locks overview"
- path: /docs/concepts/kernel/lockdep.md
-- title: "Runtime locks design"
- path: /docs/concepts/kernel/lockdep-design.md
-- title: "vDSO (libzircon)"
- path: /docs/concepts/kernel/vdso.md
- title: "Zircon and LK"
path: /docs/concepts/kernel/zx_and_lk.md
-- title: "Random number generator"
- path: /docs/concepts/kernel/cprng.md
+- title: "Kernel objects"
+ section:
+ - title: "Handles"
+ path: /docs/concepts/kernel/handles.md
+ - title: "Rights"
+ path: /docs/concepts/kernel/rights.md
+ - title: "Signals"
+ path: /docs/concepts/kernel/signals.md
+- title: "System calls"
+ section:
+ - title: "vDSO (libzircon)"
+ path: /docs/concepts/kernel/vdso.md
+- title: "Scheduling"
+ section:
+ - title: "Zircon scheduling"
+ path: /docs/concepts/kernel/kernel_scheduling.md
+ - title: "Fair scheduler"
+ path: /docs/concepts/kernel/fair_scheduler.md
+- title: "Runtime lock"
+ section:
+ - title: "Runtime lock validation"
+ path: /docs/concepts/kernel/lockdep.md
+ - title: "Locak validation design"
+ path: /docs/concepts/kernel/lockdep-design.md
+- title: "Security"
+ section:
+ - title: "Safe stack"
+ path: /docs/concepts/kernel/safestack.md
+ - title: "Shadow call stack"
+ path: /docs/concepts/kernel/shadow_call_stack.md
+ - title: "Random number generator"
+ path: /docs/concepts/kernel/cprng.md
+- title: "Errors and exceptions"
+ section:
+ - title: "Errors"
+ path: /docs/concepts/kernel/errors.md
+ - title: "Exceptions"
+ path: /docs/concepts/kernel/exceptions.md
+ - title: "Kernel internal errors"
+ path: /docs/concepts/kernel/kernel_internal_errors.md
+- title: "Waiting"
+ section:
+ - title: "Timer slack"
+ path: /docs/concepts/kernel/timer_slack.md
+ - title: "Time units"
+ path: /docs/concepts/kernel/time.md
+ - title: "Clock transformations"
+ path: /docs/concepts/kernel/clock_transformations.md
+- title: "Advanced"
+ section:
+ - title: "Kernel invariants"
+ path: /docs/concepts/kernel/kernel_invariants.md
+ - title: "Avoiding a problem with the SYSRET"
+ path: /docs/concepts/kernel/sysret_problem.md
diff --git a/docs/concepts/objects/clock_transformations.md b/docs/concepts/kernel/clock_transformations.md
similarity index 100%
rename from docs/concepts/objects/clock_transformations.md
rename to docs/concepts/kernel/clock_transformations.md
diff --git a/docs/concepts/kernel/concepts.md b/docs/concepts/kernel/concepts.md
index 7bf6935..3d61c37 100644
--- a/docs/concepts/kernel/concepts.md
+++ b/docs/concepts/kernel/concepts.md
@@ -11,7 +11,7 @@
## [System Calls](/docs/reference/syscalls/README.md)
Userspace code interacts with kernel objects via system calls, and almost
-exclusively via [Handles](/docs/concepts/objects/handles.md). In userspace, a Handle is represented as
+exclusively via [Handles](/docs/concepts/kernel/handles.md). In userspace, a Handle is represented as
32bit integer (type zx_handle_t). When syscalls are executed, the kernel checks
that Handle parameters refer to an actual handle that exists within the calling
process's handle table. The kernel further checks that the Handle is of the
@@ -43,7 +43,7 @@
representation from `fidlc` and outputs various formats that are used as glue in the VDSO, kernel,
etc.
-## [Handles](/docs/concepts/objects/handles.md) and [Rights](/docs/concepts/kernel/rights.md)
+## [Handles](/docs/concepts/kernel/handles.md) and [Rights](/docs/concepts/kernel/rights.md)
Objects may have multiple Handles (in one or more Processes) that refer to them.
@@ -160,7 +160,7 @@
which they'll return even if no signals are pending.
Timeouts may deviate from the specified deadline according to timer
-slack. See [timer slack](/docs/concepts/objects/timer_slack.md) for more information.
+slack. See [timer slack](/docs/concepts/kernel/timer_slack.md) for more information.
If a Thread is going to wait on a large set of handles, it is more efficient to use
a Port, which is an Object that other Objects may be bound to such that when signals
diff --git a/docs/concepts/objects/handles.md b/docs/concepts/kernel/handles.md
similarity index 100%
rename from docs/concepts/objects/handles.md
rename to docs/concepts/kernel/handles.md
diff --git a/docs/concepts/objects/images/handle-creation1.png b/docs/concepts/kernel/images/handle-creation1.png
similarity index 100%
rename from docs/concepts/objects/images/handle-creation1.png
rename to docs/concepts/kernel/images/handle-creation1.png
Binary files differ
diff --git a/docs/concepts/objects/images/handle-creation2.png b/docs/concepts/kernel/images/handle-creation2.png
similarity index 100%
rename from docs/concepts/objects/images/handle-creation2.png
rename to docs/concepts/kernel/images/handle-creation2.png
Binary files differ
diff --git a/docs/concepts/objects/images/handle-creation3.png b/docs/concepts/kernel/images/handle-creation3.png
similarity index 100%
rename from docs/concepts/objects/images/handle-creation3.png
rename to docs/concepts/kernel/images/handle-creation3.png
Binary files differ
diff --git a/docs/concepts/objects/images/handle-creation4.png b/docs/concepts/kernel/images/handle-creation4.png
similarity index 100%
rename from docs/concepts/objects/images/handle-creation4.png
rename to docs/concepts/kernel/images/handle-creation4.png
Binary files differ
diff --git a/docs/concepts/objects/images/src/handle-creation_readme.txt b/docs/concepts/kernel/images/src/handle-creation_readme.txt
similarity index 100%
rename from docs/concepts/objects/images/src/handle-creation_readme.txt
rename to docs/concepts/kernel/images/src/handle-creation_readme.txt
diff --git a/docs/concepts/kernel/rights.md b/docs/concepts/kernel/rights.md
index 861e656..f30738f 100644
--- a/docs/concepts/kernel/rights.md
+++ b/docs/concepts/kernel/rights.md
@@ -45,7 +45,7 @@
## See also
[Objects](/docs/reference/kernel_objects/objects.md),
-[Handles](/docs/concepts/objects/handles.md)
+[Handles](/docs/concepts/kernel/handles.md)
[`zx_channel_write()`]: /docs/reference/syscalls/channel_write.md
[`zx_handle_duplicate()`]: /docs/reference/syscalls/handle_duplicate.md
diff --git a/docs/reference/kernel_objects/time.md b/docs/concepts/kernel/time.md
similarity index 100%
rename from docs/reference/kernel_objects/time.md
rename to docs/concepts/kernel/time.md
diff --git a/docs/concepts/objects/timer_slack.md b/docs/concepts/kernel/timer_slack.md
similarity index 100%
rename from docs/concepts/objects/timer_slack.md
rename to docs/concepts/kernel/timer_slack.md
diff --git a/docs/concepts/objects/_toc.yaml b/docs/concepts/objects/_toc.yaml
deleted file mode 100644
index ba42abf..0000000
--- a/docs/concepts/objects/_toc.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
-# before making changes to this file, and add a member of the fuchsia.dev
-# team as reviewer.
-toc:
-- title: "Handles"
- path: /docs/concepts/objects/handles.md
-- title: "Clock Transformations"
- path: /docs/concepts/objects/clock_transformations.md
-- title: "Timer Slack"
- path: /docs/concepts/objects/timer_slack.md
diff --git a/docs/glossary.md b/docs/glossary.md
index f9f6e95..cdff953 100644
--- a/docs/glossary.md
+++ b/docs/glossary.md
@@ -447,7 +447,7 @@
A Handle is how a userspace process refers to a [kernel object](#kernel-object).
They can be passed to other processes over [Channels](#channel).
-- [Reference](/docs/concepts/objects/handles.md)
+- [Reference](/docs/concepts/kernel/handles.md)
### **Hardware Driver** {#hardware-driver}
diff --git a/docs/reference/README.md b/docs/reference/README.md
index 67dc19a..526a7fc 100644
--- a/docs/reference/README.md
+++ b/docs/reference/README.md
@@ -1,12 +1,17 @@
-# Reference documentation
+# Kernel reference documentation
Reference documentation for Fuchsia kernel and subsystems.
-Interface and class reference documenation is generated and hosted at
-[https://fuchsia.dev/reference](https://fuchsia.dev/reference).
-
-# General Kernel reference
+## General kernel reference
* [Kernel command line options](kernel/kernel_cmdline.md)
* [Symbolizer markup format](kernel/symbolizer_markup.md)
-* [System calls](syscalls/README.md)
\ No newline at end of file
+
+## Kernel objects reference
+
+* [Kernel objects](kernel_objects/objects.md)
+
+## System calls reference
+
+* [System calls](syscalls/README.md)
+
diff --git a/docs/reference/_toc.yaml b/docs/reference/_toc.yaml
index a999178..ba2be6f 100644
--- a/docs/reference/_toc.yaml
+++ b/docs/reference/_toc.yaml
@@ -7,7 +7,7 @@
- title: "System calls"
section:
- include: /docs/reference/syscalls/_toc.yaml
-- title: "Objects"
+- title: "Kernel objects"
section:
- include: /docs/reference/kernel_objects/_toc.yaml
- title: "Kernel"
diff --git a/docs/reference/kernel_objects/_toc.yaml b/docs/reference/kernel_objects/_toc.yaml
index ae374ae..5780734 100644
--- a/docs/reference/kernel_objects/_toc.yaml
+++ b/docs/reference/kernel_objects/_toc.yaml
@@ -1,54 +1,68 @@
-# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# Please, read https://fuchsia.dev/docs/contribute/best-practices/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/kernel_objects/objects.md
-- title: "Bus transaction initiator"
- path: /docs/reference/kernel_objects/bus_transaction_initiator.md
-- title: "Channel"
- path: /docs/reference/kernel_objects/channel.md
+- title: "IPC"
+ section:
+ - title: "Channel"
+ path: /docs/reference/kernel_objects/channel.md
+ - title: "Socket"
+ path: /docs/reference/kernel_objects/socket.md
+ - title: "FIFO"
+ path: /docs/reference/kernel_objects/fifo.md
+- title: "Tasks"
+ section:
+ - title: "Process"
+ path: /docs/reference/kernel_objects/process.md
+ - title: "Thread"
+ path: /docs/reference/kernel_objects/thread.md
+ - title: "Job"
+ path: /docs/reference/kernel_objects/job.md
+ - title: "Task"
+ path: /docs/reference/kernel_objects/task.md
+- title: "Scheduling"
+ section:
+ - title: "Profile"
+ path: /docs/reference/kernel_objects/profile.md
+- title: "Signaling"
+ section:
+ - title: "Event"
+ path: /docs/reference/kernel_objects/event.md
+ - title: "Event pair"
+ path: /docs/reference/kernel_objects/eventpair.md
+ - title: "Futex"
+ path: /docs/reference/kernel_objects/futex.md
+- title: "Memory and address space"
+ section:
+ - title: "Virtual memory object"
+ path: /docs/reference/kernel_objects/vm_object.md
+ - title: "Virtual memory address region"
+ path: /docs/reference/kernel_objects/vm_address_region.md
+ - title: "Bus transaction initiator"
+ path: /docs/reference/kernel_objects/bus_transaction_initiator.md
+ - title: "Pinned memory token"
+ path: /docs/reference/kernel_objects/pinned_memory_token.md
+ - title: "Pager"
+ path: /docs/reference/kernel_objects/pager.md
+ - title: "Stream"
+ path: /docs/reference/kernel_objects/stream.md
+- title: "Waiting"
+ section:
+ - title: "Port"
+ path: /docs/reference/kernel_objects/port.md
+ - title: "Timer"
+ path: /docs/reference/kernel_objects/timer.md
+- title: "Drivers"
+ section:
+ - title: "Interrupts"
+ path: /docs/reference/kernel_objects/interrupts.md
+ - title: "Resource"
+ path: /docs/reference/kernel_objects/resource.md
+ - title: "Log"
+ path: /docs/reference/kernel_objects/debuglog.md
- title: "Clock"
- path: /docs/reference/kernel_objects/clock.md
-- title: "Log"
- path: /docs/reference/kernel_objects/debuglog.md
-- title: "Event"
- path: /docs/reference/kernel_objects/event.md
-- title: "Event pair"
- path: /docs/reference/kernel_objects/eventpair.md
-- title: "FIFO"
- path: /docs/reference/kernel_objects/fifo.md
-- title: "Futex"
- path: /docs/reference/kernel_objects/futex.md
-- title: "Interrupts"
- path: /docs/reference/kernel_objects/interrupts.md
-- title: "Job"
- path: /docs/reference/kernel_objects/job.md
-- title: "Pager"
- path: /docs/reference/kernel_objects/pager.md
-- title: "Pinned memory token"
- path: /docs/reference/kernel_objects/pinned_memory_token.md
-- title: "Port"
- path: /docs/reference/kernel_objects/port.md
-- title: "Process"
- path: /docs/reference/kernel_objects/process.md
-- title: "Profile"
- path: /docs/reference/kernel_objects/profile.md
-- title: "Resource"
- path: /docs/reference/kernel_objects/resource.md
-- title: "Socket"
- path: /docs/reference/kernel_objects/socket.md
-- title: "Stream"
- path: /docs/reference/kernel_objects/stream.md
-- title: "Task"
- path: /docs/reference/kernel_objects/task.md
-- title: "Thread"
- path: /docs/reference/kernel_objects/thread.md
-- title: "Time units"
- path: /docs/reference/kernel_objects/time.md
-- title: "Timer"
- path: /docs/reference/kernel_objects/timer.md
-- title: "Virtual memory address region"
- path: /docs/reference/kernel_objects/vm_address_region.md
-- title: "Virtual memory object"
- path: /docs/reference/kernel_objects/vm_object.md
+ section:
+ - title: "Clock"
+ path: /docs/reference/kernel_objects/clock.md
diff --git a/docs/reference/kernel_objects/channel.md b/docs/reference/kernel_objects/channel.md
index d56fa38..23e23fd 100644
--- a/docs/reference/kernel_objects/channel.md
+++ b/docs/reference/kernel_objects/channel.md
@@ -63,7 +63,7 @@
## SEE ALSO
+ [Zircon concepts](/docs/concepts/kernel/concepts.md)
-+ [Handles](/docs/concepts/objects/handles.md)
++ [Handles](/docs/concepts/kernel/handles.md)
[`zx_channel_call()`]: /docs/reference/syscalls/channel_call.md
[`zx_channel_create()`]: /docs/reference/syscalls/channel_create.md
diff --git a/docs/reference/kernel_objects/clock.md b/docs/reference/kernel_objects/clock.md
index 047bac3..7a90e6e 100644
--- a/docs/reference/kernel_objects/clock.md
+++ b/docs/reference/kernel_objects/clock.md
@@ -203,7 +203,7 @@
## SYSCALLS
- - [clock transformations](/docs/concepts/objects/clock_transformations.md)
+ - [clock transformations](/docs/concepts/kernel/clock_transformations.md)
- [`zx_clock_create()`] - create a clock
- [`zx_clock_read()`] - read the time of the clock
- [`zx_clock_get_details()`] - fetch the details of a clock's relationship to clock monotonic
diff --git a/docs/reference/kernel_objects/objects.md b/docs/reference/kernel_objects/objects.md
index 3b0657c7..8aac3d9 100644
--- a/docs/reference/kernel_objects/objects.md
+++ b/docs/reference/kernel_objects/objects.md
@@ -84,4 +84,4 @@
different rights.
## See Also
-[Handles](/docs/concepts/objects/handles.md)
+[Handles](/docs/concepts/kernel/handles.md)
diff --git a/docs/reference/kernel_objects/process.md b/docs/reference/kernel_objects/process.md
index 6e787d3..dff41d1 100644
--- a/docs/reference/kernel_objects/process.md
+++ b/docs/reference/kernel_objects/process.md
@@ -14,7 +14,7 @@
The process object is a container of the following resources:
-+ [Handles](/docs/concepts/objects/handles.md)
++ [Handles](/docs/concepts/kernel/handles.md)
+ [Virtual Memory Address Regions](vm_address_region.md)
+ [Threads](thread.md)
diff --git a/docs/reference/kernel_objects/timer.md b/docs/reference/kernel_objects/timer.md
index 0445ec7..177a178 100644
--- a/docs/reference/kernel_objects/timer.md
+++ b/docs/reference/kernel_objects/timer.md
@@ -36,7 +36,7 @@
## SEE ALSO
-+ [timer slack](/docs/concepts/objects/timer_slack.md)
++ [timer slack](/docs/concepts/kernel/timer_slack.md)
[`zx_object_wait_one()`]: /docs/reference/syscalls/object_wait_one.md
[`zx_object_wait_many()`]: /docs/reference/syscalls/object_wait_many.md
diff --git a/docs/reference/syscalls/_toc.yaml b/docs/reference/syscalls/_toc.yaml
index 87c6667..f53b288 100644
--- a/docs/reference/syscalls/_toc.yaml
+++ b/docs/reference/syscalls/_toc.yaml
@@ -1,352 +1,414 @@
-# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# Please, read https://fuchsia.dev/docs/contribute/best-practices/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: "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_channel_call"
- path: /docs/reference/syscalls/channel_call.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: "zx_clock_adjust"
- path: /docs/reference/syscalls/clock_adjust.md
-- title: "zx_clock_create"
- path: /docs/reference/syscalls/clock_create.md
-- title: "zx_clock_get"
- path: /docs/reference/syscalls/clock_get.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_cprng_add_entropy"
- path: /docs/reference/syscalls/cprng_add_entropy.md
-- title: "zx_cprng_draw"
- path: /docs/reference/syscalls/cprng_draw.md
-- title: "zx_deadline_after"
- path: /docs/reference/syscalls/deadline_after.md
-- 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: "zx_event_create"
- path: /docs/reference/syscalls/event_create.md
-- title: "zx_eventpair_create"
- path: /docs/reference/syscalls/eventpair_create.md
-- 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: "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: "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: "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_handle_close_thread_exit"
- path: /docs/reference/syscalls/futex_wake_handle_close_thread_exit.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: "zx_guest_create"
- path: /docs/reference/syscalls/guest_create.md
-- title: "zx_guest_set_trap"
- path: /docs/reference/syscalls/guest_set_trap.md
-- 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: "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_iommu_create"
- path: /docs/reference/syscalls/iommu_create.md
-- title: "zx_ioports_release"
- path: /docs/reference/syscalls/ioports_release.md
-- title: "zx_ioports_request"
- path: /docs/reference/syscalls/ioports_request.md
-- 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: "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: "zx_nanosleep"
- path: /docs/reference/syscalls/nanosleep.md
-- 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: "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_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_pmt_unpin"
- path: /docs/reference/syscalls/pmt_unpin.md
-- 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: "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: "zx_profile_create"
- path: /docs/reference/syscalls/profile_create.md
-- title: "zx_resource_create"
- path: /docs/reference/syscalls/resource_create.md
-- title: "zx_smc_call"
- path: /docs/reference/syscalls/smc_call.md
-- 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_shutdown"
- path: /docs/reference/syscalls/socket_shutdown.md
-- title: "zx_socket_write"
- path: /docs/reference/syscalls/socket_write.md
-- 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: "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
-- title: "zx_system_get_dcache_line_size"
- path: /docs/reference/syscalls/system_get_dcache_line_size.md
-- title: "zx_system_get_event"
- path: /docs/reference/syscalls/system_get_event.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_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: "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_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: "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_ticks_get"
- path: /docs/reference/syscalls/ticks_get.md
-- title: "zx_ticks_per_second"
- path: /docs/reference/syscalls/ticks_per_second.md
-- 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: "zx_vcpu_create"
- path: /docs/reference/syscalls/vcpu_create.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_resume"
- path: /docs/reference/syscalls/vcpu_resume.md
-- title: "zx_vcpu_write_state"
- path: /docs/reference/syscalls/vcpu_write_state.md
-- 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_handle_close_thread_exit"
- path: /docs/reference/syscalls/vmar_unmap_handle_close_thread_exit.md
-- title: "zx_vmar_unmap"
- path: /docs/reference/syscalls/vmar_unmap.md
-- 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: "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: "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_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_shutdown"
+ path: /docs/reference/syscalls/socket_shutdown.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: "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_adjust"
+ path: /docs/reference/syscalls/clock_adjust.md
+ - title: "zx_clock_create"
+ path: /docs/reference/syscalls/clock_create.md
+ - title: "zx_clock_get"
+ path: /docs/reference/syscalls/clock_get.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_interrupt"
+ path: /docs/reference/syscalls/vcpu_interrupt.md
+ - title: "zx_vcpu_read_state"
+ path: /docs/reference/syscalls/vcpu_read_state.md
+ - title: "zx_vcpu_resume"
+ path: /docs/reference/syscalls/vcpu_resume.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_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: "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_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
diff --git a/docs/reference/syscalls/channel_call.md b/docs/reference/syscalls/channel_call.md
index 6aa7ac5..67c9dc3 100644
--- a/docs/reference/syscalls/channel_call.md
+++ b/docs/reference/syscalls/channel_call.md
@@ -134,7 +134,7 @@
## SEE ALSO
- - [timer slack](/docs/concepts/objects/timer_slack.md)
+ - [timer slack](/docs/concepts/kernel/timer_slack.md)
- [`zx_channel_create()`]
- [`zx_channel_read()`]
- [`zx_channel_write()`]
diff --git a/docs/reference/syscalls/clock_get_details.md b/docs/reference/syscalls/clock_get_details.md
index 2022344..d2d7e78 100644
--- a/docs/reference/syscalls/clock_get_details.md
+++ b/docs/reference/syscalls/clock_get_details.md
@@ -64,7 +64,7 @@
## SEE ALSO
- - [clock transformations](/docs/concepts/objects/clock_transformations.md)
+ - [clock transformations](/docs/concepts/kernel/clock_transformations.md)
- [clocks](/docs/reference/kernel_objects/clock.md)
- [`zx_clock_create()`]
- [`zx_clock_read()`]
diff --git a/docs/reference/syscalls/futex_wait.md b/docs/reference/syscalls/futex_wait.md
index 8ba5cf7..f7cc710 100644
--- a/docs/reference/syscalls/futex_wait.md
+++ b/docs/reference/syscalls/futex_wait.md
@@ -81,7 +81,7 @@
## SEE ALSO
- [futex objects](/docs/reference/kernel_objects/futex.md)
- - [timer slack](/docs/concepts/objects/timer_slack.md)
+ - [timer slack](/docs/concepts/kernel/timer_slack.md)
- [`zx_futex_requeue()`]
- [`zx_futex_wake()`]
diff --git a/docs/reference/syscalls/job_set_policy.md b/docs/reference/syscalls/job_set_policy.md
index e2ff520..7319b51 100644
--- a/docs/reference/syscalls/job_set_policy.md
+++ b/docs/reference/syscalls/job_set_policy.md
@@ -152,7 +152,7 @@
+ **ZX_TIMER_SLACK_EARLY**
+ **ZX_TIMER_SLACK_LATE**
-See [timer slack](/docs/concepts/objects/timer_slack.md) for more information.
+See [timer slack](/docs/concepts/kernel/timer_slack.md) for more information.
When setting timer slack policy, *options* must be **ZX_JOB_POL_RELATIVE** and
**count** must be 1.
diff --git a/docs/reference/syscalls/nanosleep.md b/docs/reference/syscalls/nanosleep.md
index 8bf63e5..98ecca6 100644
--- a/docs/reference/syscalls/nanosleep.md
+++ b/docs/reference/syscalls/nanosleep.md
@@ -46,7 +46,7 @@
## SEE ALSO
- - [timer slack](/docs/concepts/objects/timer_slack.md)
+ - [timer slack](/docs/concepts/kernel/timer_slack.md)
- [`zx_deadline_after()`]
- [`zx_timer_cancel()`]
- [`zx_timer_create()`]
diff --git a/docs/reference/syscalls/object_wait_many.md b/docs/reference/syscalls/object_wait_many.md
index 4f592e5..f25be32 100644
--- a/docs/reference/syscalls/object_wait_many.md
+++ b/docs/reference/syscalls/object_wait_many.md
@@ -104,7 +104,7 @@
## SEE ALSO
- - [timer slack](/docs/concepts/objects/timer_slack.md)
+ - [timer slack](/docs/concepts/kernel/timer_slack.md)
- [`zx_object_wait_async()`]
- [`zx_object_wait_one()`]
diff --git a/docs/reference/syscalls/object_wait_one.md b/docs/reference/syscalls/object_wait_one.md
index ae5793b..fbbedc4 100644
--- a/docs/reference/syscalls/object_wait_one.md
+++ b/docs/reference/syscalls/object_wait_one.md
@@ -78,7 +78,7 @@
## SEE ALSO
- - [timer slack](/docs/concepts/objects/timer_slack.md)
+ - [timer slack](/docs/concepts/kernel/timer_slack.md)
- [`zx_object_wait_async()`]
- [`zx_object_wait_many()`]
diff --git a/docs/reference/syscalls/port_wait.md b/docs/reference/syscalls/port_wait.md
index 329413a..38872e1 100644
--- a/docs/reference/syscalls/port_wait.md
+++ b/docs/reference/syscalls/port_wait.md
@@ -114,7 +114,7 @@
## SEE ALSO
- - [timer slack](/docs/concepts/objects/timer_slack.md)
+ - [timer slack](/docs/concepts/kernel/timer_slack.md)
- [`zx_object_wait_async()`]
- [`zx_port_create()`]
- [`zx_port_queue()`]
diff --git a/docs/reference/syscalls/timer_create.md b/docs/reference/syscalls/timer_create.md
index 4fe9ba8..553d90eb 100644
--- a/docs/reference/syscalls/timer_create.md
+++ b/docs/reference/syscalls/timer_create.md
@@ -36,7 +36,7 @@
Passing 0 in options is equivalent to **ZX_TIMER_SLACK_CENTER**.
-See [timer slack](/docs/concepts/objects/timer_slack.md) for more information.
+See [timer slack](/docs/concepts/kernel/timer_slack.md) for more information.
The returned handle has the **ZX_RIGHT_DUPLICATE**, **ZX_RIGHT_TRANSFER**,
**ZX_RIGHT_WRITE**, **ZX_RIGHT_SIGNAL**, **ZX_RIGHT_WAIT**, and