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
200
201
202
203
204
205
206
207
208
|
// Copyright 2016 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 com.google.common.collect.ImmutableMap;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.devtools.build.lib.actions.ActionInput;
import com.google.devtools.build.lib.actions.ActionInputFileCache;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.remote.RemoteProtocol.FileEntry;
import com.google.devtools.build.lib.remote.RemoteProtocol.RemoteWorkRequest;
import com.google.devtools.build.lib.remote.RemoteProtocol.RemoteWorkResponse;
import com.google.devtools.build.lib.remote.RemoteWorkGrpc.RemoteWorkFutureStub;
import com.google.devtools.build.lib.shell.Command;
import com.google.devtools.build.lib.shell.CommandException;
import com.google.devtools.build.lib.shell.CommandResult;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import io.grpc.ManagedChannel;
import io.grpc.netty.NettyChannelBuilder;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.nio.file.FileAlreadyExistsException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/**
* Implementation of {@link RemoteWorkExecutor} that uses ConcurrentMapActionCache and gRPC for
* communicating the work, inputs and outputs.
*/
@ThreadSafe
public class MemcacheWorkExecutor implements RemoteWorkExecutor {
/**
* A cache used to store the input and output files as well as the build status of the remote
* work.
*/
protected final ConcurrentMapActionCache cache;
/** Execution root for running this work locally. */
private final Path execRoot;
/** Channel over which to send work to run remotely. */
private final ManagedChannel channel;
private static final int MAX_WORK_SIZE_BYTES = 1024 * 1024 * 512;
/**
* This constructor is used when this class is used in a client. It requires a host address and
* port to connect to a remote service.
*/
private MemcacheWorkExecutor(ConcurrentMapActionCache cache, String host, int port) {
this.cache = cache;
this.execRoot = null;
this.channel = NettyChannelBuilder.forAddress(host, port).usePlaintext(true).build();
}
/**
* This constructor is used when this class is used in the remote worker. A path to the execution
* root is needed for executing work locally.
*/
private MemcacheWorkExecutor(ConcurrentMapActionCache cache, Path execRoot) {
this.cache = cache;
this.execRoot = execRoot;
this.channel = null;
}
/**
* Create an instance of MemcacheWorkExecutor that talks to a remote server.
*
* @param cache An instance of ConcurrentMapActionCache.
* @param host Hostname of the server to connect to.
* @param port Port of the server to connect to.
* @return An instance of MemcacheWorkExecutor that talks to a remote server.
*/
public static MemcacheWorkExecutor createRemoteWorkExecutor(
ConcurrentMapActionCache cache, String host, int port) {
return new MemcacheWorkExecutor(cache, host, port);
}
/**
* Create an instance of MemcacheWorkExecutor that runs locally.
*
* @param cache An instance of ConcurrentMapActionCache.
* @param execRoot Path of the execution root where work is executed.
* @return An instance of MemcacheWorkExecutor tthat runs locally in the execution root.
*/
public static MemcacheWorkExecutor createLocalWorkExecutor(
ConcurrentMapActionCache cache, Path execRoot) {
return new MemcacheWorkExecutor(cache, execRoot);
}
@Override
public ListenableFuture<RemoteWorkResponse> executeRemotely(
Path execRoot,
ActionInputFileCache actionCache,
String actionOutputKey,
Collection<String> arguments,
Collection<ActionInput> inputs,
ImmutableMap<String, String> environment,
Collection<? extends ActionInput> outputs,
int timeout)
throws IOException, WorkTooLargeException {
RemoteWorkRequest.Builder work = RemoteWorkRequest.newBuilder();
work.setOutputKey(actionOutputKey);
long workSize = 0;
for (ActionInput input : inputs) {
if (!(input instanceof Artifact)) {
continue;
}
if (!actionCache.isFile((Artifact) input)) {
continue;
}
workSize += actionCache.getSizeInBytes(input);
}
if (workSize > MAX_WORK_SIZE_BYTES) {
throw new WorkTooLargeException("Work is too large: " + workSize + " bytes.");
}
// Save all input files to cache.
for (ActionInput input : inputs) {
Path file = execRoot.getRelative(input.getExecPathString());
if (file.isDirectory()) {
// TODO(alpha): Handle this case better.
throw new UnsupportedOperationException(
"Does not support directory artifacts: " + file + ".");
}
String contentKey = cache.putFileIfNotExist(actionCache, input);
work.addInputFilesBuilder()
.setPath(input.getExecPathString())
.setContentKey(contentKey)
.setExecutable(file.isExecutable());
}
work.addAllArguments(arguments);
work.putAllEnvironment(environment);
for (ActionInput output : outputs) {
work.addOutputFilesBuilder().setPath(output.getExecPathString());
}
RemoteWorkFutureStub stub = RemoteWorkGrpc.newFutureStub(channel);
work.setTimeout(timeout);
return stub.executeSynchronously(work.build());
}
/** Execute a work item locally. */
public RemoteWorkResponse executeLocally(RemoteWorkRequest work) throws IOException {
ByteArrayOutputStream stdout = new ByteArrayOutputStream();
ByteArrayOutputStream stderr = new ByteArrayOutputStream();
try {
// Prepare directories and input files.
for (FileEntry input : work.getInputFilesList()) {
Path file = execRoot.getRelative(input.getPath());
FileSystemUtils.createDirectoryAndParents(file.getParentDirectory());
cache.writeFile(input.getContentKey(), file, input.getExecutable());
}
List<Path> outputs = new ArrayList<>(work.getOutputFilesList().size());
for (FileEntry output : work.getOutputFilesList()) {
Path file = execRoot.getRelative(output.getPath());
if (file.exists()) {
throw new FileAlreadyExistsException("Output file already exists: " + file);
}
FileSystemUtils.createDirectoryAndParents(file.getParentDirectory());
outputs.add(file);
}
Command cmd =
new Command(
work.getArgumentsList().toArray(new String[] {}),
work.getEnvironment(),
new File(execRoot.getPathString()));
CommandResult result =
cmd.execute(Command.NO_INPUT, Command.NO_OBSERVER, stdout, stderr, true);
cache.putActionOutput(work.getOutputKey(), execRoot, outputs);
return RemoteWorkResponse.newBuilder()
.setSuccess(result.getTerminationStatus().success())
.setOut(stdout.toString())
.setErr(stderr.toString())
.build();
} catch (CommandException e) {
return RemoteWorkResponse.newBuilder()
.setSuccess(false)
.setOut(stdout.toString())
.setErr(stderr.toString())
.setException(e.toString())
.build();
}
}
}
|
