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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
// 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.runtime;
import static com.google.devtools.build.lib.events.Event.of;
import static com.google.devtools.build.lib.events.EventKind.PROGRESS;
import static com.google.devtools.build.lib.util.Preconditions.checkArgument;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.common.collect.Sets;
import com.google.common.eventbus.Subscribe;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.devtools.build.lib.actions.ActionExecutedEvent;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.EventReportingArtifacts;
import com.google.devtools.build.lib.analysis.BuildInfoEvent;
import com.google.devtools.build.lib.analysis.NoBuildEvent;
import com.google.devtools.build.lib.analysis.NoBuildRequestFinishedEvent;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildEventWithConfiguration;
import com.google.devtools.build.lib.buildeventstream.AbortedEvent;
import com.google.devtools.build.lib.buildeventstream.AnnounceBuildEventTransportsEvent;
import com.google.devtools.build.lib.buildeventstream.ArtifactGroupNamer;
import com.google.devtools.build.lib.buildeventstream.BuildEvent;
import com.google.devtools.build.lib.buildeventstream.BuildEventId;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.Aborted.AbortReason;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId.NamedSetOfFilesId;
import com.google.devtools.build.lib.buildeventstream.BuildEventTransport;
import com.google.devtools.build.lib.buildeventstream.BuildEventTransportClosedEvent;
import com.google.devtools.build.lib.buildeventstream.BuildEventWithOrderConstraint;
import com.google.devtools.build.lib.buildeventstream.LastBuildEvent;
import com.google.devtools.build.lib.buildeventstream.NullConfiguration;
import com.google.devtools.build.lib.buildeventstream.ProgressEvent;
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.buildtool.buildevent.TestingCompleteEvent;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetView;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.events.Reporter;
import com.google.devtools.build.lib.rules.extra.ExtraAction;
import com.google.devtools.build.lib.util.Pair;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;
/**
* Listens for {@link BuildEvent}s and streams them to the provided {@link BuildEventTransport}s.
*
* <p>The streamer takes care of closing all {@link BuildEventTransport}s. It does so after having
* received a {@link BuildCompleteEvent}. Furthermore, it emits two event types to the
* {@code eventBus}. After having received the first {@link BuildEvent} it emits a
* {@link AnnounceBuildEventTransportsEvent} that contains a list of all its transports.
* Furthermore, after a transport has been closed, it emits
* a {@link BuildEventTransportClosedEvent}.
*/
public class BuildEventStreamer implements EventHandler {
private final Collection<BuildEventTransport> transports;
private final Reporter reporter;
private Set<BuildEventId> announcedEvents;
private final Set<BuildEventId> postedEvents = new HashSet<>();
private final Set<BuildEventId> configurationsPosted = new HashSet<>();
private List<Pair<String, String>> bufferedStdoutStderrPairs = new ArrayList<>();
private final Multimap<BuildEventId, BuildEvent> pendingEvents = HashMultimap.create();
private int progressCount;
private final CountingArtifactGroupNamer artifactGroupNamer = new CountingArtifactGroupNamer();
private OutErrProvider outErrProvider;
private AbortReason abortReason = AbortReason.UNKNOWN;
// Will be set to true if the build was invoked through "bazel test".
private boolean isTestCommand;
private static final Logger log = Logger.getLogger(BuildEventStreamer.class.getName());
/**
* Provider for stdout and stderr output.
*/
public interface OutErrProvider {
/**
* Return the chunk of stdout that was produced since the last call to this function (or the
* beginning of the build, for the first call). It is the responsibility of the class
* implementing this interface to properly synchronize with simultaneously written output.
*/
String getOut();
/**
* Return the chunk of stderr that was produced since the last call to this function (or the
* beginning of the build, for the first call). It is the responsibility of the class
* implementing this interface to properly synchronize with simultaneously written output.
*/
String getErr();
}
private static class CountingArtifactGroupNamer implements ArtifactGroupNamer {
private final Map<Object, Long> reportedArtifactNames = new HashMap<>();
private long nextArtifactName;
@Override
public NamedSetOfFilesId apply(Object id) {
Long name;
synchronized (this) {
name = reportedArtifactNames.get(id);
}
if (name == null) {
return null;
}
return NamedSetOfFilesId.newBuilder().setId(name.toString()).build();
}
/**
* If the {@link NestedSetView} has no name already, return a new name for it. Return null
* otherwise.
*/
synchronized String maybeName(NestedSetView<Artifact> view) {
if (reportedArtifactNames.containsKey(view.identifier())) {
return null;
}
Long name = nextArtifactName;
nextArtifactName++;
reportedArtifactNames.put(view.identifier(), name);
return name.toString();
}
}
public BuildEventStreamer(Collection<BuildEventTransport> transports, Reporter reporter) {
checkArgument(transports.size() > 0);
this.transports = transports;
this.reporter = reporter;
this.announcedEvents = null;
this.progressCount = 0;
}
public void registerOutErrProvider(OutErrProvider outErrProvider) {
this.outErrProvider = outErrProvider;
}
/**
* Post a new event to all transports; simultaneously keep track of the events we announce to
* still come.
*
* <p>Moreover, link unannounced events to the progress stream; we only expect failure events to
* come before their parents.
*/
private void post(BuildEvent event) {
BuildEvent linkEvent = null;
BuildEventId id = event.getEventId();
List<BuildEvent> flushEvents = null;
boolean lastEvent = false;
synchronized (this) {
if (announcedEvents == null) {
announcedEvents = new HashSet<>();
// The very first event of a stream is implicitly announced by the convention that
// a complete stream has to have at least one entry. In this way we keep the invariant
// that the set of posted events is always a subset of the set of announced events.
announcedEvents.add(id);
if (!event.getChildrenEvents().contains(ProgressEvent.INITIAL_PROGRESS_UPDATE)) {
linkEvent = ProgressEvent.progressChainIn(progressCount, event.getEventId());
progressCount++;
announcedEvents.addAll(linkEvent.getChildrenEvents());
// the new first event in the stream, implicitly announced by the fact that complete
// stream may not be empty.
announcedEvents.add(linkEvent.getEventId());
postedEvents.add(linkEvent.getEventId());
}
if (reporter != null) {
reporter.post(new AnnounceBuildEventTransportsEvent(transports));
}
if (!bufferedStdoutStderrPairs.isEmpty()) {
flushEvents = new ArrayList<>(bufferedStdoutStderrPairs.size());
for (Pair<String, String> outErrPair : bufferedStdoutStderrPairs) {
flushEvents.add(flushStdoutStderrEvent(outErrPair.getFirst(), outErrPair.getSecond()));
}
}
bufferedStdoutStderrPairs = null;
} else {
if (!announcedEvents.contains(id)) {
String out = null;
String err = null;
if (outErrProvider != null) {
out = outErrProvider.getOut();
err = outErrProvider.getErr();
}
linkEvent = ProgressEvent.progressChainIn(progressCount, id, out, err);
progressCount++;
announcedEvents.addAll(linkEvent.getChildrenEvents());
postedEvents.add(linkEvent.getEventId());
}
}
if (event instanceof BuildInfoEvent) {
// The specification for BuildInfoEvent says that there may be many such events,
// but all except the first one should be ignored.
if (postedEvents.contains(id)) {
return;
}
}
postedEvents.add(id);
announcedEvents.addAll(event.getChildrenEvents());
// We keep as an invariant that postedEvents is a subset of announced events, so this is a
// cheaper test for equality
if (announcedEvents.size() == postedEvents.size()) {
lastEvent = true;
}
}
BuildEvent mainEvent = event;
if (lastEvent) {
mainEvent = new LastBuildEvent(event);
}
for (BuildEventTransport transport : transports) {
if (linkEvent != null) {
transport.sendBuildEvent(linkEvent, artifactGroupNamer);
}
transport.sendBuildEvent(mainEvent, artifactGroupNamer);
}
if (flushEvents != null) {
for (BuildEvent flushEvent : flushEvents) {
for (BuildEventTransport transport : transports) {
transport.sendBuildEvent(flushEvent, artifactGroupNamer);
}
}
}
}
/** Clear pending events by generating aborted events for all their requisits. */
private void clearPendingEvents() {
while (!pendingEvents.isEmpty()) {
BuildEventId id = pendingEvents.keySet().iterator().next();
buildEvent(new AbortedEvent(id, abortReason, ""));
}
}
/**
* Clear all events that are still announced; events not naturally closed by the expected event
* normally only occur if the build is aborted.
*/
private void clearAnnouncedEvents() {
if (announcedEvents != null) {
// create a copy of the identifiers to clear, as the post method
// will change the set of already announced events.
Set<BuildEventId> ids;
synchronized (this) {
ids = Sets.difference(announcedEvents, postedEvents);
}
for (BuildEventId id : ids) {
post(new AbortedEvent(id, abortReason, ""));
}
}
}
private ScheduledFuture<?> bepUploadWaitEvent(ScheduledExecutorService executor) {
final long startNanos = System.nanoTime();
return executor.scheduleAtFixedRate(
() -> {
long deltaNanos = System.nanoTime() - startNanos;
long deltaSeconds = TimeUnit.NANOSECONDS.toSeconds(deltaNanos);
Event waitEvt =
of(PROGRESS, null, "Waiting for build event protocol upload: " + deltaSeconds + "s");
if (reporter != null) {
reporter.handle(waitEvt);
}
},
0,
1,
TimeUnit.SECONDS);
}
private void close() {
ScheduledExecutorService executor = null;
try {
executor = Executors.newSingleThreadScheduledExecutor();
List<ListenableFuture<Void>> closeFutures = new ArrayList<>(transports.size());
for (final BuildEventTransport transport : transports) {
ListenableFuture<Void> closeFuture = transport.close();
closeFuture.addListener(
() -> {
if (reporter != null) {
reporter.post(new BuildEventTransportClosedEvent(transport));
}
},
executor);
closeFutures.add(closeFuture);
}
try {
if (closeFutures.isEmpty()) {
// Don't spam events if there is nothing to close.
return;
}
ScheduledFuture<?> f = bepUploadWaitEvent(executor);
// Wait for all transports to close.
Futures.allAsList(closeFutures).get();
f.cancel(true);
} catch (Exception e) {
log.severe("Failed to close a build event transport: " + e);
}
} finally {
if (executor != null) {
executor.shutdown();
}
}
}
private void maybeReportArtifactSet(NestedSetView<Artifact> view) {
String name = artifactGroupNamer.maybeName(view);
if (name == null) {
return;
}
for (NestedSetView<Artifact> transitive : view.transitives()) {
maybeReportArtifactSet(transitive);
}
post(new NamedArtifactGroup(name, view));
}
private void maybeReportArtifactSet(NestedSet<Artifact> set) {
maybeReportArtifactSet(new NestedSetView<Artifact>(set));
}
private void maybeReportConfiguration(BuildConfiguration configuration) {
BuildEvent event = configuration;
if (configuration == null) {
event = new NullConfiguration();
}
BuildEventId id = event.getEventId();
synchronized (this) {
if (configurationsPosted.contains(id)) {
return;
}
configurationsPosted.add(id);
}
post(event);
}
@Override
public void handle(Event event) {}
@Subscribe
public void buildInterrupted(BuildInterruptedEvent event) {
abortReason = AbortReason.USER_INTERRUPTED;
}
@Subscribe
public void buildEvent(BuildEvent event) {
if (isActionWithoutError(event) || bufferUntilPrerequisitesReceived(event)) {
return;
}
if (isTestCommand && event instanceof BuildCompleteEvent) {
// In case of "bazel test" ignore the BuildCompleteEvent, as it will be followed by a
// TestingCompleteEvent that contains the correct exit code.
return;
}
if (event instanceof BuildStartingEvent) {
BuildRequest buildRequest = ((BuildStartingEvent) event).getRequest();
isTestCommand = "test".equals(buildRequest.getCommandName());
}
if (event instanceof BuildEventWithConfiguration) {
for (BuildConfiguration configuration :
((BuildEventWithConfiguration) event).getConfigurations()) {
maybeReportConfiguration(configuration);
}
}
if (event instanceof EventReportingArtifacts) {
for (NestedSet<Artifact> artifactSet :
((EventReportingArtifacts) event).reportedArtifacts()) {
maybeReportArtifactSet(artifactSet);
}
}
post(event);
// Reconsider all events blocked by the event just posted.
Collection<BuildEvent> toReconsider = pendingEvents.removeAll(event.getEventId());
for (BuildEvent freedEvent : toReconsider) {
buildEvent(freedEvent);
}
if (event instanceof BuildCompleteEvent
|| event instanceof TestingCompleteEvent
|| event instanceof NoBuildRequestFinishedEvent) {
buildComplete();
}
if (event instanceof NoBuildEvent) {
if (!((NoBuildEvent) event).separateFinishedEvent()) {
buildComplete();
}
}
}
private synchronized BuildEvent flushStdoutStderrEvent(String out, String err) {
BuildEvent updateEvent = ProgressEvent.progressUpdate(progressCount, out, err);
progressCount++;
announcedEvents.addAll(updateEvent.getChildrenEvents());
postedEvents.add(updateEvent.getEventId());
return updateEvent;
}
void flush() {
BuildEvent updateEvent = null;
synchronized (this) {
String out = null;
String err = null;
if (outErrProvider != null) {
out = outErrProvider.getOut();
err = outErrProvider.getErr();
}
if (announcedEvents != null) {
updateEvent = flushStdoutStderrEvent(out, err);
} else {
bufferedStdoutStderrPairs.add(Pair.of(out, err));
}
}
if (updateEvent != null) {
for (BuildEventTransport transport : transports) {
transport.sendBuildEvent(updateEvent, artifactGroupNamer);
}
}
}
@VisibleForTesting
public ImmutableSet<BuildEventTransport> getTransports() {
return ImmutableSet.copyOf(transports);
}
private void buildComplete() {
clearPendingEvents();
String out = null;
String err = null;
if (outErrProvider != null) {
out = outErrProvider.getOut();
err = outErrProvider.getErr();
}
post(ProgressEvent.finalProgressUpdate(progressCount, out, err));
clearAnnouncedEvents();
close();
}
/**
* Return true, if the action is not worth being reported. This is the case, if the action
* executed successfully and is not an ExtraAction.
*/
private static boolean isActionWithoutError(BuildEvent event) {
return event instanceof ActionExecutedEvent
&& ((ActionExecutedEvent) event).getException() == null
&& (!(((ActionExecutedEvent) event).getAction() instanceof ExtraAction));
}
private boolean bufferUntilPrerequisitesReceived(BuildEvent event) {
if (!(event instanceof BuildEventWithOrderConstraint)) {
return false;
}
// Check if all prerequisite events are posted already.
for (BuildEventId prerequisiteId : ((BuildEventWithOrderConstraint) event).postedAfter()) {
if (!postedEvents.contains(prerequisiteId)) {
pendingEvents.put(prerequisiteId, event);
return true;
}
}
return false;
}
}
|