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
|
// 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.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.authandtls.AuthAndTLSOptions;
import com.google.devtools.build.lib.buildeventstream.PathConverter;
import com.google.devtools.build.lib.buildtool.BuildRequest;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.exec.ExecutorBuilder;
import com.google.devtools.build.lib.runtime.BlazeModule;
import com.google.devtools.build.lib.runtime.Command;
import com.google.devtools.build.lib.runtime.CommandEnvironment;
import com.google.devtools.build.lib.runtime.ServerBuilder;
import com.google.devtools.build.lib.util.AbruptExitException;
import com.google.devtools.build.lib.util.ExitCode;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.common.options.OptionsBase;
import com.google.devtools.common.options.OptionsProvider;
import com.google.devtools.remoteexecution.v1test.Digest;
import java.io.IOException;
/** RemoteModule provides distributed cache and remote execution for Bazel. */
public final class RemoteModule extends BlazeModule {
@VisibleForTesting
static final class CasPathConverter implements PathConverter {
// Not final; unfortunately, the Bazel startup process requires us to create this object before
// we have the options available, so we have to create it first, and then set the options
// afterwards. At the time of this writing, I believe that we aren't using the PathConverter
// before the options are available, so this should be safe.
// TODO(ulfjack): Change the Bazel startup process to make the options available when we create
// the PathConverter.
RemoteOptions options;
@Override
public String apply(Path path) {
if (options == null || !remoteEnabled(options)) {
return null;
}
String server = options.remoteCache;
String remoteInstanceName = options.remoteInstanceName;
try {
Digest digest = Digests.computeDigest(path);
return remoteInstanceName.isEmpty()
? String.format(
"bytestream://%s/blobs/%s/%d",
server,
digest.getHash(),
digest.getSizeBytes())
: String.format(
"bytestream://%s/%s/blobs/%s/%d",
server,
remoteInstanceName,
digest.getHash(),
digest.getSizeBytes());
} catch (IOException e) {
// TODO(ulfjack): Don't fail silently!
return null;
}
}
}
private final CasPathConverter converter = new CasPathConverter();
private RemoteActionContextProvider actionContextProvider;
@Override
public void serverInit(OptionsProvider startupOptions, ServerBuilder builder)
throws AbruptExitException {
builder.addPathToUriConverter(converter);
}
@Override
public void beforeCommand(CommandEnvironment env) {
env.getEventBus().register(this);
RemoteOptions remoteOptions = env.getOptions().getOptions(RemoteOptions.class);
AuthAndTLSOptions authAndTlsOptions = env.getOptions().getOptions(AuthAndTLSOptions.class);
converter.options = remoteOptions;
// Quit if no remote options specified.
if (remoteOptions == null) {
return;
}
try {
ChannelOptions channelOpts = ChannelOptions.create(authAndTlsOptions);
boolean restCache = SimpleBlobStoreFactory.isRemoteCacheOptions(remoteOptions);
boolean grpcCache = GrpcRemoteCache.isRemoteCacheOptions(remoteOptions);
Retrier retrier = new Retrier(remoteOptions);
final RemoteActionCache cache;
if (restCache) {
cache = new SimpleBlobStoreActionCache(SimpleBlobStoreFactory.create(remoteOptions));
} else if (grpcCache) {
cache = new GrpcRemoteCache(GrpcUtils.createChannel(remoteOptions.remoteCache, channelOpts),
channelOpts, remoteOptions, retrier);
} else if (remoteOptions.remoteExecutor != null) {
// If a remote executor but no remote cache is specified, assume both at the same target.
cache =
new GrpcRemoteCache(GrpcUtils.createChannel(remoteOptions.remoteExecutor, channelOpts),
channelOpts, remoteOptions, retrier);
} else {
cache = null;
}
final GrpcRemoteExecutor executor;
if (remoteOptions.remoteExecutor != null) {
executor = new GrpcRemoteExecutor(
GrpcUtils.createChannel(remoteOptions.remoteExecutor, channelOpts),
channelOpts.getCallCredentials(),
remoteOptions.remoteTimeout,
retrier);
} else {
executor = null;
}
actionContextProvider = new RemoteActionContextProvider(env, cache, executor);
} catch (IOException e) {
env.getReporter().handle(Event.error(e.getMessage()));
env.getBlazeModuleEnvironment().exit(new AbruptExitException(ExitCode.COMMAND_LINE_ERROR));
}
}
@Override
public void executorInit(CommandEnvironment env, BuildRequest request, ExecutorBuilder builder) {
if (actionContextProvider != null) {
builder.addActionContextProvider(actionContextProvider);
}
}
@Override
public Iterable<Class<? extends OptionsBase>> getCommandOptions(Command command) {
return "build".equals(command.name())
? ImmutableList.<Class<? extends OptionsBase>>of(
RemoteOptions.class, AuthAndTLSOptions.class)
: ImmutableList.<Class<? extends OptionsBase>>of();
}
public static boolean remoteEnabled(RemoteOptions options) {
return SimpleBlobStoreFactory.isRemoteCacheOptions(options)
|| GrpcRemoteCache.isRemoteCacheOptions(options);
}
}
|
