This proposal introduces machinery for documenting kernel APIs, addressing the long-standing challenge of maintaining stable interfaces between the kernel and user-space programs. Despite the kernel's commitment to never breaking user space, the lack of machine-readable API specifications has led to breakages and across system calls and IOCTLs.
Specifications can document parameter types, valid ranges, constraints, and alignment requirements. They capture return value semantics including success conditions and error codes with their meaning. Execution context requirements, capabilities, locking constraints, signal handling behavior, and side effects can all be formally specified. These specifications live alongside the code they document and are both human-readable and machine-parseable. They can be validated at runtime when CONFIG_KAPI_RUNTIME_CHECKS is enabled, exported via debugfs for userspace tools, and extracted from either vmlinux or source code. This enables static analysis tools to verify userspace API usage at compile time, test generation based on formal specifications, consistent error handling validation, automated documentation generation, and formal verification of kernel interfaces. The implementation includes a core framework with ELF section storage, kerneldoc integration for inline specification, a debugfs interface for runtime querying, and a Rust-based extraction tool (tools/kapi) supporting JSON, RST, and plain text output formats. Example specifications are provided for the four fundamental file syscalls (sys_open, sys_close, sys_read, sys_write). The series also includes a KUnit test suite with 38 tests and a runtime verification selftest with 29+ TAP tests. The series with runtime testing enabled (CONFIG_KAPI_RUNTIME_CHECKS=y) currently survives LTP tests in a KVM VM. Changes since RFC v5: - Streamlined example specs: focus on open/close/read/write to start with. - Added KUnit test suite. - Added runtime verification selftest. - Fixed kernel test robot warnings from v5: fixed "document isn't included in any toctree" (kernel-api-spec.rst now properly added to Documentation/dev-tools/index.rst), fixed sparse "non size-preserving integer to pointer cast" warnings in kernel_api_spec.c. - Rebased on v7.0-rc1. References: RFC v5: https://lore.kernel.org/lkml/[email protected]/ RFC v4: https://lore.kernel.org/lkml/[email protected]/ RFC v3: https://lore.kernel.org/lkml/[email protected]/ RFC v2: https://lore.kernel.org/lkml/[email protected]/ RFC v1: https://lore.kernel.org/lkml/[email protected]/ Sasha Levin (9): kernel/api: introduce kernel API specification framework kernel/api: enable kerneldoc-based API specifications kernel/api: add debugfs interface for kernel API specifications tools/kapi: Add kernel API specification extraction tool kernel/api: add API specification for sys_open kernel/api: add API specification for sys_close kernel/api: add API specification for sys_read kernel/api: add API specification for sys_write kernel/api: add runtime verification selftest .gitignore | 1 + Documentation/dev-tools/index.rst | 1 + Documentation/dev-tools/kernel-api-spec.rst | 629 +++++++ MAINTAINERS | 12 + arch/x86/include/asm/syscall_wrapper.h | 40 + fs/open.c | 576 +++++- fs/read_write.c | 687 +++++++ include/asm-generic/vmlinux.lds.h | 28 + include/linux/kernel_api_spec.h | 1580 +++++++++++++++++ include/linux/syscall_api_spec.h | 192 ++ include/linux/syscalls.h | 39 + init/Kconfig | 2 + kernel/Makefile | 3 + kernel/api/.gitignore | 2 + kernel/api/Kconfig | 70 + kernel/api/Makefile | 14 + kernel/api/kapi_debugfs.c | 503 ++++++ kernel/api/kapi_kunit.c | 536 ++++++ kernel/api/kernel_api_spec.c | 1277 +++++++++++++ scripts/Makefile.build | 31 + scripts/Makefile.clean | 3 + tools/docs/kernel-doc | 5 + tools/kapi/.gitignore | 4 + tools/kapi/Cargo.toml | 19 + tools/kapi/src/extractor/debugfs.rs | 581 ++++++ tools/kapi/src/extractor/kerneldoc_parser.rs | 1554 ++++++++++++++++ tools/kapi/src/extractor/mod.rs | 463 +++++ tools/kapi/src/extractor/source_parser.rs | 405 +++++ .../src/extractor/vmlinux/binary_utils.rs | 505 ++++++ .../src/extractor/vmlinux/magic_finder.rs | 112 ++ tools/kapi/src/extractor/vmlinux/mod.rs | 842 +++++++++ tools/kapi/src/formatter/json.rs | 727 ++++++++ tools/kapi/src/formatter/mod.rs | 140 ++ tools/kapi/src/formatter/plain.rs | 708 ++++++++ tools/kapi/src/formatter/rst.rs | 852 +++++++++ tools/kapi/src/main.rs | 119 ++ tools/lib/python/kdoc/kdoc_apispec.py | 887 +++++++++ tools/lib/python/kdoc/kdoc_output.py | 9 +- tools/lib/python/kdoc/kdoc_parser.py | 86 +- tools/testing/selftests/kapi/Makefile | 7 + tools/testing/selftests/kapi/kapi_test_util.h | 31 + tools/testing/selftests/kapi/test_kapi.c | 1021 +++++++++++ 42 files changed, 15294 insertions(+), 9 deletions(-) create mode 100644 Documentation/dev-tools/kernel-api-spec.rst create mode 100644 include/linux/kernel_api_spec.h create mode 100644 include/linux/syscall_api_spec.h create mode 100644 kernel/api/.gitignore create mode 100644 kernel/api/Kconfig create mode 100644 kernel/api/Makefile create mode 100644 kernel/api/kapi_debugfs.c create mode 100644 kernel/api/kapi_kunit.c create mode 100644 kernel/api/kernel_api_spec.c create mode 100644 tools/kapi/.gitignore create mode 100644 tools/kapi/Cargo.toml create mode 100644 tools/kapi/src/extractor/debugfs.rs create mode 100644 tools/kapi/src/extractor/kerneldoc_parser.rs create mode 100644 tools/kapi/src/extractor/mod.rs create mode 100644 tools/kapi/src/extractor/source_parser.rs create mode 100644 tools/kapi/src/extractor/vmlinux/binary_utils.rs create mode 100644 tools/kapi/src/extractor/vmlinux/magic_finder.rs create mode 100644 tools/kapi/src/extractor/vmlinux/mod.rs create mode 100644 tools/kapi/src/formatter/json.rs create mode 100644 tools/kapi/src/formatter/mod.rs create mode 100644 tools/kapi/src/formatter/plain.rs create mode 100644 tools/kapi/src/formatter/rst.rs create mode 100644 tools/kapi/src/main.rs create mode 100644 tools/lib/python/kdoc/kdoc_apispec.py create mode 100644 tools/testing/selftests/kapi/Makefile create mode 100644 tools/testing/selftests/kapi/kapi_test_util.h create mode 100644 tools/testing/selftests/kapi/test_kapi.c -- 2.51.0
