1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
# //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](https://github.com/google/crubit)).
[TOC]
## Rolling Rust compiler and other Rust tools
Steps to roll the Rust compiler (and other Rust tools like `rustfmt`) to
a new version:
- Locally, update `RUST_REVISION` in `update_rust.py`.
(Update `RUST_SUB_REVISION` when the build or packaging is changed, but
the upstream Rust revision we build from is not changed.)
- Follow the general roll process below
## 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.
- Follow the general roll process below
## General roll process
- Author a CL that updates `CRUBIT_REVISION` and/or `RUST_REVISION`
(see one of the sections above for details).
- Upload the CL to Gerrit.
Ask [CQ](//docs/infra/cq.md) for Rust-specific tryjobs in the CL description:
`Cq-Include-Trybots: luci.chromium.try:linux-rust-x64-rel,linux-rust-x64-dbg,android-rust-arm-rel,android-rust-arm-dbg`.
- Run `linux_upload_clang` tryjob. This will run `package_rust.py` which will
`build_rust.py` and then upload a new version of the Rust toolchain package to
the staging bucket. This step runs `build_crubit.py` but doesn't (yet) package
the built binaries.
TODO(https://crbug.com/1329611): Update the docs once Crubit also gets packaged.
- Move the new toolchain package from staging to prod.
(A small set of people have the permission for this. There are
some Google-internal docs with more details.)
- Run CQ (see also `Cq-Include-Trybots` suggested above).
This step will test that `gclient sync` can fetch the new Rust toolchain
package + that the new package works fine in Chromium build.
- Land the CL. The new package won't be used outside of this CL
until this step.
## Building and testing the tools locally
### Prerequisites
#### LLVM/Clang build
`build_crubit.py` depends on having a locally-built LLVM/Clang:
`tools/clang/scripts/build.py --bootstrap --without-android --without-fuchsia`.
Among other things this prerequisite is required to generate
`third_party/llvm-bootstrap-install` where `build_crubit.py` will look for
LLVM/Clang libs and headers).
#### 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`:
```sh
$ cat ../.gclient
solutions = [
{
"name": "src",
"url": "https://chromium.googlesource.com/chromium/src.git",
...
"custom_vars": {
"checkout_bazel": True,
"use_rust": True,
},
},
]
```
#### Supported host platforms
So far `build_crubit.py` has only been tested on Linux hosts.
### Building
Just run `tools/rust/build_rust.py` or `tools/rust/build_crubit.py`.
### Deploying
`build_rust.py` by default copies the newly build executables/binaries into
`//third_party/rust-toolchain`. Currently a manual step is needed to copy
Crubit binaries (note that the `_impl` suffix has been dropped from the binary
name during the copy - this is expected):
```sh
cp \
third_party/crubit/bazel-bin/rs_bindings_from_cc/rs_bindings_from_cc_impl \
third_party/rust-toolchain/rs_bindings_from_cc
```
### Testing
Ensure that `args.gn` contains `enable_rust = true` and then build
`//build/rust/tests` directory - e.g. `ninja -C out/rust build/rust/tests`.
Native Rust tests from `//build/rust` can be run via
`out/rust/bin/run_build_rust_tests`.
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.
|
