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
|
// 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.concurrent;
import com.google.common.base.Preconditions;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.ForkJoinTask;
import java.util.concurrent.Future;
/** A {@link QuiescingExecutor} implementation that wraps a {@link ForkJoinPool}. */
// TODO(bazel-team): This extends AQV to ensure that they share the same semantics for interrupt
// handling, error propagation, and task completion. Because FJP provides a native implementation
// for awaitQuiescence, a careful refactoring would allow FJQE to avoid the overhead of
// maintaining AQV.remainingTasks.
public class ForkJoinQuiescingExecutor extends AbstractQueueVisitor {
private ForkJoinQuiescingExecutor(
ForkJoinPool forkJoinPool, ErrorClassifier errorClassifier, boolean shutdownOnCompletion) {
super(
forkJoinPool,
shutdownOnCompletion,
/*failFastOnException=*/ true,
errorClassifier);
}
/** Builder for {@link ForkJoinQuiescingExecutor}. */
public static class Builder {
private ForkJoinPool forkJoinPool = null;
private boolean owned = false;
private ErrorClassifier errorClassifier = ErrorClassifier.DEFAULT;
private Builder() {
}
/**
* Sets the {@link ForkJoinPool} that will be used by the to-be-built
* {@link ForkJoinQuiescingExecutor}. The given {@link ForkJoinPool} will _not_ be shut down on
* completion of the {@link ForkJoinQuiescingExecutor}.
*/
public Builder withoutOwnershipOf(ForkJoinPool forkJoinPool) {
Preconditions.checkState(this.forkJoinPool == null);
this.forkJoinPool = forkJoinPool;
this.owned = false;
return this;
}
/**
* Sets the {@link ForkJoinPool} that will be used by the to-be-built
* {@link ForkJoinQuiescingExecutor}. The given {@link ForkJoinPool} will be shut down on
* completion of the {@link ForkJoinQuiescingExecutor}.
*/
public Builder withOwnershipOf(ForkJoinPool forkJoinPool) {
Preconditions.checkState(this.forkJoinPool == null);
this.forkJoinPool = forkJoinPool;
this.owned = true;
return this;
}
/**
* Sets the {@link ErrorClassifier} that will be used by the to-be-built
* {@link ForkJoinQuiescingExecutor}.
*/
public Builder setErrorClassifier(ErrorClassifier errorClassifier) {
this.errorClassifier = errorClassifier;
return this;
}
/**
* Returns a fresh {@link ForkJoinQuiescingExecutor} using the previously given options.
*/
public ForkJoinQuiescingExecutor build() {
Preconditions.checkNotNull(forkJoinPool);
return new ForkJoinQuiescingExecutor(
forkJoinPool, errorClassifier, /*shutdownOnCompletion=*/ owned);
}
}
/** Returns a fresh {@link Builder}. */
public static Builder newBuilder() {
return new Builder();
}
@Override
protected void executeRunnable(WrappedRunnable runnable) {
if (ForkJoinTask.inForkJoinPool()) {
@SuppressWarnings("unused")
Future<?> possiblyIgnoredError = ForkJoinTask.adapt(runnable).fork();
} else {
super.executeRunnable(runnable);
}
}
}
|
