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
|
// 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.filegroup;
import static com.google.devtools.build.lib.analysis.OutputGroupInfo.INTERNAL_SUFFIX;
import com.google.devtools.build.lib.actions.Actions;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.MutableActionGraph.ActionConflictException;
import com.google.devtools.build.lib.analysis.CompilationHelper;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.MiddlemanProvider;
import com.google.devtools.build.lib.analysis.OutputGroupInfo;
import com.google.devtools.build.lib.analysis.PrerequisiteArtifacts;
import com.google.devtools.build.lib.analysis.RuleConfiguredTargetBuilder;
import com.google.devtools.build.lib.analysis.RuleConfiguredTargetFactory;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.Runfiles;
import com.google.devtools.build.lib.analysis.RunfilesProvider;
import com.google.devtools.build.lib.analysis.TransitiveInfoCollection;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.analysis.test.InstrumentedFilesCollector;
import com.google.devtools.build.lib.analysis.test.InstrumentedFilesCollector.InstrumentationSpec;
import com.google.devtools.build.lib.analysis.test.InstrumentedFilesProvider;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.FileTypeSet;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.Iterator;
import java.util.List;
/**
* ConfiguredTarget for "filegroup".
*/
public class Filegroup implements RuleConfiguredTargetFactory {
/** Error message for output groups that are explicitly blacklisted for filegroup reference. */
public static final String ILLEGAL_OUTPUT_GROUP_ERROR =
"Output group %s is not permitted for " + "reference in filegroups.";
@Override
public ConfiguredTarget create(RuleContext ruleContext)
throws InterruptedException, RuleErrorException, ActionConflictException {
String outputGroupName = ruleContext.attributes().get("output_group", Type.STRING);
if (outputGroupName.endsWith(INTERNAL_SUFFIX)) {
ruleContext.throwWithAttributeError(
"output_group", String.format(ILLEGAL_OUTPUT_GROUP_ERROR, outputGroupName));
}
NestedSet<Artifact> filesToBuild =
outputGroupName.isEmpty()
? PrerequisiteArtifacts.nestedSet(ruleContext, "srcs", Mode.TARGET)
: getArtifactsForOutputGroup(
outputGroupName, ruleContext.getPrerequisites("srcs", Mode.TARGET));
NestedSet<Artifact> middleman =
CompilationHelper.getAggregatingMiddleman(
ruleContext, Actions.escapeLabel(ruleContext.getLabel()), filesToBuild);
InstrumentedFilesProvider instrumentedFilesProvider =
InstrumentedFilesCollector.collect(ruleContext,
// what do *we* know about whether this is a source file or not
new InstrumentationSpec(FileTypeSet.ANY_FILE, "srcs", "deps", "data"),
InstrumentedFilesCollector.NO_METADATA_COLLECTOR, filesToBuild);
RunfilesProvider runfilesProvider = RunfilesProvider.withData(
new Runfiles.Builder(
ruleContext.getWorkspaceName(),
ruleContext.getConfiguration().legacyExternalRunfiles())
.addRunfiles(ruleContext, RunfilesProvider.DEFAULT_RUNFILES)
.build(),
// If you're visiting a filegroup as data, then we also visit its data as data.
new Runfiles.Builder(
ruleContext.getWorkspaceName(),
ruleContext.getConfiguration().legacyExternalRunfiles())
.addTransitiveArtifacts(filesToBuild)
.addDataDeps(ruleContext).build());
return new RuleConfiguredTargetBuilder(ruleContext)
.add(RunfilesProvider.class, runfilesProvider)
.setFilesToBuild(filesToBuild)
.setRunfilesSupport(null, getExecutable(filesToBuild))
.add(InstrumentedFilesProvider.class, instrumentedFilesProvider)
.add(MiddlemanProvider.class, new MiddlemanProvider(middleman))
.add(FilegroupPathProvider.class,
new FilegroupPathProvider(getFilegroupPath(ruleContext)))
.build();
}
/**
* Returns the single Artifact from filesToBuild or {@code null} if there are multiple elements.
*/
private Artifact getExecutable(NestedSet<Artifact> filesToBuild) {
Iterator<Artifact> it = filesToBuild.iterator();
if (it.hasNext()) {
Artifact out = it.next();
if (!it.hasNext()) {
return out;
}
}
return null;
}
private PathFragment getFilegroupPath(RuleContext ruleContext) {
String attr = ruleContext.attributes().get("path", Type.STRING);
if (attr.isEmpty()) {
return PathFragment.EMPTY_FRAGMENT;
} else {
return ruleContext.getLabel().getPackageIdentifier().getSourceRoot().getRelative(attr);
}
}
/** Returns the artifacts from the given targets that are members of the given output group. */
private static NestedSet<Artifact> getArtifactsForOutputGroup(
String outputGroupName, List<? extends TransitiveInfoCollection> deps) {
NestedSetBuilder<Artifact> result = NestedSetBuilder.stableOrder();
for (TransitiveInfoCollection dep : deps) {
OutputGroupInfo outputGroupInfo = OutputGroupInfo.get(dep);
if (outputGroupInfo != null) {
result.addTransitive(outputGroupInfo.getOutputGroup(outputGroupName));
}
}
return result.build();
}
}
|
