Permalink
Browse files

Prototype for remote execution using gRPC and Netty transport

This change implements a remote worker that executes work (build or test).
Bazel will be a client of the remote worker. The communication uses gRPC
and Netty as transport.

A single remote worker has little advantage over running locally. Additional
infrastructure is needed to run workers on multiple machines and distributing
the work among them.

This change provides the basic building blocks for a distributed build farm.

(Mainly reformatting changes compared to https://bazel-review.googlesource.com/3110, some BUILD file changes.)

--
Change-Id: If7d285444ef42a6823b59443af17b61b04b9ce6a
Reviewed-on: https://bazel-review.googlesource.com/#/c/3110/
MOS_MIGRATED_REVID=122376861
  • Loading branch information...
1 parent db89a64 commit a1a79cb0a1880e825618c6440219680f27faa0b7 @hhclam hhclam committed with kchodorow May 15, 2016
Showing with 709 additions and 76 deletions.
  1. +19 −0 WORKSPACE
  2. +12 −1 scripts/bootstrap/compile.sh
  3. +1 −0 src/BUILD
  4. +3 −0 src/main/java/com/google/devtools/build/lib/remote/BUILD
  5. +3 −3 src/main/java/com/google/devtools/build/lib/remote/HazelcastCacheFactory.java
  6. +2 −2 src/main/java/com/google/devtools/build/lib/remote/MemcacheActionCache.java
  7. +208 −0 src/main/java/com/google/devtools/build/lib/remote/MemcacheWorkExecutor.java
  8. +23 −8 src/main/java/com/google/devtools/build/lib/remote/README.md
  9. +22 −8 src/main/java/com/google/devtools/build/lib/remote/RemoteModule.java
  10. +5 −3 src/main/java/com/google/devtools/build/lib/remote/RemoteOptions.java
  11. +15 −10 src/main/java/com/google/devtools/build/lib/remote/RemoteSpawnStrategy.java
  12. +3 −36 src/main/java/com/google/devtools/build/lib/remote/RemoteWorkExecutor.java
  13. +1 −3 src/main/java/com/google/devtools/build/lib/remote/WorkTooLargeException.java
  14. +6 −1 src/main/protobuf/BUILD
  15. +7 −1 src/main/protobuf/remote_protocol.proto
  16. +10 −0 src/test/shell/bazel/BUILD
  17. +82 −0 src/test/shell/bazel/remote_execution_test.sh
  18. +6 −0 src/tools/remote_worker/BUILD
  19. +17 −0 src/tools/remote_worker/README.md
  20. +26 −0 src/tools/remote_worker/src/main/java/com/google/devtools/build/remote/BUILD
  21. +177 −0 src/tools/remote_worker/src/main/java/com/google/devtools/build/remote/RemoteWorker.java
  22. +55 −0 src/tools/remote_worker/src/main/java/com/google/devtools/build/remote/RemoteWorkerOptions.java
  23. +6 −0 third_party/README.md
View
@@ -19,6 +19,25 @@ bind(
actual = "//:dummy",
)
+# Protobuf code generation for GRPC requires three external labels:
+# //external:grpc-java_plugin
+# //external:grpc-jar
+# //external:guava
+bind(
+ name = "grpc-java-plugin",
+ actual = "//third_party/grpc:grpc-java-plugin",
+)
+
+bind(
+ name = "grpc-jar",
+ actual = "//third_party/grpc:grpc-jar",
+)
+
+bind(
+ name = "guava",
+ actual = "//third_party:guava",
+)
+
# For tools/cpp/test/...
load("//tools/cpp/test:docker_repository.bzl", "docker_repository")
docker_repository()
@@ -41,11 +41,13 @@ linux)
JAVA_HOME="${JAVA_HOME:-$(readlink -f $(which javac) | sed 's_/bin/javac__')}"
if [ "${MACHINE_IS_64BIT}" = 'yes' ]; then
PROTOC=${PROTOC:-third_party/protobuf/protoc-linux-x86_64.exe}
+ GRPC_JAVA_PLUGIN=${GRPC_JAVA_PLUGIN:-third_party/grpc/protoc-gen-grpc-java-0.13.2-linux-x86_64.exe}
else
if [ "${MACHINE_IS_ARM}" = 'yes' ]; then
PROTOC=${PROTOC:-third_party/protobuf/protoc-linux-arm32.exe}
else
PROTOC=${PROTOC:-third_party/protobuf/protoc-linux-x86_32.exe}
+ GRPC_JAVA_PLUGIN=${GRPC_JAVA_PLUGIN:-third_party/grpc/protoc-gen-grpc-java-0.13.2-linux-x86_32.exe}
fi
fi
;;
@@ -57,6 +59,7 @@ freebsd)
# We choose the 32-bit version for maximum compatiblity since 64-bit
# linux binaries are only supported in FreeBSD-11.
PROTOC=${PROTOC:-third_party/protobuf/protoc-linux-x86_32.exe}
+ GRPC_JAVA_PLUGIN=${GRPC_JAVA_PLUGIN:-third_party/grpc/protoc-gen-grpc-java-0.13.2-linux-x86_32.exe}
;;
darwin)
@@ -66,6 +69,7 @@ darwin)
fi
if [ "${MACHINE_IS_64BIT}" = 'yes' ]; then
PROTOC=${PROTOC:-third_party/protobuf/protoc-osx-x86_64.exe}
+ GRPC_JAVA_PLUGIN=${GRPC_JAVA_PLUGIN:-third_party/grpc/protoc-gen-grpc-java-0.13.2-osx-x86_64.exe}
else
PROTOC=${PROTOC:-third_party/protobuf/protoc-osx-x86_32.exe}
fi
@@ -80,14 +84,19 @@ msys*|mingw*)
# We do not use the JNI library on Windows.
if [ "${MACHINE_IS_64BIT}" = 'yes' ]; then
PROTOC=${PROTOC:-third_party/protobuf/protoc-windows-x86_64.exe}
+ GRPC_JAVA_PLUGIN=${GRPC_JAVA_PLUGIN:-third_party/grpc/protoc-gen-grpc-java-0.13.2-windows-x86_64.exe}
else
PROTOC=${PROTOC:-third_party/protobuf/protoc-windows-x86_32.exe}
+ GRPC_JAVA_PLUGIN=${GRPC_JAVA_PLUGIN:-third_party/grpc/protoc-gen-grpc-java-0.13.2-windows-x86_32.exe}
fi
esac
[[ -x "${PROTOC-}" ]] \
|| fail "Protobuf compiler not found in ${PROTOC-}"
+[[ -x "${GRPC_JAVA_PLUGIN-}" ]] \
+ || fail "gRPC Java plugin not found in ${GRPC_JAVA_PLUGIN-}"
+
# Check that javac -version returns a upper version than $JAVA_VERSION.
get_java_version
[ ${JAVA_VERSION#*.} -le ${JAVAC_VERSION#*.} ] || \
@@ -168,7 +177,9 @@ function create_deploy_jar() {
if [ -z "${BAZEL_SKIP_JAVA_COMPILATION}" ]; then
log "Compiling Java stubs for protocol buffers..."
for f in $PROTO_FILES ; do
- run "${PROTOC}" -Isrc/main/protobuf/ --java_out=${OUTPUT_DIR}/src "$f"
+ run "${PROTOC}" -Isrc/main/protobuf/ --java_out=${OUTPUT_DIR}/src \
+ --plugin=protoc-gen-grpc="${GRPC_JAVA_PLUGIN-}" \
+ --grpc_out=${OUTPUT_DIR}/src "$f"
done
java_compilation "Bazel Java" "$DIRS" "$EXCLUDE_FILES" "$LIBRARY_JARS" "${OUTPUT_DIR}"
View
@@ -14,6 +14,7 @@ filegroup(
visibility = [
"//src/test/java:__pkg__",
"//src/tools/generate_workspace:__pkg__",
+ "//src/tools/remote_worker:__subpackages__",
],
)
@@ -5,13 +5,15 @@ package(
java_library(
name = "remote",
srcs = glob(["*.java"]),
+ tags = ["bazel"],
deps = [
"//src/main/java/com/google/devtools/build/lib:build-base",
"//src/main/java/com/google/devtools/build/lib:concurrent",
"//src/main/java/com/google/devtools/build/lib:events",
"//src/main/java/com/google/devtools/build/lib:io",
"//src/main/java/com/google/devtools/build/lib:packages-internal",
"//src/main/java/com/google/devtools/build/lib:runtime",
+ "//src/main/java/com/google/devtools/build/lib:shell",
"//src/main/java/com/google/devtools/build/lib:util",
"//src/main/java/com/google/devtools/build/lib:vfs",
"//src/main/java/com/google/devtools/build/lib/actions",
@@ -23,6 +25,7 @@ java_library(
"//third_party:gson",
"//third_party:guava",
"//third_party:hazelcast",
+ "//third_party/grpc:grpc-jar",
"//third_party/protobuf",
],
)
@@ -26,14 +26,14 @@
* A factory class for providing a {@link ConcurrentMap} object implemented by Hazelcast.
* Hazelcast will work as a distributed memory cache.
*/
-final class HazelcastCacheFactory {
+public final class HazelcastCacheFactory {
private static final String CACHE_NAME = "hazelcast-build-cache";
- static ConcurrentMap<String, byte[]> create(RemoteOptions options) {
+ public static ConcurrentMap<String, byte[]> create(RemoteOptions options) {
HazelcastInstance instance;
if (options.hazelcastNode != null) {
- // If --hazelast_node is then create a client instance.
+ // If --hazelcast_node is then create a client instance.
ClientConfig config = new ClientConfig();
ClientNetworkConfig net = config.getNetworkConfig();
net.addAddress(options.hazelcastNode.split(","));
@@ -39,7 +39,7 @@
* The thread satefy is guaranteed by the underlying memcache client.
*/
@ThreadSafe
-final class MemcacheActionCache implements RemoteActionCache {
+public final class MemcacheActionCache implements RemoteActionCache {
private final Path execRoot;
private final ConcurrentMap<String, byte[]> cache;
private static final int MAX_MEMORY_KBYTES = 512 * 1024;
@@ -48,7 +48,7 @@
/**
* Construct an action cache using JCache API.
*/
- MemcacheActionCache(
+ public MemcacheActionCache(
Path execRoot, RemoteOptions options, ConcurrentMap<String, byte[]> cache) {
this.execRoot = execRoot;
this.cache = cache;
@@ -0,0 +1,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 MemcacheActionCache 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 MemcacheActionCache 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(MemcacheActionCache 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(MemcacheActionCache 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 MemcacheActionCache.
+ * @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(
+ MemcacheActionCache cache, String host, int port) {
+ return new MemcacheWorkExecutor(cache, host, port);
+ }
+
+ /**
+ * Create an instance of MemcacheWorkExecutor that runs locally.
+ * @param cache An instance of MemcacheActionCache.
+ * @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(
+ MemcacheActionCache 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.getMutableEnvironment().putAll(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();
+ }
+ }
+}
Oops, something went wrong.

0 comments on commit a1a79cb

Please sign in to comment.