Skip to content

Commit b3a4583

Browse files
committed
Introduce Local Remote Execution
Provide generated toolchain configurations and a reproducible remote execution toolchain container with a C++ toolchain that can be used for fully hermetic integration tests. Once it's stabilized this allows us to distribute application-specific toolchain containers and to share CI caches with contributors to eliminate redundant rebuilds.
1 parent 43b4ea8 commit b3a4583

25 files changed

+4887
-1
lines changed

.bazelrc

+14
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,17 @@ build:tsan --run_under=//tools:tsan.sh
5454
startup --windows_enable_symlinks
5555
build:windows --cxxopt=/std:c++14 --host_cxxopt=/std:c++14
5656
build:windows --enable_runfiles
57+
58+
# Local remote execution flags.
59+
60+
# TODO(aaronmondal): rules_rust doesn't work with this enabled.
61+
#
62+
# Tracked in: https://github.com/TraceMachina/nativelink/issues/477.
63+
build:lre --incompatible_enable_cc_toolchain_resolution
64+
65+
# TODO(aaronmondal): Remove when https://github.com/bazelbuild/bazel/issues/7254
66+
# is resolved.
67+
build:lre --define=EXECUTOR=remote
68+
69+
# See: https://github.com/bazelbuild/bazel/issues/19714#issuecomment-1745604978
70+
build:lre --repo_env=BAZEL_DO_NOT_DETECT_CPP_TOOLCHAIN=1

.github/workflows/lre.yaml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Local Remote Execution
3+
4+
on:
5+
push:
6+
branches: [main]
7+
pull_request:
8+
branches: [main]
9+
10+
permissions: read-all
11+
12+
jobs:
13+
local:
14+
strategy:
15+
fail-fast: false
16+
matrix:
17+
os: [ubuntu-22.04]
18+
name: Local / ${{ matrix.os }}
19+
runs-on: ${{ matrix.os }}
20+
steps:
21+
22+
- name: Checkout
23+
uses: >- # v4.1.1
24+
actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
25+
26+
- name: Install Nix
27+
uses: >- #v7
28+
DeterminateSystems/nix-installer-action@5620eb4af6b562c53e4d4628c0b6e4f9d9ae8612
29+
30+
- name: Cache Nix derivations
31+
uses: >- # Custom commit, last pinned at 2023-11-17.
32+
DeterminateSystems/magic-nix-cache-action@a04e6275a6bea232cd04fc6f3cbf20d4cb02a3e1
33+
34+
- name: Build hello_lre with LRE toolchain.
35+
run: >
36+
nix develop --impure --command
37+
bash -c "bazel run \
38+
--config=lre \
39+
--verbose_failures \
40+
//local-remote-execution/examples:hello_lre"

WORKSPACE.bazel

+16
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@ workspace(name = "nativelink")
22

33
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
44

5+
http_archive(
6+
name = "rules_cc",
7+
sha256 = "2037875b9a4456dce4a79d112a8ae885bbc4aad968e6587dca6e64f3a0900cdf",
8+
strip_prefix = "rules_cc-0.0.9",
9+
urls = ["https://github.com/bazelbuild/rules_cc/releases/download/0.0.9/rules_cc-0.0.9.tar.gz"],
10+
)
11+
12+
register_execution_platforms(
13+
"@nativelink//local-remote-execution/generated/config:platform",
14+
)
15+
16+
register_toolchains(
17+
"@nativelink//local-remote-execution/generated/config:cc-toolchain",
18+
"@nativelink//local-remote-execution/generated/java:all",
19+
)
20+
521
http_archive(
622
name = "rules_rust",
723
sha256 = "36ab8f9facae745c9c9c1b33d225623d976e78f2cc3f729b7973d8c20934ab95",

flake.nix

+12
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@
3535

3636
customStdenv = import ./tools/llvmStdenv.nix { inherit pkgs; };
3737

38+
# TODO(aaronmondal): This doesn't work with rules_rust yet.
39+
# Tracked in https://github.com/TraceMachina/nativelink/issues/477.
40+
customClang = pkgs.callPackage ./tools/customClang.nix {
41+
inherit pkgs;
42+
stdenv = customStdenv;
43+
};
44+
3845
craneLib = crane.lib.${system};
3946

4047
src = pkgs.lib.cleanSourceWith {
@@ -68,6 +75,8 @@
6875
publish-ghcr = import ./tools/publish-ghcr.nix { inherit pkgs; };
6976

7077
local-image-test = import ./tools/local-image-test.nix { inherit pkgs; };
78+
79+
generate-toolchains = import ./tools/generate-toolchains.nix { inherit pkgs; };
7180
in
7281
{
7382
apps = {
@@ -79,6 +88,7 @@
7988
packages = {
8089
inherit publish-ghcr local-image-test;
8190
default = nativelink;
91+
lre = import ./local-remote-execution/image.nix { inherit pkgs nativelink; };
8292
image = pkgs.dockerTools.streamLayeredImage {
8393
name = "nativelink";
8494
contents = [
@@ -124,6 +134,8 @@
124134

125135
# Additional tools from within our development environment.
126136
local-image-test
137+
generate-toolchains
138+
customClang
127139
] ++ maybeDarwinDeps;
128140
shellHook = ''
129141
# Generate the .pre-commit-config.yaml symlink when entering the

local-remote-execution/README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Local Remote Execution
2+
3+
Nativelink's Local Remote Execution is a framework to build and rapidly iterate
4+
custom toolchain setups that are transparent, fully hermetic and reproducible
5+
across machines of the same system architecture.
6+
7+
When used in conjunction with Nix, Local Remote Execution recreates the remote
8+
execution environment in your local development environment. This lets you
9+
seamlessly switch between remote and local builds while reusing the same cache.
10+
11+
## Demo
12+
13+
> [!Note]
14+
> Local Remote Execution currently only works on `x86_64-linux`.
15+
16+
First, create an OCI image containing with the toolchains:
17+
18+
```
19+
generate-toolchains
20+
```
21+
22+
The `generate-toolchains` command creates an OCI image from a nix `stdenv` and
23+
generates toolchain configs from it. The resulting [generated C++ toolchains](
24+
./generated/cc/BUILD) have all tools pinned to specific derivations in
25+
`/nix/store/*`. These paths mirror the ones that you fetched when entering the
26+
flake development environment, i.e. the tools in the container and in you local
27+
environment are the same.
28+
29+
You can now build targets with the generated toolchain configs:
30+
31+
```
32+
bazel run --config=lre //local-remote-execution/examples:hello_lre
33+
```
34+
35+
If you have the remote execution container deployed as a worker you can switch
36+
to remote execution. For instance when using the [Kubernetes example](../deployment-examples/kubernetes):
37+
38+
```
39+
bazel run \
40+
--config=lre \
41+
--remote_cache=grpc://172.20.255.200:50051 \
42+
--define=EXECUTOR=remote \
43+
--remote_executor=grpc://172.20.255.201:50052 \
44+
//local-remote-execution/examples:hello_lre
45+
```

local-remote-execution/cpp_env.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"ABI_LIBC_VERSION": "glibc_2.35",
3+
"BAZEL_TARGET_LIBC": "glibc_2.35",
4+
"BAZEL_HOST_SYSTEM": "x86_64-unknown-linux-gnu"
5+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
load("@rules_cc//cc:defs.bzl", "cc_binary")
2+
3+
cc_binary(
4+
name = "hello_lre",
5+
srcs = ["hello.cpp"],
6+
copts = ["--verbose"],
7+
)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#include <iostream>
2+
3+
auto main() -> int {
4+
std::cout << "Hello, world!" << '\n';
5+
return 0;
6+
}
+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2021 Google LLC
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)