: sphinx.addnodesdocument)}( rawsource children]( translations
LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba
attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget$/translations/zh_CN/rust/quick-startmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/zh_TW/rust/quick-startmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/it_IT/rust/quick-startmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/ja_JP/rust/quick-startmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/ko_KR/rust/quick-startmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/pt_BR/rust/quick-startmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/sp_SP/rust/quick-startmodnameN classnameN refexplicituh1hhh ubeh }(h ]h ]h"]h$]h&]current_languageEnglishuh1h
hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah }(h ]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhh>/var/lib/git/docbuild/linux/Documentation/rust/quick-start.rsthKubhsection)}(hhh](htitle)}(h Quick Starth]h Quick Start}(hhhhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hKThis document describes how to get started with kernel development in Rust.h]hKThis document describes how to get started with kernel development in Rust.}(hhhhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXG There are a few ways to install a Rust toolchain needed for kernel development.
A simple way is to use the packages from your Linux distribution if they are
suitable -- the first section below explains this approach. An advantage of this
approach is that, typically, the distribution will match the LLVM used by Rust
and Clang.h]hXG There are a few ways to install a Rust toolchain needed for kernel development.
A simple way is to use the packages from your Linux distribution if they are
suitable -- the first section below explains this approach. An advantage of this
approach is that, typically, the distribution will match the LLVM used by Rust
and Clang.}(hhhhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hX Another way is using the prebuilt stable versions of LLVM+Rust provided on
`kernel.org `_. These are the same slim
and fast LLVM toolchains from :ref:`Getting LLVM ` with versions
of Rust added to them that Rust for Linux supports. Two sets are provided: the
"latest LLVM" and "matching LLVM" (please see the link for more information).h](hKAnother way is using the prebuilt stable versions of LLVM+Rust provided on
}(hhhhhNhNubh reference)}(h7`kernel.org `_h]h
kernel.org}(hj hhhNhNubah }(h ]h ]h"]h$]h&]name
kernel.orgrefuri'https://kernel.org/pub/tools/llvm/rust/uh1j hhubhtarget)}(h* h]h }(h ]
kernel-orgah ]h"]
kernel.orgah$]h&]refurij uh1j
referencedKhhubh8. These are the same slim
and fast LLVM toolchains from }(hhhhhNhNubh)}(h":ref:`Getting LLVM `h]hinline)}(hj- h]h Getting LLVM}(hj1 hhhNhNubah }(h ]h ](xrefstdstd-refeh"]h$]h&]uh1j/ hj+ ubah }(h ]h ]h"]h$]h&]refdocrust/quick-start refdomainj< reftyperef refexplicitrefwarn reftarget getting_llvmuh1hhhhKhhubh with versions
of Rust added to them that Rust for Linux supports. Two sets are provided: the
“latest LLVM” and “matching LLVM” (please see the link for more information).}(hhhhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hAlternatively, the next two "Requirements" sections explain each component and
how to install them through ``rustup``, the standalone installers from Rust
and/or building them.h](hoAlternatively, the next two “Requirements” sections explain each component and
how to install them through }(hjZ hhhNhNubhliteral)}(h
``rustup``h]hrustup}(hjd hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hjZ ubh;, the standalone installers from Rust
and/or building them.}(hjZ hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hFThe rest of the document explains other aspects on how to get started.h]hFThe rest of the document explains other aspects on how to get started.}(hj| hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h
Distributionsh]h
Distributions}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhK ubh)}(hhh](h)}(h
Arch Linuxh]h
Arch Linux}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhK ubh)}(haArch Linux provides recent Rust releases and thus it should generally work out
of the box, e.g.::h]h`Arch Linux provides recent Rust releases and thus it should generally work out
of the box, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK!hj hhubh
literal_block)}(h$pacman -S rust rust-src rust-bindgenh]h$pacman -S rust rust-src rust-bindgen}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhK$hj hhubeh }(h ]
arch-linuxah ]h"]
arch linuxah$]h&]uh1hhj hhhhhK ubh)}(hhh](h)}(hDebianh]hDebian}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhK(ubh)}(hDebian 13 (Trixie), as well as Testing and Debian Unstable (Sid) provide recent
Rust releases and thus they should generally work out of the box, e.g.::h]hDebian 13 (Trixie), as well as Testing and Debian Unstable (Sid) provide recent
Rust releases and thus they should generally work out of the box, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK*hj hhubj )}(h6apt install rustc rust-src bindgen rustfmt rust-clippyh]h6apt install rustc rust-src bindgen rustfmt rust-clippy}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhK-hj hhubeh }(h ]debianah ]h"]debianah$]h&]uh1hhj hhhhhK(ubh)}(hhh](h)}(h Fedora Linuxh]h Fedora Linux}(hj
hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhK1ubh)}(hcFedora Linux provides recent Rust releases and thus it should generally work out
of the box, e.g.::h]hbFedora Linux provides recent Rust releases and thus it should generally work out
of the box, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK3hj hhubj )}(h4dnf install rust rust-src bindgen-cli rustfmt clippyh]h4dnf install rust rust-src bindgen-cli rustfmt clippy}hj& sbah }(h ]h ]h"]h$]h&]hhuh1j hhhK6hj hhubeh }(h ] fedora-linuxah ]h"] fedora linuxah$]h&]uh1hhj hhhhhK1ubh)}(hhh](h)}(h Gentoo Linuxh]h Gentoo Linux}(hj? hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj< hhhhhK:ubh)}(hcGentoo Linux provides recent Rust releases and thus it should generally work out
of the box, e.g.::h]hbGentoo Linux provides recent Rust releases and thus it should generally work out
of the box, e.g.:}(hjM hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK {} }:
pkgs.mkShell {
nativeBuildInputs = with pkgs; [ rustc rust-bindgen rustfmt clippy ];
RUST_LIB_SRC = "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}";
}h]h{ pkgs ? import {} }:
pkgs.mkShell {
nativeBuildInputs = with pkgs; [ rustc rust-bindgen rustfmt clippy ];
RUST_LIB_SRC = "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}";
}}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKJhj hhubeh }(h ]nixah ]h"]nixah$]h&]uh1hhj hhhhhKEubh)}(hhh](h)}(hopenSUSEh]hopenSUSE}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKRubh)}(hopenSUSE Slowroll and openSUSE Tumbleweed provide recent Rust releases and thus
they should generally work out of the box, e.g.::h]hopenSUSE Slowroll and openSUSE Tumbleweed provide recent Rust releases and thus
they should generally work out of the box, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKThj hhubj )}(h/zypper install rust rust-src rust-bindgen clangh]h/zypper install rust rust-src rust-bindgen clang}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKWhj hhubeh }(h ]opensuseah ]h"]opensuseah$]h&]uh1hhj hhhhhKRubh)}(hhh](h)}(hUbuntuh]hUbuntu}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhK[ubh)}(hgUbuntu 26.04 LTS provides recent Rust releases and thus it should
generally work out of the box, e.g.::h]hfUbuntu 26.04 LTS provides recent Rust releases and thus it should
generally work out of the box, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK]hj hhubj )}(h6apt install rustc rust-src bindgen rustfmt rust-clippyh]h6apt install rustc rust-src bindgen rustfmt rust-clippy}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhK`hj hhubh)}(h5In addition, ``RUST_LIB_SRC`` needs to be set, e.g.::h](h
In addition, }(hj$ hhhNhNubjc )}(h``RUST_LIB_SRC``h]h RUST_LIB_SRC}(hj, hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj$ ubh needs to be set, e.g.:}(hj$ hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKbhj hhubj )}(hFRUST_LIB_SRC=/usr/src/rustc-$(rustc --version | cut -d' ' -f2)/libraryh]hFRUST_LIB_SRC=/usr/src/rustc-$(rustc --version | cut -d' ' -f2)/library}hjD sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKdhj hhubh)}(hLFor convenience, ``RUST_LIB_SRC`` can be exported to the global environment.h](hFor convenience, }(hjR hhhNhNubjc )}(h``RUST_LIB_SRC``h]h RUST_LIB_SRC}(hjZ hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hjR ubh+ can be exported to the global environment.}(hjR hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKfhj hhubh)}(hhh](h)}(h24.04 LTS and olderh]h24.04 LTS and older}(hju hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhjr hhhhhKjubh)}(hThough Ubuntu 24.04 LTS and older versions still provide recent Rust
releases, they require some additional configuration to be set, using
the versioned packages, e.g.::h]hThough Ubuntu 24.04 LTS and older versions still provide recent Rust
releases, they require some additional configuration to be set, using
the versioned packages, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKlhjr hhubj )}(hapt install rustc-1.85 rust-1.85-src bindgen-0.71 rustfmt-1.85 \
rust-1.85-clippy
ln -s /usr/lib/rust-1.85/bin/rustfmt /usr/bin/rustfmt-1.85
ln -s /usr/lib/rust-1.85/bin/clippy-driver /usr/bin/clippy-driver-1.85h]hapt install rustc-1.85 rust-1.85-src bindgen-0.71 rustfmt-1.85 \
rust-1.85-clippy
ln -s /usr/lib/rust-1.85/bin/rustfmt /usr/bin/rustfmt-1.85
ln -s /usr/lib/rust-1.85/bin/clippy-driver /usr/bin/clippy-driver-1.85}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKphjr hhubh)}(hiNone of these packages set their tools as defaults; therefore they should be
specified explicitly, e.g.::h]hhNone of these packages set their tools as defaults; therefore they should be
specified explicitly, e.g.:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKuhjr hhubj )}(hmake LLVM=1 RUSTC=rustc-1.85 RUSTDOC=rustdoc-1.85 RUSTFMT=rustfmt-1.85 \
CLIPPY_DRIVER=clippy-driver-1.85 BINDGEN=bindgen-0.71h]hmake LLVM=1 RUSTC=rustc-1.85 RUSTDOC=rustdoc-1.85 RUSTFMT=rustfmt-1.85 \
CLIPPY_DRIVER=clippy-driver-1.85 BINDGEN=bindgen-0.71}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKxhjr hhubh)}(h|Alternatively, modify the ``PATH`` variable to place the Rust 1.85 binaries
first and set ``bindgen`` as the default, e.g.::h](hAlternatively, modify the }(hj hhhNhNubjc )}(h``PATH``h]hPATH}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh8 variable to place the Rust 1.85 binaries
first and set }(hj hhhNhNubjc )}(h ``bindgen``h]hbindgen}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh as the default, e.g.:}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhK{hjr hhubj )}(hPATH=/usr/lib/rust-1.85/bin:$PATH
update-alternatives --install /usr/bin/bindgen bindgen \
/usr/bin/bindgen-0.71 100
update-alternatives --set bindgen /usr/bin/bindgen-0.71h]hPATH=/usr/lib/rust-1.85/bin:$PATH
update-alternatives --install /usr/bin/bindgen bindgen \
/usr/bin/bindgen-0.71 100
update-alternatives --set bindgen /usr/bin/bindgen-0.71}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhK~hjr hhubh)}(hM``RUST_LIB_SRC`` may need to be set when using the versioned packages, e.g.::h](jc )}(h``RUST_LIB_SRC``h]h RUST_LIB_SRC}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh< may need to be set when using the versioned packages, e.g.:}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhjr hhubj )}(hKRUST_LIB_SRC=/usr/src/rustc-$(rustc-1.85 --version | cut -d' ' -f2)/libraryh]hKRUST_LIB_SRC=/usr/src/rustc-$(rustc-1.85 --version | cut -d' ' -f2)/library}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhjr hhubh)}(hLFor convenience, ``RUST_LIB_SRC`` can be exported to the global environment.h](hFor convenience, }(hj% hhhNhNubjc )}(h``RUST_LIB_SRC``h]h RUST_LIB_SRC}(hj- hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj% ubh+ can be exported to the global environment.}(hj% hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhjr hhubh)}(hIn addition, ``bindgen-0.71`` is available in newer releases (24.04 LTS),
but it may not be available in older ones (20.04 LTS and 22.04 LTS),
thus ``bindgen`` may need to be built manually (please see below).h](h
In addition, }(hjE hhhNhNubjc )}(h``bindgen-0.71``h]h bindgen-0.71}(hjM hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hjE ubhw is available in newer releases (24.04 LTS),
but it may not be available in older ones (20.04 LTS and 22.04 LTS),
thus }(hjE hhhNhNubjc )}(h ``bindgen``h]hbindgen}(hj_ hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hjE ubh2 may need to be built manually (please see below).}(hjE hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhjr hhubeh }(h ]
lts-and-olderah ]h"]24.04 lts and olderah$]h&]uh1hhj hhhhhKjubeh }(h ]ubuntuah ]h"]ubuntuah$]h&]uh1hhj hhhhhK[ubeh }(h ]
distributionsah ]h"]
distributionsah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hRequirements: Buildingh]hRequirements: Building}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(hAThis section explains how to fetch the tools needed for building.h]hAThis section explains how to fetch the tools needed for building.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hTTo easily check whether the requirements are met, the following target
can be used::h]hSTo easily check whether the requirements are met, the following target
can be used:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(hmake LLVM=1 rustavailableh]hmake LLVM=1 rustavailable}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(hThis triggers the same logic used by Kconfig to determine whether
``RUST_IS_AVAILABLE`` should be enabled; but it also explains why not
if that is the case.h](hBThis triggers the same logic used by Kconfig to determine whether
}(hj hhhNhNubjc )}(h``RUST_IS_AVAILABLE``h]hRUST_IS_AVAILABLE}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubhE should be enabled; but it also explains why not
if that is the case.}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hhh](h)}(hrustch]hrustc}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(h2A recent version of the Rust compiler is required.h]h2A recent version of the Rust compiler is required.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hIf ``rustup`` is being used, enter the kernel build directory (or use
``--path=`` argument to the ``set`` sub-command) and run,
for instance::h](hIf }(hj hhhNhNubjc )}(h
``rustup``h]hrustup}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh9 is being used, enter the kernel build directory (or use
}(hj hhhNhNubjc )}(h``--path=``h]h--path=}(hj# hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh argument to the }(hj hhhNhNubjc )}(h``set``h]hset}(hj5 hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh$ sub-command) and run,
for instance:}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(hrustup override set stableh]hrustup override set stable}hjM sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(hzThis will configure your working directory to use the given version of
``rustc`` without affecting your default toolchain.h](hGThis will configure your working directory to use the given version of
}(hj[ hhhNhNubjc )}(h ``rustc``h]hrustc}(hjc hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj[ ubh* without affecting your default toolchain.}(hj[ hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hZNote that the override applies to the current working directory (and its
sub-directories).h]hZNote that the override applies to the current working directory (and its
sub-directories).}(hj{ hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hCIf you are not using ``rustup``, fetch a standalone installer from:h](hIf you are not using }(hj hhhNhNubjc )}(h
``rustup``h]hrustup}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh$, fetch a standalone installer from:}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh block_quote)}(hNhttps://forge.rust-lang.org/infra/other-installation-methods.html#standalone
h]h)}(hLhttps://forge.rust-lang.org/infra/other-installation-methods.html#standaloneh]j )}(hj h]hLhttps://forge.rust-lang.org/infra/other-installation-methods.html#standalone}(hj hhhNhNubah }(h ]h ]h"]h$]h&]refurij uh1j hj ubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hhhKhj hhubeh }(h ]rustcah ]h"]rustcah$]h&]uh1hhj hhhhhKubh)}(hhh](h)}(h Rust standard library sourceh]h Rust standard library source}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(hbThe Rust standard library source is required because the build system will
cross-compile ``core``.h](hYThe Rust standard library source is required because the build system will
cross-compile }(hj hhhNhNubjc )}(h``core``h]hcore}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh.}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(h"If ``rustup`` is being used, run::h](hIf }(hj hhhNhNubjc )}(h
``rustup``h]hrustup}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh is being used, run:}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h rustup component add rust-srch]h rustup component add rust-src}hj& sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(hThe components are installed per toolchain, thus upgrading the Rust compiler
version later on requires re-adding the component.h]hThe components are installed per toolchain, thus upgrading the Rust compiler
version later on requires re-adding the component.}(hj4 hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hOtherwise, if a standalone installer is used, the Rust source tree may be
downloaded into the toolchain's installation folder::h]hOtherwise, if a standalone installer is used, the Rust source tree may be
downloaded into the toolchain’s installation folder:}(hjB hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(hcurl -L "https://static.rust-lang.org/dist/rust-src-$(rustc --version | cut -d' ' -f2).tar.gz" |
tar -xzf - -C "$(rustc --print sysroot)/lib" \
"rust-src-$(rustc --version | cut -d' ' -f2)/rust-src/lib/" \
--strip-components=3h]hcurl -L "https://static.rust-lang.org/dist/rust-src-$(rustc --version | cut -d' ' -f2).tar.gz" |
tar -xzf - -C "$(rustc --print sysroot)/lib" \
"rust-src-$(rustc --version | cut -d' ' -f2)/rust-src/lib/" \
--strip-components=3}hjP sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(hIn this case, upgrading the Rust compiler version later on requires manually
updating the source tree (this can be done by removing ``$(rustc --print
sysroot)/lib/rustlib/src/rust`` then rerunning the above command).h](hIn this case, upgrading the Rust compiler version later on requires manually
updating the source tree (this can be done by removing }(hj^ hhhNhNubjc )}(h1``$(rustc --print
sysroot)/lib/rustlib/src/rust``h]h-$(rustc --print
sysroot)/lib/rustlib/src/rust}(hjf hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj^ ubh# then rerunning the above command).}(hj^ hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubeh }(h ] rust-standard-library-sourceah ]h"] rust standard library sourceah$]h&]uh1hhj hhhhhKubh)}(hhh](h)}(hlibclangh]hlibclang}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(h``libclang`` (part of LLVM) is used by ``bindgen`` to understand the C code
in the kernel, which means LLVM needs to be installed; like when the kernel
is compiled with ``LLVM=1``.h](jc )}(h ``libclang``h]hlibclang}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh (part of LLVM) is used by }(hj hhhNhNubjc )}(h ``bindgen``h]hbindgen}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubhw to understand the C code
in the kernel, which means LLVM needs to be installed; like when the kernel
is compiled with }(hj hhhNhNubjc )}(h
``LLVM=1``h]hLLVM=1}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh.}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hcLinux distributions are likely to have a suitable one available, so it is
best to check that first.h]hcLinux distributions are likely to have a suitable one available, so it is
best to check that first.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hOThere are also some binaries for several systems and architectures uploaded at:h]hOThere are also some binaries for several systems and architectures uploaded at:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h(https://releases.llvm.org/download.html
h]h)}(h'https://releases.llvm.org/download.htmlh]j )}(hj h]h'https://releases.llvm.org/download.html}(hj hhhNhNubah }(h ]h ]h"]h$]h&]refurij uh1j hj ubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hhhKhj hhubh)}(hNOtherwise, building LLVM takes quite a while, but it is not a complex process:h]hNOtherwise, building LLVM takes quite a while, but it is not a complex process:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(hThttps://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm
h]h)}(hShttps://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvmh]j )}(hj) h]hShttps://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm}(hj+ hhhNhNubah }(h ]h ]h"]h$]h&]refurij) uh1j hj' ubah }(h ]h ]h"]h$]h&]uh1hhhhKhj# ubah }(h ]h ]h"]h$]h&]uh1j hhhKhj hhubh)}(hPlease see Documentation/kbuild/llvm.rst for more information and further ways
to fetch pre-built releases and distribution packages.h]hPlease see Documentation/kbuild/llvm.rst for more information and further ways
to fetch pre-built releases and distribution packages.}(hjE hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubeh }(h ]libclangah ]h"]libclangah$]h&]uh1hhj hhhhhKubh)}(hhh](h)}(hbindgenh]hbindgen}(hj^ hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj[ hhhhhKubh)}(h`The bindings to the C side of the kernel are generated at build time using
the ``bindgen`` tool.h](hOThe bindings to the C side of the kernel are generated at build time using
the }(hjl hhhNhNubjc )}(h ``bindgen``h]hbindgen}(hjt hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hjl ubh tool.}(hjl hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj[ hhubh)}(h]Install it, for instance, via (note that this will download and build the tool
from source)::h]h\Install it, for instance, via (note that this will download and build the tool
from source):}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj[ hhubj )}(h"cargo install --locked bindgen-clih]h"cargo install --locked bindgen-cli}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj[ hhubh)}(hX ``bindgen`` uses the ``clang-sys`` crate to find a suitable ``libclang`` (which
may be linked statically, dynamically or loaded at runtime). By default, the
``cargo`` command above will produce a ``bindgen`` binary that will load
``libclang`` at runtime. If it is not found (or a different ``libclang`` than
the one found should be used), the process can be tweaked, e.g. by using the
``LIBCLANG_PATH`` environment variable. For details, please see ``clang-sys``'s
documentation at:h](jc )}(h ``bindgen``h]hbindgen}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh
uses the }(hj hhhNhNubjc )}(h
``clang-sys``h]h clang-sys}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh crate to find a suitable }(hj hhhNhNubjc )}(h ``libclang``h]hlibclang}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubhU (which
may be linked statically, dynamically or loaded at runtime). By default, the
}(hj hhhNhNubjc )}(h ``cargo``h]hcargo}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh command above will produce a }(hj hhhNhNubjc )}(h ``bindgen``h]hbindgen}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh binary that will load
}(hj hhhNhNubjc )}(h ``libclang``h]hlibclang}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh0 at runtime. If it is not found (or a different }(hj hhhNhNubjc )}(h ``libclang``h]hlibclang}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubhS than
the one found should be used), the process can be tweaked, e.g. by using the
}(hj hhhNhNubjc )}(h``LIBCLANG_PATH``h]h
LIBCLANG_PATH}(hj* hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh/ environment variable. For details, please see }(hj hhhNhNubjc )}(h
``clang-sys``h]h clang-sys}(hj< hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj ubh’s
documentation at:}(hj hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhj[ hhubj )}(hnhttps://github.com/KyleMayes/clang-sys#linking
https://github.com/KyleMayes/clang-sys#environment-variables
h](h)}(h.https://github.com/KyleMayes/clang-sys#linkingh]j )}(hjZ h]h.https://github.com/KyleMayes/clang-sys#linking}(hj\ hhhNhNubah }(h ]h ]h"]h$]h&]refurijZ uh1j hjX ubah }(h ]h ]h"]h$]h&]uh1hhhhKhjT ubh)}(h`_ language server can
be used with many editors to enable syntax highlighting, completion, go to
definition, and other features.h](hThe }(hj
hhhNhNubj )}(h3`rust-analyzer `_h]h
rust-analyzer}(hj
hhhNhNubah }(h ]h ]h"]h$]h&]name
rust-analyzerj https://rust-analyzer.github.io/uh1j hj
ubj )}(h# h]h }(h ]id1ah ]h"]
rust-analyzerah$]h&]refurij
uh1j j& Khj
ubh language server can
be used with many editors to enable syntax highlighting, completion, go to
definition, and other features.}(hj
hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhM6hj
hhubh)}(h``rust-analyzer`` needs a configuration file, ``rust-project.json``, which
can be generated by the ``rust-analyzer`` Make target::h](jc )}(h``rust-analyzer``h]h
rust-analyzer}(hj
hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj
ubh needs a configuration file, }(hj
hhhNhNubjc )}(h``rust-project.json``h]hrust-project.json}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj
ubh , which
can be generated by the }(hj
hhhNhNubjc )}(h``rust-analyzer``h]h
rust-analyzer}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj
ubh
Make target:}(hj
hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhM:hj
hhubj )}(hmake LLVM=1 rust-analyzerh]hmake LLVM=1 rust-analyzer}hj3 sbah }(h ]h ]h"]h$]h&]hhuh1j hhhM=hj
hhubeh }(h ]
rust-analyzerah ]h"]h$]j
ah&]uh1hhj hhhhhM4j& Kubeh }(h ]requirements-developingah ]h"]requirements: developingah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h
Configurationh]h
Configuration}(hjS hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhjP hhhhhMAubh)}(hX ``Rust support`` (``CONFIG_RUST``) needs to be enabled in the ``General setup``
menu. The option is only shown if a suitable Rust toolchain is found (see
above), as long as the other requirements are met. In turn, this will make
visible the rest of options that depend on Rust.h](jc )}(h``Rust support``h]h Rust support}(hje hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hja ubh (}(hja hhhNhNubjc )}(h``CONFIG_RUST``h]h CONFIG_RUST}(hjw hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hja ubh ) needs to be enabled in the }(hja hhhNhNubjc )}(h``General setup``h]h
General setup}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hja ubh
menu. The option is only shown if a suitable Rust toolchain is found (see
above), as long as the other requirements are met. In turn, this will make
visible the rest of options that depend on Rust.}(hja hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhMChjP hhubh)}(hAfterwards, go to::h]hAfterwards, go to:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMHhjP hhubj )}(h@Kernel hacking
-> Sample kernel code
-> Rust samplesh]h@Kernel hacking
-> Sample kernel code
-> Rust samples}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhMJhjP hhubh)}(hAAnd enable some sample modules either as built-in or as loadable.h]hAAnd enable some sample modules either as built-in or as loadable.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMNhjP hhubeh }(h ]
configurationah ]h"]
configurationah$]h&]uh1hhhhhhhhMAubh)}(hhh](h)}(hBuildingh]hBuilding}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhMRubh)}(heBuilding a kernel with a complete LLVM toolchain is the best supported setup
at the moment. That is::h]hdBuilding a kernel with a complete LLVM toolchain is the best supported setup
at the moment. That is:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMThj hhubj )}(h make LLVM=1h]h make LLVM=1}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhMWhj hhubh)}(hXUsing GCC also works for some configurations, but it is very experimental at
the moment.h]hXUsing GCC also works for some configurations, but it is very experimental at
the moment.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMYhj hhubeh }(h ]buildingah ]h"]buildingah$]h&]uh1hhhhhhhhMRubh)}(hhh](h)}(hHackingh]hHacking}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhM^ubh)}(hTo dive deeper, take a look at the source code of the samples
at ``samples/rust/``, the Rust support code under ``rust/`` and
the ``Rust hacking`` menu under ``Kernel hacking``.h](hATo dive deeper, take a look at the source code of the samples
at }(hj' hhhNhNubjc )}(h``samples/rust/``h]h
samples/rust/}(hj/ hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj' ubh , the Rust support code under }(hj' hhhNhNubjc )}(h ``rust/``h]hrust/}(hjA hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj' ubh and
the }(hj' hhhNhNubjc )}(h``Rust hacking``h]h Rust hacking}(hjS hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj' ubh menu under }(hj' hhhNhNubjc )}(h``Kernel hacking``h]hKernel hacking}(hje hhhNhNubah }(h ]h ]h"]h$]h&]uh1jb hj' ubh.}(hj' hhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhM`hj hhubeh }(h ]hackingah ]h"]hackingah$]h&]uh1hhhhhhhhM^ubeh }(h ] quick-startah ]h"] quick startah$]h&]uh1hhhhhhhhKubeh }(h ]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN
source_urlN
toc_backlinksentryfootnote_backlinksK
sectnum_xformKstrip_commentsNstrip_elements_with_classesN
strip_classesN report_levelK
halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-sig input_encoding_error_handlerstrictoutput_encodingutf-8 output_encoding_error_handlerj error_encodingutf-8 error_encoding_error_handlerbackslashreplace
language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid
dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN
_config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthK trim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales] character_level_inline_markupdoctitle_xform
docinfo_xformKsectsubtitle_xform
image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j j j" j j j j j j j j9 j6 j j j j j j j j j| jy j j j j j j jX jU j j jM jJ jS jP j
j
j
j
rust-analyzerj
j j j j j j u nametypes}(j j" j j j j9 j j j j j| j j j jX j jM jS j
j
j j j j uh }(j hj j j j j j j j j6 j j j< j j j j j j jy jr j j j j j j jU j j j[ jJ j jP j j
jV j
j
jC j
j
j
j jP j j j j u
footnote_refs}
citation_refs}
autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK
id_counter collectionsCounter}j KsRparse_messages]hsystem_message)}(hhh]h)}(h0Duplicate implicit target name: "rust-analyzer".h]h4Duplicate implicit target name: “rust-analyzer”.}(hj
hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj
ubah }(h ]h ]h"]h$]h&]j
alevelKtypeINFOsourcehnjlineKuh1j
hj
hhhhhM8ubatransform_messages] transformerN include_log]
decorationNhhub.