[syscalls][rights][doc] abigen comments to reflect syscall handle rights

This is a first pass at documenting the rights required for handles
passed to syscalls. There's lots more to do:

1) Something more like parseable syntax;
2) More complete specification;
3) Use this to autoupdate .md docs;
4) Verify that each handle actually has some associated documentation;
5) Test the markup vs. implementation using something like syzkaller;
6) Consider generating helpers to reduce the source code length in
   kernel/syscalls/;
... and probably lots more.

But writing down what the rights appear-to-be, as a first step.

ZX-968 #comment [syscalls][rights][doc] abigen comments to reflect syscall handle rights
ZX-2399 #comment [syscalls][rights][doc] abigen comments to reflect syscall handle rights
ZX-2967 #comment [syscalls][rights][doc] abigen comments to reflect syscall handle rights

Test: CQ, no behaviour change intended
Change-Id: I51f53d0d5b3f28238c0a9fa158477720f8021e34
8 files changed
tree: 3a0b542f84dae884f4e28f45d141cc950bbbfbec
  1. bootloader/
  2. docs/
  3. kernel/
  4. make/
  5. prebuilt/
  6. public/
  7. scripts/
  8. system/
  9. third_party/
  10. .clang-format
  11. .clang-tidy
  12. .dir-locals.el
  13. .gitignore
  14. .travis.yml
  15. AUTHORS
  16. LICENSE
  17. MAINTAINERS
  18. makefile
  19. navbar.md
  20. PATENTS
  21. README.md
README.md

Zircon

Zircon is the core platform that powers the Fuchsia OS. Zircon is composed of a microkernel (source in kernel/...) as well as a small set of userspace services, drivers, and libraries (source in system/...) necessary for the system to boot, talk to hardware, load userspace processes and run them, etc. Fuchsia builds a much larger OS on top of this foundation.

The canonical Zircon Git repository is located at: https://fuchsia.googlesource.com/zircon

A read-only mirror of the code is present at: https://github.com/fuchsia-mirror/zircon

The Zircon Kernel provides syscalls to manage processes, threads, virtual memory, inter-process communication, waiting on object state changes, and locking (via futexes).

Currently there are some temporary syscalls that have been used for early bringup work, which will be going away in the future as the long term syscall API/ABI surface is finalized. The expectation is that there will be about 100 syscalls.

Zircon syscalls are generally non-blocking. The wait_one, wait_many port_wait and thread sleep being the notable exceptions.

This page is a non-comprehensive index of the zircon documentation.