docs/devel/codebase.rst

5 This section presents the various parts of QEMU and how the codebase is
15 `MAINTAINERS <https://gitlab.com/qemu-project/qemu/-/blob/master/MAINTAINERS>`_
18 Some of the main QEMU subsystems are:
27 - `Monitor<QEMU monitor>`
28 - :ref:`QOM (QEMU Object Model)<qom>`
34 More documentation on QEMU subsystems can be found on :ref:`internal-subsystem`
48 * `accel <https://gitlab.com/qemu-project/qemu/-/tree/master/accel>`_:
50   `accelerators <Accelerators>` supported by QEMU
53   `target <https://gitlab.com/qemu-project/qemu/-/tree/master/target>`_.
54 * `audio <https://gitlab.com/qemu-project/qemu/-/tree/master/audio>`_:
56 * `authz <https://gitlab.com/qemu-project/qemu/-/tree/master/authz>`_:
57   `QEMU Authorization framework<client authorization>`.
58 * `backends <https://gitlab.com/qemu-project/qemu/-/tree/master/backends>`_:
61 * `block <https://gitlab.com/qemu-project/qemu/-/tree/master/block>`_:
63 * `bsd-user <https://gitlab.com/qemu-project/qemu/-/tree/master/bsd-user>`_:
65 * build: Where the code built goes by default. You can tell the QEMU build
67 * `chardev <https://gitlab.com/qemu-project/qemu/-/tree/master/chardev>`_:
69 * `common-user <https://gitlab.com/qemu-project/qemu/-/tree/master/common-user>`_:
71 * `configs <https://gitlab.com/qemu-project/qemu/-/tree/master/configs>`_:
72   Makefiles defining configurations to build QEMU.
73 * `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib>`_:
75 * `crypto <https://gitlab.com/qemu-project/qemu/-/tree/master/crypto>`_:
76   Cryptographic algorithms used in QEMU.
77 * `disas <https://gitlab.com/qemu-project/qemu/-/tree/master/disas>`_:
78   Disassembly functions used by QEMU target code.
79 * `docs <https://gitlab.com/qemu-project/qemu/-/tree/master/docs>`_:
80   QEMU Documentation.
81 * `dump <https://gitlab.com/qemu-project/qemu/-/tree/master/dump>`_:
83 * `ebpf <https://gitlab.com/qemu-project/qemu/-/tree/master/ebpf>`_:
84   eBPF program support in QEMU. `virtio-net RSS<ebpf-rss>` uses it.
85 * `fpu <https://gitlab.com/qemu-project/qemu/-/tree/master/fpu>`_:
87 * `fsdev <https://gitlab.com/qemu-project/qemu/-/tree/master/fsdev>`_:
89 * `gdbstub <https://gitlab.com/qemu-project/qemu/-/tree/master/gdbstub>`_:
91 * `gdb-xml <https://gitlab.com/qemu-project/qemu/-/tree/master/gdb-xml>`_:
93 * `host <https://gitlab.com/qemu-project/qemu/-/tree/master/host>`_:
96 * `linux-headers <https://gitlab.com/qemu-project/qemu/-/tree/master/linux-headers>`_:
99 * `linux-user <https://gitlab.com/qemu-project/qemu/-/tree/master/linux-user>`_:
102 * `.gitlab-ci.d <https://gitlab.com/qemu-project/qemu/-/tree/master/.gitlab-ci.d>`_:
104 * `include <https://gitlab.com/qemu-project/qemu/-/tree/master/include>`_:
105   All headers associated to different subsystems in QEMU. The hierarchy used
107 * `hw <https://gitlab.com/qemu-project/qemu/-/tree/master/hw>`_:
110 * `io <https://gitlab.com/qemu-project/qemu/-/tree/master/io>`_:
111   QEMU `I/O channels <https://lists.gnu.org/archive/html/qemu-devel/2015-11/msg04208.html>`_.
112 * `libdecnumber <https://gitlab.com/qemu-project/qemu/-/tree/master/libdecnumber>`_:
114 * `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/migration>`__:
116 * `monitor <https://gitlab.com/qemu-project/qemu/-/tree/master/monitor>`_:
117   `Monitor <QEMU monitor>` implementation (HMP & QMP).
118 * `nbd <https://gitlab.com/qemu-project/qemu/-/tree/master/nbd>`_:
119   QEMU NBD (Network Block Device) server.
120 * `net <https://gitlab.com/qemu-project/qemu/-/tree/master/net>`_:
122 * `pc-bios <https://gitlab.com/qemu-project/qemu/-/tree/master/pc-bios>`_:
124   QEMU without compilation.
125 * `plugins <https://gitlab.com/qemu-project/qemu/-/tree/master/plugins>`_:
127   `tests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tcg/plugins>`__
128   and `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib/plugins>`__
130 * `po <https://gitlab.com/qemu-project/qemu/-/tree/master/po>`_:
132 * `python <https://gitlab.com/qemu-project/qemu/-/tree/master/python>`_:
134 * `qapi <https://gitlab.com/qemu-project/qemu/-/tree/master/qapi>`_:
136 * `qobject <https://gitlab.com/qemu-project/qemu/-/tree/master/qobject>`_:
137   QEMU Object implementation.
138 * `qga <https://gitlab.com/qemu-project/qemu/-/tree/master/qga>`_:
139   QEMU `Guest agent <qemu-ga>` implementation.
140 * `qom <https://gitlab.com/qemu-project/qemu/-/tree/master/qom>`_:
141   QEMU :ref:`Object model <qom>` implementation, with monitor associated commands.
142 * `replay <https://gitlab.com/qemu-project/qemu/-/tree/master/replay>`_:
143   QEMU :ref:`Record/replay <replay>` implementation.
144 * `roms <https://gitlab.com/qemu-project/qemu/-/tree/master/roms>`_:
147 * `rust <https://gitlab.com/qemu-project/qemu/-/tree/master/rust>`_:
148   Rust integration in QEMU. It contains the new interfaces defined and
150 * `scripts <https://gitlab.com/qemu-project/qemu/-/tree/master/scripts>`_:
152   tools for QEMU codebase and execution traces.
153 * `scsi <https://gitlab.com/qemu-project/qemu/-/tree/master/scsi>`_:
155 * `semihosting <https://gitlab.com/qemu-project/qemu/-/tree/master/semihosting>`_:
156   QEMU `Semihosting <Semihosting>` implementation.
157 * `stats <https://gitlab.com/qemu-project/qemu/-/tree/master/stats>`_:
158   `Monitor <QEMU monitor>` stats commands implementation.
159 * `storage-daemon <https://gitlab.com/qemu-project/qemu/-/tree/master/storage-daemon>`_:
160   QEMU `Storage daemon <storage-daemon>` implementation.
161 * `stubs <https://gitlab.com/qemu-project/qemu/-/tree/master/stubs>`_:
162   Various stubs (empty functions) used to compile QEMU with specific
164 * `subprojects <https://gitlab.com/qemu-project/qemu/-/tree/master/subprojects>`_:
165   QEMU submodules used by QEMU build system.
166 * `system <https://gitlab.com/qemu-project/qemu/-/tree/master/system>`_:
167   QEMU `system mode <System emulation>` implementation (cpu, mmu, boot support).
168 * `target <https://gitlab.com/qemu-project/qemu/-/tree/master/target>`_:
172 * `tcg <https://gitlab.com/qemu-project/qemu/-/tree/master/tcg>`_:
175 * `tests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests>`_:
176   QEMU `test <testing>` suite
178   - `data <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/data>`_:
180   - `decode <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/decode>`_:
182   - `docker <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/docker>`_:
184   - `fp <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/fp>`_:
185     QEMU testsuite for soft float implementation.
186   - `functional <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/functional>`_:
188   - `lcitool <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/lcitool>`_:
190   - `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/migration>`_:
192   - `multiboot <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/multiboot>`_:
194   - `qapi-schema <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qapi-schema>`_:
196   - `qemu-iotests <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qemu-iotests>`_:
197     `Disk image and block tests <qemu-iotests>`.
198   - `qtest <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qtest>`_:
200   - `tcg <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tcg>`__:
203   - `tsan <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/tsan>`_:
205   - `uefi-test-tools <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/uefi-test-tools>`_:
207   - `unit <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/unit>`_:
208     QEMU `Unit tests <unit-tests>`.
209 * `trace <https://gitlab.com/qemu-project/qemu/-/tree/master/trace>`_:
212 * `ui <https://gitlab.com/qemu-project/qemu/-/tree/master/ui>`_:
213   QEMU User interfaces.
214 * `util <https://gitlab.com/qemu-project/qemu/-/tree/master/util>`_:
215   Utility code used by other parts of QEMU.