Clean up RuleContext's attribute access API.
All calls now go through RuleContext.attributes(), which
guarantees both native and aspect-supplied attributes are checked.
For aspect attributes, only type queries are supported (e.g. "does
this attribute exist?", "what is its type?"). Not value queries.
This is because the code this is cleaning up accesses aspect
attributes through a String->Attribute map, which doesn't include
values. If ever needed we could further extend with something
more robust.
--
MOS_MIGRATED_REVID=140771242
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/RuleContext.java b/src/main/java/com/google/devtools/build/lib/analysis/RuleContext.java
index 265ea6e..1b45009 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/RuleContext.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/RuleContext.java
@@ -154,10 +154,9 @@
private final ListMultimap<String, ConfiguredTarget> targetMap;
private final ListMultimap<String, ConfiguredFilesetEntry> filesetEntryMap;
private final ImmutableMap<Label, ConfigMatchingProvider> configConditions;
- private final AttributeMap attributes;
+ private final AspectAwareAttributeMapper attributes;
private final ImmutableSet<String> features;
private final String ruleClassNameForLogging;
- private final ImmutableMap<String, Attribute> aspectAttributes;
private final BuildConfiguration hostConfiguration;
private final ConfigurationFragmentPolicy configurationFragmentPolicy;
private final Class<? extends BuildConfiguration.Fragment> universalFragment;
@@ -189,10 +188,9 @@
this.targetMap = targetMap;
this.filesetEntryMap = filesetEntryMap;
this.configConditions = configConditions;
- this.attributes = attributes;
+ this.attributes = new AspectAwareAttributeMapper(attributes, aspectAttributes);
this.features = getEnabledFeatures();
this.ruleClassNameForLogging = ruleClassNameForLogging;
- this.aspectAttributes = aspectAttributes;
this.skylarkProviderRegistry = builder.skylarkProviderRegistry;
this.hostConfiguration = builder.hostConfiguration;
reporter = builder.reporter;
@@ -274,11 +272,17 @@
* Attributes from aspects.
*/
public ImmutableMap<String, Attribute> getAspectAttributes() {
- return aspectAttributes;
+ return attributes.getAspectAttributes();
}
/**
- * Accessor for the Rule's attribute values.
+ * Accessor for the attributes of the rule and its aspects.
+ *
+ * <p>The rule's native attributes can be queried both on their structure / existence and values
+ * Aspect attributes can only be queried on their structure.
+ *
+ * <p>This should be the sole interface for reading rule/aspect attributes in {@link RuleContext}.
+ * Don't expose other access points through new public methods.
*/
public AttributeMap attributes() {
return attributes;
@@ -658,25 +662,11 @@
}
/**
- * Returns the Attribute associated with this name, if it's a valid attribute for this rule,
- * or is associated with an attached aspect. Otherwise returns null.
- */
- @Nullable
- public Attribute getAttribute(String attributeName) {
- Attribute result = getRule().getAttributeDefinition(attributeName);
- if (result != null) {
- return result;
- }
- return aspectAttributes.get(attributeName);
- }
-
- /**
* Returns true iff the rule, or any attached aspect, has an attribute with the given name and
* type.
*/
public boolean isAttrDefined(String attrName, Type<?> type) {
- Attribute attribute = getAttribute(attrName);
- return attribute != null && attribute.getType() == type;
+ return attributes().has(attrName, type);
}
/**
@@ -684,8 +674,7 @@
* a string to a {@link TransitiveInfoCollection}.
*/
public Map<String, TransitiveInfoCollection> getPrerequisiteMap(String attributeName) {
- Attribute attributeDefinition = getAttribute(attributeName);
- Preconditions.checkState(attributeDefinition.getType() == BuildType.LABEL_DICT_UNARY);
+ Preconditions.checkState(attributes().has(attributeName, BuildType.LABEL_DICT_UNARY));
ImmutableMap.Builder<String, TransitiveInfoCollection> result = ImmutableMap.builder();
Map<String, Label> dict = attributes().get(attributeName, BuildType.LABEL_DICT_UNARY);
@@ -708,7 +697,7 @@
*/
public List<? extends TransitiveInfoCollection> getPrerequisites(String attributeName,
Mode mode) {
- Attribute attributeDefinition = getAttribute(attributeName);
+ Attribute attributeDefinition = attributes().getAttributeDefinition(attributeName);
if ((mode == Mode.TARGET) && (attributeDefinition.hasSplitConfigurationTransition())) {
// TODO(bazel-team): If you request a split-configured attribute in the target configuration,
// we return only the list of configured targets for the first architecture; this is for
@@ -736,7 +725,7 @@
getSplitPrerequisites(String attributeName) {
checkAttribute(attributeName, Mode.SPLIT);
- Attribute attributeDefinition = getAttribute(attributeName);
+ Attribute attributeDefinition = attributes().getAttributeDefinition(attributeName);
@SuppressWarnings("unchecked") // Attribute.java doesn't have the BuildOptions symbol.
SplitTransition<BuildOptions> transition =
(SplitTransition<BuildOptions>) attributeDefinition.getSplitTransition(rule);
@@ -873,7 +862,7 @@
*/
@Nullable
public FilesToRunProvider getExecutablePrerequisite(String attributeName, Mode mode) {
- Attribute ruleDefinition = getAttribute(attributeName);
+ Attribute ruleDefinition = attributes().getAttributeDefinition(attributeName);
if (ruleDefinition == null) {
throw new IllegalStateException(getRuleClassNameForLogging() + " attribute " + attributeName
@@ -1070,7 +1059,7 @@
}
private void checkAttribute(String attributeName, Mode mode) {
- Attribute attributeDefinition = getAttribute(attributeName);
+ Attribute attributeDefinition = attributes.getAttributeDefinition(attributeName);
if (attributeDefinition == null) {
throw new IllegalStateException(getRule().getLocation() + ": " + getRuleClassNameForLogging()
+ " attribute " + attributeName + " is not defined");
@@ -1112,7 +1101,7 @@
* This is intended for Skylark, where the Mode is implicitly chosen.
*/
public Mode getAttributeMode(String attributeName) {
- Attribute attributeDefinition = getAttribute(attributeName);
+ Attribute attributeDefinition = attributes().getAttributeDefinition(attributeName);
if (attributeDefinition == null) {
throw new IllegalStateException(getRule().getLocation() + ": " + getRuleClassNameForLogging()
+ " attribute " + attributeName + " is not defined");
