aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/query2/output/AspectResolver.java
blob: 6acdc9ea8d03f627710522562409153b1b6239ad (plain)
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
// Copyright 2014 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.devtools.build.lib.query2.output;

import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.packages.AspectDefinition;
import com.google.devtools.build.lib.packages.AspectFactory;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.NoSuchThingException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.PackageIdentifier;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.PackageProvider;
import com.google.devtools.build.lib.syntax.Label;
import com.google.devtools.build.lib.util.BinaryPredicate;

import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import javax.annotation.Nullable;

/** Utility class that determines additional dependencies of a target from its aspects. */
public class AspectResolver {
  private final PackageProvider packageProvider;
  private final EventHandler eventHandler;

  public AspectResolver(PackageProvider packageProvider, EventHandler eventHandler) {
    this.packageProvider = packageProvider;
    this.eventHandler = eventHandler;
  }

  /**
   * Compute additional dependencies of target from aspects. This method is going to load direct
   * deps of target to determine their types. Returns map of attributes and corresponding label
   * values.
   */
  Map<Attribute, Collection<Label>> computeAspectDependenciesWithAttributes(Target target)
      throws InterruptedException {
    Map<Attribute, Collection<Label>> aspectDependencies = new LinkedHashMap<>();
    if (target instanceof Rule) {
      Multimap<Attribute, Label> transitions =
          ((Rule) target).getTransitions(Rule.NO_NODEP_ATTRIBUTES);
      for (Entry<Attribute, Label> entry : transitions.entries()) {
        Target toTarget;
        try {
          toTarget = packageProvider.getTarget(eventHandler, entry.getValue());
          Map<Attribute, Collection<Label>> deps = Multimaps.asMap(
              AspectDefinition.visitAspectsIfRequired(target, entry.getKey(), toTarget));
          aspectDependencies.putAll(deps);
        } catch (NoSuchThingException e) {
          // Do nothing. One of target direct deps has an error. The dependency on the BUILD file
          // (or one of the files included in it) will be reported in the query result of :BUILD.
        }
      }
    }
    return aspectDependencies;
  }

  /**
   * Compute additional dependencies of target from aspects. This method is going to load direct
   * deps of target to determine their types. Returns set of labels.
   */
  Set<Label> computeAspectDependencies(Target target) throws InterruptedException {
    Set<Label> labels = new LinkedHashSet<Label>();
    for (Collection<Label> labelCollection :
        computeAspectDependenciesWithAttributes(target).values()) {
      labels.addAll(labelCollection);
    }
    return labels;
  }

  /** The way aspect dependencies for a BUILD file are calculated. */
  enum BuildFileDependencyMode  {

    /** Return all the subincluded files that may affect the package. */
    SUBINCLUDE {
      @Override
      protected Collection<Label> getDependencies(Package pkg) {
        return pkg.getSubincludeLabels();
      }
    },

    /** Return all Skylark files that may affect the package. */
    SKYLARK {
      @Override
      protected Collection<Label> getDependencies(Package pkg) {
        return pkg.getSkylarkFileDependencies();
      }
    };

    protected abstract Collection<Label> getDependencies(Package pkg);
  };

  Set<Label> computeBuildFileDependencies(Package pkg, BuildFileDependencyMode mode)
      throws InterruptedException {
    Set<Label> result = new LinkedHashSet<>();
    result.addAll(mode.getDependencies(pkg));

    Set<PackageIdentifier> dependentPackages = new LinkedHashSet<>();
    // First compute with packages can possibly affect the aspect attributes of this package:
    // Iterate over all rules...
    for (Target target : pkg.getTargets()) {

      if (!(target instanceof Rule)) {
        continue;
      }

      // ...figure out which direct dependencies can possibly have aspects attached to them...
      Multimap<Attribute, Label> depsWithPossibleAspects = ((Rule) target).getTransitions(
          new BinaryPredicate<Rule, Attribute>() {
            @Override
            public boolean apply(@Nullable Rule rule, @Nullable Attribute attribute) {
              for (Class<? extends AspectFactory<?, ?, ?>> aspectFactory : attribute.getAspects()) {
                if (!AspectFactory.Util.create(aspectFactory).getDefinition()
                    .getAttributes().isEmpty()) {
                  return true;
                }
              }

              return false;
            }
          });

      // ...and add the package of the aspect.
      for (Label depLabel : depsWithPossibleAspects.values()) {
        dependentPackages.add(depLabel.getPackageIdentifier());
      }
    }

    // Then add all the subinclude labels of the packages thus found to the result.
    for (PackageIdentifier packageIdentifier : dependentPackages) {
      try {
        result.add(Label.create(packageIdentifier, "BUILD"));
        Package dependentPackage = packageProvider.getPackage(eventHandler, packageIdentifier);
        result.addAll(mode.getDependencies(dependentPackage));
      } catch (NoSuchPackageException e) {
        // If the package is not found, just add its BUILD file, which is already done above.
        // Hopefully this error is not raised when there is a syntax error in a subincluded file
        // or something.
      } catch (Label.SyntaxException e) {
        throw new IllegalStateException(e);
      }
    }

    return result;
  }
}