21 #include "llvm/ADT/ArrayRef.h" 22 #include "llvm/ADT/SmallVector.h" 23 #include "llvm/ADT/StringMap.h" 24 #include "llvm/ADT/StringRef.h" 25 #include "llvm/ADT/StringSwitch.h" 26 #include "llvm/Support/Compiler.h" 27 #include "llvm/Support/ErrorHandling.h" 28 #include "llvm/Support/raw_ostream.h" 36 using namespace clang;
39 bool IsFramework,
bool IsExplicit,
unsigned VisibilityID)
40 : Name(Name), DefinitionLoc(DefinitionLoc), Parent(Parent),
41 VisibilityID(VisibilityID), IsMissingRequirement(
false),
42 HasIncompatibleModuleFile(
false), IsAvailable(
true),
43 IsFromModuleFile(
false), IsFramework(IsFramework), IsExplicit(IsExplicit),
45 InferSubmodules(
false), InferExplicitSubmodules(
false),
46 InferExportWildcard(
false), ConfigMacrosExhaustive(
false),
47 NoUndeclaredIncludes(
false), ModuleMapIsPrivate(
false),
48 NameVisibility(Hidden) {
62 Parent->SubModuleIndex[
Name] = Parent->SubModules.size();
63 Parent->SubModules.push_back(
this);
76 StringRef Env = Target.
getTriple().getEnvironmentName();
79 if (Platform == Feature || Target.
getTriple().getOSName() == Feature ||
83 auto CmpPlatformEnv = [](StringRef LHS, StringRef RHS) {
84 auto Pos = LHS.find(
"-");
85 if (Pos == StringRef::npos)
88 NewLHS += LHS.slice(Pos+1, LHS.size());
99 if (Target.
getTriple().isOSDarwin() && PlatformEnv.endswith(
"simulator"))
100 return PlatformEnv == Feature || CmpPlatformEnv(PlatformEnv, Feature);
102 return PlatformEnv == Feature;
109 bool HasFeature = llvm::StringSwitch<bool>(Feature)
110 .Case(
"altivec", LangOpts.AltiVec)
111 .Case(
"blocks", LangOpts.Blocks)
112 .Case(
"coroutines", LangOpts.CoroutinesTS)
113 .Case(
"cplusplus", LangOpts.CPlusPlus)
114 .Case(
"cplusplus11", LangOpts.CPlusPlus11)
115 .Case(
"cplusplus14", LangOpts.CPlusPlus14)
116 .Case(
"cplusplus17", LangOpts.CPlusPlus17)
117 .Case(
"c99", LangOpts.C99)
118 .Case(
"c11", LangOpts.C11)
119 .Case(
"c17", LangOpts.C17)
120 .Case(
"freestanding", LangOpts.Freestanding)
121 .Case(
"gnuinlineasm", LangOpts.GNUAsm)
122 .Case(
"objc", LangOpts.ObjC)
123 .Case(
"objc_arc", LangOpts.ObjCAutoRefCount)
124 .Case(
"opencl", LangOpts.OpenCL)
126 .Case(
"zvector", LangOpts.ZVector)
143 for (
const Module *Current =
this; Current; Current = Current->Parent) {
144 if (Current->ShadowingModule) {
145 ShadowingModule = Current->ShadowingModule;
148 for (
unsigned I = 0, N = Current->Requirements.size(); I != N; ++I) {
149 if (
hasFeature(Current->Requirements[I].first, LangOpts, Target) !=
150 Current->Requirements[I].second) {
151 Req = Current->Requirements[I];
155 if (!Current->MissingHeaders.empty()) {
156 MissingHeader = Current->MissingHeaders.front();
161 llvm_unreachable(
"could not find a reason why module is unavailable");
165 const Module *This =
this;
185 const std::pair<std::string, SourceLocation> &IdComponent) {
186 return IdComponent.first;
191 template<
typename InputIter>
193 bool AllowStringLiterals =
true) {
194 for (InputIter It = Begin; It !=
End; ++It) {
203 OS.write_escaped(Name);
209 template<
typename Container>
219 Names.push_back(M->Name);
223 llvm::raw_string_ostream Out(Result);
224 printModuleId(Out, Names.rbegin(), Names.rend(), AllowStringLiterals);
232 if (nameParts.empty() || M->Name != nameParts.back())
234 nameParts = nameParts.drop_back();
236 return nameParts.empty();
241 return {
"", U.
Entry->getDir()};
247 if (!TopHeaderNames.empty()) {
248 for (std::vector<std::string>::iterator
249 I = TopHeaderNames.begin(), E = TopHeaderNames.end(); I != E; ++I) {
251 TopHeaders.insert(FE);
253 TopHeaderNames.clear();
256 return llvm::makeArrayRef(TopHeaders.begin(), TopHeaders.end());
266 for (
auto *Use : Top->DirectUses)
271 if (!Requested->
Parent && Requested->
Name ==
"_Builtin_stddef_max_align_t")
283 if (
hasFeature(Feature, LangOpts, Target) == RequiredState)
290 auto needUpdate = [MissingRequirement](
Module *M) {
291 return M->IsAvailable || (!M->IsMissingRequirement && MissingRequirement);
294 if (!needUpdate(
this))
298 Stack.push_back(
this);
299 while (!Stack.empty()) {
300 Module *Current = Stack.back();
303 if (!needUpdate(Current))
310 Sub != SubEnd; ++Sub) {
311 if (needUpdate(*Sub))
312 Stack.push_back(*Sub);
318 llvm::StringMap<unsigned>::const_iterator Pos = SubModuleIndex.find(Name);
319 if (Pos == SubModuleIndex.end())
322 return SubModules[Pos->getValue()];
327 for (std::vector<Module *>::const_iterator I = SubModules.begin(),
328 E = SubModules.end();
332 Exported.push_back(Mod);
336 bool AnyWildcard =
false;
337 bool UnrestrictedWildcard =
false;
339 for (
unsigned I = 0, N =
Exports.size(); I != N; ++I) {
343 Exported.push_back(Mod);
351 if (UnrestrictedWildcard)
355 WildcardRestrictions.push_back(Restriction);
357 WildcardRestrictions.clear();
358 UnrestrictedWildcard =
true;
367 for (
unsigned I = 0, N =
Imports.size(); I != N; ++I) {
369 bool Acceptable = UnrestrictedWildcard;
372 for (
unsigned R = 0, NR = WildcardRestrictions.size(); R != NR; ++R) {
373 Module *Restriction = WildcardRestrictions[R];
384 Exported.push_back(Mod);
388 void Module::buildVisibleModulesCache()
const {
389 assert(VisibleModulesCache.empty() &&
"cache does not need building");
392 VisibleModulesCache.insert(
this);
396 while (!Stack.empty()) {
397 Module *CurrModule = Stack.pop_back_val();
400 if (VisibleModulesCache.insert(CurrModule).second)
415 OS.indent(Indent + 2);
425 OS.indent(Indent + 2);
427 for (
unsigned I = 0, N =
Requirements.size(); I != N; ++I) {
438 OS.indent(Indent + 2);
439 OS <<
"umbrella header \"";
440 OS.write_escaped(H.NameAsWritten);
443 OS.indent(Indent + 2);
445 OS.write_escaped(D.NameAsWritten);
450 OS.indent(Indent + 2);
451 OS <<
"config_macros ";
453 OS <<
"[exhaustive]";
454 for (
unsigned I = 0, N =
ConfigMacros.size(); I != N; ++I) {
471 for (
auto &K : Kinds) {
472 assert(&K == &Kinds[K.Kind] &&
"kinds in wrong order");
473 for (
auto &H :
Headers[K.Kind]) {
474 OS.indent(Indent + 2);
475 OS << K.Prefix <<
"header \"";
476 OS.write_escaped(H.NameAsWritten);
477 OS <<
"\" { size " << H.Entry->getSize()
478 <<
" mtime " << H.Entry->getModificationTime() <<
" }\n";
482 for (
auto &U : *Unresolved) {
483 OS.indent(Indent + 2);
484 OS << Kinds[U.Kind].Prefix <<
"header \"";
485 OS.write_escaped(U.FileName);
487 if (U.Size || U.ModTime) {
490 OS <<
" size " << *U.Size;
492 OS <<
" mtime " << *U.ModTime;
500 OS.indent(Indent + 2);
510 if (!(*MI)->IsInferred || (*MI)->IsFramework)
511 (*MI)->print(OS, Indent + 2);
513 for (
unsigned I = 0, N =
Exports.size(); I != N; ++I) {
514 OS.indent(Indent + 2);
517 OS << Restriction->getFullModuleName(
true);
527 OS.indent(Indent + 2);
535 for (
unsigned I = 0, N =
DirectUses.size(); I != N; ++I) {
536 OS.indent(Indent + 2);
543 OS.indent(Indent + 2);
549 for (
unsigned I = 0, N =
LinkLibraries.size(); I != N; ++I) {
550 OS.indent(Indent + 2);
560 OS.indent(Indent + 2);
568 for (
unsigned I = 0, N =
Conflicts.size(); I != N; ++I) {
569 OS.indent(Indent + 2);
571 OS <<
Conflicts[I].Other->getFullModuleName(
true);
578 OS.indent(Indent + 2);
581 OS <<
"module * {\n";
583 OS.indent(Indent + 4);
586 OS.indent(Indent + 2);
600 assert(Loc.
isValid() &&
"setVisible expects a valid import location");
608 Visiting *ExportedBy;
611 std::function<void(Visiting)> VisitModule = [&](Visiting V) {
613 unsigned ID = V.M->getVisibilityID();
614 if (ImportLocs.size() <=
ID)
615 ImportLocs.resize(ID + 1);
616 else if (ImportLocs[ID].isValid())
619 ImportLocs[
ID] = Loc;
624 V.M->getExportedModules(Exports);
625 for (
Module *E : Exports) {
627 if (E->isAvailable())
628 VisitModule({E, &V});
631 for (
auto &
C : V.M->Conflicts) {
632 if (isVisible(
C.Other)) {
634 for (Visiting *I = &V; I; I = I->ExportedBy)
635 Path.push_back(I->M);
636 Cb(Path,
C.Other,
C.Message);
640 VisitModule({M,
nullptr});
unsigned IsAvailable
Whether this module is available in the current translation unit.
SmallVector< UnresolvedExportDecl, 2 > UnresolvedExports
The set of export declarations that have yet to be resolved.
std::string Name
The name of this module.
SmallVector< UnresolvedHeaderDirective, 1 > MissingHeaders
Headers that are mentioned in the module map file but could not be found on the file system...
std::vector< Module * >::iterator submodule_iterator
Implements support for file system lookup, file system caching, and directory search management...
Defines the clang::FileManager interface and associated types.
submodule_iterator submodule_begin()
unsigned IsExternC
Whether this is an 'extern "C"' module (which implicitly puts all headers in it within an 'extern "C"...
const llvm::Triple & getTriple() const
Returns the target triple of the primary target.
std::vector< UnresolvedConflict > UnresolvedConflicts
The list of conflicts for which the module-id has not yet been resolved.
Module * getTopLevelModule()
Retrieve the top-level module for this (sub)module, which may be this module.
Defines the clang::Module class, which describes a module in the source code.
static bool hasFeature(StringRef Feature, const LangOptions &LangOpts, const TargetInfo &Target)
Determine whether a translation unit built using the current language options has the given feature...
unsigned IsFramework
Whether this is a framework module.
void addRequirement(StringRef Feature, bool RequiredState, const LangOptions &LangOpts, const TargetInfo &Target)
Add the given feature requirement to the list of features required by this module.
ModuleKind Kind
The kind of this module.
void markUnavailable(bool MissingRequirement=false)
Mark this module and all of its submodules as unavailable.
static bool HasFeature(const Preprocessor &PP, StringRef Feature)
HasFeature - Return true if we recognize and implement the feature specified by the identifier as a s...
SmallVector< Requirement, 2 > Requirements
The set of language features required to use this module.
Header getUmbrellaHeader() const
Retrieve the header that serves as the umbrella header for this module.
void setVisible(Module *M, SourceLocation Loc, VisibleCallback Vis=[](Module *) {}, ConflictCallback Cb=[](ArrayRef< Module *>, Module *, StringRef) {})
Make a specific module visible.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Describes a module or submodule.
unsigned InferExportWildcard
Whether, when inferring submodules, the inferr submodules should export all modules they import (e...
std::string getFullModuleName(bool AllowStringLiterals=false) const
Retrieve the full name of this module, including the path from its top-level module.
bool isSubModuleOf(const Module *Other) const
Determine whether this module is a submodule of the given other module.
Module * Parent
The parent of this module.
submodule_iterator submodule_end()
std::vector< std::string > ModuleFeatures
The names of any features to enable in module 'requires' decls in addition to the hard-coded list in ...
unsigned NoUndeclaredIncludes
Whether files in this module can only include non-modular headers and headers from used modules...
void getExportedModules(SmallVectorImpl< Module *> &Exported) const
Appends this module's list of exported modules to Exported.
unsigned IsSystem
Whether this is a "system" module (which assumes that all headers in it are system headers)...
const FileEntry * getFile(StringRef Filename, bool OpenFile=false, bool CacheFailure=true)
Lookup, cache, and verify the specified file (real or virtual).
Module * findSubmodule(StringRef Name) const
Find the submodule with the given name.
llvm::SmallSetVector< Module *, 2 > Imports
The set of modules imported by this module, and on which this module depends.
const DirectoryEntry * Entry
Exposes information about the current target.
Defines the clang::LangOptions interface.
SmallVector< ModuleId, 2 > UnresolvedDirectUses
The set of use declarations that have yet to be resolved.
unsigned ConfigMacrosExhaustive
Whether the set of configuration macros is exhaustive.
void print(raw_ostream &OS, unsigned Indent=0) const
Print the module map for this module to the given stream.
static StringRef getModuleNameFromComponent(const std::pair< std::string, SourceLocation > &IdComponent)
ArrayRef< const FileEntry * > getTopHeaders(FileManager &FileMgr)
The top-level headers associated with this module.
llvm::SmallVector< LinkLibrary, 2 > LinkLibraries
The set of libraries or frameworks to link against when an entity from this module is used...
Module(StringRef Name, SourceLocation DefinitionLoc, Module *Parent, bool IsFramework, bool IsExplicit, unsigned VisibilityID)
Construct a new module or submodule.
bool isAvailable() const
Determine whether this module is available for use within the current translation unit...
The result type of a method or function.
SmallVector< ExportDecl, 2 > Exports
The set of export declarations.
llvm::function_ref< void(ArrayRef< Module * > Path, Module *Conflict, StringRef Message)> ConflictCallback
A callback to call when a module conflict is found.
bool fullModuleNameIs(ArrayRef< StringRef > nameParts) const
Whether the full name of this module is equal to joining nameParts with "."s.
LLVM_READONLY bool isValidIdentifier(StringRef S, bool AllowDollar=false)
Return true if this is a valid ASCII identifier.
StringRef getPlatformName() const
Retrieve the name of the platform as it is used in the availability attribute.
Encodes a location in the source.
std::string ExportAsModule
The module through which entities defined in this module will eventually be exposed, for use in "private" modules.
Information about a directory name as found in the module map file.
Cached information about one file (either on disk or in the virtual file system). ...
static void printModuleId(raw_ostream &OS, InputIter Begin, InputIter End, bool AllowStringLiterals=true)
SmallVector< Header, 2 > Headers[5]
The headers that are part of this module.
std::pair< std::string, bool > Requirement
An individual requirement: a feature name and a flag indicating the required state of that feature...
SmallVector< UnresolvedHeaderDirective, 1 > UnresolvedHeaders
Headers that are mentioned in the module map file but that we have not yet attempted to resolve to a ...
Dataflow Directional Tag Classes.
bool isValid() const
Return true if this is a valid SourceLocation object.
unsigned IsMissingRequirement
Whether this module is missing a feature from Requirements.
llvm::PointerUnion< const DirectoryEntry *, const FileEntry * > Umbrella
The umbrella header or directory.
Module * ShadowingModule
A module with the same name that shadows this module.
static bool isPlatformEnvironment(const TargetInfo &Target, StringRef Feature)
virtual bool hasFeature(StringRef Feature) const
Determine whether the given target has the given feature.
unsigned ModuleMapIsPrivate
Whether this module came from a "private" module map, found next to a regular (public) module map...
std::vector< Conflict > Conflicts
The list of conflicts.
SmallVector< Module *, 2 > DirectUses
The directly used modules.
void dump() const
Dump the contents of this module to the given output stream.
DirectoryName getUmbrellaDir() const
Retrieve the directory for which this module serves as the umbrella.
Cached information about one directory (either on disk or in the virtual file system).
llvm::function_ref< void(Module *M)> VisibleCallback
A callback to call when a module is made visible (directly or indirectly) by a call to setVisible...
Defines the clang::SourceLocation class and associated facilities.
unsigned InferSubmodules
Whether we should infer submodules for this module based on the headers.
bool isTLSSupported() const
Whether the target supports thread-local storage.
bool directlyUses(const Module *Requested) const
Determine whether this module has declared its intention to directly use another module.
Defines the clang::TargetInfo interface.
std::vector< std::string > ConfigMacros
The set of "configuration macros", which are macros that (intentionally) change how this module is bu...
std::string UmbrellaAsWritten
The name of the umbrella entry, as written in the module map.
unsigned IsExplicit
Whether this is an explicit submodule.
std::vector< Module * >::const_iterator submodule_const_iterator
unsigned InferExplicitSubmodules
Whether, when inferring submodules, the inferred submodules should be explicit.