-
Notifications
You must be signed in to change notification settings - Fork 4k
/
CompileCommandLine.java
251 lines (225 loc) · 9.46 KB
/
CompileCommandLine.java
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
// Copyright 2017 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.rules.cpp;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.actions.AbstractCommandLine;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.CommandLine;
import com.google.devtools.build.lib.actions.CommandLineExpansionException;
import com.google.devtools.build.lib.actions.PathMapper;
import com.google.devtools.build.lib.rules.cpp.CcCommon.CoptsFilter;
import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.ExpansionException;
import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.FeatureConfiguration;
import com.google.devtools.build.lib.util.Pair;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nullable;
/** The compile command line for the C++ compile action. */
public final class CompileCommandLine {
private final Artifact sourceFile;
private final CoptsFilter coptsFilter;
private final FeatureConfiguration featureConfiguration;
private final CcToolchainVariables variables;
private final String actionName;
private final Artifact dotdFile;
private CompileCommandLine(
Artifact sourceFile,
CoptsFilter coptsFilter,
FeatureConfiguration featureConfiguration,
CcToolchainVariables variables,
String actionName,
Artifact dotdFile) {
this.sourceFile = Preconditions.checkNotNull(sourceFile);
this.coptsFilter = coptsFilter;
this.featureConfiguration = Preconditions.checkNotNull(featureConfiguration);
this.variables = variables;
this.actionName = actionName;
this.dotdFile = isGenerateDotdFile(sourceFile) ? dotdFile : null;
}
/** Returns true if Dotd file should be generated. */
private boolean isGenerateDotdFile(Artifact sourceArtifact) {
return CppFileTypes.headerDiscoveryRequired(sourceArtifact)
&& !featureConfiguration.isEnabled(CppRuleClasses.PARSE_SHOWINCLUDES);
}
/** Returns the environment variables that should be set for C++ compile actions. */
ImmutableMap<String, String> getEnvironment(PathMapper pathMapper)
throws CommandLineExpansionException {
try {
return featureConfiguration.getEnvironmentVariables(actionName, variables, pathMapper);
} catch (ExpansionException e) {
throw new CommandLineExpansionException(e.getMessage());
}
}
/** Returns the tool path for the compilation based on the current feature configuration. */
@VisibleForTesting
public String getToolPath() {
Preconditions.checkArgument(
featureConfiguration.actionIsConfigured(actionName),
"Expected action_config for '%s' to be configured",
actionName);
return featureConfiguration.getToolPathForAction(actionName);
}
/**
* @param overwrittenVariables: Variables that will overwrite original build variables. When null,
* unmodified original variables are used.
*/
List<String> getArguments(
@Nullable PathFragment parameterFilePath,
@Nullable CcToolchainVariables overwrittenVariables,
PathMapper pathMapper)
throws CommandLineExpansionException {
List<String> commandLine = new ArrayList<>();
// first: The command name.
commandLine.add(getToolPath());
// second: The compiler options.
if (parameterFilePath != null) {
commandLine.add("@" + parameterFilePath.getSafePathString());
} else {
commandLine.addAll(getCompilerOptions(overwrittenVariables, pathMapper));
}
return commandLine;
}
/**
* Returns {@link CommandLine} instance that contains the exactly same command line as the {@link
* CppCompileAction}.
*
* @param cppCompileAction - {@link CppCompileAction} owning this {@link CompileCommandLine}.
*/
public CommandLine getFilteredFeatureConfigurationCommandLine(CppCompileAction cppCompileAction) {
return new AbstractCommandLine() {
@Override
public Iterable<String> arguments() throws CommandLineExpansionException {
CcToolchainVariables overwrittenVariables = cppCompileAction.getOverwrittenVariables();
List<String> compilerOptions = getCompilerOptions(overwrittenVariables, PathMapper.NOOP);
return ImmutableList.<String>builder().add(getToolPath()).addAll(compilerOptions).build();
}
};
}
public List<String> getCompilerOptions(
@Nullable CcToolchainVariables overwrittenVariables, PathMapper pathMapper)
throws CommandLineExpansionException {
try {
List<String> options = new ArrayList<>();
CcToolchainVariables updatedVariables = variables;
if (variables != null && overwrittenVariables != null) {
CcToolchainVariables.Builder variablesBuilder = CcToolchainVariables.builder(variables);
variablesBuilder.addAllNonTransitive(overwrittenVariables);
updatedVariables = variablesBuilder.build();
}
addFilteredOptions(
options,
featureConfiguration.getPerFeatureExpansions(actionName, updatedVariables, pathMapper));
return options;
} catch (ExpansionException e) {
throw new CommandLineExpansionException(e.getMessage());
}
}
// For each option in 'in', add it to 'out' unless it is matched by the 'coptsFilter' regexp.
private void addFilteredOptions(
List<String> out, List<Pair<String, List<String>>> expandedFeatures) {
for (Pair<String, List<String>> pair : expandedFeatures) {
if (pair.getFirst().equals(CppRuleClasses.UNFILTERED_COMPILE_FLAGS_FEATURE_NAME)) {
out.addAll(pair.getSecond());
continue;
}
// We do not uses Java's stream API here as it causes a substantial overhead compared to the
// very little work that this is actually doing.
for (String flag : pair.getSecond()) {
if (coptsFilter.passesFilter(flag)) {
out.add(flag);
}
}
}
}
public Artifact getSourceFile() {
return sourceFile;
}
public Artifact getDotdFile() {
return dotdFile;
}
public CcToolchainVariables getVariables() {
return variables;
}
/**
* Returns all user provided copts flags.
*
* <p>TODO(b/64108724): Get rid of this method when we don't need to parse copts to collect
* include directories anymore (meaning there is a way of specifying include directories using an
* explicit attribute, not using platform-dependent garbage bag that copts is).
*/
public ImmutableList<String> getCopts(PathMapper pathMapper) {
if (variables.isAvailable(CompileBuildVariables.USER_COMPILE_FLAGS.getVariableName())) {
try {
return CcToolchainVariables.toStringList(
variables, CompileBuildVariables.USER_COMPILE_FLAGS.getVariableName(), pathMapper);
} catch (ExpansionException e) {
throw new IllegalStateException(
"Should not happen - 'user_compile_flags' should be a string list, but wasn't.", e);
}
} else {
return ImmutableList.of();
}
}
public static Builder builder(
Artifact sourceFile, CoptsFilter coptsFilter, String actionName, Artifact dotdFile) {
return new Builder(sourceFile, coptsFilter, actionName, dotdFile);
}
/** A builder for a {@link CompileCommandLine}. */
public static final class Builder {
private final Artifact sourceFile;
private CoptsFilter coptsFilter;
private FeatureConfiguration featureConfiguration;
private CcToolchainVariables variables = CcToolchainVariables.EMPTY;
private final String actionName;
@Nullable private final Artifact dotdFile;
public CompileCommandLine build() {
return new CompileCommandLine(
Preconditions.checkNotNull(sourceFile),
Preconditions.checkNotNull(coptsFilter),
Preconditions.checkNotNull(featureConfiguration),
Preconditions.checkNotNull(variables),
Preconditions.checkNotNull(actionName),
dotdFile);
}
private Builder(
Artifact sourceFile, CoptsFilter coptsFilter, String actionName, Artifact dotdFile) {
this.sourceFile = sourceFile;
this.coptsFilter = coptsFilter;
this.actionName = actionName;
this.dotdFile = dotdFile;
}
/** Sets the feature configuration for this compile action. */
@CanIgnoreReturnValue
public Builder setFeatureConfiguration(FeatureConfiguration featureConfiguration) {
this.featureConfiguration = featureConfiguration;
return this;
}
@CanIgnoreReturnValue
public Builder setVariables(CcToolchainVariables variables) {
this.variables = variables;
return this;
}
@CanIgnoreReturnValue
@VisibleForTesting
Builder setCoptsFilter(CoptsFilter filter) {
this.coptsFilter = Preconditions.checkNotNull(filter);
return this;
}
}
}