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
|
// Copyright 2014 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 static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.packages.BuildType.LABEL;
import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
import static com.google.devtools.build.lib.packages.BuildType.LICENSE;
import static com.google.devtools.build.lib.packages.BuildType.NODEP_LABEL;
import static com.google.devtools.build.lib.syntax.Type.BOOLEAN;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.PlatformConfiguration;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.analysis.TemplateVariableInfo;
import com.google.devtools.build.lib.analysis.config.HostTransition;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.Attribute.LabelLateBoundDefault;
import com.google.devtools.build.lib.packages.AttributeMap;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.syntax.Type;
/**
* Rule definition for compiler definition.
*/
public final class CcToolchainRule implements RuleDefinition {
public static final String LIBC_TOP_ATTR = ":libc_top";
public static final String FDO_OPTIMIZE_ATTR = ":fdo_optimize";
public static final String FDO_PROFILE_ATTR = ":fdo_profile";
/**
* Determines if the given target is a cc_toolchain or one of its subclasses. New subclasses
* should be added to this method.
*/
static boolean isCcToolchain(Target target) {
String ruleClass = ((Rule) target).getRuleClass();
return ruleClass.endsWith("cc_toolchain");
}
private static Label getLabel(AttributeMap attributes, String attrName, Label defaultValue) {
if (attributes.has(attrName, LABEL)) {
Label value = attributes.get(attrName, LABEL);
if (value != null) {
return value;
}
}
return defaultValue;
}
private static final LabelLateBoundDefault<?> LIBC_TOP_VALUE =
LabelLateBoundDefault.fromTargetConfiguration(
CppConfiguration.class,
null,
(rule, attributes, cppConfig) ->
// This avoids analyzing the label from the CROSSTOOL if the attribute is set.
getLabel(attributes, "libc_top", cppConfig.getSysrootLabel()));
private static final LabelLateBoundDefault<?> FDO_OPTIMIZE_VALUE =
LabelLateBoundDefault.fromTargetConfiguration(
CppConfiguration.class,
null,
(rule, attributes, cppConfig) -> cppConfig.getFdoOptimizeLabel());
private static final LabelLateBoundDefault<?> FDO_PROFILE_VALUE =
LabelLateBoundDefault.fromTargetConfiguration(
CppConfiguration.class,
null,
(rule, attributes, cppConfig) -> cppConfig.getFdoProfileLabel());
private static final LabelLateBoundDefault<?> FDO_PREFETCH_HINTS =
LabelLateBoundDefault.fromTargetConfiguration(
CppConfiguration.class,
null,
(rule, attributes, cppConfig) -> cppConfig.getFdoPrefetchHintsLabel());
/**
* Returns true if zipper should be loaded. We load the zipper executable if FDO optimization is
* enabled through --fdo_optimize or --fdo_profile
*/
private static boolean shouldIncludeZipperInToolchain(CppConfiguration cppConfiguration) {
return cppConfiguration.getFdoOptimizeLabel() != null
|| cppConfiguration.getFdoProfileLabel() != null
|| cppConfiguration.getFdoPath() != null;
}
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment env) {
final Label zipper = env.getToolsLabel("//tools/zip:zipper");
return builder
.setUndocumented()
.requiresConfigurationFragments(CppConfiguration.class, PlatformConfiguration.class)
.advertiseProvider(TemplateVariableInfo.class)
.add(attr("output_licenses", LICENSE))
.add(attr("cpu", STRING).mandatory())
.add(attr("compiler", STRING))
.add(
attr("all_files", LABEL)
.legacyAllowAnyFileType()
.cfg(HostTransition.INSTANCE)
.mandatory())
.add(
attr("compiler_files", LABEL)
.legacyAllowAnyFileType()
.cfg(HostTransition.INSTANCE)
.mandatory())
.add(
attr("strip_files", LABEL)
.legacyAllowAnyFileType()
.cfg(HostTransition.INSTANCE)
.mandatory())
.add(
attr("objcopy_files", LABEL)
.legacyAllowAnyFileType()
.cfg(HostTransition.INSTANCE)
.mandatory())
.add(attr("as_files", LABEL).legacyAllowAnyFileType().cfg(HostTransition.INSTANCE))
.add(attr("ar_files", LABEL).legacyAllowAnyFileType().cfg(HostTransition.INSTANCE))
.add(
attr("linker_files", LABEL)
.legacyAllowAnyFileType()
.cfg(HostTransition.INSTANCE)
.mandatory())
.add(
attr("dwp_files", LABEL)
.legacyAllowAnyFileType()
.cfg(HostTransition.INSTANCE)
.mandatory())
.add(attr("coverage_files", LABEL).legacyAllowAnyFileType().cfg(HostTransition.INSTANCE))
.add(attr("static_runtime_libs", LABEL_LIST).legacyAllowAnyFileType().mandatory())
.add(attr("dynamic_runtime_libs", LABEL_LIST).legacyAllowAnyFileType().mandatory())
.add(attr("module_map", LABEL).legacyAllowAnyFileType().cfg(HostTransition.INSTANCE))
.add(attr("supports_param_files", BOOLEAN).value(true))
.add(attr("supports_header_parsing", BOOLEAN).value(false))
.add(
attr("$interface_library_builder", LABEL)
.cfg(HostTransition.INSTANCE)
.singleArtifact()
.value(env.getToolsLabel("//tools/cpp:interface_library_builder")))
.add(
attr("$link_dynamic_library_tool", LABEL)
.cfg(HostTransition.INSTANCE)
.singleArtifact()
.value(env.getToolsLabel("//tools/cpp:link_dynamic_library")))
.add(
attr(CcToolchain.CC_TOOLCHAIN_TYPE_ATTRIBUTE_NAME, NODEP_LABEL)
.value(CppRuleClasses.ccToolchainTypeAttribute(env)))
.add(
attr(":zipper", LABEL)
.cfg(HostTransition.INSTANCE)
.singleArtifact()
.value(
LabelLateBoundDefault.fromTargetConfiguration(
CppConfiguration.class,
null,
(rule, attributes, cppConfig) ->
shouldIncludeZipperInToolchain(cppConfig) ? zipper : null)))
// TODO(b/78578234): Make this the default and remove the late-bound versions.
.add(attr("libc_top", LABEL).allowedFileTypes())
.add(attr(LIBC_TOP_ATTR, LABEL).value(LIBC_TOP_VALUE))
.add(attr(FDO_OPTIMIZE_ATTR, LABEL).singleArtifact().value(FDO_OPTIMIZE_VALUE))
.add(
attr(FDO_PROFILE_ATTR, LABEL)
.allowedRuleClasses("fdo_profile")
.mandatoryProviders(ImmutableList.of(FdoProfileProvider.PROVIDER.id()))
.value(FDO_PROFILE_VALUE))
.add(
attr(":fdo_prefetch_hints", LABEL)
.allowedRuleClasses("fdo_prefetch_hints")
.mandatoryProviders(ImmutableList.of(FdoPrefetchHintsProvider.PROVIDER.id()))
.value(FDO_PREFETCH_HINTS))
.add(attr("proto", Type.STRING))
.add(
attr("toolchain_identifier", Type.STRING)
.nonconfigurable("Used in configuration creation")
.value(""))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("cc_toolchain")
.ancestors(BaseRuleClasses.BaseRule.class)
.factoryClass(CcToolchain.class)
.build();
}
}
|
