README.md
1# Zircon
2
3Zircon is the core platform that powers the Fuchsia OS. Zircon is
4composed of a microkernel (source in kernel/...) as well as a small
5set of userspace services, drivers, and libraries (source in system/...)
6necessary for the system to boot, talk to hardware, load userspace
7processes and run them, etc. Fuchsia builds a much larger OS on top
8of this foundation.
9
10The canonical Zircon Git repository is located
11at: https://fuchsia.googlesource.com/zircon
12
13A read-only mirror of the code is present
14at: https://github.com/fuchsia-mirror/zircon
15
16The Zircon Kernel provides syscalls to manage processes, threads,
17virtual memory, inter-process communication, waiting on object state
18changes, and locking (via futexes).
19
20Currently there are some temporary syscalls that have been used for early
21bringup work, which will be going away in the future as the long term
22syscall API/ABI surface is finalized. The expectation is that there will
23be about 100 syscalls.
24
25Zircon syscalls are generally non-blocking. The wait_one, wait_many
26port_wait and thread sleep being the notable exceptions.
27
28This page is a non-comprehensive index of the zircon documentation.
29
30+ [Getting Started](docs/getting_started.md)
31+ [Contributing Patches](docs/contributing.md)
32
33+ [Concepts Overview](docs/concepts.md)
34+ [Kernel Objects](docs/objects.md)
35+ [Process Objects](docs/objects/process.md)
36+ [Thread Objects](docs/objects/thread.md)
37+ [Handles](docs/handles.md)
38+ [System Calls](docs/syscalls.md)
39
40+ [Driver Development Kit](docs/ddk/overview.md)
41
42+ [Testing](docs/testing.md)
43+ [Hacking notes](docs/hacking.md)
44+ [Memory usage analysis tools](docs/memory.md)
45+ [Relationship with LK](docs/zx_and_lk.md)
46+ [Micro-benchmarks](docs/benchmarks/microbenchmarks.md)
47