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
209
210
211
212
213
|
// Copyright 2015 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.worker;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMultimap;
import com.google.common.eventbus.Subscribe;
import com.google.devtools.build.lib.actions.ResourceManager;
import com.google.devtools.build.lib.actions.SpawnActionContext;
import com.google.devtools.build.lib.buildtool.BuildRequest;
import com.google.devtools.build.lib.buildtool.buildevent.BuildCompleteEvent;
import com.google.devtools.build.lib.buildtool.buildevent.BuildInterruptedEvent;
import com.google.devtools.build.lib.buildtool.buildevent.BuildStartingEvent;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.exec.ExecutorBuilder;
import com.google.devtools.build.lib.exec.SpawnRunner;
import com.google.devtools.build.lib.exec.apple.XcodeLocalEnvProvider;
import com.google.devtools.build.lib.exec.local.LocalEnvProvider;
import com.google.devtools.build.lib.exec.local.LocalExecutionOptions;
import com.google.devtools.build.lib.exec.local.LocalSpawnRunner;
import com.google.devtools.build.lib.exec.local.PosixLocalEnvProvider;
import com.google.devtools.build.lib.exec.local.WindowsLocalEnvProvider;
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.commands.CleanCommand.CleanStartingEvent;
import com.google.devtools.build.lib.util.OS;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.common.options.OptionsBase;
import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.Map;
/** A module that adds the WorkerActionContextProvider to the available action context providers. */
public class WorkerModule extends BlazeModule {
private CommandEnvironment env;
private WorkerFactory workerFactory;
private WorkerPool workerPool;
private ImmutableMap<String, Integer> workerPoolConfig;
private WorkerOptions options;
@Override
public Iterable<Class<? extends OptionsBase>> getCommandOptions(Command command) {
return "build".equals(command.name())
? ImmutableList.of(WorkerOptions.class)
: ImmutableList.of();
}
@Override
public void beforeCommand(CommandEnvironment env) {
this.env = env;
env.getEventBus().register(this);
}
@Subscribe
public void cleanStarting(CleanStartingEvent event) {
if (workerPool != null) {
this.options = event.getOptionsProvider().getOptions(WorkerOptions.class);
workerFactory.setReporter(env.getReporter());
workerFactory.setOptions(options);
shutdownPool("Clean command is running, shutting down worker pool...");
}
}
@Subscribe
public void buildStarting(BuildStartingEvent event) {
options = event.getRequest().getOptions(WorkerOptions.class);
if (workerFactory == null) {
Path workerDir =
env.getOutputBase().getRelative(env.getRuntime().getProductName() + "-workers");
try {
if (!workerDir.createDirectory()) {
// Clean out old log files.
for (Path logFile : workerDir.getDirectoryEntries()) {
if (logFile.getBaseName().endsWith(".log")) {
try {
logFile.delete();
} catch (IOException e) {
env.getReporter()
.handle(Event.error("Could not delete old worker log: " + logFile));
}
}
}
}
} catch (IOException e) {
env.getReporter()
.handle(Event.error("Could not create base directory for workers: " + workerDir));
}
workerFactory = new WorkerFactory(options, workerDir);
}
workerFactory.setReporter(env.getReporter());
workerFactory.setOptions(options);
// Use a LinkedHashMap instead of an ImmutableMap.Builder to allow duplicates; the last value
// passed wins.
LinkedHashMap<String, Integer> newConfigBuilder = new LinkedHashMap<>();
for (Map.Entry<String, Integer> entry : options.workerMaxInstances) {
newConfigBuilder.put(entry.getKey(), entry.getValue());
}
if (!newConfigBuilder.containsKey("")) {
// Empty string gives the number of workers for any type of worker not explicitly specified.
// If no value is given, use the default, 4.
newConfigBuilder.put("", 4);
}
ImmutableMap<String, Integer> newConfig = ImmutableMap.copyOf(newConfigBuilder);
// If the config changed compared to the last run, we have to create a new pool.
if (workerPoolConfig != null && !workerPoolConfig.equals(newConfig)) {
shutdownPool(
"Worker configuration has changed, restarting worker pool...",
/* alwaysLog= */ true);
}
if (workerPool == null) {
workerPoolConfig = newConfig;
workerPool = new WorkerPool(workerFactory, workerPoolConfig, options.highPriorityWorkers);
}
}
@Override
public void executorInit(CommandEnvironment env, BuildRequest request, ExecutorBuilder builder) {
Preconditions.checkNotNull(workerPool);
ImmutableMultimap<String, String> extraFlags =
ImmutableMultimap.copyOf(env.getOptions().getOptions(WorkerOptions.class).workerExtraFlags);
WorkerSpawnRunner spawnRunner =
new WorkerSpawnRunner(
env.getExecRoot(),
workerPool,
extraFlags,
env.getReporter(),
createFallbackRunner(env));
builder.addActionContext(new WorkerSpawnStrategy(env.getExecRoot(), spawnRunner));
builder.addStrategyByContext(SpawnActionContext.class, "standalone");
builder.addStrategyByContext(SpawnActionContext.class, "worker");
}
private static SpawnRunner createFallbackRunner(CommandEnvironment env) {
LocalExecutionOptions localExecutionOptions =
env.getOptions().getOptions(LocalExecutionOptions.class);
LocalEnvProvider localEnvProvider =
OS.getCurrent() == OS.DARWIN
? new XcodeLocalEnvProvider(env.getClientEnv())
: (OS.getCurrent() == OS.WINDOWS
? new WindowsLocalEnvProvider(env.getClientEnv())
: new PosixLocalEnvProvider(env.getClientEnv()));
return new LocalSpawnRunner(
env.getExecRoot(),
localExecutionOptions,
ResourceManager.instance(),
localEnvProvider);
}
@Subscribe
public void buildComplete(BuildCompleteEvent event) {
if (options != null && options.workerQuitAfterBuild) {
shutdownPool("Build completed, shutting down worker pool...");
}
}
// Kill workers on Ctrl-C to quickly end the interrupted build.
// TODO(philwo) - make sure that this actually *kills* the workers and not just politely waits
// for them to finish.
@Subscribe
public void buildInterrupted(BuildInterruptedEvent event) {
shutdownPool("Build interrupted, shutting down worker pool...");
}
/** Shuts down the worker pool and sets {#code workerPool} to null. */
private void shutdownPool(String reason) {
shutdownPool(reason, /* alwaysLog= */ false);
}
/** Shuts down the worker pool and sets {#code workerPool} to null. */
private void shutdownPool(String reason, boolean alwaysLog) {
Preconditions.checkArgument(!reason.isEmpty());
if (workerPool != null) {
if ((options != null && options.workerVerbose) || alwaysLog) {
env.getReporter().handle(Event.info(reason));
}
workerPool.close();
workerPool = null;
}
}
@Override
public void afterCommand() {
this.env = null;
this.options = null;
if (this.workerFactory != null) {
this.workerFactory.setReporter(null);
}
}
}
|
