/
ConfiguredTargetFactory.java
710 lines (671 loc) · 33.4 KB
/
ConfiguredTargetFactory.java
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
// 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.analysis;
import static java.util.stream.Collectors.joining;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Verify;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Artifact.SourceArtifact;
import com.google.devtools.build.lib.actions.ArtifactFactory;
import com.google.devtools.build.lib.actions.FailAction;
import com.google.devtools.build.lib.actions.MutableActionGraph.ActionConflictException;
import com.google.devtools.build.lib.analysis.ExecGroupCollection.InvalidExecGroupException;
import com.google.devtools.build.lib.analysis.config.BuildConfigurationValue;
import com.google.devtools.build.lib.analysis.config.ConfigConditions;
import com.google.devtools.build.lib.analysis.config.Fragment;
import com.google.devtools.build.lib.analysis.config.RequiredFragmentsUtil;
import com.google.devtools.build.lib.analysis.configuredtargets.EnvironmentGroupConfiguredTarget;
import com.google.devtools.build.lib.analysis.configuredtargets.InputFileConfiguredTarget;
import com.google.devtools.build.lib.analysis.configuredtargets.OutputFileConfiguredTarget;
import com.google.devtools.build.lib.analysis.configuredtargets.PackageGroupConfiguredTarget;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget;
import com.google.devtools.build.lib.analysis.starlark.StarlarkRuleConfiguredTargetUtil;
import com.google.devtools.build.lib.analysis.test.AnalysisFailure;
import com.google.devtools.build.lib.analysis.test.AnalysisFailureInfo;
import com.google.devtools.build.lib.analysis.test.AnalysisFailurePropagationException;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.packages.AdvertisedProviderSet;
import com.google.devtools.build.lib.packages.Aspect;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.ConfigurationFragmentPolicy;
import com.google.devtools.build.lib.packages.ConfigurationFragmentPolicy.MissingFragmentPolicy;
import com.google.devtools.build.lib.packages.ConstantRuleVisibility;
import com.google.devtools.build.lib.packages.EnvironmentGroup;
import com.google.devtools.build.lib.packages.InputFile;
import com.google.devtools.build.lib.packages.OutputFile;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.PackageGroup;
import com.google.devtools.build.lib.packages.PackageGroupsRuleVisibility;
import com.google.devtools.build.lib.packages.PackageSpecification;
import com.google.devtools.build.lib.packages.PackageSpecification.PackageGroupContents;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.packages.RuleVisibility;
import com.google.devtools.build.lib.packages.StarlarkProviderIdentifier;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.packages.semantics.BuildLanguageOptions;
import com.google.devtools.build.lib.profiler.memory.CurrentRuleTracker;
import com.google.devtools.build.lib.server.FailureDetails.FailAction.Code;
import com.google.devtools.build.lib.skyframe.AspectKeyCreator;
import com.google.devtools.build.lib.skyframe.ConfiguredTargetAndData;
import com.google.devtools.build.lib.skyframe.ConfiguredTargetKey;
import com.google.devtools.build.lib.util.OrderedSetMultimap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import javax.annotation.Nullable;
import net.starlark.java.eval.Mutability;
/**
* This class creates {@link ConfiguredTarget} instances using a given {@link
* ConfiguredRuleClassProvider}.
*/
@ThreadSafe
public final class ConfiguredTargetFactory {
// This class is not meant to be outside of the analysis phase machinery and is only public
// in order to be accessible from the .view.skyframe package.
private final ConfiguredRuleClassProvider ruleClassProvider;
public ConfiguredTargetFactory(ConfiguredRuleClassProvider ruleClassProvider) {
this.ruleClassProvider = ruleClassProvider;
}
/**
* Returns the visibility of the given target. Errors during package group resolution are reported
* to the {@code AnalysisEnvironment}.
*/
private static NestedSet<PackageGroupContents> convertVisibility(
OrderedSetMultimap<DependencyKind, ConfiguredTargetAndData> prerequisiteMap,
EventHandler reporter,
Target target) {
RuleVisibility ruleVisibility = target.getVisibility();
if (ruleVisibility instanceof ConstantRuleVisibility) {
return ((ConstantRuleVisibility) ruleVisibility).isPubliclyVisible()
? NestedSetBuilder.create(
Order.STABLE_ORDER,
PackageGroupContents.create(ImmutableList.of(PackageSpecification.everything())))
: NestedSetBuilder.emptySet(Order.STABLE_ORDER);
} else if (ruleVisibility instanceof PackageGroupsRuleVisibility) {
PackageGroupsRuleVisibility packageGroupsVisibility =
(PackageGroupsRuleVisibility) ruleVisibility;
NestedSetBuilder<PackageGroupContents> result = NestedSetBuilder.stableOrder();
for (Label groupLabel : packageGroupsVisibility.getPackageGroups()) {
// PackageGroupsConfiguredTargets are always in the package-group configuration.
TransitiveInfoCollection group = findVisibilityPrerequisite(prerequisiteMap, groupLabel);
PackageSpecificationProvider provider = null;
// group == null can only happen if the package group list comes
// from a default_visibility attribute, because in every other case,
// this missing link is caught during transitive closure visitation or
// if the RuleConfiguredTargetGraph threw out a visibility edge
// because if would have caused a cycle. The filtering should be done
// in a single place, ConfiguredTargetGraph, but for now, this is the
// minimally invasive way of providing a sane error message in case a
// cycle is created by a visibility attribute.
if (group != null) {
provider = group.get(PackageGroupConfiguredTarget.PROVIDER);
}
if (provider != null) {
result.addTransitive(provider.getPackageSpecifications());
} else {
reporter.handle(Event.error(target.getLocation(),
String.format("Label '%s' does not refer to a package group", groupLabel)));
}
}
result.add(packageGroupsVisibility.getDirectPackages());
return result.build();
} else {
throw new IllegalStateException("unknown visibility");
}
}
@Nullable
private static TransitiveInfoCollection findVisibilityPrerequisite(
OrderedSetMultimap<DependencyKind, ConfiguredTargetAndData> prerequisiteMap, Label label) {
for (ConfiguredTargetAndData prerequisite :
prerequisiteMap.get(DependencyKind.VISIBILITY_DEPENDENCY)) {
if (prerequisite.getTarget().getLabel().equals(label)
&& prerequisite.getConfiguration() == null) {
return prerequisite.getConfiguredTarget();
}
}
return null;
}
/**
* Invokes the appropriate constructor to create a {@link ConfiguredTarget} instance.
*
* <p>For use in {@code ConfiguredTargetFunction}.
*
* <p>Returns null if Skyframe deps are missing or upon certain errors.
*/
@Nullable
public ConfiguredTarget createConfiguredTarget(
AnalysisEnvironment analysisEnvironment,
ArtifactFactory artifactFactory,
Target target,
BuildConfigurationValue config,
BuildConfigurationValue hostConfig,
ConfiguredTargetKey configuredTargetKey,
OrderedSetMultimap<DependencyKind, ConfiguredTargetAndData> prerequisiteMap,
ConfigConditions configConditions,
@Nullable ToolchainCollection<ResolvedToolchainContext> toolchainContexts,
@Nullable NestedSet<Package> transitivePackages,
ExecGroupCollection.Builder execGroupCollectionBuilder)
throws InterruptedException, ActionConflictException, InvalidExecGroupException,
AnalysisFailurePropagationException {
if (target instanceof Rule) {
try {
CurrentRuleTracker.beginConfiguredTarget(((Rule) target).getRuleClassObject());
return createRule(
analysisEnvironment,
(Rule) target,
config,
hostConfig,
configuredTargetKey,
prerequisiteMap,
configConditions,
toolchainContexts,
transitivePackages,
execGroupCollectionBuilder);
} finally {
CurrentRuleTracker.endConfiguredTarget();
}
}
// Visibility, like all package groups, doesn't have a configuration
NestedSet<PackageGroupContents> visibility =
convertVisibility(prerequisiteMap, analysisEnvironment.getEventHandler(), target);
if (target instanceof OutputFile) {
OutputFile outputFile = (OutputFile) target;
TargetContext targetContext =
new TargetContext(
analysisEnvironment,
target,
config,
prerequisiteMap.get(DependencyKind.OUTPUT_FILE_RULE_DEPENDENCY),
visibility);
if (analysisEnvironment.getSkyframeEnv().valuesMissing()) {
return null;
}
Label ruleLabel = outputFile.getGeneratingRule().getLabel();
RuleConfiguredTarget rule =
(RuleConfiguredTarget)
targetContext.findDirectPrerequisite(
ruleLabel,
// Don't pass a specific configuration, as we don't care what configuration the
// generating rule is in. There can only be one actual dependency here, which is
// the target that generated the output file.
Optional.empty());
Verify.verifyNotNull(
rule, "While analyzing %s, missing generating rule %s", outputFile, ruleLabel);
// If analysis failures are allowed and the generating rule has failure info, just propagate
// it. The output artifact won't exist, so we can't create an OutputFileConfiguredTarget.
if (config.allowAnalysisFailures()
&& rule.get(AnalysisFailureInfo.STARLARK_CONSTRUCTOR.getKey()) != null) {
return rule;
}
Artifact artifact = rule.getArtifactByOutputLabel(outputFile.getLabel());
return new OutputFileConfiguredTarget(targetContext, outputFile, rule, artifact);
} else if (target instanceof InputFile) {
InputFile inputFile = (InputFile) target;
TargetContext targetContext =
new TargetContext(
analysisEnvironment,
target,
config,
prerequisiteMap.get(DependencyKind.OUTPUT_FILE_RULE_DEPENDENCY),
visibility);
SourceArtifact artifact =
artifactFactory.getSourceArtifact(
inputFile.getExecPath(
analysisEnvironment
.getStarlarkSemantics()
.getBool(BuildLanguageOptions.EXPERIMENTAL_SIBLING_REPOSITORY_LAYOUT)),
inputFile.getPackage().getSourceRoot().get(),
ConfiguredTargetKey.builder()
.setLabel(target.getLabel())
.setConfiguration(config)
.build());
return new InputFileConfiguredTarget(targetContext, inputFile, artifact);
} else if (target instanceof PackageGroup) {
PackageGroup packageGroup = (PackageGroup) target;
TargetContext targetContext =
new TargetContext(
analysisEnvironment,
target,
config,
prerequisiteMap.get(DependencyKind.VISIBILITY_DEPENDENCY),
visibility);
return new PackageGroupConfiguredTarget(targetContext, packageGroup);
} else if (target instanceof EnvironmentGroup) {
TargetContext targetContext =
new TargetContext(analysisEnvironment, target, config, ImmutableSet.of(), visibility);
return new EnvironmentGroupConfiguredTarget(targetContext);
} else {
throw new AssertionError("Unexpected target class: " + target.getClass().getName());
}
}
/**
* Factory method: constructs a RuleConfiguredTarget of the appropriate class, based on the rule
* class. May return null if an error occurred.
*/
@Nullable
private ConfiguredTarget createRule(
AnalysisEnvironment env,
Rule rule,
BuildConfigurationValue configuration,
BuildConfigurationValue hostConfiguration,
ConfiguredTargetKey configuredTargetKey,
OrderedSetMultimap<DependencyKind, ConfiguredTargetAndData> prerequisiteMap,
ConfigConditions configConditions,
@Nullable ToolchainCollection<ResolvedToolchainContext> toolchainContexts,
@Nullable NestedSet<Package> transitivePackages,
ExecGroupCollection.Builder execGroupCollectionBuilder)
throws InterruptedException, ActionConflictException, InvalidExecGroupException,
AnalysisFailurePropagationException {
RuleClass ruleClass = rule.getRuleClassObject();
ConfigurationFragmentPolicy configurationFragmentPolicy =
ruleClass.getConfigurationFragmentPolicy();
// Visibility computation and checking is done for every rule.
RuleContext ruleContext =
new RuleContext.Builder(env, rule, /*aspects=*/ ImmutableList.of(), configuration)
.setRuleClassProvider(ruleClassProvider)
.setHostConfiguration(hostConfiguration)
.setConfigurationFragmentPolicy(configurationFragmentPolicy)
.setActionOwnerSymbol(configuredTargetKey)
.setMutability(Mutability.create("configured target"))
.setVisibility(convertVisibility(prerequisiteMap, env.getEventHandler(), rule))
.setPrerequisites(transformPrerequisiteMap(prerequisiteMap))
.setConfigConditions(configConditions)
.setToolchainContexts(toolchainContexts)
.setExecGroupCollectionBuilder(execGroupCollectionBuilder)
.setRequiredConfigFragments(
RequiredFragmentsUtil.getRuleRequiredFragmentsIfEnabled(
rule,
configuration,
ruleClassProvider.getFragmentRegistry().getUniversalFragments(),
configConditions,
prerequisiteMap.values()))
.setTransitivePackagesForRunfileRepoMappingManifest(transitivePackages)
.build();
List<NestedSet<AnalysisFailure>> analysisFailures =
depAnalysisFailures(ruleContext, ImmutableList.of());
if (!analysisFailures.isEmpty()) {
return erroredConfiguredTargetWithFailures(ruleContext, analysisFailures);
}
if (ruleContext.hasErrors()) {
return erroredConfiguredTarget(ruleContext);
}
try {
Class<?> missingFragmentClass = null;
for (Class<? extends Fragment> fragmentClass :
configurationFragmentPolicy.getRequiredConfigurationFragments()) {
if (!configuration.hasFragment(fragmentClass)) {
MissingFragmentPolicy missingFragmentPolicy =
configurationFragmentPolicy.getMissingFragmentPolicy(fragmentClass);
if (missingFragmentPolicy != MissingFragmentPolicy.IGNORE) {
if (missingFragmentPolicy == MissingFragmentPolicy.FAIL_ANALYSIS) {
ruleContext.ruleError(
missingFragmentError(
ruleContext, configurationFragmentPolicy, configuration.checksum()));
return null;
}
// Otherwise missingFragmentPolicy == MissingFragmentPolicy.CREATE_FAIL_ACTIONS:
missingFragmentClass = fragmentClass;
}
}
}
if (missingFragmentClass != null) {
return createFailConfiguredTargetForMissingFragmentClass(ruleContext, missingFragmentClass);
}
try {
ConfiguredTarget target;
if (ruleClass.isStarlark()) {
// TODO(bazel-team): maybe merge with RuleConfiguredTargetBuilder?
target =
StarlarkRuleConfiguredTargetUtil.buildRule(
ruleContext, ruleClass.getAdvertisedProviders());
} else {
target =
Preconditions.checkNotNull(
ruleClass.getConfiguredTargetFactory(RuleConfiguredTargetFactory.class),
"No configured target factory for %s",
ruleClass)
.create(ruleContext);
}
return target != null ? target : erroredConfiguredTarget(ruleContext);
} finally {
ruleContext.close();
}
} catch (RuleErrorException ruleErrorException) {
return erroredConfiguredTarget(ruleContext);
}
}
/**
* If {@code --allow_analysis_failures} is true, returns a collection of propagated analysis
* failures from the target's dependencies and {@code extraDeps} -- one NestedSet per dep with
* failures to propagate. Otherwise if {@code --allow_analysis_failures} is false, returns the
* empty set.
*/
private static ImmutableList<NestedSet<AnalysisFailure>> depAnalysisFailures(
RuleContext ruleContext, Iterable<? extends TransitiveInfoCollection> extraDeps) {
if (ruleContext.getConfiguration().allowAnalysisFailures()) {
ImmutableList.Builder<NestedSet<AnalysisFailure>> analysisFailures = ImmutableList.builder();
Iterable<? extends TransitiveInfoCollection> infoCollections =
Iterables.concat(ruleContext.getConfiguredTargetMap().values(), extraDeps);
for (TransitiveInfoCollection infoCollection : infoCollections) {
AnalysisFailureInfo failureInfo =
infoCollection.get(AnalysisFailureInfo.STARLARK_CONSTRUCTOR);
if (failureInfo != null) {
analysisFailures.add(failureInfo.getCausesNestedSet());
}
}
return analysisFailures.build();
}
// Analysis failures are only created and propagated if --allow_analysis_failures is
// enabled, otherwise these result in actual rule errors which are not caught.
return ImmutableList.of();
}
private static ConfiguredTarget erroredConfiguredTargetWithFailures(
RuleContext ruleContext, List<NestedSet<AnalysisFailure>> analysisFailures)
throws ActionConflictException, InterruptedException, AnalysisFailurePropagationException {
RuleConfiguredTargetBuilder builder = new RuleConfiguredTargetBuilder(ruleContext);
builder.addNativeDeclaredProvider(AnalysisFailureInfo.forAnalysisFailureSets(analysisFailures));
builder.addProvider(RunfilesProvider.class, RunfilesProvider.simple(Runfiles.EMPTY));
ConfiguredTarget configuredTarget = builder.build();
if (configuredTarget == null) {
// A failure here is a failure in analysis failure testing machinery, not a "normal" analysis
// failure that some outer analysis failure test may want to capture. Instead, this failure
// means that the outer test would be unusable. So we throw an exception rather than returning
// null and allowing it to propagate up in the usual way.
throw new AnalysisFailurePropagationException(
ruleContext.getLabel(), ruleContext.getSuppressedErrorMessages());
}
return configuredTarget;
}
/**
* Returns a {@link ConfiguredTarget} which indicates that an analysis error occurred in
* processing the target. In most cases, this returns null, which signals to callers that the
* target failed to build and thus the build should fail. However, if analysis failures are
* allowed in this build, this returns a stub {@link ConfiguredTarget} which contains information
* about the failure.
*/
@Nullable
private static ConfiguredTarget erroredConfiguredTarget(RuleContext ruleContext)
throws ActionConflictException, InterruptedException, AnalysisFailurePropagationException {
if (ruleContext.getConfiguration().allowAnalysisFailures()) {
ImmutableList.Builder<AnalysisFailure> analysisFailures = ImmutableList.builder();
for (String errorMessage : ruleContext.getSuppressedErrorMessages()) {
analysisFailures.add(new AnalysisFailure(ruleContext.getLabel(), errorMessage));
}
RuleConfiguredTargetBuilder builder = new RuleConfiguredTargetBuilder(ruleContext);
builder.addNativeDeclaredProvider(
AnalysisFailureInfo.forAnalysisFailures(analysisFailures.build()));
builder.addProvider(RunfilesProvider.class, RunfilesProvider.simple(Runfiles.EMPTY));
ConfiguredTarget configuredTarget = builder.build();
if (configuredTarget == null) {
// See comment in erroredConfiguredTargetWithFailures.
throw new AnalysisFailurePropagationException(
ruleContext.getLabel(), ruleContext.getSuppressedErrorMessages());
}
return configuredTarget;
} else {
// Returning a null ConfiguredTarget is an indication a rule error occurred. Exceptions are
// not propagated, as this would show a nasty stack trace to users, and only provide info
// on one specific failure with poor messaging. By returning null, the caller can
// inspect ruleContext for multiple errors and output thorough messaging on each.
return null;
}
}
private static String missingFragmentError(
RuleContext ruleContext,
ConfigurationFragmentPolicy configurationFragmentPolicy,
String configurationId) {
RuleClass ruleClass = ruleContext.getRule().getRuleClassObject();
Set<Class<?>> missingFragments = new LinkedHashSet<>();
for (Class<? extends Fragment> fragment :
configurationFragmentPolicy.getRequiredConfigurationFragments()) {
if (!ruleContext.getConfiguration().hasFragment(fragment)) {
missingFragments.add(fragment);
}
}
Preconditions.checkState(!missingFragments.isEmpty());
return "all rules of type "
+ ruleClass.getName()
+ " require the presence of all of ["
+ missingFragments.stream().map(Class::getSimpleName).collect(joining(","))
+ "], but these were all disabled in configuration "
+ configurationId;
}
@VisibleForTesting
public static OrderedSetMultimap<Attribute, ConfiguredTargetAndData> transformPrerequisiteMap(
OrderedSetMultimap<DependencyKind, ConfiguredTargetAndData> map) {
OrderedSetMultimap<Attribute, ConfiguredTargetAndData> result = OrderedSetMultimap.create();
for (Map.Entry<DependencyKind, ConfiguredTargetAndData> entry : map.entries()) {
if (DependencyKind.isToolchain(entry.getKey())) {
continue;
}
Attribute attribute = entry.getKey().getAttribute();
result.put(attribute, entry.getValue());
}
return result;
}
/**
* Constructs a {@link ConfiguredAspect}. Returns null if an error occurs; in that case, {@code
* aspectFactory} should call one of the error reporting methods of {@link RuleContext}.
*/
public ConfiguredAspect createAspect(
AnalysisEnvironment env,
ConfiguredTargetAndData associatedTarget,
ImmutableList<Aspect> aspectPath,
ConfiguredAspectFactory aspectFactory,
Aspect aspect,
OrderedSetMultimap<DependencyKind, ConfiguredTargetAndData> prerequisiteMap,
ConfigConditions configConditions,
@Nullable ToolchainCollection<ResolvedToolchainContext> toolchainContexts,
@Nullable ExecGroupCollection.Builder execGroupCollectionBuilder,
BuildConfigurationValue aspectConfiguration,
BuildConfigurationValue hostConfiguration,
@Nullable NestedSet<Package> transitivePackages,
AspectKeyCreator.AspectKey aspectKey)
throws InterruptedException, ActionConflictException, InvalidExecGroupException {
RuleContext ruleContext =
new RuleContext.Builder(env, associatedTarget.getTarget(), aspectPath, aspectConfiguration)
.setRuleClassProvider(ruleClassProvider)
.setHostConfiguration(hostConfiguration)
.setConfigurationFragmentPolicy(aspect.getDefinition().getConfigurationFragmentPolicy())
.setActionOwnerSymbol(aspectKey)
.setMutability(Mutability.create("aspect"))
.setVisibility(
convertVisibility(
prerequisiteMap, env.getEventHandler(), associatedTarget.getTarget()))
.setPrerequisites(transformPrerequisiteMap(prerequisiteMap))
.setAspectAttributes(mergeAspectAttributes(aspectPath))
.setConfigConditions(configConditions)
.setToolchainContexts(toolchainContexts)
.setExecGroupCollectionBuilder(execGroupCollectionBuilder)
.setExecProperties(ImmutableMap.of())
.setRequiredConfigFragments(
RequiredFragmentsUtil.getAspectRequiredFragmentsIfEnabled(
aspect,
aspectFactory,
associatedTarget.getTarget().getAssociatedRule(),
aspectConfiguration,
ruleClassProvider.getFragmentRegistry().getUniversalFragments(),
configConditions,
Iterables.concat(prerequisiteMap.values(), ImmutableList.of(associatedTarget))))
.setTransitivePackagesForRunfileRepoMappingManifest(transitivePackages)
.build();
// If allowing analysis failures, targets should be created as normal as possible, and errors
// will be propagated via a hook elsewhere as AnalysisFailureInfo.
boolean allowAnalysisFailures = ruleContext.getConfiguration().allowAnalysisFailures();
List<NestedSet<AnalysisFailure>> analysisFailures =
depAnalysisFailures(ruleContext, ImmutableList.of(associatedTarget.getConfiguredTarget()));
if (!analysisFailures.isEmpty()) {
return erroredConfiguredAspectWithFailures(ruleContext, analysisFailures);
}
if (ruleContext.hasErrors() && !allowAnalysisFailures) {
return erroredConfiguredAspect(ruleContext);
}
ConfiguredAspect configuredAspect;
try {
configuredAspect =
aspectFactory.create(
associatedTarget,
ruleContext,
aspect.getParameters(),
ruleClassProvider.getToolsRepository());
if (configuredAspect == null) {
return erroredConfiguredAspect(ruleContext);
}
} finally {
ruleContext.close();
}
validateAdvertisedProviders(
configuredAspect,
aspectKey,
aspect.getDefinition().getAdvertisedProviders(),
associatedTarget.getTarget(),
env.getEventHandler());
return configuredAspect;
}
private static ConfiguredAspect erroredConfiguredAspectWithFailures(
RuleContext ruleContext, List<NestedSet<AnalysisFailure>> analysisFailures)
throws ActionConflictException, InterruptedException {
ConfiguredAspect.Builder builder = new ConfiguredAspect.Builder(ruleContext);
builder.addNativeDeclaredProvider(AnalysisFailureInfo.forAnalysisFailureSets(analysisFailures));
// Unlike erroredConfiguredTargetAspectWithFailures, we do not add a RunfilesProvider; that
// would result in a RunfilesProvider being provided twice in the merged configured target.
// TODO(b/242887801): builder.build() could potentially return null; in that case, should we
// throw an exception, as erroredConfiguredTarget does, to avoid propagating the error to an
// outer analysis failure test?
return builder.build();
}
/**
* Returns a {@link ConfiguredAspect} which indicates that an analysis error occurred in
* processing the aspect. In most cases, this returns null, which signals to callers that the
* target failed to build and thus the build should fail. However, if analysis failures are
* allowed in this build, this returns a stub {@link ConfiguredAspect} which contains information
* about the failure.
*/
@Nullable
private static ConfiguredAspect erroredConfiguredAspect(RuleContext ruleContext)
throws ActionConflictException, InterruptedException {
if (ruleContext.getConfiguration().allowAnalysisFailures()) {
ImmutableList.Builder<AnalysisFailure> analysisFailures = ImmutableList.builder();
for (String errorMessage : ruleContext.getSuppressedErrorMessages()) {
analysisFailures.add(new AnalysisFailure(ruleContext.getLabel(), errorMessage));
}
ConfiguredAspect.Builder builder = new ConfiguredAspect.Builder(ruleContext);
builder.addNativeDeclaredProvider(
AnalysisFailureInfo.forAnalysisFailures(analysisFailures.build()));
// Unlike erroredConfiguredTarget, we do not add a RunfilesProvider; that would result in a
// RunfilesProvider being provided twice in the merged configured target.
// TODO(b/242887801): builder.build() could potentially return null; in that case, should we
// throw an exception, as erroredConfiguredTarget does, to avoid propagating the error to an
// outer analysis failure test?
return builder.build();
} else {
// Returning a null ConfiguredAspect is an indication a rule error occurred. Exceptions are
// not propagated, as this would show a nasty stack trace to users, and only provide info
// on one specific failure with poor messaging. By returning null, the caller can
// inspect ruleContext for multiple errors and output thorough messaging on each.
return null;
}
}
private static ImmutableMap<String, Attribute> mergeAspectAttributes(
ImmutableList<Aspect> aspectPath) {
if (aspectPath.isEmpty()) {
return ImmutableMap.of();
} else if (aspectPath.size() == 1) {
return aspectPath.get(0).getDefinition().getAttributes();
} else {
LinkedHashMap<String, Attribute> aspectAttributes = new LinkedHashMap<>();
for (Aspect underlyingAspect : aspectPath) {
ImmutableMap<String, Attribute> currentAttributes = underlyingAspect.getDefinition()
.getAttributes();
for (Map.Entry<String, Attribute> kv : currentAttributes.entrySet()) {
if (!aspectAttributes.containsKey(kv.getKey())) {
aspectAttributes.put(kv.getKey(), kv.getValue());
}
}
}
return ImmutableMap.copyOf(aspectAttributes);
}
}
private static void validateAdvertisedProviders(
ConfiguredAspect configuredAspect,
AspectKeyCreator.AspectKey aspectKey,
AdvertisedProviderSet advertisedProviders,
Target target,
EventHandler eventHandler) {
if (advertisedProviders.canHaveAnyProvider()) {
return;
}
for (Class<?> aClass : advertisedProviders.getBuiltinProviders()) {
if (configuredAspect.getProvider(aClass.asSubclass(TransitiveInfoProvider.class)) == null) {
eventHandler.handle(
Event.error(
target.getLocation(),
String.format(
"Aspect '%s', applied to '%s', does not provide advertised provider '%s'",
aspectKey.getAspectClass().getName(),
target.getLabel(),
aClass.getSimpleName())));
}
}
for (StarlarkProviderIdentifier providerId : advertisedProviders.getStarlarkProviders()) {
if (configuredAspect.get(providerId) == null) {
eventHandler.handle(
Event.error(
target.getLocation(),
String.format(
"Aspect '%s', applied to '%s', does not provide advertised provider '%s'",
aspectKey.getAspectClass().getName(), target.getLabel(), providerId)));
}
}
}
/**
* A pseudo-implementation for configured targets that creates fail actions for all declared
* outputs, both implicit and explicit, due to a missing fragment class.
*/
private static ConfiguredTarget createFailConfiguredTargetForMissingFragmentClass(
RuleContext ruleContext, Class<?> missingFragmentClass) throws InterruptedException {
RuleConfiguredTargetBuilder builder = new RuleConfiguredTargetBuilder(ruleContext);
if (!ruleContext.getOutputArtifacts().isEmpty()) {
ruleContext.registerAction(
new FailAction(
ruleContext.getActionOwner(),
ruleContext.getOutputArtifacts(),
"Missing fragment class: " + missingFragmentClass.getName(),
Code.FRAGMENT_CLASS_MISSING));
}
builder.addProvider(RunfilesProvider.class, RunfilesProvider.simple(Runfiles.EMPTY));
try {
return builder.build();
} catch (ActionConflictException e) {
throw new IllegalStateException(
"Can't have an action conflict with one action: " + ruleContext.getLabel(), e);
}
}
}