aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTarget.java
blob: ab90da58ce4e8f6c97d33299955f8efbc7eb8b68 (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
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
// 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.analysis;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import com.google.common.collect.UnmodifiableIterator;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.config.ConfigMatchingProvider;
import com.google.devtools.build.lib.analysis.config.RunUnder;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.packages.OutputFile;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.rules.SkylarkApiProvider;

import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

/**
 * A generic implementation of RuleConfiguredTarget. Do not use directly. Use {@link
 * RuleConfiguredTargetBuilder} instead.
 */
public final class RuleConfiguredTarget extends AbstractConfiguredTarget {
  /**
   * The configuration transition for an attribute through which a prerequisite
   * is requested.
   */
  public enum Mode {
    TARGET,
    HOST,
    DATA,
    SPLIT,
    DONT_CHECK
  }

  private final ImmutableMap<Class<? extends TransitiveInfoProvider>, Object> providers;
  private final ImmutableList<Artifact> mandatoryStampFiles;
  private final Set<ConfigMatchingProvider> configConditions;
  private final ImmutableList<Aspect> aspects;

  RuleConfiguredTarget(RuleContext ruleContext,
      ImmutableList<Artifact> mandatoryStampFiles,
      ImmutableMap<String, Object> skylarkProviders,
      Map<Class<? extends TransitiveInfoProvider>, TransitiveInfoProvider> providers) {
    super(ruleContext);
    // We don't use ImmutableMap.Builder here to allow augmenting the initial list of 'default'
    // providers by passing them in.
    Map<Class<? extends TransitiveInfoProvider>, Object> providerBuilder = new LinkedHashMap<>();
    providerBuilder.putAll(providers);
    Preconditions.checkState(providerBuilder.containsKey(RunfilesProvider.class));
    Preconditions.checkState(providerBuilder.containsKey(FileProvider.class));
    Preconditions.checkState(providerBuilder.containsKey(FilesToRunProvider.class));

    // Initialize every SkylarkApiProvider
    for (Object provider : skylarkProviders.values()) {
      if (provider instanceof SkylarkApiProvider) {
        ((SkylarkApiProvider) provider).init(this);
      }
    }

    providerBuilder.put(SkylarkProviders.class, new SkylarkProviders(skylarkProviders));

    this.providers = ImmutableMap.copyOf(providerBuilder);
    this.mandatoryStampFiles = mandatoryStampFiles;
    this.configConditions = ruleContext.getConfigConditions();
    this.aspects = ImmutableList.of();

    // If this rule is the run_under target, then check that we have an executable; note that
    // run_under is only set in the target configuration, and the target must also be analyzed for
    // the target configuration.
    RunUnder runUnder = getConfiguration().getRunUnder();
    if (runUnder != null && getLabel().equals(runUnder.getLabel())) {
      if (getProvider(FilesToRunProvider.class).getExecutable() == null) {
        ruleContext.ruleError("run_under target " + runUnder.getLabel() + " is not executable");
      }
    }

    // Make sure that all declared output files are also created as artifacts. The
    // CachingAnalysisEnvironment makes sure that they all have generating actions.
    if (!ruleContext.hasErrors()) {
      for (OutputFile out : ruleContext.getRule().getOutputFiles()) {
        ruleContext.createOutputArtifact(out);
      }
    }
  }

  /**
   * Merge a configured target with its associated aspects.
   *
   * <p>If aspects are present, the configured target must be created from a rule (instead of e.g.
   * an input or an output file).
   */
  public static ConfiguredTarget mergeAspects(
      ConfiguredTarget base, Iterable<Aspect> aspects) {
    if (Iterables.isEmpty(aspects)) {
      // If there are no aspects, don't bother with creating a proxy object
      return base;
    } else {
      // Aspects can only be attached to rules for now. This invariant is upheld by
      // DependencyResolver#requiredAspects()
      return new RuleConfiguredTarget((RuleConfiguredTarget) base, aspects);
    }
  }

  /**
   * Creates an instance based on a configured target and a set of aspects.
   */
  private RuleConfiguredTarget(RuleConfiguredTarget base, Iterable<Aspect> aspects) {
    super(base.getTarget(), base.getConfiguration());

    Set<Class<? extends TransitiveInfoProvider>> providers = new HashSet<>();

    providers.addAll(base.providers.keySet());
    for (Aspect aspect : aspects) {
      for (TransitiveInfoProvider aspectProvider : aspect) {
        if (!providers.add(aspectProvider.getClass())) {
          throw new IllegalStateException(
              "Provider " + aspectProvider.getClass() + " provided twice");
        }
      }
    }
    this.providers = base.providers;
    this.mandatoryStampFiles = base.mandatoryStampFiles;
    this.configConditions = base.configConditions;
    this.aspects = ImmutableList.copyOf(aspects);
  }

  /**
   * The configuration conditions that trigger this rule's configurable attributes.
   */
  Set<ConfigMatchingProvider> getConfigConditions() {
    return configConditions;
  }

  @Override
  public <P extends TransitiveInfoProvider> P getProvider(Class<P> providerClass) {
    AnalysisUtils.checkProvider(providerClass);
    // TODO(bazel-team): Should aspects be allowed to override providers on the configured target
    // class?
    Object provider = providers.get(providerClass);
    if (provider == null) {
      for (Aspect aspect : aspects) {
        provider = aspect.getProviders().get(providerClass);
        if (provider != null) {
          break;
        }
      }
    }

    return providerClass.cast(provider);
  }

  /**
   * Returns a value provided by this target. Only meant to use from Skylark.
   */
  @Override
  public Object get(String providerKey) {
    return getProvider(SkylarkProviders.class).skylarkProviders.get(providerKey);
  }

  public ImmutableList<Artifact> getMandatoryStampFiles() {
    return mandatoryStampFiles;
  }

  @Override
  public final Rule getTarget() {
    return (Rule) super.getTarget();
  }

  /**
   * A helper class for transitive infos provided by Skylark rule implementations.
   */
  @Immutable
  public static final class SkylarkProviders implements TransitiveInfoProvider {
    private final ImmutableMap<String, Object> skylarkProviders;

    private SkylarkProviders(ImmutableMap<String, Object> skylarkProviders) {
      Preconditions.checkNotNull(skylarkProviders);
      this.skylarkProviders = skylarkProviders;
    }

    /**
     * Returns the keys for the Skylark providers.
     */
    public ImmutableCollection<String> getKeys() {
      return skylarkProviders.keySet();
    }
  }

  @Override
  public UnmodifiableIterator<TransitiveInfoProvider> iterator() {
    Map<Class<? extends TransitiveInfoProvider>, TransitiveInfoProvider> allProviders =
        new LinkedHashMap<>();
    for (int i = aspects.size() - 1; i >= 0; i++) {
      for (TransitiveInfoProvider tip : aspects.get(i)) {
        allProviders.put(tip.getClass(), tip);
      }
    }

    for (Map.Entry<Class<? extends TransitiveInfoProvider>, Object> entry : providers.entrySet()) {
      allProviders.put(entry.getKey(), entry.getKey().cast(entry.getValue()));
    }

    return ImmutableList.copyOf(allProviders.values()).iterator();
  }

  @Override
  public String errorMessage(String name) {
    return String.format("target (rule class of '%s') doesn't have provider '%s'.",
        getTarget().getRuleClass(), name);
  }

  @Override
  public ImmutableCollection<String> getKeys() {
    return ImmutableList.<String>builder().addAll(super.getKeys())
        .addAll(getProvider(SkylarkProviders.class).skylarkProviders.keySet()).build();
  }
}