commit	810d69697106af9077721c17a69a686bc6b2c580	[log] [tgz]
author	Hans Wennborg <hans@chromium.org>	Tue Oct 03 15:58:15 2023
committer	Copybara-Service <copybara-worker@google.com>	Sun Oct 22 20:09:33 2023
tree	a15ba7f5bec198a0e17e39f8cd88391c793e4f1c
parent	783f1c439d500a844b900ab5849f4c53a02a0a25 [diff]

tree: a15ba7f5bec198a0e17e39f8cd88391c793e4f1c

README.md

//tools/rust

This directory contains scripts for building, packaging, and distributing the Rust toolchain (the Rust compiler, and also C++/Rust FFI tools like Crubit).

Background

Like with Clang, Chromium uses bleeding edge Rust tooling. We track the upstream projects' latest development as closely as possible. However, Chromium cannot use official Rust builds for various reasons which require us to match the Rust LLVM backend version with the Clang we use.

It would not be reasonable to build the tooling for every Chromium build, so we build it centrally (with the scripts here) and distribute it for all to use (also fetched with the scripts here).

Rust build overview

Each Rust package is built from an Rust git, usually from HEAD directly, along with the current Clang/LLVM revision in use in Chromium. Hence a new Rust package must be built whenever either Rust or Clang is updated. When building Rust we also build additional tools such as clippy and rustfmt, and interop tools including bindgen and crubit.

The Rust build also includes building LLVM for rustc to use, and Clang for bindgen and crubit to use.

The *_upload_clang and *_upload_rust trybots are used to build Clang and Rust respectively from the revisions specified in the Chromium source tree. These are uploaded to a storage bucket when the build succeeds. After being copied from staging to production by a developer (see cs/copy_staging_to_prod_and_goma.sh), they can then be fetched by gclient sync.

The update_rust.py script is used by gclient sync to fetch the Rust toolchain for the revisions specified in the script.

Rolling Rust

Follow the directions in //docs/updating_clang.md to roll Clang and Rust together. To just roll Rust on its own, use the --skip-clang argument when running upload_revision.py.

The upload_revision.py script will update the revision of Rust to be built and used in update_rust.py and will start the trybots that will build the Rust toolchain.

After the build has succeeded and the new toolchain has been copied to production, the CQ will run trybots to verify that our code still builds and tests pass with the new Rust toolchain.

Possible failure: Missing dependencies

build_rust.py will vendor all dependencies before starting the build. To do this it first initializes git submodules. Then it runs cargo vendor. However some parts of the compiler build are excluded from the top level Cargo.toml workspace. Thus it passes --sync dir for a number of subdirectories, based on dist.rs, the nightly tarball packager.

If another Cargo.toml is required in the future, and not part of the workspace it would produce missing dependencies, and the set of directories in build_rust.py would need to be updated.

Possible failure: Missing sources or inputs

A build error when building the stdlib in Chromium may look like:

FAILED: local_rustc_sysroot/lib/rustlib/x86_64-unknown-linux-gnu/lib/libstd.rlib
...build command...
ERROR: file not in GN sources: ../../third_party/rust-toolchain/lib/rustlib/src/rust/library/std/src/../../portable-simd/crates/std_float/src/lib.rs

Or:

FAILED: local_rustc_sysroot/lib/rustlib/x86_64-unknown-linux-gnu/lib/libstd.rlib
...build command...
ERROR: file not in GN inputs: ../../third_party/rust-toolchain/lib/rustlib/src/rust/library/std/src/../../stdarch/crates/core_arch/src/core_arch_docs.md

When building the stdlib in Chromium, the GN rules must have every rust source or other input file that makes up the crate listed in the sources and inputs GN variables. gnrt will walk the directory tree from the root of the crate and put every relevant file into the set. But sometimes a crate includes modules from paths outside the crate root's directory tree, with a path directive such as

#[path = "../../stuff.rs"]
mod stuff;

or will include!() a file from another path, which is common for .md files:

include!("../../other_place.md")

The first error is saying the source file std_float/src/lib.rs did not appear in the sources variable. The ../../ part of the path shows that this is outside the crate root's directory tree. The second error is saying that core_arch/src/core_arch_docs.md did not appear in the inputs variable.

To fix the error:

Determine the path that is missing, relative to the crate root. In the above example this is ../../portable-simd/crates/std_float/src. We could also use ../../portable-simd or anything in between, though that would add a lot more sources to the GN rules than is necessary in this case. It's best to point to the directory of the module root (where the lib.rs or mod.rs is located).
Find the failing build target crate's rules in //build/rust/std/gnrt_config.toml. The failing crate in the above example is libstd.rlib, so we want the [crate.std] section of the config file.
Determine if the missing file should go in sources or inputs.
- For sources, add the path to a extra_src_roots list in the crate's rules. For the above example, we could add extra_src_roots = ['../../portable-simd/crates/std_float/src'].
- For inputs, add the path to a extra_input_roots list in the crate's rules. For the above example, we could add extra_input_roots = ['../../stdarch/crates/core_arch/src'].
Run tools/rust/gnrt_stdlib.py to use gnrt to rebuild the stdlib GN rules using the updated config.

Local development

To build the Rust toolchain locally, run //tools/rust/build_rust.py. It has additional flags to skip steps if you're making local changes and want to retry a build. The script will produce its outputs in //third_party/rust-toolchain/, which is the same place that gclient sync places them.

Building the rust_build_tests GN target is a good way to quickly verify the toolchain is working.

Rolling Crubit tools

Steps to roll the Crubit tools (e.g. rs_bindings_from_cc tool) to a new version:

Locally, update CRUBIT_REVISION in update_rust.py. (Update CRUBIT_SUB_REVISION when the build or packaging is changed, but the upstream Rust revision we build from is not changed.)
Locally, update crubit_revision in //DEPS, so that it matches the revision from the previous bullet item.
Run manual tests locally (see the “Building and testing the tools locally” section below). TODO(https://crbug.com/1329611): These manual steps should be made obsolete once Rust-specific tryjobs cover Crubit tests.

Building and testing Crubit locally

Prerequisites

Bazel

build_crubit.py depends on Bazel.

To get Bazel, ensure that you have checkout_bazel set in your .gclient file and then rerun gclient sync:

$ cat ../.gclient
solutions = [
  {
    "name": "src",
    "url": "https://chromium.googlesource.com/chromium/src.git",
    ...
    "custom_vars": {
      "checkout_bazel": True,
      "checkout_crubit": True,
    },
  },
]

Building

Just run tools/rust/build_crubit.py. So far build_crubit.py has only been tested on Linux hosts.

Deploying

build_crubit.py will copy files into the directory specified in the (optional) --install-to cmdline parameter - for example:

$ tools/rust/build_crubit.py --install-to=third_party/rust-toolchain/bin/

Testing

Crubit tests are under //build/rust/tests/test_rs_bindings_from_cc. Until Crubit is built on the bots, the tests are commented out in //build/rust/tests/BUILD.gn, but they should still be built and run before rolling Crubit. TODO(https://crbug.com/1329611): Rephrase this paragraph after Crubit is built and tested on the bots.