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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.remote;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.actions.ActionExecutionMetadata;
import com.google.devtools.build.lib.actions.ActionInput;
import com.google.devtools.build.lib.actions.Spawn;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.exec.SpawnResult;
import com.google.devtools.build.lib.exec.SpawnResult.Status;
import com.google.devtools.build.lib.exec.SpawnRunner;
import com.google.devtools.build.lib.remote.ContentDigests.ActionKey;
import com.google.devtools.build.lib.remote.RemoteProtocol.Action;
import com.google.devtools.build.lib.remote.RemoteProtocol.ActionResult;
import com.google.devtools.build.lib.remote.RemoteProtocol.Command;
import com.google.devtools.build.lib.remote.RemoteProtocol.ContentDigest;
import com.google.devtools.build.lib.remote.RemoteProtocol.ExecuteReply;
import com.google.devtools.build.lib.remote.RemoteProtocol.ExecuteRequest;
import com.google.devtools.build.lib.remote.RemoteProtocol.ExecutionStatus;
import com.google.devtools.build.lib.remote.RemoteProtocol.Platform;
import com.google.devtools.build.lib.remote.TreeNodeRepository.TreeNode;
import com.google.devtools.build.lib.runtime.AuthAndTLSOptions;
import com.google.devtools.build.lib.util.io.FileOutErr;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.protobuf.TextFormat;
import com.google.protobuf.TextFormat.ParseException;
import io.grpc.StatusRuntimeException;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.SortedMap;
import java.util.TreeSet;
/**
* A client for the remote execution service.
*/
@ThreadSafe
final class RemoteSpawnRunner implements SpawnRunner {
private final Path execRoot;
private final RemoteOptions options;
// TODO(olaola): This will be set on a per-action basis instead.
private final Platform platform;
private final GrpcRemoteExecutor executor;
RemoteSpawnRunner(
Path execRoot,
RemoteOptions options,
GrpcRemoteExecutor executor) {
this.execRoot = execRoot;
this.options = options;
if (options.experimentalRemotePlatformOverride != null) {
Platform.Builder platformBuilder = Platform.newBuilder();
try {
TextFormat.getParser().merge(options.experimentalRemotePlatformOverride, platformBuilder);
} catch (ParseException e) {
throw new RuntimeException("Failed to parse --experimental_remote_platform_override", e);
}
platform = platformBuilder.build();
} else {
platform = null;
}
this.executor = executor;
}
RemoteSpawnRunner(
Path execRoot,
RemoteOptions options,
AuthAndTLSOptions authTlsOptions) {
this(execRoot, options, connect(options, authTlsOptions));
}
private static GrpcRemoteExecutor connect(RemoteOptions options,
AuthAndTLSOptions authTlsOptions) {
Preconditions.checkArgument(GrpcRemoteExecutor.isRemoteExecutionOptions(options));
ChannelOptions channelOptions = ChannelOptions.create(authTlsOptions,
options.grpcMaxChunkSizeBytes);
return new GrpcRemoteExecutor(
RemoteUtils.createChannel(options.remoteExecutor, channelOptions), channelOptions, options);
}
@Override
public SpawnResult exec(Spawn spawn, SpawnExecutionPolicy policy)
throws InterruptedException, IOException {
ActionExecutionMetadata owner = spawn.getResourceOwner();
if (owner.getOwner() != null) {
policy.report(ProgressStatus.EXECUTING);
}
try {
// Temporary hack: the TreeNodeRepository should be created and maintained upstream!
TreeNodeRepository repository =
new TreeNodeRepository(execRoot, policy.getActionInputFileCache());
SortedMap<PathFragment, ActionInput> inputMap = policy.getInputMapping();
TreeNode inputRoot = repository.buildFromActionInputs(inputMap);
repository.computeMerkleDigests(inputRoot);
Command command = buildCommand(spawn.getArguments(), spawn.getEnvironment());
Action action =
buildAction(
spawn.getOutputFiles(),
ContentDigests.computeDigest(command),
repository.getMerkleDigest(inputRoot));
ActionKey actionKey = ContentDigests.computeActionKey(action);
ActionResult result =
this.options.remoteAcceptCached ? executor.getCachedActionResult(actionKey) : null;
if (result == null) {
// Cache miss or we don't accept cache hits.
// Upload the command and all the inputs into the remote cache.
executor.uploadBlob(command.toByteArray());
// TODO(olaola): this should use the ActionInputFileCache for SHA1 digests!
executor.uploadTree(repository, execRoot, inputRoot);
// TODO(olaola): set BuildInfo and input total bytes as well.
ExecuteRequest.Builder request =
ExecuteRequest.newBuilder()
.setAction(action)
.setAcceptCached(this.options.remoteAcceptCached)
.setTotalInputFileCount(inputMap.size())
.setTimeoutMillis(policy.getTimeoutMillis());
ExecuteReply reply = executor.executeRemotely(request.build());
ExecutionStatus status = reply.getStatus();
if (!status.getSucceeded()
&& (status.getError() != ExecutionStatus.ErrorCode.EXEC_FAILED)) {
return new SpawnResult.Builder()
// TODO(ulfjack): Improve the translation of the error status.
.setStatus(Status.EXECUTION_FAILED)
.setExitCode(-1)
.build();
}
result = reply.getResult();
}
// TODO(ulfjack): Download stdout, stderr, and the output files in a single call.
passRemoteOutErr(executor, result, policy.getFileOutErr());
executor.downloadAllResults(result, execRoot);
return new SpawnResult.Builder()
.setStatus(Status.SUCCESS)
.setExitCode(result.getReturnCode())
.build();
} catch (StatusRuntimeException | CacheNotFoundException e) {
throw new IOException(e);
}
}
private Action buildAction(
Collection<? extends ActionInput> outputs, ContentDigest command, ContentDigest inputRoot) {
Action.Builder action = Action.newBuilder();
action.setCommandDigest(command);
action.setInputRootDigest(inputRoot);
// Somewhat ugly: we rely on the stable order of outputs here for remote action caching.
for (ActionInput output : outputs) {
action.addOutputPath(output.getExecPathString());
}
if (platform != null) {
action.setPlatform(platform);
}
return action.build();
}
private Command buildCommand(List<String> arguments, ImmutableMap<String, String> environment) {
Command.Builder command = Command.newBuilder();
command.addAllArgv(arguments);
// Sorting the environment pairs by variable name.
TreeSet<String> variables = new TreeSet<>(environment.keySet());
for (String var : variables) {
command.addEnvironmentBuilder().setVariable(var).setValue(environment.get(var));
}
return command.build();
}
private static void passRemoteOutErr(
RemoteActionCache cache, ActionResult result, FileOutErr outErr)
throws CacheNotFoundException {
ImmutableList<byte[]> streams =
cache.downloadBlobs(ImmutableList.of(result.getStdoutDigest(), result.getStderrDigest()));
outErr.printOut(new String(streams.get(0), UTF_8));
outErr.printErr(new String(streams.get(1), UTF_8));
}
}
|
