blob: d08cef1a1563342ca6920c33d37d451bb16b2c03 [file] [log] [blame]
Chandler Carruth55fc8732012-12-04 09:13:33 +00001//===--- Module.cpp - Describe a module -----------------------------------===//
Douglas Gregor1a4761e2011-11-30 23:21:26 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the Module class, which describes a module in the source
11// code.
12//
13//===----------------------------------------------------------------------===//
Richard Smith5794b532013-10-28 22:18:19 +000014
Douglas Gregor1a4761e2011-11-30 23:21:26 +000015#include "clang/Basic/Module.h"
16#include "clang/Basic/FileManager.h"
Douglas Gregor51f564f2011-12-31 04:05:44 +000017#include "clang/Basic/LangOptions.h"
Douglas Gregore727d212012-01-30 06:38:25 +000018#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisc1d22392013-03-13 21:13:43 +000019#include "llvm/ADT/ArrayRef.h"
Douglas Gregor51f564f2011-12-31 04:05:44 +000020#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/StringSwitch.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000022#include "llvm/Support/ErrorHandling.h"
23#include "llvm/Support/raw_ostream.h"
Richard Smith5794b532013-10-28 22:18:19 +000024
Douglas Gregor1a4761e2011-11-30 23:21:26 +000025using namespace clang;
26
Douglas Gregorb7a78192012-01-04 23:32:19 +000027Module::Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent,
28 bool IsFramework, bool IsExplicit)
Argyrios Kyrtzidise2ac16b2012-09-29 01:06:04 +000029 : Name(Name), DefinitionLoc(DefinitionLoc), Parent(Parent),
30 Umbrella(), ASTFile(0), IsAvailable(true), IsFromModuleFile(false),
Douglas Gregora1f1fad2012-01-27 19:52:33 +000031 IsFramework(IsFramework), IsExplicit(IsExplicit), IsSystem(false),
32 InferSubmodules(false), InferExplicitSubmodules(false),
Douglas Gregor970e4412013-03-20 03:59:18 +000033 InferExportWildcard(false), ConfigMacrosExhaustive(false),
34 NameVisibility(Hidden)
Douglas Gregorb7a78192012-01-04 23:32:19 +000035{
36 if (Parent) {
37 if (!Parent->isAvailable())
38 IsAvailable = false;
Douglas Gregor2f04f182012-02-02 18:42:48 +000039 if (Parent->IsSystem)
40 IsSystem = true;
Douglas Gregorb7a78192012-01-04 23:32:19 +000041
42 Parent->SubModuleIndex[Name] = Parent->SubModules.size();
43 Parent->SubModules.push_back(this);
44 }
45}
46
Douglas Gregor1a4761e2011-11-30 23:21:26 +000047Module::~Module() {
Douglas Gregorb7a78192012-01-04 23:32:19 +000048 for (submodule_iterator I = submodule_begin(), IEnd = submodule_end();
Douglas Gregor1a4761e2011-11-30 23:21:26 +000049 I != IEnd; ++I) {
Douglas Gregorb7a78192012-01-04 23:32:19 +000050 delete *I;
Douglas Gregor1a4761e2011-11-30 23:21:26 +000051 }
Douglas Gregor1a4761e2011-11-30 23:21:26 +000052}
53
Douglas Gregor51f564f2011-12-31 04:05:44 +000054/// \brief Determine whether a translation unit built using the current
55/// language options has the given feature.
Douglas Gregordc58aa72012-01-30 06:01:29 +000056static bool hasFeature(StringRef Feature, const LangOptions &LangOpts,
57 const TargetInfo &Target) {
Douglas Gregor51f564f2011-12-31 04:05:44 +000058 return llvm::StringSwitch<bool>(Feature)
Douglas Gregore727d212012-01-30 06:38:25 +000059 .Case("altivec", LangOpts.AltiVec)
Douglas Gregor51f564f2011-12-31 04:05:44 +000060 .Case("blocks", LangOpts.Blocks)
61 .Case("cplusplus", LangOpts.CPlusPlus)
Richard Smith80ad52f2013-01-02 11:42:31 +000062 .Case("cplusplus11", LangOpts.CPlusPlus11)
Douglas Gregor51f564f2011-12-31 04:05:44 +000063 .Case("objc", LangOpts.ObjC1)
64 .Case("objc_arc", LangOpts.ObjCAutoRefCount)
Douglas Gregore727d212012-01-30 06:38:25 +000065 .Case("opencl", LangOpts.OpenCL)
66 .Case("tls", Target.isTLSSupported())
67 .Default(Target.hasFeature(Feature));
Douglas Gregor51f564f2011-12-31 04:05:44 +000068}
69
Richard Smith5794b532013-10-28 22:18:19 +000070bool
Douglas Gregordc58aa72012-01-30 06:01:29 +000071Module::isAvailable(const LangOptions &LangOpts, const TargetInfo &Target,
Richard Smith5794b532013-10-28 22:18:19 +000072 Requirement &Req) const {
Douglas Gregor51f564f2011-12-31 04:05:44 +000073 if (IsAvailable)
74 return true;
75
76 for (const Module *Current = this; Current; Current = Current->Parent) {
Richard Smith5794b532013-10-28 22:18:19 +000077 for (unsigned I = 0, N = Current->Requirements.size(); I != N; ++I) {
78 if (hasFeature(Current->Requirements[I].first, LangOpts, Target) !=
79 Current->Requirements[I].second) {
80 Req = Current->Requirements[I];
Douglas Gregor51f564f2011-12-31 04:05:44 +000081 return false;
82 }
83 }
84 }
85
86 llvm_unreachable("could not find a reason why module is unavailable");
Douglas Gregor51f564f2011-12-31 04:05:44 +000087}
88
Douglas Gregor0adaa882011-12-05 17:28:06 +000089bool Module::isSubModuleOf(Module *Other) const {
90 const Module *This = this;
91 do {
92 if (This == Other)
93 return true;
94
95 This = This->Parent;
96 } while (This);
97
98 return false;
99}
100
Douglas Gregor1e123682011-12-05 22:27:44 +0000101const Module *Module::getTopLevelModule() const {
102 const Module *Result = this;
103 while (Result->Parent)
104 Result = Result->Parent;
105
106 return Result;
107}
108
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000109std::string Module::getFullModuleName() const {
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000110 SmallVector<StringRef, 2> Names;
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000111
112 // Build up the set of module names (from innermost to outermost).
113 for (const Module *M = this; M; M = M->Parent)
114 Names.push_back(M->Name);
115
116 std::string Result;
Craig Topper163fbf82013-07-08 03:55:09 +0000117 for (SmallVectorImpl<StringRef>::reverse_iterator I = Names.rbegin(),
118 IEnd = Names.rend();
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000119 I != IEnd; ++I) {
120 if (!Result.empty())
121 Result += '.';
122
123 Result += *I;
124 }
125
126 return Result;
127}
128
Douglas Gregor10694ce2011-12-08 17:39:04 +0000129const DirectoryEntry *Module::getUmbrellaDir() const {
130 if (const FileEntry *Header = getUmbrellaHeader())
131 return Header->getDir();
132
133 return Umbrella.dyn_cast<const DirectoryEntry *>();
134}
135
Argyrios Kyrtzidisc1d22392013-03-13 21:13:43 +0000136ArrayRef<const FileEntry *> Module::getTopHeaders(FileManager &FileMgr) {
137 if (!TopHeaderNames.empty()) {
138 for (std::vector<std::string>::iterator
139 I = TopHeaderNames.begin(), E = TopHeaderNames.end(); I != E; ++I) {
140 if (const FileEntry *FE = FileMgr.getFile(*I))
141 TopHeaders.insert(FE);
142 }
143 TopHeaderNames.clear();
144 }
145
146 return llvm::makeArrayRef(TopHeaders.begin(), TopHeaders.end());
147}
148
Richard Smith5794b532013-10-28 22:18:19 +0000149void Module::addRequirement(StringRef Feature, bool RequiredState,
150 const LangOptions &LangOpts,
Douglas Gregordc58aa72012-01-30 06:01:29 +0000151 const TargetInfo &Target) {
Richard Smith5794b532013-10-28 22:18:19 +0000152 Requirements.push_back(Requirement(Feature, RequiredState));
Douglas Gregor51f564f2011-12-31 04:05:44 +0000153
154 // If this feature is currently available, we're done.
Richard Smith5794b532013-10-28 22:18:19 +0000155 if (hasFeature(Feature, LangOpts, Target) == RequiredState)
Douglas Gregor51f564f2011-12-31 04:05:44 +0000156 return;
157
158 if (!IsAvailable)
159 return;
160
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000161 SmallVector<Module *, 2> Stack;
Douglas Gregor51f564f2011-12-31 04:05:44 +0000162 Stack.push_back(this);
163 while (!Stack.empty()) {
164 Module *Current = Stack.back();
165 Stack.pop_back();
166
167 if (!Current->IsAvailable)
168 continue;
169
170 Current->IsAvailable = false;
Douglas Gregorb7a78192012-01-04 23:32:19 +0000171 for (submodule_iterator Sub = Current->submodule_begin(),
172 SubEnd = Current->submodule_end();
Douglas Gregor51f564f2011-12-31 04:05:44 +0000173 Sub != SubEnd; ++Sub) {
Douglas Gregorb7a78192012-01-04 23:32:19 +0000174 if ((*Sub)->IsAvailable)
175 Stack.push_back(*Sub);
Douglas Gregor51f564f2011-12-31 04:05:44 +0000176 }
177 }
178}
179
Douglas Gregorb7a78192012-01-04 23:32:19 +0000180Module *Module::findSubmodule(StringRef Name) const {
181 llvm::StringMap<unsigned>::const_iterator Pos = SubModuleIndex.find(Name);
182 if (Pos == SubModuleIndex.end())
183 return 0;
184
185 return SubModules[Pos->getValue()];
186}
187
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000188static void printModuleId(raw_ostream &OS, const ModuleId &Id) {
Douglas Gregoraf13bfc2011-12-02 18:58:38 +0000189 for (unsigned I = 0, N = Id.size(); I != N; ++I) {
190 if (I)
191 OS << ".";
192 OS << Id[I].first;
193 }
194}
195
Argyrios Kyrtzidis21a00042013-02-19 19:34:40 +0000196void Module::getExportedModules(SmallVectorImpl<Module *> &Exported) const {
Dmitri Gribenko86250892013-11-04 21:51:33 +0000197 // All non-explicit submodules are exported.
198 for (std::vector<Module *>::const_iterator I = SubModules.begin(),
199 E = SubModules.end();
200 I != E; ++I) {
201 Module *Mod = *I;
202 if (!Mod->IsExplicit)
203 Exported.push_back(Mod);
204 }
205
206 // Find re-exported modules by filtering the list of imported modules.
Argyrios Kyrtzidis21a00042013-02-19 19:34:40 +0000207 bool AnyWildcard = false;
208 bool UnrestrictedWildcard = false;
209 SmallVector<Module *, 4> WildcardRestrictions;
210 for (unsigned I = 0, N = Exports.size(); I != N; ++I) {
211 Module *Mod = Exports[I].getPointer();
212 if (!Exports[I].getInt()) {
213 // Export a named module directly; no wildcards involved.
214 Exported.push_back(Mod);
215
216 continue;
217 }
218
219 // Wildcard export: export all of the imported modules that match
220 // the given pattern.
221 AnyWildcard = true;
222 if (UnrestrictedWildcard)
223 continue;
224
225 if (Module *Restriction = Exports[I].getPointer())
226 WildcardRestrictions.push_back(Restriction);
227 else {
228 WildcardRestrictions.clear();
229 UnrestrictedWildcard = true;
230 }
231 }
232
233 // If there were any wildcards, push any imported modules that were
234 // re-exported by the wildcard restriction.
235 if (!AnyWildcard)
236 return;
237
238 for (unsigned I = 0, N = Imports.size(); I != N; ++I) {
239 Module *Mod = Imports[I];
240 bool Acceptable = UnrestrictedWildcard;
241 if (!Acceptable) {
242 // Check whether this module meets one of the restrictions.
243 for (unsigned R = 0, NR = WildcardRestrictions.size(); R != NR; ++R) {
244 Module *Restriction = WildcardRestrictions[R];
245 if (Mod == Restriction || Mod->isSubModuleOf(Restriction)) {
246 Acceptable = true;
247 break;
248 }
249 }
250 }
251
252 if (!Acceptable)
253 continue;
254
255 Exported.push_back(Mod);
256 }
257}
258
Richard Smithb7751002013-07-25 23:08:39 +0000259void Module::buildVisibleModulesCache() const {
260 assert(VisibleModulesCache.empty() && "cache does not need building");
261
262 // This module is visible to itself.
263 VisibleModulesCache.insert(this);
264
Dmitri Gribenkobc64d352013-10-31 22:24:10 +0000265 // Every imported module is visible.
Richard Smith8b1ab402013-11-01 02:19:14 +0000266 SmallVector<Module *, 16> Stack(Imports.begin(), Imports.end());
Dmitri Gribenkobc64d352013-10-31 22:24:10 +0000267 while (!Stack.empty()) {
268 Module *CurrModule = Stack.pop_back_val();
Richard Smithb7751002013-07-25 23:08:39 +0000269
Richard Smith8b1ab402013-11-01 02:19:14 +0000270 // Every module transitively exported by an imported module is visible.
271 if (VisibleModulesCache.insert(CurrModule).second)
272 CurrModule->getExportedModules(Stack);
Richard Smithb7751002013-07-25 23:08:39 +0000273 }
274}
275
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000276void Module::print(raw_ostream &OS, unsigned Indent) const {
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000277 OS.indent(Indent);
278 if (IsFramework)
279 OS << "framework ";
280 if (IsExplicit)
281 OS << "explicit ";
Douglas Gregora1f1fad2012-01-27 19:52:33 +0000282 OS << "module " << Name;
Douglas Gregor51f564f2011-12-31 04:05:44 +0000283
Douglas Gregora1f1fad2012-01-27 19:52:33 +0000284 if (IsSystem) {
285 OS.indent(Indent + 2);
286 OS << " [system]";
287 }
288
289 OS << " {\n";
290
Richard Smith5794b532013-10-28 22:18:19 +0000291 if (!Requirements.empty()) {
Douglas Gregor51f564f2011-12-31 04:05:44 +0000292 OS.indent(Indent + 2);
293 OS << "requires ";
Richard Smith5794b532013-10-28 22:18:19 +0000294 for (unsigned I = 0, N = Requirements.size(); I != N; ++I) {
Douglas Gregor51f564f2011-12-31 04:05:44 +0000295 if (I)
296 OS << ", ";
Richard Smith5794b532013-10-28 22:18:19 +0000297 if (!Requirements[I].second)
298 OS << "!";
299 OS << Requirements[I].first;
Douglas Gregor51f564f2011-12-31 04:05:44 +0000300 }
301 OS << "\n";
302 }
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000303
Douglas Gregor10694ce2011-12-08 17:39:04 +0000304 if (const FileEntry *UmbrellaHeader = getUmbrellaHeader()) {
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000305 OS.indent(Indent + 2);
Douglas Gregor489ad432011-12-08 18:00:48 +0000306 OS << "umbrella header \"";
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000307 OS.write_escaped(UmbrellaHeader->getName());
308 OS << "\"\n";
Douglas Gregor489ad432011-12-08 18:00:48 +0000309 } else if (const DirectoryEntry *UmbrellaDir = getUmbrellaDir()) {
310 OS.indent(Indent + 2);
311 OS << "umbrella \"";
312 OS.write_escaped(UmbrellaDir->getName());
313 OS << "\"\n";
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000314 }
Douglas Gregor63a72682013-03-20 00:22:05 +0000315
316 if (!ConfigMacros.empty() || ConfigMacrosExhaustive) {
317 OS.indent(Indent + 2);
318 OS << "config_macros ";
319 if (ConfigMacrosExhaustive)
Douglas Gregor970e4412013-03-20 03:59:18 +0000320 OS << "[exhaustive]";
Douglas Gregor63a72682013-03-20 00:22:05 +0000321 for (unsigned I = 0, N = ConfigMacros.size(); I != N; ++I) {
322 if (I)
323 OS << ", ";
324 OS << ConfigMacros[I];
325 }
Douglas Gregor970e4412013-03-20 03:59:18 +0000326 OS << "\n";
Douglas Gregor63a72682013-03-20 00:22:05 +0000327 }
328
Lawrence Crowlbc3f6282013-06-20 21:14:14 +0000329 for (unsigned I = 0, N = NormalHeaders.size(); I != N; ++I) {
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000330 OS.indent(Indent + 2);
331 OS << "header \"";
Lawrence Crowlbc3f6282013-06-20 21:14:14 +0000332 OS.write_escaped(NormalHeaders[I]->getName());
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000333 OS << "\"\n";
334 }
Douglas Gregor2b49d1f2012-10-15 06:28:11 +0000335
336 for (unsigned I = 0, N = ExcludedHeaders.size(); I != N; ++I) {
337 OS.indent(Indent + 2);
338 OS << "exclude header \"";
339 OS.write_escaped(ExcludedHeaders[I]->getName());
340 OS << "\"\n";
341 }
Lawrence Crowlbc3f6282013-06-20 21:14:14 +0000342
343 for (unsigned I = 0, N = PrivateHeaders.size(); I != N; ++I) {
344 OS.indent(Indent + 2);
345 OS << "private header \"";
346 OS.write_escaped(PrivateHeaders[I]->getName());
347 OS << "\"\n";
348 }
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000349
Douglas Gregorb7a78192012-01-04 23:32:19 +0000350 for (submodule_const_iterator MI = submodule_begin(), MIEnd = submodule_end();
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000351 MI != MIEnd; ++MI)
Douglas Gregorb7a78192012-01-04 23:32:19 +0000352 (*MI)->print(OS, Indent + 2);
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000353
Douglas Gregoraf13bfc2011-12-02 18:58:38 +0000354 for (unsigned I = 0, N = Exports.size(); I != N; ++I) {
355 OS.indent(Indent + 2);
Douglas Gregorf4ac17e2011-12-05 17:34:59 +0000356 OS << "export ";
357 if (Module *Restriction = Exports[I].getPointer()) {
358 OS << Restriction->getFullModuleName();
359 if (Exports[I].getInt())
360 OS << ".*";
361 } else {
362 OS << "*";
363 }
Douglas Gregoraf13bfc2011-12-02 18:58:38 +0000364 OS << "\n";
365 }
366
367 for (unsigned I = 0, N = UnresolvedExports.size(); I != N; ++I) {
368 OS.indent(Indent + 2);
369 OS << "export ";
370 printModuleId(OS, UnresolvedExports[I].Id);
Douglas Gregorf4ac17e2011-12-05 17:34:59 +0000371 if (UnresolvedExports[I].Wildcard) {
372 if (UnresolvedExports[I].Id.empty())
373 OS << "*";
374 else
375 OS << ".*";
376 }
Douglas Gregoraf13bfc2011-12-02 18:58:38 +0000377 OS << "\n";
378 }
379
Daniel Jasperddd2dfc2013-09-24 09:14:14 +0000380 for (unsigned I = 0, N = DirectUses.size(); I != N; ++I) {
381 OS.indent(Indent + 2);
382 OS << "use ";
383 OS << DirectUses[I]->getFullModuleName();
384 OS << "\n";
385 }
386
387 for (unsigned I = 0, N = UnresolvedDirectUses.size(); I != N; ++I) {
388 OS.indent(Indent + 2);
389 OS << "use ";
390 printModuleId(OS, UnresolvedDirectUses[I]);
391 OS << "\n";
392 }
393
Douglas Gregorb6cbe512013-01-14 17:21:00 +0000394 for (unsigned I = 0, N = LinkLibraries.size(); I != N; ++I) {
395 OS.indent(Indent + 2);
396 OS << "link ";
397 if (LinkLibraries[I].IsFramework)
398 OS << "framework ";
399 OS << "\"";
400 OS.write_escaped(LinkLibraries[I].Library);
401 OS << "\"";
402 }
403
Douglas Gregor906d66a2013-03-20 21:10:35 +0000404 for (unsigned I = 0, N = UnresolvedConflicts.size(); I != N; ++I) {
405 OS.indent(Indent + 2);
406 OS << "conflict ";
407 printModuleId(OS, UnresolvedConflicts[I].Id);
408 OS << ", \"";
409 OS.write_escaped(UnresolvedConflicts[I].Message);
410 OS << "\"\n";
411 }
412
413 for (unsigned I = 0, N = Conflicts.size(); I != N; ++I) {
414 OS.indent(Indent + 2);
415 OS << "conflict ";
416 OS << Conflicts[I].Other->getFullModuleName();
417 OS << ", \"";
418 OS.write_escaped(Conflicts[I].Message);
419 OS << "\"\n";
420 }
421
Douglas Gregor1e123682011-12-05 22:27:44 +0000422 if (InferSubmodules) {
423 OS.indent(Indent + 2);
424 if (InferExplicitSubmodules)
425 OS << "explicit ";
426 OS << "module * {\n";
427 if (InferExportWildcard) {
428 OS.indent(Indent + 4);
429 OS << "export *\n";
430 }
431 OS.indent(Indent + 2);
432 OS << "}\n";
433 }
434
Douglas Gregor1a4761e2011-11-30 23:21:26 +0000435 OS.indent(Indent);
436 OS << "}\n";
437}
438
439void Module::dump() const {
440 print(llvm::errs());
441}
442
443