Documentation/translations/zh_CN/rust/quick-start.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2 .. include:: ../disclaimer-zh_CN.rst
   3
   4 :Original: Documentation/rust/quick-start.rst
   5
   6 :翻译:
   7
   8  司延腾 Yanteng Si <siyanteng@loongson.cn>
   9
  10
  11 快速入门
  12 ========
  13
  14 本文介绍了如何开始使用Rust进行内核开发。
  15
  16
  17 构建依赖
  18 --------
  19
  20 本节描述了如何获取构建所需的工具。
  21
  22 其中一些依赖也许可以从Linux发行版中获得，包名可能是 ``rustc`` , ``rust-src`` ,
  23 ``rust-bindgen`` 等。然而，在写这篇文章的时候，它们很可能还不够新，除非发行版跟踪最
  24 新的版本。
  25
  26 为了方便检查是否满足要求，可以使用以下目标::
  27
  28         make LLVM=1 rustavailable
  29
  30 这会触发与Kconfig用来确定是否应该启用 ``RUST_IS_AVAILABLE`` 相同的逻辑；不过，如
  31 果Kconfig认为不该启用，它会列出未满足的条件。
  32
  33
  34 rustc
  35 *****
  36
  37 需要一个特定版本的Rust编译器。较新的版本可能会也可能不会工作，因为就目前而言，内核依赖
  38 于一些不稳定的Rust特性。
  39
  40 如果使用的是 ``rustup`` ，请进入内核编译目录（或者用 ``--path=<build-dir>`` 参数
  41 来 ``设置`` sub-command)并运行::
  42
  43         rustup override set $(scripts/min-tool-version.sh rustc)
  44
  45 +这将配置你的工作目录使用正确版本的 ``rustc``，而不影响你的默认工具链。
  46
  47 请注意覆盖应用当前的工作目录（和它的子目录）。
  48
  49 如果你使用 ``rustup``， 可以从下面的链接拉取一个单独的安装程序:
  50
  51         https://forge.rust-lang.org/infra/other-installation-methods.html#standalone
  52
  53
  54 Rust标准库源代码
  55 ****************
  56
  57 Rust标准库的源代码是必需的，因为构建系统会交叉编译 ``core`` 和 ``alloc`` 。
  58
  59 如果正在使用 ``rustup`` ，请运行::
  60
  61         rustup component add rust-src
  62
  63 这些组件是按工具链安装的，因此以后升级Rust编译器版本需要重新添加组件。
  64
  65 否则，如果使用独立的安装程序，可以将Rust源码树下载到安装工具链的文件夹中::
  66
  67        curl -L "https://static.rust-lang.org/dist/rust-src-$(scripts/min-tool-version.sh rustc).tar.gz" |
  68                tar -xzf - -C "$(rustc --print sysroot)/lib" \
  69                "rust-src-$(scripts/min-tool-version.sh rustc)/rust-src/lib/" \
  70                --strip-components=3
  71
  72 在这种情况下，以后升级Rust编译器版本需要手动更新这个源代码树（这可以通过移除
  73 ``$(rustc --print sysroot)/lib/rustlib/src/rust`` ，然后重新执行上
  74 面的命令做到）。
  75
  76
  77 libclang
  78 ********
  79
  80 ``bindgen`` 使用 ``libclang`` （LLVM的一部分）来理解内核中的C代码，这意味着需要安
  81 装LLVM；同在开启``LLVM=1`` 时编译内核一样。
  82
  83 Linux发行版中可能会有合适的包，所以最好先检查一下。
  84
  85 适用于部分系统和架构的二进制文件也可到以下网址下载：
  86
  87         https://releases.llvm.org/download.html
  88
  89 或者自行构建LLVM，这需要相当长的时间，但并不是一个复杂的过程：
  90
  91         https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm
  92
  93 请参阅 Documentation/kbuild/llvm.rst 了解更多信息，以及获取预构建版本和发行包
  94 的进一步方法。
  95
  96
  97 bindgen
  98 *******
  99
 100 内核的C端绑定是在构建时使用 ``bindgen`` 工具生成的。这需要特定的版本。
 101
 102 通过以下方式安装它（注意，这将从源码下载并构建该工具）::
 103
 104         cargo install --locked --version $(scripts/min-tool-version.sh bindgen) bindgen-cli
 105
 106 ``bindgen`` 需要找到合适的 ``libclang`` 才能工作。如果没有找到（或者找到的
 107 ``libclang`` 与应该使用的 ``libclang`` 不同），则可以使用 ``clang-sys``
 108 理解的环境变量（Rust绑定创建的 ``bindgen`` 用来访问 ``libclang``）:
 109
 110
 111 * ``LLVM_CONFIG_PATH`` 可以指向一个 ``llvm-config`` 可执行文件。
 112
 113 * 或者 ``LIBCLANG_PATH`` 可以指向 ``libclang`` 共享库或包含它的目录。
 114
 115 * 或者 ``CLANG_PATH`` 可以指向 ``clang`` 可执行文件。
 116
 117 详情请参阅 ``clang-sys`` 的文档:
 118
 119
 120 开发依赖
 121 --------
 122
 123 本节解释了如何获取开发所需的工具。也就是说，在构建内核时不需要这些工具。
 124
 125
 126 rustfmt
 127 *******
 128
 129 ``rustfmt`` 工具被用来自动格式化所有的Rust内核代码，包括生成的C绑定（详情请见
 130 coding-guidelines.rst ）。
 131
 132 如果使用的是 ``rustup`` ，它的 ``默认`` 配置文件已经安装了这个工具，因此不需要做什么。
 133 如果使用的是其他配置文件，可以手动安装该组件::
 134
 135         rustup component add rustfmt
 136
 137 独立的安装程序也带有 ``rustfmt`` 。
 138
 139
 140 clippy
 141 ******
 142
 143 ``clippy`` 是一个Rust linter。运行它可以为Rust代码提供额外的警告。它可以通过向 ``make``
 144 传递 ``CLIPPY=1`` 来运行（关于细节，详见 general-information.rst ）。
 145
 146 如果正在使用 ``rustup`` ，它的 ``默认`` 配置文件已经安装了这个工具，因此不需要做什么。
 147 如果使用的是另一个配置文件，该组件可以被手动安装::
 148
 149         rustup component add clippy
 150
 151 独立的安装程序也带有 ``clippy`` 。
 152
 153
 154 cargo
 155 *****
 156
 157 ``cargo`` 是Rust的本地构建系统。目前需要它来运行测试，因为它被用来构建一个自定义的标准
 158 库，其中包含了内核中自定义 ``alloc`` 所提供的设施。测试可以使用 ``rusttest`` Make 目标
 159 来运行。
 160
 161 如果使用的是 ``rustup`` ，所有的配置文件都已经安装了该工具，因此不需要再做什么。
 162
 163 独立的安装程序也带有 ``cargo`` 。
 164
 165
 166 rustdoc
 167 *******
 168
 169 ``rustdoc`` 是Rust的文档工具。它为Rust代码生成漂亮的HTML文档（详情请见 general-information.rst ）。
 170
 171 ``rustdoc`` 也被用来测试文档化的Rust代码中提供的例子（称为doctests或文档测试）。
 172 ``rusttest`` 是本功能的Make目标。
 173
 174 如果使用的是 ``rustup`` ，所有的配置文件都已经安装了这个工具，因此不需要做什么。
 175
 176 独立的安装程序也带有 ``rustdoc`` 。
 177
 178
 179 rust-analyzer
 180 *************
 181
 182 `rust-analyzer <https://rust-analyzer.github.io/>`_ 语言服务器可以和许多编辑器
 183 一起使用，以实现语法高亮、补全、转到定义和其他功能。
 184
 185 ``rust-analyzer`` 需要一个配置文件， ``rust-project.json``, 它可以由 ``rust-analyzer``
 186 Make 目标生成::
 187
 188        make LLVM=1 rust-analyzer
 189
 190
 191 配置
 192 ----
 193
 194 Rust支持（CONFIG_RUST）需要在 ``General setup`` 菜单中启用。在其他要求得到满足的情
 195 况下，该选项只有在找到合适的Rust工具链时才会显示（见上文）。相应的，这将使依赖Rust的其
 196 他选项可见。
 197
 198 之后，进入::
 199
 200         Kernel hacking
 201             -> Sample kernel code
 202                 -> Rust samples
 203
 204 并启用一些内置或可加载的样例模块。
 205
 206
 207 构建
 208 ----
 209
 210 用完整的LLVM工具链构建内核是目前支持的最佳设置。即::
 211
 212         make LLVM=1
 213
 214 使用GCC对某些配置也是可行的，但目前它是非常试验性的。
 215
 216
 217 折腾
 218 ----
 219
 220 要想深入了解，请看 ``samples/rust/`` 下的样例源代码、 ``rust/`` 下的Rust支持代码和
 221 ``Kernel hacking`` 下的 ``Rust hacking`` 菜单。
 222
 223 如果使用的是GDB/Binutils，而Rust符号没有被demangled，原因是工具链还不支持Rust的新v0
 224 mangling方案。有几个办法可以解决：
 225
 226   - 安装一个较新的版本（GDB >= 10.2, Binutils >= 2.36）。
 227
 228   - 一些版本的GDB（例如vanilla GDB 10.1）能够使用嵌入在调试信息(``CONFIG_DEBUG_INFO``)
 229     中的pre-demangled的名字。