aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/remote/GrpcRemoteExecutor.java
blob: 173f10ddb08e5f457d931ddebd3edace06c93c18 (plain)
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
// 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.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.util.Preconditions;
import com.google.devtools.remoteexecution.v1test.ExecuteRequest;
import com.google.devtools.remoteexecution.v1test.ExecuteResponse;
import com.google.devtools.remoteexecution.v1test.ExecutionGrpc;
import com.google.devtools.remoteexecution.v1test.ExecutionGrpc.ExecutionBlockingStub;
import com.google.longrunning.Operation;
import com.google.protobuf.InvalidProtocolBufferException;
import com.google.rpc.Status;
import com.google.watcher.v1.Change;
import com.google.watcher.v1.ChangeBatch;
import com.google.watcher.v1.Request;
import com.google.watcher.v1.WatcherGrpc;
import com.google.watcher.v1.WatcherGrpc.WatcherBlockingStub;
import io.grpc.Channel;
import io.grpc.Status.Code;
import io.grpc.StatusRuntimeException;
import io.grpc.protobuf.StatusProto;
import java.io.IOException;
import java.util.Iterator;
import java.util.concurrent.TimeUnit;
import javax.annotation.Nullable;

/** A remote work executor that uses gRPC for communicating the work, inputs and outputs. */
@ThreadSafe
public class GrpcRemoteExecutor {
  private final RemoteOptions options;
  private final ChannelOptions channelOptions;
  private final Channel channel;
  private final Retrier retrier;

  public static boolean isRemoteExecutionOptions(RemoteOptions options) {
    return options.remoteExecutor != null;
  }

  public GrpcRemoteExecutor(Channel channel, ChannelOptions channelOptions, RemoteOptions options) {
    this.options = options;
    this.channelOptions = channelOptions;
    this.channel = channel;
    this.retrier = new Retrier(options);
  }

  private ExecutionBlockingStub execBlockingStub() {
    return ExecutionGrpc.newBlockingStub(channel)
        .withCallCredentials(channelOptions.getCallCredentials())
        .withDeadlineAfter(options.remoteTimeout, TimeUnit.SECONDS);
  }

  private WatcherBlockingStub watcherBlockingStub() {
    return WatcherGrpc.newBlockingStub(channel)
        .withCallCredentials(channelOptions.getCallCredentials());
  }

  private @Nullable ExecuteResponse getOperationResponse(Operation op)
      throws IOException {
    if (op.getResultCase() == Operation.ResultCase.ERROR) {
      StatusRuntimeException e = StatusProto.toStatusRuntimeException(op.getError());
      if (e.getStatus().getCode() == Code.DEADLINE_EXCEEDED) {
        // This was caused by the command itself exceeding the timeout,
        // therefore it is not retriable.
        // TODO(olaola): this should propagate a timeout SpawnResult instead of raising.
        throw new IOException("Remote execution time out");
      }
      throw e;
    }
    if (op.getDone()) {
      Preconditions.checkState(op.getResultCase() != Operation.ResultCase.RESULT_NOT_SET);
      try {
        return op.getResponse().unpack(ExecuteResponse.class);
      } catch (InvalidProtocolBufferException e) {
        throw new IOException(e);
      }
    }
    return null;
  }

  public ExecuteResponse executeRemotely(ExecuteRequest request)
      throws IOException, InterruptedException {
    Operation op = retrier.execute(() -> execBlockingStub().execute(request));
    ExecuteResponse resp = getOperationResponse(op);
    if (resp != null) {
      return resp;
    }
    Request wr = Request.newBuilder().setTarget(op.getName()).build();
    return retrier.execute(
        () -> {
          Iterator<ChangeBatch> replies = watcherBlockingStub().watch(wr);
          while (replies.hasNext()) {
            ChangeBatch cb = replies.next();
            for (Change ch : cb.getChangesList()) {
              switch (ch.getState()) {
                case INITIAL_STATE_SKIPPED:
                  continue;
                case ERROR:
                  try {
                    throw StatusProto.toStatusRuntimeException(ch.getData().unpack(Status.class));
                  } catch (InvalidProtocolBufferException e) {
                    throw new RuntimeException(e);
                  }
                case DOES_NOT_EXIST:
                  // TODO(olaola): either make this retriable, or use a different exception.
                  throw new IOException(
                      String.format("Operation %s lost on the remote server.", op.getName()));
                case EXISTS:
                  Operation o;
                  try {
                    o = ch.getData().unpack(Operation.class);
                  } catch (InvalidProtocolBufferException e) {
                    throw new RuntimeException(e);
                  }
                  ExecuteResponse r = getOperationResponse(o);
                  if (r != null) {
                    return r;
                  }
                  continue;
                default:
                  // This can only happen if the enum gets unexpectedly extended.
                  throw new IOException(String.format("Illegal change state: %s", ch.getState()));
              }
            }
          }
          throw new IOException(
              String.format("Watch request for %s terminated with no result.", op.getName()));
        });
  }
}