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
|
// 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.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.FeatureConfiguration;
import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.Variables;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.regex.Pattern;
/** Handles creation of CppCompileAction used to compile linkstamp sources. */
public class CppLinkstampCompileHelper {
/**
* Creates {@link CppCompileAction} to compile linkstamp source
*
* @param inputsForInvalidation: see {@link CppCompileAction#inputsForInvalidation}
*/
public static CppCompileAction createLinkstampCompileAction(
RuleContext ruleContext,
Artifact sourceFile,
Artifact outputFile,
Iterable<Artifact> compilationInputs,
Iterable<Artifact> nonCodeInputs,
Iterable<Artifact> inputsForInvalidation,
ImmutableList<Artifact> buildInfoHeaderArtifacts,
Iterable<String> additionalLinkstampDefines,
CcToolchainProvider ccToolchainProvider,
boolean codeCoverageEnabled,
CppConfiguration cppConfiguration,
String fdoBuildStamp,
FeatureConfiguration featureConfiguration,
boolean needsPic,
String labelReplacement,
String outputReplacement,
CppSemantics semantics) {
CppCompileActionBuilder builder =
new CppCompileActionBuilder(ruleContext, ccToolchainProvider)
.addMandatoryInputs(compilationInputs)
.setVariables(
getVariables(
ruleContext,
sourceFile,
outputFile,
labelReplacement,
outputReplacement,
additionalLinkstampDefines,
buildInfoHeaderArtifacts,
featureConfiguration,
cppConfiguration,
ccToolchainProvider,
needsPic,
fdoBuildStamp,
codeCoverageEnabled))
.setFeatureConfiguration(featureConfiguration)
.setSourceFile(sourceFile)
.setSemantics(semantics)
.setOutputs(outputFile, null)
.setInputsForInvalidation(inputsForInvalidation)
.setBuiltinIncludeFiles(buildInfoHeaderArtifacts)
.addMandatoryInputs(nonCodeInputs)
.setCppConfiguration(cppConfiguration)
.setActionName(CppCompileAction.LINKSTAMP_COMPILE);
semantics.finalizeCompileActionBuilder(ruleContext, builder);
return builder.buildOrThrowIllegalStateException();
}
private static ImmutableList<String> computeAllLinkstampDefines(
String labelReplacement,
String outputReplacement,
Iterable<String> additionalLinkstampDefines,
CppConfiguration cppConfiguration,
String fdoBuildStamp,
boolean codeCoverageEnabled) {
String labelPattern = Pattern.quote("${LABEL}");
String outputPathPattern = Pattern.quote("${OUTPUT_PATH}");
Builder<String> defines =
ImmutableList.<String>builder()
.add("GPLATFORM=\"" + cppConfiguration + "\"")
.add("BUILD_COVERAGE_ENABLED=" + (codeCoverageEnabled ? "1" : "0"))
// G3_VERSION_INFO and G3_TARGET_NAME are C string literals that normally
// contain the label of the target being linked. However, they are set
// differently when using shared native deps. In that case, a single .so file
// is shared by multiple targets, and its contents cannot depend on which
// target(s) were specified on the command line. So in that case we have
// to use the (obscure) name of the .so file instead, or more precisely
// the path of the .so file relative to the workspace root.
.add("G3_VERSION_INFO=\"${LABEL}\"")
.add("G3_TARGET_NAME=\"${LABEL}\"")
// G3_BUILD_TARGET is a C string literal containing the output of this
// link. (An undocumented and untested invariant is that G3_BUILD_TARGET is the
// location of the executable, either absolutely, or relative to the directory part of
// BUILD_INFO.)
.add("G3_BUILD_TARGET=\"${OUTPUT_PATH}\"")
.addAll(additionalLinkstampDefines);
if (fdoBuildStamp != null) {
defines.add(CppConfiguration.FDO_STAMP_MACRO + "=\"" + fdoBuildStamp + "\"");
}
return defines
.build()
.stream()
.map(
define ->
define
.replaceAll(labelPattern, labelReplacement)
.replaceAll(outputPathPattern, outputReplacement))
.collect(ImmutableList.toImmutableList());
}
private static Variables getVariables(
RuleContext ruleContext,
Artifact sourceFile,
Artifact outputFile,
String labelReplacement,
String outputReplacement,
Iterable<String> additionalLinkstampDefines,
ImmutableList<Artifact> buildInfoHeaderArtifacts,
FeatureConfiguration featureConfiguration,
CppConfiguration cppConfiguration,
CcToolchainProvider ccToolchainProvider,
boolean needsPic,
String fdoBuildStamp,
boolean codeCoverageEnabled) {
// TODO(b/34761650): Remove all this hardcoding by separating a full blown compile action.
Preconditions.checkArgument(
featureConfiguration.actionIsConfigured(CppCompileAction.LINKSTAMP_COMPILE));
CcCompilationInfo ccCompilationInfo =
new CcCompilationInfo.Builder(ruleContext)
.addIncludeDir(PathFragment.create("."))
.addDefines(
computeAllLinkstampDefines(
labelReplacement,
outputReplacement,
additionalLinkstampDefines,
cppConfiguration,
fdoBuildStamp,
codeCoverageEnabled))
.build();
return CompileBuildVariables.setupVariables(
ruleContext,
featureConfiguration,
ccToolchainProvider,
sourceFile,
outputFile,
/* gcnoFile= */ null,
/* dwoFile= */ null,
/* ltoIndexingFile= */ null,
ccCompilationInfo,
buildInfoHeaderArtifacts
.stream()
.map(Artifact::getExecPathString)
.collect(ImmutableList.toImmutableList()),
/* userCompileFlags= */ ImmutableList.of(),
/* cppModuleMap= */ null,
needsPic,
outputFile.getExecPath(),
fdoBuildStamp,
/* dotdFileExecPath= */ null,
/* variablesExtensions= */ ImmutableList.of(),
/* additionalBuildVariables= */ ImmutableMap.of(),
// TODO(b/76449614): Remove use of optional_*_flag from CROSSTOOL and get rid of this param
ruleContext.getFeatures());
}
}
|
