162 lines · plain
1.. SPDX-License-Identifier: GPL-2.02 3General Information4===================5 6This document contains useful information to know when working with7the Rust support in the kernel.8 9 10``no_std``11----------12 13The Rust support in the kernel can link only `core <https://doc.rust-lang.org/core/>`_,14but not `std <https://doc.rust-lang.org/std/>`_. Crates for use in the15kernel must opt into this behavior using the ``#![no_std]`` attribute.16 17 18.. _rust_code_documentation:19 20Code documentation21------------------22 23Rust kernel code is documented using ``rustdoc``, its built-in documentation24generator.25 26The generated HTML docs include integrated search, linked items (e.g. types,27functions, constants), source code, etc. They may be read at:28 29 https://rust.docs.kernel.org30 31For linux-next, please see:32 33 https://rust.docs.kernel.org/next/34 35There are also tags for each main release, e.g.:36 37 https://rust.docs.kernel.org/6.10/38 39The docs can also be easily generated and read locally. This is quite fast40(same order as compiling the code itself) and no special tools or environment41are needed. This has the added advantage that they will be tailored to42the particular kernel configuration used. To generate them, use the ``rustdoc``43target with the same invocation used for compilation, e.g.::44 45 make LLVM=1 rustdoc46 47To read the docs locally in your web browser, run e.g.::48 49 xdg-open Documentation/output/rust/rustdoc/kernel/index.html50 51To learn about how to write the documentation, please see coding-guidelines.rst.52 53 54Extra lints55-----------56 57While ``rustc`` is a very helpful compiler, some extra lints and analyses are58available via ``clippy``, a Rust linter. To enable it, pass ``CLIPPY=1`` to59the same invocation used for compilation, e.g.::60 61 make LLVM=1 CLIPPY=162 63Please note that Clippy may change code generation, thus it should not be64enabled while building a production kernel.65 66 67Abstractions vs. bindings68-------------------------69 70Abstractions are Rust code wrapping kernel functionality from the C side.71 72In order to use functions and types from the C side, bindings are created.73Bindings are the declarations for Rust of those functions and types from74the C side.75 76For instance, one may write a ``Mutex`` abstraction in Rust which wraps77a ``struct mutex`` from the C side and calls its functions through the bindings.78 79Abstractions are not available for all the kernel internal APIs and concepts,80but it is intended that coverage is expanded as time goes on. "Leaf" modules81(e.g. drivers) should not use the C bindings directly. Instead, subsystems82should provide as-safe-as-possible abstractions as needed.83 84.. code-block::85 86 rust/bindings/87 (rust/helpers/)88 89 include/ -----+ <-+90 | |91 drivers/ rust/kernel/ +----------+ <-+ |92 fs/ | bindgen | |93 .../ +-------------------+ +----------+ --+ |94 | Abstractions | | |95 +---------+ | +------+ +------+ | +----------+ | |96 | my_foo | -----> | | foo | | bar | | -------> | Bindings | <-+ |97 | driver | Safe | | sub- | | sub- | | Unsafe | | |98 +---------+ | |system| |system| | | bindings | <-----+99 | | +------+ +------+ | | crate | |100 | | kernel crate | +----------+ |101 | +-------------------+ |102 | |103 +------------------# FORBIDDEN #--------------------------------+104 105The main idea is to encapsulate all direct interaction with the kernel's C APIs106into carefully reviewed and documented abstractions. Then users of these107abstractions cannot introduce undefined behavior (UB) as long as:108 109#. The abstractions are correct ("sound").110#. Any ``unsafe`` blocks respect the safety contract necessary to call the111 operations inside the block. Similarly, any ``unsafe impl``\ s respect the112 safety contract necessary to implement the trait.113 114Bindings115~~~~~~~~116 117By including a C header from ``include/`` into118``rust/bindings/bindings_helper.h``, the ``bindgen`` tool will auto-generate the119bindings for the included subsystem. After building, see the ``*_generated.rs``120output files in the ``rust/bindings/`` directory.121 122For parts of the C header that ``bindgen`` does not auto generate, e.g. C123``inline`` functions or non-trivial macros, it is acceptable to add a small124wrapper function to ``rust/helpers/`` to make it available for the Rust side as125well.126 127Abstractions128~~~~~~~~~~~~129 130Abstractions are the layer between the bindings and the in-kernel users. They131are located in ``rust/kernel/`` and their role is to encapsulate the unsafe132access to the bindings into an as-safe-as-possible API that they expose to their133users. Users of the abstractions include things like drivers or file systems134written in Rust.135 136Besides the safety aspect, the abstractions are supposed to be "ergonomic", in137the sense that they turn the C interfaces into "idiomatic" Rust code. Basic138examples are to turn the C resource acquisition and release into Rust139constructors and destructors or C integer error codes into Rust's ``Result``\ s.140 141 142Conditional compilation143-----------------------144 145Rust code has access to conditional compilation based on the kernel146configuration:147 148.. code-block:: rust149 150 #[cfg(CONFIG_X)] // Enabled (`y` or `m`)151 #[cfg(CONFIG_X="y")] // Enabled as a built-in (`y`)152 #[cfg(CONFIG_X="m")] // Enabled as a module (`m`)153 #[cfg(not(CONFIG_X))] // Disabled154 155For other predicates that Rust's ``cfg`` does not support, e.g. expressions with156numerical comparisons, one may define a new Kconfig symbol:157 158.. code-block:: kconfig159 160 config RUSTC_VERSION_MIN_107900161 def_bool y if RUSTC_VERSION >= 107900162