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
|
// 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.cpp;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.ActionOwner;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Executor;
import com.google.devtools.build.lib.actions.ResourceSet;
import com.google.devtools.build.lib.analysis.actions.AbstractFileWriteAction;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.util.Fingerprint;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
/**
* Creates C++ module map artifact genfiles. These are then passed to Clang to
* do dependency checking.
*/
public class CppModuleMapAction extends AbstractFileWriteAction {
private static final String GUID = "4f407081-1951-40c1-befc-d6b4daff5de3";
// C++ module map of the current target
private final CppModuleMap cppModuleMap;
/**
* If set, the paths in the module map are relative to the current working directory instead
* of relative to the module map file's location.
*/
private final boolean moduleMapHomeIsCwd;
// Data required to build the actual module map.
// NOTE: If you add a field here, you'll likely need to add it to the cache key in computeKey().
private final ImmutableList<Artifact> privateHeaders;
private final ImmutableList<Artifact> publicHeaders;
private final ImmutableList<CppModuleMap> dependencies;
private final ImmutableList<PathFragment> additionalExportedHeaders;
private final boolean compiledModule;
private final boolean generateSubmodules;
public CppModuleMapAction(ActionOwner owner, CppModuleMap cppModuleMap,
Iterable<Artifact> privateHeaders, Iterable<Artifact> publicHeaders,
Iterable<CppModuleMap> dependencies, Iterable<PathFragment> additionalExportedHeaders,
boolean compiledModule, boolean moduleMapHomeIsCwd, boolean generateSubmodules) {
super(owner, ImmutableList.<Artifact>of(), cppModuleMap.getArtifact(),
/*makeExecutable=*/false);
this.cppModuleMap = cppModuleMap;
this.moduleMapHomeIsCwd = moduleMapHomeIsCwd;
this.privateHeaders = ImmutableList.copyOf(privateHeaders);
this.publicHeaders = ImmutableList.copyOf(publicHeaders);
this.dependencies = ImmutableList.copyOf(dependencies);
this.additionalExportedHeaders = ImmutableList.copyOf(additionalExportedHeaders);
this.compiledModule = compiledModule;
this.generateSubmodules = generateSubmodules;
}
@Override
public DeterministicWriter newDeterministicWriter(EventHandler eventHandler, Executor executor) {
return new DeterministicWriter() {
@Override
public void writeOutputFile(OutputStream out) throws IOException {
StringBuilder content = new StringBuilder();
PathFragment fragment = cppModuleMap.getArtifact().getExecPath();
int segmentsToExecPath = fragment.segmentCount() - 1;
// For details about the different header types, see:
// http://clang.llvm.org/docs/Modules.html#header-declaration
String leadingPeriods = moduleMapHomeIsCwd ? "" : Strings.repeat("../", segmentsToExecPath);
content.append("module \"").append(cppModuleMap.getName()).append("\" {\n");
content.append(" export *\n");
HashSet<PathFragment> deduper = new HashSet<>();
for (Artifact artifact : publicHeaders) {
appendHeader(
content, "", artifact.getExecPath(), leadingPeriods, /*canCompile=*/true, deduper);
}
for (Artifact artifact : privateHeaders) {
appendHeader(content, "private", artifact.getExecPath(), leadingPeriods,
/*canCompile=*/true, deduper);
}
for (PathFragment additionalExportedHeader : additionalExportedHeaders) {
appendHeader(
content, "", additionalExportedHeader, leadingPeriods, /*canCompile*/ false, deduper);
}
for (CppModuleMap dep : dependencies) {
content.append(" use \"").append(dep.getName()).append("\"\n");
}
content.append("}");
for (CppModuleMap dep : dependencies) {
content.append("\nextern module \"")
.append(dep.getName())
.append("\" \"")
.append(leadingPeriods)
.append(dep.getArtifact().getExecPath())
.append("\"");
}
out.write(content.toString().getBytes(StandardCharsets.ISO_8859_1));
}
};
}
private void appendHeader(StringBuilder content, String visibilitySpecifier, PathFragment path,
String leadingPeriods, boolean canCompile, HashSet<PathFragment> deduper) {
if (deduper.contains(path)) {
return;
}
deduper.add(path);
if (generateSubmodules) {
content.append(" module \"").append(path).append("\" {\n");
content.append(" export *\n ");
}
content.append(" ");
if (!visibilitySpecifier.isEmpty()) {
content.append(visibilitySpecifier).append(" ");
}
if (!canCompile || !shouldCompileHeader(path)) {
content.append("textual ");
}
content.append("header \"").append(leadingPeriods).append(path).append("\"");
if (generateSubmodules) {
content.append("\n }");
}
content.append("\n");
}
private boolean shouldCompileHeader(PathFragment path) {
return compiledModule && !CppFileTypes.CPP_TEXTUAL_INCLUDE.matches(path);
}
@Override
public String getMnemonic() {
return "CppModuleMap";
}
@Override
protected String computeKey() {
Fingerprint f = new Fingerprint();
f.addString(GUID);
f.addInt(privateHeaders.size());
for (Artifact artifact : privateHeaders) {
f.addPath(artifact.getRootRelativePath());
}
f.addInt(publicHeaders.size());
for (Artifact artifact : publicHeaders) {
f.addPath(artifact.getRootRelativePath());
}
f.addInt(dependencies.size());
for (CppModuleMap dep : dependencies) {
f.addPath(dep.getArtifact().getExecPath());
}
f.addInt(additionalExportedHeaders.size());
for (PathFragment path : additionalExportedHeaders) {
f.addPath(path);
}
f.addPath(cppModuleMap.getArtifact().getExecPath());
f.addString(cppModuleMap.getName());
f.addBoolean(moduleMapHomeIsCwd);
f.addBoolean(compiledModule);
f.addBoolean(generateSubmodules);
return f.hexDigestAndReset();
}
@Override
public ResourceSet estimateResourceConsumptionLocal() {
return ResourceSet.createWithRamCpuIo(/*memoryMb=*/0, /*cpuUsage=*/0, /*ioUsage=*/0.02);
}
@VisibleForTesting
public Collection<Artifact> getPublicHeaders() {
return publicHeaders;
}
@VisibleForTesting
public Collection<Artifact> getPrivateHeaders() {
return privateHeaders;
}
@VisibleForTesting
public ImmutableList<PathFragment> getAdditionalExportedHeaders() {
return additionalExportedHeaders;
}
@VisibleForTesting
public Collection<Artifact> getDependencyArtifacts() {
List<Artifact> artifacts = new ArrayList<>();
for (CppModuleMap map : dependencies) {
artifacts.add(map.getArtifact());
}
return artifacts;
}
}
|
