blob: 594d79d38b2f79db94c3d118e9c67af120a45ec9 (
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
|
// Copyright 2015 Google Inc. 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.sandbox;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.eventbus.Subscribe;
import com.google.devtools.build.lib.actions.ActionContextConsumer;
import com.google.devtools.build.lib.actions.ActionContextProvider;
import com.google.devtools.build.lib.buildtool.BuildRequest;
import com.google.devtools.build.lib.buildtool.buildevent.BuildStartingEvent;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.runtime.BlazeModule;
import com.google.devtools.build.lib.runtime.BlazeRuntime;
import com.google.devtools.build.lib.runtime.Command;
import com.google.devtools.build.lib.runtime.CommandEnvironment;
import com.google.devtools.build.lib.util.OS;
import com.google.devtools.common.options.OptionsBase;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
/**
* This module provides the Sandbox spawn strategy.
*/
public class SandboxModule extends BlazeModule {
public static final String SANDBOX_NOT_SUPPORTED_MESSAGE =
"Sandboxed execution is not supported on your system and thus hermeticity of actions cannot "
+ "be guaranteed. See http://bazel.io/docs/bazel-user-manual.html#sandboxing for more "
+ "information. You can turn off this warning via --ignore_unsupported_sandboxing";
// Per-server state
private final ExecutorService backgroundWorkers = Executors.newCachedThreadPool();
private Boolean sandboxingSupported = null;
// Per-command state
private CommandEnvironment env;
private BuildRequest buildRequest;
private synchronized boolean isSandboxingSupported(BlazeRuntime runtime) {
if (sandboxingSupported == null) {
sandboxingSupported = NamespaceSandboxRunner.isSupported(runtime);
}
return sandboxingSupported.booleanValue();
}
@Override
public Iterable<ActionContextProvider> getActionContextProviders() {
Preconditions.checkNotNull(buildRequest);
Preconditions.checkNotNull(env);
if (isSandboxingSupported(env.getRuntime())) {
return ImmutableList.<ActionContextProvider>of(
new SandboxActionContextProvider(env, buildRequest, backgroundWorkers));
}
// For now, sandboxing is only supported on Linux and there's not much point in showing a scary
// warning to the user if they can't do anything about it.
if (!buildRequest.getOptions(SandboxOptions.class).ignoreUnsupportedSandboxing
&& OS.getCurrent() == OS.LINUX) {
env.getReporter().handle(Event.warn(SANDBOX_NOT_SUPPORTED_MESSAGE));
}
return ImmutableList.of();
}
@Override
public Iterable<ActionContextConsumer> getActionContextConsumers() {
Preconditions.checkNotNull(env);
if (isSandboxingSupported(env.getRuntime())) {
return ImmutableList.<ActionContextConsumer>of(new SandboxActionContextConsumer());
}
return ImmutableList.of();
}
@Override
public Iterable<Class<? extends OptionsBase>> getCommandOptions(Command command) {
return command.builds()
? ImmutableList.<Class<? extends OptionsBase>>of(SandboxOptions.class)
: ImmutableList.<Class<? extends OptionsBase>>of();
}
@Override
public void beforeCommand(Command command, CommandEnvironment env) {
this.env = env;
env.getEventBus().register(this);
}
@Override
public void afterCommand() {
this.env = null;
this.buildRequest = null;
}
@Subscribe
public void buildStarting(BuildStartingEvent event) {
buildRequest = event.getRequest();
}
/**
* Shut down the background worker pool in the canonical way.
*
* <p>See https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html
*/
@Override
public void blazeShutdown() {
// Disable new tasks from being submitted
backgroundWorkers.shutdown();
try {
// Wait a while for existing tasks to terminate
if (!backgroundWorkers.awaitTermination(5, TimeUnit.SECONDS)) {
backgroundWorkers.shutdownNow(); // Cancel currently executing tasks
// Wait a while for tasks to respond to being cancelled and force-kill them if necessary
// after the timeout.
backgroundWorkers.awaitTermination(5, TimeUnit.SECONDS);
}
} catch (InterruptedException ie) {
// (Re-)Cancel if current thread also interrupted
backgroundWorkers.shutdownNow();
// Preserve interrupt status
Thread.currentThread().interrupt();
}
}
}
|
