xref: /freebsd/sys/README.md (revision 32e47f62)
1d1087fe8SMitchell HorneFreeBSD Kernel Source:
2d1087fe8SMitchell Horne----------------------
3d1087fe8SMitchell Horne
4d1087fe8SMitchell HorneThis directory contains the source files and build glue that make up the FreeBSD
5d1087fe8SMitchell Hornekernel and its modules, including both original and contributed software.
6d1087fe8SMitchell Horne
79e0dcd0aSMitchell HorneKernel configuration files are located in the `conf/` subdirectory of each
89e0dcd0aSMitchell Hornearchitecture. `GENERIC` is the configuration used in release builds. `NOTES`
99e0dcd0aSMitchell Hornecontains documentation of all possible entries. `LINT` is a compile-only
109e0dcd0aSMitchell Horneconfiguration used to maximize build coverage and detect regressions.
119e0dcd0aSMitchell Horne
1232e47f62SMitchell HorneDocumentation:
1332e47f62SMitchell Horne--------------
1432e47f62SMitchell Horne
1532e47f62SMitchell HorneSource code documentation is maintained in a set of man pages, under section 9.
1632e47f62SMitchell HorneThese pages are located in [`share/man/man9`](../share/man/man9), from the
1732e47f62SMitchell Hornetop-level of the src tree. Consult [`intro(9)`](https://man.freebsd.org/intro/9)
1832e47f62SMitchell Hornefor an overview of existing pages.
1932e47f62SMitchell Horne
2032e47f62SMitchell HorneSome additional high-level documentation of the kernel is maintained in the
2132e47f62SMitchell Horne[Architecture Handbook](https://docs.freebsd.org/en/books/arch-handbook/).
2232e47f62SMitchell Horne
23d1087fe8SMitchell HorneSource Roadmap:
24d1087fe8SMitchell Horne---------------
25d1087fe8SMitchell Horne| Directory | Description |
26d1087fe8SMitchell Horne| --------- | ----------- |
2739701338SMitchell Horne| amd64 | AMD64 (64-bit x86) architecture support |
2839701338SMitchell Horne| arm | 32-bit ARM architecture support |
2939701338SMitchell Horne| arm64 | 64-bit ARM (AArch64) architecture support |
3039701338SMitchell Horne| cam | Common Access Method storage subsystem - `cam(4)` and `ctl(4)` |
3139701338SMitchell Horne| cddl | CDDL-licensed optional sources such as DTrace |
3239701338SMitchell Horne| conf | kernel build glue |
3339701338SMitchell Horne| compat | Linux compatibility layer, FreeBSD 32-bit compatibility |
3439701338SMitchell Horne| contrib | 3rd-party imported software such as OpenZFS |
3539701338SMitchell Horne| crypto | crypto drivers |
3639701338SMitchell Horne| ddb | interactive kernel debugger - `ddb(4)` |
3739701338SMitchell Horne| fs | most filesystems, excluding UFS, NFS, and ZFS |
38144661f9SJohn-Mark Gurney| dev | device drivers and other arch independent code |
3939701338SMitchell Horne| gdb | kernel remote GDB stub - `gdb(4)` |
4039701338SMitchell Horne| geom | GEOM framework - `geom(4)` |
4139701338SMitchell Horne| i386 | i386 (32-bit x86) architecture support |
42d1087fe8SMitchell Horne| kern | main part of the kernel |
4339701338SMitchell Horne| libkern | libc-like and other support functions for kernel use |
4439701338SMitchell Horne| modules | kernel module infrastructure |
4539701338SMitchell Horne| net | core networking code |
4639701338SMitchell Horne| net80211 | wireless networking (IEEE 802.11) - `net80211(4)` |
4739701338SMitchell Horne| netgraph | graph-based networking subsystem - `netgraph(4)` |
4839701338SMitchell Horne| netinet | IPv4 protocol implementation - `inet(4)` |
4939701338SMitchell Horne| netinet6 | IPv6 protocol implementation - `inet6(4)` |
5039701338SMitchell Horne| netipsec | IPsec protocol implementation - `ipsec(4)` |
5139701338SMitchell Horne| netpfil | packet filters - `ipfw(4)`, `pf(4)`, and `ipfilter(4)` |
5239701338SMitchell Horne| opencrypto | OpenCrypto framework - `crypto(7)` |
5339701338SMitchell Horne| powerpc | PowerPC/POWER (32 and 64-bit) architecture support |
5439701338SMitchell Horne| riscv | 64-bit RISC-V architecture support |
5539701338SMitchell Horne| security | security facilities - `audit(4)` and `mac(4)` |
56d1087fe8SMitchell Horne| sys | kernel headers |
5739701338SMitchell Horne| tests | kernel unit tests |
5839701338SMitchell Horne| ufs | Unix File System - `ffs(7)` |
5939701338SMitchell Horne| vm | virtual memory system |
60d1087fe8SMitchell Horne| x86 | code shared by AMD64 and i386 architectures |
61