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 2016 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.turbine.options;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import java.util.Optional;
import org.jspecify.nullness.Nullable;
/** Header compilation options. */
@AutoValue
public abstract class TurbineOptions {
/**
* This modes controls how a probablistic Java classpath reduction is used. For each mode except
* {@code NONE} a speculative compilation is performed against a subset of the original classpath.
* If it fails due to a missing symbol, it is retried with the original transitive classpath.
*/
public enum ReducedClasspathMode {
/**
* Bazel performs classpath reduction, and invokes turbine passing only the reduced classpath.
* If the compilation fails and requires fallback, turbine finishes with exit code 0 but records
* that the reduced classpath compilation failed in the jdeps proto.
*/
BAZEL_REDUCED,
/**
* Indicates that the reduced classpath compilation failed when Bazel previously invoked
* turbine, and that we are retrying with a transitive classpath.
*/
BAZEL_FALLBACK,
/**
* Turbine implements reduced classpaths locally, with in-process fallback if the compilation
* fails.
*/
JAVABUILDER_REDUCED,
/** Reduced classpaths are disabled, and a full transitive classpath is used. */
NONE
}
/** Paths to the Java source files to compile. */
public abstract ImmutableList<String> sources();
/** Paths to classpath artifacts. */
public abstract ImmutableList<String> classPath();
/** Paths to compilation bootclasspath artifacts. */
public abstract ImmutableSet<String> bootClassPath();
/** The language version. */
public abstract LanguageVersion languageVersion();
/** The target platform's system modules. */
public abstract Optional<String> system();
/** The output jar. */
public abstract Optional<String> output();
/** Paths to annotation processor artifacts. */
public abstract ImmutableList<String> processorPath();
/** Annotation processor class names. */
public abstract ImmutableSet<String> processors();
/** Class names of annotation processor that are built in. */
public abstract ImmutableSet<String> builtinProcessors();
/** Source jars for compilation. */
public abstract ImmutableList<String> sourceJars();
/** Output jdeps file. */
public abstract Optional<String> outputDeps();
/** Output manifest file. */
public abstract Optional<String> outputManifest();
/** The direct dependencies. */
public abstract ImmutableSet<String> directJars();
/** The label of the target being compiled. */
public abstract Optional<String> targetLabel();
/**
* If present, the name of the rule that injected an aspect that compiles this target.
*
* <p>Note that this rule will have a completely different label to {@link #targetLabel} above.
*/
public abstract Optional<String> injectingRuleKind();
/** The .jdeps artifacts for direct dependencies. */
public abstract ImmutableList<String> depsArtifacts();
/** Print usage information. */
public abstract boolean help();
/** Additional Java compiler flags. */
public abstract ImmutableList<String> javacOpts();
/** The reduced classpath optimization mode. */
public abstract ReducedClasspathMode reducedClasspathMode();
/** An optional path for profiling output. */
public abstract Optional<String> profile();
/** An optional path for generated source output. */
public abstract Optional<String> gensrcOutput();
/** An optional path for generated resource output. */
public abstract Optional<String> resourceOutput();
public abstract int fullClasspathLength();
public abstract int reducedClasspathLength();
public static Builder builder() {
return new AutoValue_TurbineOptions.Builder()
.setSources(ImmutableList.of())
.setClassPath(ImmutableList.of())
.setBootClassPath(ImmutableList.of())
.setProcessorPath(ImmutableList.of())
.setProcessors(ImmutableList.of())
.setBuiltinProcessors(ImmutableList.of())
.setSourceJars(ImmutableList.of())
.setDirectJars(ImmutableList.of())
.setDepsArtifacts(ImmutableList.of())
.addAllJavacOpts(ImmutableList.of())
.setLanguageVersion(LanguageVersion.createDefault())
.setReducedClasspathMode(ReducedClasspathMode.NONE)
.setHelp(false)
.setFullClasspathLength(0)
.setReducedClasspathLength(0);
}
/** A {@link Builder} for {@link TurbineOptions}. */
@AutoValue.Builder
public abstract static class Builder {
public abstract Builder setOutput(String output);
public abstract Builder setClassPath(ImmutableList<String> classPath);
public abstract Builder setBootClassPath(ImmutableList<String> bootClassPath);
public abstract Builder setLanguageVersion(LanguageVersion languageVersion);
public abstract Builder setSystem(String system);
public abstract Builder setSources(ImmutableList<String> sources);
public abstract Builder setProcessorPath(ImmutableList<String> processorPath);
public abstract Builder setProcessors(ImmutableList<String> processors);
public abstract Builder setBuiltinProcessors(ImmutableList<String> builtinProcessors);
public abstract Builder setSourceJars(ImmutableList<String> sourceJars);
public abstract Builder setOutputDeps(String outputDeps);
public abstract Builder setOutputManifest(String outputManifest);
public abstract Builder setTargetLabel(String targetLabel);
public abstract Builder setInjectingRuleKind(String injectingRuleKind);
public abstract Builder setDepsArtifacts(ImmutableList<String> depsArtifacts);
public abstract Builder setHelp(boolean help);
abstract ImmutableList.Builder<String> javacOptsBuilder();
public Builder addAllJavacOpts(Iterable<String> javacOpts) {
javacOptsBuilder().addAll(javacOpts);
return this;
}
public abstract Builder setReducedClasspathMode(ReducedClasspathMode reducedClasspathMode);
public abstract Builder setDirectJars(ImmutableList<String> jars);
public abstract Builder setProfile(String profile);
public abstract Builder setGensrcOutput(String gensrcOutput);
public abstract Builder setResourceOutput(String resourceOutput);
public abstract Builder setFullClasspathLength(int fullClasspathLength);
public abstract Builder setReducedClasspathLength(int reducedClasspathLength);
public abstract TurbineOptions build();
}
// TODO(b/188833569): remove when AutoValue adds @Nullable to Object if its on the classpath
@Override
public abstract boolean equals(@Nullable Object other);
@Override
public abstract int hashCode();
}
|
