1 //===--- HeaderSearch.cpp - Resolve Header File Locations ---===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the DirectoryLookup and HeaderSearch interfaces.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Lex/HeaderSearch.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/IdentifierTable.h"
17 #include "clang/Lex/HeaderMap.h"
18 #include "clang/Lex/HeaderSearchOptions.h"
19 #include "clang/Lex/LexDiagnostic.h"
20 #include "clang/Lex/Lexer.h"
21 #include "llvm/ADT/APInt.h"
22 #include "llvm/ADT/Hashing.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/Support/Capacity.h"
25 #include "llvm/Support/FileSystem.h"
26 #include "llvm/Support/Path.h"
27 #include "llvm/Support/raw_ostream.h"
29 #if defined(LLVM_ON_UNIX)
32 using namespace clang
;
34 const IdentifierInfo
*
35 HeaderFileInfo::getControllingMacro(ExternalIdentifierLookup
*External
) {
37 return ControllingMacro
;
39 if (!ControllingMacroID
|| !External
)
42 ControllingMacro
= External
->GetIdentifier(ControllingMacroID
);
43 return ControllingMacro
;
46 ExternalHeaderFileInfoSource::~ExternalHeaderFileInfoSource() {}
48 HeaderSearch::HeaderSearch(IntrusiveRefCntPtr
<HeaderSearchOptions
> HSOpts
,
49 SourceManager
&SourceMgr
, DiagnosticsEngine
&Diags
,
50 const LangOptions
&LangOpts
,
51 const TargetInfo
*Target
)
52 : HSOpts(HSOpts
), Diags(Diags
), FileMgr(SourceMgr
.getFileManager()),
53 FrameworkMap(64), ModMap(SourceMgr
, Diags
, LangOpts
, Target
, *this),
57 NoCurDirSearch
= false;
59 ExternalLookup
= nullptr;
60 ExternalSource
= nullptr;
62 NumMultiIncludeFileOptzn
= 0;
63 NumFrameworkLookups
= NumSubFrameworkLookups
= 0;
66 HeaderSearch::~HeaderSearch() {
68 for (unsigned i
= 0, e
= HeaderMaps
.size(); i
!= e
; ++i
)
69 delete HeaderMaps
[i
].second
;
72 void HeaderSearch::PrintStats() {
73 fprintf(stderr
, "\n*** HeaderSearch Stats:\n");
74 fprintf(stderr
, "%d files tracked.\n", (int)FileInfo
.size());
75 unsigned NumOnceOnlyFiles
= 0, MaxNumIncludes
= 0, NumSingleIncludedFiles
= 0;
76 for (unsigned i
= 0, e
= FileInfo
.size(); i
!= e
; ++i
) {
77 NumOnceOnlyFiles
+= FileInfo
[i
].isImport
;
78 if (MaxNumIncludes
< FileInfo
[i
].NumIncludes
)
79 MaxNumIncludes
= FileInfo
[i
].NumIncludes
;
80 NumSingleIncludedFiles
+= FileInfo
[i
].NumIncludes
== 1;
82 fprintf(stderr
, " %d #import/#pragma once files.\n", NumOnceOnlyFiles
);
83 fprintf(stderr
, " %d included exactly once.\n", NumSingleIncludedFiles
);
84 fprintf(stderr
, " %d max times a file is included.\n", MaxNumIncludes
);
86 fprintf(stderr
, " %d #include/#include_next/#import.\n", NumIncluded
);
87 fprintf(stderr
, " %d #includes skipped due to"
88 " the multi-include optimization.\n", NumMultiIncludeFileOptzn
);
90 fprintf(stderr
, "%d framework lookups.\n", NumFrameworkLookups
);
91 fprintf(stderr
, "%d subframework lookups.\n", NumSubFrameworkLookups
);
94 /// CreateHeaderMap - This method returns a HeaderMap for the specified
95 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
96 const HeaderMap
*HeaderSearch::CreateHeaderMap(const FileEntry
*FE
) {
97 // We expect the number of headermaps to be small, and almost always empty.
98 // If it ever grows, use of a linear search should be re-evaluated.
99 if (!HeaderMaps
.empty()) {
100 for (unsigned i
= 0, e
= HeaderMaps
.size(); i
!= e
; ++i
)
101 // Pointer equality comparison of FileEntries works because they are
102 // already uniqued by inode.
103 if (HeaderMaps
[i
].first
== FE
)
104 return HeaderMaps
[i
].second
;
107 if (const HeaderMap
*HM
= HeaderMap::Create(FE
, FileMgr
)) {
108 HeaderMaps
.push_back(std::make_pair(FE
, HM
));
115 std::string
HeaderSearch::getModuleFileName(Module
*Module
) {
116 const FileEntry
*ModuleMap
=
117 getModuleMap().getModuleMapFileForUniquing(Module
);
118 return getModuleFileName(Module
->Name
, ModuleMap
->getName());
121 std::string
HeaderSearch::getModuleFileName(StringRef ModuleName
,
122 StringRef ModuleMapPath
) {
123 // If we don't have a module cache path, we can't do anything.
124 if (ModuleCachePath
.empty())
125 return std::string();
127 SmallString
<256> Result(ModuleCachePath
);
128 llvm::sys::fs::make_absolute(Result
);
130 if (HSOpts
->DisableModuleHash
) {
131 llvm::sys::path::append(Result
, ModuleName
+ ".pcm");
133 // Construct the name <ModuleName>-<hash of ModuleMapPath>.pcm which should
134 // ideally be globally unique to this particular module. Name collisions
135 // in the hash are safe (because any translation unit can only import one
136 // module with each name), but result in a loss of caching.
138 // To avoid false-negatives, we form as canonical a path as we can, and map
139 // to lower-case in case we're on a case-insensitive file system.
141 FileMgr
.getDirectory(llvm::sys::path::parent_path(ModuleMapPath
));
143 return std::string();
144 auto DirName
= FileMgr
.getCanonicalName(Dir
);
145 auto FileName
= llvm::sys::path::filename(ModuleMapPath
);
147 llvm::hash_code Hash
=
148 llvm::hash_combine(DirName
.lower(), FileName
.lower());
150 SmallString
<128> HashStr
;
151 llvm::APInt(64, size_t(Hash
)).toStringUnsigned(HashStr
, /*Radix*/36);
152 llvm::sys::path::append(Result
, ModuleName
+ "-" + HashStr
.str() + ".pcm");
154 return Result
.str().str();
157 Module
*HeaderSearch::lookupModule(StringRef ModuleName
, bool AllowSearch
) {
158 // Look in the module map to determine if there is a module by this name.
159 Module
*Module
= ModMap
.findModule(ModuleName
);
160 if (Module
|| !AllowSearch
|| !LangOpts
.ModulesImplicitMaps
)
163 // Look through the various header search paths to load any available module
164 // maps, searching for a module map that describes this module.
165 for (unsigned Idx
= 0, N
= SearchDirs
.size(); Idx
!= N
; ++Idx
) {
166 if (SearchDirs
[Idx
].isFramework()) {
167 // Search for or infer a module map for a framework.
168 SmallString
<128> FrameworkDirName
;
169 FrameworkDirName
+= SearchDirs
[Idx
].getFrameworkDir()->getName();
170 llvm::sys::path::append(FrameworkDirName
, ModuleName
+ ".framework");
171 if (const DirectoryEntry
*FrameworkDir
172 = FileMgr
.getDirectory(FrameworkDirName
)) {
174 = SearchDirs
[Idx
].getDirCharacteristic() != SrcMgr::C_User
;
175 Module
= loadFrameworkModule(ModuleName
, FrameworkDir
, IsSystem
);
181 // FIXME: Figure out how header maps and module maps will work together.
183 // Only deal with normal search directories.
184 if (!SearchDirs
[Idx
].isNormalDir())
187 bool IsSystem
= SearchDirs
[Idx
].isSystemHeaderDirectory();
188 // Search for a module map file in this directory.
189 if (loadModuleMapFile(SearchDirs
[Idx
].getDir(), IsSystem
,
190 /*IsFramework*/false) == LMM_NewlyLoaded
) {
191 // We just loaded a module map file; check whether the module is
193 Module
= ModMap
.findModule(ModuleName
);
198 // Search for a module map in a subdirectory with the same name as the
200 SmallString
<128> NestedModuleMapDirName
;
201 NestedModuleMapDirName
= SearchDirs
[Idx
].getDir()->getName();
202 llvm::sys::path::append(NestedModuleMapDirName
, ModuleName
);
203 if (loadModuleMapFile(NestedModuleMapDirName
, IsSystem
,
204 /*IsFramework*/false) == LMM_NewlyLoaded
){
205 // If we just loaded a module map file, look for the module again.
206 Module
= ModMap
.findModule(ModuleName
);
211 // If we've already performed the exhaustive search for module maps in this
212 // search directory, don't do it again.
213 if (SearchDirs
[Idx
].haveSearchedAllModuleMaps())
216 // Load all module maps in the immediate subdirectories of this search
218 loadSubdirectoryModuleMaps(SearchDirs
[Idx
]);
220 // Look again for the module.
221 Module
= ModMap
.findModule(ModuleName
);
229 //===----------------------------------------------------------------------===//
230 // File lookup within a DirectoryLookup scope
231 //===----------------------------------------------------------------------===//
233 /// getName - Return the directory or filename corresponding to this lookup
235 const char *DirectoryLookup::getName() const {
237 return getDir()->getName();
239 return getFrameworkDir()->getName();
240 assert(isHeaderMap() && "Unknown DirectoryLookup");
241 return getHeaderMap()->getFileName();
244 static const FileEntry
*
245 getFileAndSuggestModule(HeaderSearch
&HS
, StringRef FileName
,
246 const DirectoryEntry
*Dir
, bool IsSystemHeaderDir
,
247 ModuleMap::KnownHeader
*SuggestedModule
) {
248 // If we have a module map that might map this header, load it and
249 // check whether we'll have a suggestion for a module.
250 HS
.hasModuleMap(FileName
, Dir
, IsSystemHeaderDir
);
251 if (SuggestedModule
) {
252 const FileEntry
*File
= HS
.getFileMgr().getFile(FileName
,
255 // If there is a module that corresponds to this header, suggest it.
256 *SuggestedModule
= HS
.findModuleForHeader(File
);
258 // FIXME: This appears to be a no-op. We loaded the module map for this
259 // directory at the start of this function.
260 if (!SuggestedModule
->getModule() &&
261 HS
.hasModuleMap(FileName
, Dir
, IsSystemHeaderDir
))
262 *SuggestedModule
= HS
.findModuleForHeader(File
);
268 return HS
.getFileMgr().getFile(FileName
, /*openFile=*/true);
271 /// LookupFile - Lookup the specified file in this search path, returning it
272 /// if it exists or returning null if not.
273 const FileEntry
*DirectoryLookup::LookupFile(
276 SmallVectorImpl
<char> *SearchPath
,
277 SmallVectorImpl
<char> *RelativePath
,
278 ModuleMap::KnownHeader
*SuggestedModule
,
279 bool &InUserSpecifiedSystemFramework
,
281 SmallVectorImpl
<char> &MappedName
) const {
282 InUserSpecifiedSystemFramework
= false;
283 HasBeenMapped
= false;
285 SmallString
<1024> TmpDir
;
287 // Concatenate the requested file onto the directory.
288 TmpDir
= getDir()->getName();
289 llvm::sys::path::append(TmpDir
, Filename
);
291 StringRef
SearchPathRef(getDir()->getName());
293 SearchPath
->append(SearchPathRef
.begin(), SearchPathRef
.end());
296 RelativePath
->clear();
297 RelativePath
->append(Filename
.begin(), Filename
.end());
300 return getFileAndSuggestModule(HS
, TmpDir
.str(), getDir(),
301 isSystemHeaderDirectory(),
306 return DoFrameworkLookup(Filename
, HS
, SearchPath
, RelativePath
,
307 SuggestedModule
, InUserSpecifiedSystemFramework
);
309 assert(isHeaderMap() && "Unknown directory lookup");
310 const HeaderMap
*HM
= getHeaderMap();
311 SmallString
<1024> Path
;
312 StringRef Dest
= HM
->lookupFilename(Filename
, Path
);
316 const FileEntry
*Result
;
318 // Check if the headermap maps the filename to a framework include
319 // ("Foo.h" -> "Foo/Foo.h"), in which case continue header lookup using the
320 // framework include.
321 if (llvm::sys::path::is_relative(Dest
)) {
323 MappedName
.append(Dest
.begin(), Dest
.end());
324 Filename
= StringRef(MappedName
.begin(), MappedName
.size());
325 HasBeenMapped
= true;
326 Result
= HM
->LookupFile(Filename
, HS
.getFileMgr());
329 Result
= HS
.getFileMgr().getFile(Dest
);
334 StringRef
SearchPathRef(getName());
336 SearchPath
->append(SearchPathRef
.begin(), SearchPathRef
.end());
339 RelativePath
->clear();
340 RelativePath
->append(Filename
.begin(), Filename
.end());
346 /// \brief Given a framework directory, find the top-most framework directory.
348 /// \param FileMgr The file manager to use for directory lookups.
349 /// \param DirName The name of the framework directory.
350 /// \param SubmodulePath Will be populated with the submodule path from the
351 /// returned top-level module to the originally named framework.
352 static const DirectoryEntry
*
353 getTopFrameworkDir(FileManager
&FileMgr
, StringRef DirName
,
354 SmallVectorImpl
<std::string
> &SubmodulePath
) {
355 assert(llvm::sys::path::extension(DirName
) == ".framework" &&
356 "Not a framework directory");
358 // Note: as an egregious but useful hack we use the real path here, because
359 // frameworks moving between top-level frameworks to embedded frameworks tend
360 // to be symlinked, and we base the logical structure of modules on the
361 // physical layout. In particular, we need to deal with crazy includes like
363 // #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
365 // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
366 // which one should access with, e.g.,
368 // #include <Bar/Wibble.h>
370 // Similar issues occur when a top-level framework has moved into an
371 // embedded framework.
372 const DirectoryEntry
*TopFrameworkDir
= FileMgr
.getDirectory(DirName
);
373 DirName
= FileMgr
.getCanonicalName(TopFrameworkDir
);
375 // Get the parent directory name.
376 DirName
= llvm::sys::path::parent_path(DirName
);
380 // Determine whether this directory exists.
381 const DirectoryEntry
*Dir
= FileMgr
.getDirectory(DirName
);
385 // If this is a framework directory, then we're a subframework of this
387 if (llvm::sys::path::extension(DirName
) == ".framework") {
388 SubmodulePath
.push_back(llvm::sys::path::stem(DirName
));
389 TopFrameworkDir
= Dir
;
393 return TopFrameworkDir
;
396 /// DoFrameworkLookup - Do a lookup of the specified file in the current
397 /// DirectoryLookup, which is a framework directory.
398 const FileEntry
*DirectoryLookup::DoFrameworkLookup(
401 SmallVectorImpl
<char> *SearchPath
,
402 SmallVectorImpl
<char> *RelativePath
,
403 ModuleMap::KnownHeader
*SuggestedModule
,
404 bool &InUserSpecifiedSystemFramework
) const
406 FileManager
&FileMgr
= HS
.getFileMgr();
408 // Framework names must have a '/' in the filename.
409 size_t SlashPos
= Filename
.find('/');
410 if (SlashPos
== StringRef::npos
) return nullptr;
412 // Find out if this is the home for the specified framework, by checking
413 // HeaderSearch. Possible answers are yes/no and unknown.
414 HeaderSearch::FrameworkCacheEntry
&CacheEntry
=
415 HS
.LookupFrameworkCache(Filename
.substr(0, SlashPos
));
417 // If it is known and in some other directory, fail.
418 if (CacheEntry
.Directory
&& CacheEntry
.Directory
!= getFrameworkDir())
421 // Otherwise, construct the path to this framework dir.
423 // FrameworkName = "/System/Library/Frameworks/"
424 SmallString
<1024> FrameworkName
;
425 FrameworkName
+= getFrameworkDir()->getName();
426 if (FrameworkName
.empty() || FrameworkName
.back() != '/')
427 FrameworkName
.push_back('/');
429 // FrameworkName = "/System/Library/Frameworks/Cocoa"
430 StringRef
ModuleName(Filename
.begin(), SlashPos
);
431 FrameworkName
+= ModuleName
;
433 // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
434 FrameworkName
+= ".framework/";
436 // If the cache entry was unresolved, populate it now.
437 if (!CacheEntry
.Directory
) {
438 HS
.IncrementFrameworkLookupCount();
440 // If the framework dir doesn't exist, we fail.
441 const DirectoryEntry
*Dir
= FileMgr
.getDirectory(FrameworkName
.str());
442 if (!Dir
) return nullptr;
444 // Otherwise, if it does, remember that this is the right direntry for this
446 CacheEntry
.Directory
= getFrameworkDir();
448 // If this is a user search directory, check if the framework has been
449 // user-specified as a system framework.
450 if (getDirCharacteristic() == SrcMgr::C_User
) {
451 SmallString
<1024> SystemFrameworkMarker(FrameworkName
);
452 SystemFrameworkMarker
+= ".system_framework";
453 if (llvm::sys::fs::exists(SystemFrameworkMarker
.str())) {
454 CacheEntry
.IsUserSpecifiedSystemFramework
= true;
459 // Set the 'user-specified system framework' flag.
460 InUserSpecifiedSystemFramework
= CacheEntry
.IsUserSpecifiedSystemFramework
;
463 RelativePath
->clear();
464 RelativePath
->append(Filename
.begin()+SlashPos
+1, Filename
.end());
467 // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
468 unsigned OrigSize
= FrameworkName
.size();
470 FrameworkName
+= "Headers/";
474 // Without trailing '/'.
475 SearchPath
->append(FrameworkName
.begin(), FrameworkName
.end()-1);
478 FrameworkName
.append(Filename
.begin()+SlashPos
+1, Filename
.end());
479 const FileEntry
*FE
= FileMgr
.getFile(FrameworkName
.str(),
480 /*openFile=*/!SuggestedModule
);
482 // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
483 const char *Private
= "Private";
484 FrameworkName
.insert(FrameworkName
.begin()+OrigSize
, Private
,
485 Private
+strlen(Private
));
487 SearchPath
->insert(SearchPath
->begin()+OrigSize
, Private
,
488 Private
+strlen(Private
));
490 FE
= FileMgr
.getFile(FrameworkName
.str(), /*openFile=*/!SuggestedModule
);
493 // If we found the header and are allowed to suggest a module, do so now.
494 if (FE
&& SuggestedModule
) {
495 // Find the framework in which this header occurs.
496 StringRef FrameworkPath
= FE
->getDir()->getName();
497 bool FoundFramework
= false;
499 // Determine whether this directory exists.
500 const DirectoryEntry
*Dir
= FileMgr
.getDirectory(FrameworkPath
);
504 // If this is a framework directory, then we're a subframework of this
506 if (llvm::sys::path::extension(FrameworkPath
) == ".framework") {
507 FoundFramework
= true;
511 // Get the parent directory name.
512 FrameworkPath
= llvm::sys::path::parent_path(FrameworkPath
);
513 if (FrameworkPath
.empty())
517 if (FoundFramework
) {
518 // Find the top-level framework based on this framework.
519 SmallVector
<std::string
, 4> SubmodulePath
;
520 const DirectoryEntry
*TopFrameworkDir
521 = ::getTopFrameworkDir(FileMgr
, FrameworkPath
, SubmodulePath
);
523 // Determine the name of the top-level framework.
524 StringRef ModuleName
= llvm::sys::path::stem(TopFrameworkDir
->getName());
526 // Load this framework module. If that succeeds, find the suggested module
527 // for this header, if any.
528 bool IsSystem
= getDirCharacteristic() != SrcMgr::C_User
;
529 if (HS
.loadFrameworkModule(ModuleName
, TopFrameworkDir
, IsSystem
)) {
530 *SuggestedModule
= HS
.findModuleForHeader(FE
);
533 *SuggestedModule
= HS
.findModuleForHeader(FE
);
539 void HeaderSearch::setTarget(const TargetInfo
&Target
) {
540 ModMap
.setTarget(Target
);
544 //===----------------------------------------------------------------------===//
545 // Header File Location.
546 //===----------------------------------------------------------------------===//
548 /// \brief Return true with a diagnostic if the file that MSVC would have found
549 /// fails to match the one that Clang would have found with MSVC header search
551 static bool checkMSVCHeaderSearch(DiagnosticsEngine
&Diags
,
552 const FileEntry
*MSFE
, const FileEntry
*FE
,
553 SourceLocation IncludeLoc
) {
554 if (MSFE
&& FE
!= MSFE
) {
555 Diags
.Report(IncludeLoc
, diag::ext_pp_include_search_ms
) << MSFE
->getName();
561 static const char *copyString(StringRef Str
, llvm::BumpPtrAllocator
&Alloc
) {
562 assert(!Str
.empty());
563 char *CopyStr
= Alloc
.Allocate
<char>(Str
.size()+1);
564 std::copy(Str
.begin(), Str
.end(), CopyStr
);
565 CopyStr
[Str
.size()] = '\0';
569 /// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
570 /// return null on failure. isAngled indicates whether the file reference is
571 /// for system \#include's or not (i.e. using <> instead of ""). Includers, if
572 /// non-empty, indicates where the \#including file(s) are, in case a relative
573 /// search is needed. Microsoft mode will pass all \#including files.
574 const FileEntry
*HeaderSearch::LookupFile(
575 StringRef Filename
, SourceLocation IncludeLoc
, bool isAngled
,
576 const DirectoryLookup
*FromDir
, const DirectoryLookup
*&CurDir
,
577 ArrayRef
<std::pair
<const FileEntry
*, const DirectoryEntry
*>> Includers
,
578 SmallVectorImpl
<char> *SearchPath
, SmallVectorImpl
<char> *RelativePath
,
579 ModuleMap::KnownHeader
*SuggestedModule
, bool SkipCache
) {
581 *SuggestedModule
= ModuleMap::KnownHeader();
583 // If 'Filename' is absolute, check to see if it exists and no searching.
584 if (llvm::sys::path::is_absolute(Filename
)) {
587 // If this was an #include_next "/absolute/file", fail.
588 if (FromDir
) return nullptr;
593 RelativePath
->clear();
594 RelativePath
->append(Filename
.begin(), Filename
.end());
596 // Otherwise, just return the file.
597 return FileMgr
.getFile(Filename
, /*openFile=*/true);
600 // This is the header that MSVC's header search would have found.
601 const FileEntry
*MSFE
= nullptr;
602 ModuleMap::KnownHeader MSSuggestedModule
;
604 // Unless disabled, check to see if the file is in the #includer's
605 // directory. This cannot be based on CurDir, because each includer could be
606 // a #include of a subdirectory (#include "foo/bar.h") and a subsequent
607 // include of "baz.h" should resolve to "whatever/foo/baz.h".
608 // This search is not done for <> headers.
609 if (!Includers
.empty() && !isAngled
&& !NoCurDirSearch
) {
610 SmallString
<1024> TmpDir
;
612 for (const auto &IncluderAndDir
: Includers
) {
613 const FileEntry
*Includer
= IncluderAndDir
.first
;
615 // Concatenate the requested file onto the directory.
616 // FIXME: Portability. Filename concatenation should be in sys::Path.
617 TmpDir
= IncluderAndDir
.second
->getName();
618 TmpDir
.push_back('/');
619 TmpDir
.append(Filename
.begin(), Filename
.end());
621 // FIXME: We don't cache the result of getFileInfo across the call to
622 // getFileAndSuggestModule, because it's a reference to an element of
623 // a container that could be reallocated across this call.
625 // FIXME: If we have no includer, that means we're processing a #include
626 // from a module build. We should treat this as a system header if we're
627 // building a [system] module.
628 bool IncluderIsSystemHeader
=
629 Includer
&& getFileInfo(Includer
).DirInfo
!= SrcMgr::C_User
;
630 if (const FileEntry
*FE
= getFileAndSuggestModule(
631 *this, TmpDir
.str(), IncluderAndDir
.second
,
632 IncluderIsSystemHeader
, SuggestedModule
)) {
634 assert(First
&& "only first includer can have no file");
638 // Leave CurDir unset.
639 // This file is a system header or C++ unfriendly if the old file is.
641 // Note that we only use one of FromHFI/ToHFI at once, due to potential
642 // reallocation of the underlying vector potentially making the first
643 // reference binding dangling.
644 HeaderFileInfo
&FromHFI
= getFileInfo(Includer
);
645 unsigned DirInfo
= FromHFI
.DirInfo
;
646 bool IndexHeaderMapHeader
= FromHFI
.IndexHeaderMapHeader
;
647 StringRef Framework
= FromHFI
.Framework
;
649 HeaderFileInfo
&ToHFI
= getFileInfo(FE
);
650 ToHFI
.DirInfo
= DirInfo
;
651 ToHFI
.IndexHeaderMapHeader
= IndexHeaderMapHeader
;
652 ToHFI
.Framework
= Framework
;
655 StringRef
SearchPathRef(IncluderAndDir
.second
->getName());
657 SearchPath
->append(SearchPathRef
.begin(), SearchPathRef
.end());
660 RelativePath
->clear();
661 RelativePath
->append(Filename
.begin(), Filename
.end());
666 // Otherwise, we found the path via MSVC header search rules. If
667 // -Wmsvc-include is enabled, we have to keep searching to see if we
668 // would've found this header in -I or -isystem directories.
669 if (Diags
.isIgnored(diag::ext_pp_include_search_ms
, IncludeLoc
)) {
673 if (SuggestedModule
) {
674 MSSuggestedModule
= *SuggestedModule
;
675 *SuggestedModule
= ModuleMap::KnownHeader();
686 // If this is a system #include, ignore the user #include locs.
687 unsigned i
= isAngled
? AngledDirIdx
: 0;
689 // If this is a #include_next request, start searching after the directory the
690 // file was found in.
692 i
= FromDir
-&SearchDirs
[0];
694 // Cache all of the lookups performed by this method. Many headers are
695 // multiply included, and the "pragma once" optimization prevents them from
696 // being relex/pp'd, but they would still have to search through a
697 // (potentially huge) series of SearchDirs to find it.
698 LookupFileCacheInfo
&CacheLookup
= LookupFileCache
[Filename
];
700 // If the entry has been previously looked up, the first value will be
701 // non-zero. If the value is equal to i (the start point of our search), then
702 // this is a matching hit.
703 if (!SkipCache
&& CacheLookup
.StartIdx
== i
+1) {
704 // Skip querying potentially lots of directories for this lookup.
705 i
= CacheLookup
.HitIdx
;
706 if (CacheLookup
.MappedName
)
707 Filename
= CacheLookup
.MappedName
;
709 // Otherwise, this is the first query, or the previous query didn't match
710 // our search start. We will fill in our found location below, so prime the
711 // start point value.
712 CacheLookup
.reset(/*StartIdx=*/i
+1);
715 SmallString
<64> MappedName
;
717 // Check each directory in sequence to see if it contains this file.
718 for (; i
!= SearchDirs
.size(); ++i
) {
719 bool InUserSpecifiedSystemFramework
= false;
720 bool HasBeenMapped
= false;
721 const FileEntry
*FE
=
722 SearchDirs
[i
].LookupFile(Filename
, *this, SearchPath
, RelativePath
,
723 SuggestedModule
, InUserSpecifiedSystemFramework
,
724 HasBeenMapped
, MappedName
);
726 CacheLookup
.MappedName
=
727 copyString(Filename
, LookupFileCache
.getAllocator());
731 CurDir
= &SearchDirs
[i
];
733 // This file is a system header or C++ unfriendly if the dir is.
734 HeaderFileInfo
&HFI
= getFileInfo(FE
);
735 HFI
.DirInfo
= CurDir
->getDirCharacteristic();
737 // If the directory characteristic is User but this framework was
738 // user-specified to be treated as a system framework, promote the
740 if (HFI
.DirInfo
== SrcMgr::C_User
&& InUserSpecifiedSystemFramework
)
741 HFI
.DirInfo
= SrcMgr::C_System
;
743 // If the filename matches a known system header prefix, override
744 // whether the file is a system header.
745 for (unsigned j
= SystemHeaderPrefixes
.size(); j
; --j
) {
746 if (Filename
.startswith(SystemHeaderPrefixes
[j
-1].first
)) {
747 HFI
.DirInfo
= SystemHeaderPrefixes
[j
-1].second
? SrcMgr::C_System
753 // If this file is found in a header map and uses the framework style of
754 // includes, then this header is part of a framework we're building.
755 if (CurDir
->isIndexHeaderMap()) {
756 size_t SlashPos
= Filename
.find('/');
757 if (SlashPos
!= StringRef::npos
) {
758 HFI
.IndexHeaderMapHeader
= 1;
759 HFI
.Framework
= getUniqueFrameworkName(StringRef(Filename
.begin(),
764 if (checkMSVCHeaderSearch(Diags
, MSFE
, FE
, IncludeLoc
)) {
766 *SuggestedModule
= MSSuggestedModule
;
770 // Remember this location for the next lookup we do.
771 CacheLookup
.HitIdx
= i
;
775 // If we are including a file with a quoted include "foo.h" from inside
776 // a header in a framework that is currently being built, and we couldn't
777 // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
778 // "Foo" is the name of the framework in which the including header was found.
779 if (!Includers
.empty() && Includers
.front().first
&& !isAngled
&&
780 Filename
.find('/') == StringRef::npos
) {
781 HeaderFileInfo
&IncludingHFI
= getFileInfo(Includers
.front().first
);
782 if (IncludingHFI
.IndexHeaderMapHeader
) {
783 SmallString
<128> ScratchFilename
;
784 ScratchFilename
+= IncludingHFI
.Framework
;
785 ScratchFilename
+= '/';
786 ScratchFilename
+= Filename
;
788 const FileEntry
*FE
= LookupFile(
789 ScratchFilename
, IncludeLoc
, /*isAngled=*/true, FromDir
, CurDir
,
790 Includers
.front(), SearchPath
, RelativePath
, SuggestedModule
);
792 if (checkMSVCHeaderSearch(Diags
, MSFE
, FE
, IncludeLoc
)) {
794 *SuggestedModule
= MSSuggestedModule
;
798 LookupFileCacheInfo
&CacheLookup
= LookupFileCache
[Filename
];
799 CacheLookup
.HitIdx
= LookupFileCache
[ScratchFilename
].HitIdx
;
800 // FIXME: SuggestedModule.
805 if (checkMSVCHeaderSearch(Diags
, MSFE
, nullptr, IncludeLoc
)) {
807 *SuggestedModule
= MSSuggestedModule
;
811 // Otherwise, didn't find it. Remember we didn't find this.
812 CacheLookup
.HitIdx
= SearchDirs
.size();
816 /// LookupSubframeworkHeader - Look up a subframework for the specified
817 /// \#include file. For example, if \#include'ing <HIToolbox/HIToolbox.h> from
818 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
819 /// is a subframework within Carbon.framework. If so, return the FileEntry
820 /// for the designated file, otherwise return null.
821 const FileEntry
*HeaderSearch::
822 LookupSubframeworkHeader(StringRef Filename
,
823 const FileEntry
*ContextFileEnt
,
824 SmallVectorImpl
<char> *SearchPath
,
825 SmallVectorImpl
<char> *RelativePath
,
826 ModuleMap::KnownHeader
*SuggestedModule
) {
827 assert(ContextFileEnt
&& "No context file?");
829 // Framework names must have a '/' in the filename. Find it.
830 // FIXME: Should we permit '\' on Windows?
831 size_t SlashPos
= Filename
.find('/');
832 if (SlashPos
== StringRef::npos
) return nullptr;
834 // Look up the base framework name of the ContextFileEnt.
835 const char *ContextName
= ContextFileEnt
->getName();
837 // If the context info wasn't a framework, couldn't be a subframework.
838 const unsigned DotFrameworkLen
= 10;
839 const char *FrameworkPos
= strstr(ContextName
, ".framework");
840 if (FrameworkPos
== nullptr ||
841 (FrameworkPos
[DotFrameworkLen
] != '/' &&
842 FrameworkPos
[DotFrameworkLen
] != '\\'))
845 SmallString
<1024> FrameworkName(ContextName
, FrameworkPos
+DotFrameworkLen
+1);
847 // Append Frameworks/HIToolbox.framework/
848 FrameworkName
+= "Frameworks/";
849 FrameworkName
.append(Filename
.begin(), Filename
.begin()+SlashPos
);
850 FrameworkName
+= ".framework/";
853 *FrameworkMap
.insert(std::make_pair(Filename
.substr(0, SlashPos
),
854 FrameworkCacheEntry())).first
;
856 // Some other location?
857 if (CacheLookup
.second
.Directory
&&
858 CacheLookup
.first().size() == FrameworkName
.size() &&
859 memcmp(CacheLookup
.first().data(), &FrameworkName
[0],
860 CacheLookup
.first().size()) != 0)
863 // Cache subframework.
864 if (!CacheLookup
.second
.Directory
) {
865 ++NumSubFrameworkLookups
;
867 // If the framework dir doesn't exist, we fail.
868 const DirectoryEntry
*Dir
= FileMgr
.getDirectory(FrameworkName
.str());
869 if (!Dir
) return nullptr;
871 // Otherwise, if it does, remember that this is the right direntry for this
873 CacheLookup
.second
.Directory
= Dir
;
876 const FileEntry
*FE
= nullptr;
879 RelativePath
->clear();
880 RelativePath
->append(Filename
.begin()+SlashPos
+1, Filename
.end());
883 // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
884 SmallString
<1024> HeadersFilename(FrameworkName
);
885 HeadersFilename
+= "Headers/";
888 // Without trailing '/'.
889 SearchPath
->append(HeadersFilename
.begin(), HeadersFilename
.end()-1);
892 HeadersFilename
.append(Filename
.begin()+SlashPos
+1, Filename
.end());
893 if (!(FE
= FileMgr
.getFile(HeadersFilename
.str(), /*openFile=*/true))) {
895 // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
896 HeadersFilename
= FrameworkName
;
897 HeadersFilename
+= "PrivateHeaders/";
900 // Without trailing '/'.
901 SearchPath
->append(HeadersFilename
.begin(), HeadersFilename
.end()-1);
904 HeadersFilename
.append(Filename
.begin()+SlashPos
+1, Filename
.end());
905 if (!(FE
= FileMgr
.getFile(HeadersFilename
.str(), /*openFile=*/true)))
909 // This file is a system header or C++ unfriendly if the old file is.
911 // Note that the temporary 'DirInfo' is required here, as either call to
912 // getFileInfo could resize the vector and we don't want to rely on order
914 unsigned DirInfo
= getFileInfo(ContextFileEnt
).DirInfo
;
915 getFileInfo(FE
).DirInfo
= DirInfo
;
917 // If we're supposed to suggest a module, look for one now.
918 if (SuggestedModule
) {
919 // Find the top-level framework based on this framework.
920 FrameworkName
.pop_back(); // remove the trailing '/'
921 SmallVector
<std::string
, 4> SubmodulePath
;
922 const DirectoryEntry
*TopFrameworkDir
923 = ::getTopFrameworkDir(FileMgr
, FrameworkName
, SubmodulePath
);
925 // Determine the name of the top-level framework.
926 StringRef ModuleName
= llvm::sys::path::stem(TopFrameworkDir
->getName());
928 // Load this framework module. If that succeeds, find the suggested module
929 // for this header, if any.
930 bool IsSystem
= false;
931 if (loadFrameworkModule(ModuleName
, TopFrameworkDir
, IsSystem
)) {
932 *SuggestedModule
= findModuleForHeader(FE
);
939 //===----------------------------------------------------------------------===//
940 // File Info Management.
941 //===----------------------------------------------------------------------===//
943 /// \brief Merge the header file info provided by \p OtherHFI into the current
944 /// header file info (\p HFI)
945 static void mergeHeaderFileInfo(HeaderFileInfo
&HFI
,
946 const HeaderFileInfo
&OtherHFI
) {
947 HFI
.isImport
|= OtherHFI
.isImport
;
948 HFI
.isPragmaOnce
|= OtherHFI
.isPragmaOnce
;
949 HFI
.isModuleHeader
|= OtherHFI
.isModuleHeader
;
950 HFI
.NumIncludes
+= OtherHFI
.NumIncludes
;
952 if (!HFI
.ControllingMacro
&& !HFI
.ControllingMacroID
) {
953 HFI
.ControllingMacro
= OtherHFI
.ControllingMacro
;
954 HFI
.ControllingMacroID
= OtherHFI
.ControllingMacroID
;
957 if (OtherHFI
.External
) {
958 HFI
.DirInfo
= OtherHFI
.DirInfo
;
959 HFI
.External
= OtherHFI
.External
;
960 HFI
.IndexHeaderMapHeader
= OtherHFI
.IndexHeaderMapHeader
;
963 if (HFI
.Framework
.empty())
964 HFI
.Framework
= OtherHFI
.Framework
;
969 /// getFileInfo - Return the HeaderFileInfo structure for the specified
971 HeaderFileInfo
&HeaderSearch::getFileInfo(const FileEntry
*FE
) {
972 if (FE
->getUID() >= FileInfo
.size())
973 FileInfo
.resize(FE
->getUID()+1);
975 HeaderFileInfo
&HFI
= FileInfo
[FE
->getUID()];
976 if (ExternalSource
&& !HFI
.Resolved
)
977 mergeHeaderFileInfo(HFI
, ExternalSource
->GetHeaderFileInfo(FE
));
982 bool HeaderSearch::tryGetFileInfo(const FileEntry
*FE
, HeaderFileInfo
&Result
) const {
983 if (FE
->getUID() >= FileInfo
.size())
985 const HeaderFileInfo
&HFI
= FileInfo
[FE
->getUID()];
993 bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry
*File
) {
994 // Check if we've ever seen this file as a header.
995 if (File
->getUID() >= FileInfo
.size())
998 // Resolve header file info from the external source, if needed.
999 HeaderFileInfo
&HFI
= FileInfo
[File
->getUID()];
1000 if (ExternalSource
&& !HFI
.Resolved
)
1001 mergeHeaderFileInfo(HFI
, ExternalSource
->GetHeaderFileInfo(File
));
1003 return HFI
.isPragmaOnce
|| HFI
.isImport
||
1004 HFI
.ControllingMacro
|| HFI
.ControllingMacroID
;
1007 void HeaderSearch::MarkFileModuleHeader(const FileEntry
*FE
,
1008 ModuleMap::ModuleHeaderRole Role
,
1009 bool isCompilingModuleHeader
) {
1010 if (FE
->getUID() >= FileInfo
.size())
1011 FileInfo
.resize(FE
->getUID()+1);
1013 HeaderFileInfo
&HFI
= FileInfo
[FE
->getUID()];
1014 HFI
.isModuleHeader
= true;
1015 HFI
.isCompilingModuleHeader
= isCompilingModuleHeader
;
1016 HFI
.setHeaderRole(Role
);
1019 bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry
*File
, bool isImport
){
1020 ++NumIncluded
; // Count # of attempted #includes.
1022 // Get information about this file.
1023 HeaderFileInfo
&FileInfo
= getFileInfo(File
);
1025 // If this is a #import directive, check that we have not already imported
1028 // If this has already been imported, don't import it again.
1029 FileInfo
.isImport
= true;
1031 // Has this already been #import'ed or #include'd?
1032 if (FileInfo
.NumIncludes
) return false;
1034 // Otherwise, if this is a #include of a file that was previously #import'd
1035 // or if this is the second #include of a #pragma once file, ignore it.
1036 if (FileInfo
.isImport
)
1040 // Next, check to see if the file is wrapped with #ifndef guards. If so, and
1041 // if the macro that guards it is defined, we know the #include has no effect.
1042 if (const IdentifierInfo
*ControllingMacro
1043 = FileInfo
.getControllingMacro(ExternalLookup
))
1044 if (ControllingMacro
->hasMacroDefinition()) {
1045 ++NumMultiIncludeFileOptzn
;
1049 // Increment the number of times this file has been included.
1050 ++FileInfo
.NumIncludes
;
1055 size_t HeaderSearch::getTotalMemory() const {
1056 return SearchDirs
.capacity()
1057 + llvm::capacity_in_bytes(FileInfo
)
1058 + llvm::capacity_in_bytes(HeaderMaps
)
1059 + LookupFileCache
.getAllocator().getTotalMemory()
1060 + FrameworkMap
.getAllocator().getTotalMemory();
1063 StringRef
HeaderSearch::getUniqueFrameworkName(StringRef Framework
) {
1064 return FrameworkNames
.insert(Framework
).first
->first();
1067 bool HeaderSearch::hasModuleMap(StringRef FileName
,
1068 const DirectoryEntry
*Root
,
1070 if (!enabledModules() || !LangOpts
.ModulesImplicitMaps
)
1073 SmallVector
<const DirectoryEntry
*, 2> FixUpDirectories
;
1075 StringRef DirName
= FileName
;
1077 // Get the parent directory name.
1078 DirName
= llvm::sys::path::parent_path(DirName
);
1079 if (DirName
.empty())
1082 // Determine whether this directory exists.
1083 const DirectoryEntry
*Dir
= FileMgr
.getDirectory(DirName
);
1087 // Try to load the module map file in this directory.
1088 switch (loadModuleMapFile(Dir
, IsSystem
,
1089 llvm::sys::path::extension(Dir
->getName()) ==
1091 case LMM_NewlyLoaded
:
1092 case LMM_AlreadyLoaded
:
1093 // Success. All of the directories we stepped through inherit this module
1095 for (unsigned I
= 0, N
= FixUpDirectories
.size(); I
!= N
; ++I
)
1096 DirectoryHasModuleMap
[FixUpDirectories
[I
]] = true;
1099 case LMM_NoDirectory
:
1100 case LMM_InvalidModuleMap
:
1104 // If we hit the top of our search, we're done.
1108 // Keep track of all of the directories we checked, so we can mark them as
1109 // having module maps if we eventually do find a module map.
1110 FixUpDirectories
.push_back(Dir
);
1114 ModuleMap::KnownHeader
1115 HeaderSearch::findModuleForHeader(const FileEntry
*File
) const {
1116 if (ExternalSource
) {
1117 // Make sure the external source has handled header info about this file,
1118 // which includes whether the file is part of a module.
1119 (void)getFileInfo(File
);
1121 return ModMap
.findModuleForHeader(File
);
1124 static const FileEntry
*getPrivateModuleMap(const FileEntry
*File
,
1125 FileManager
&FileMgr
) {
1126 StringRef Filename
= llvm::sys::path::filename(File
->getName());
1127 SmallString
<128> PrivateFilename(File
->getDir()->getName());
1128 if (Filename
== "module.map")
1129 llvm::sys::path::append(PrivateFilename
, "module_private.map");
1130 else if (Filename
== "module.modulemap")
1131 llvm::sys::path::append(PrivateFilename
, "module.private.modulemap");
1134 return FileMgr
.getFile(PrivateFilename
);
1137 bool HeaderSearch::loadModuleMapFile(const FileEntry
*File
, bool IsSystem
) {
1138 // Find the directory for the module. For frameworks, that may require going
1139 // up from the 'Modules' directory.
1140 const DirectoryEntry
*Dir
= nullptr;
1141 if (getHeaderSearchOpts().ModuleMapFileHomeIsCwd
)
1142 Dir
= FileMgr
.getDirectory(".");
1144 Dir
= File
->getDir();
1145 StringRef
DirName(Dir
->getName());
1146 if (llvm::sys::path::filename(DirName
) == "Modules") {
1147 DirName
= llvm::sys::path::parent_path(DirName
);
1148 if (DirName
.endswith(".framework"))
1149 Dir
= FileMgr
.getDirectory(DirName
);
1150 // FIXME: This assert can fail if there's a race between the above check
1151 // and the removal of the directory.
1152 assert(Dir
&& "parent must exist");
1156 switch (loadModuleMapFileImpl(File
, IsSystem
, Dir
)) {
1157 case LMM_AlreadyLoaded
:
1158 case LMM_NewlyLoaded
:
1160 case LMM_NoDirectory
:
1161 case LMM_InvalidModuleMap
:
1164 llvm_unreachable("Unknown load module map result");
1167 HeaderSearch::LoadModuleMapResult
1168 HeaderSearch::loadModuleMapFileImpl(const FileEntry
*File
, bool IsSystem
,
1169 const DirectoryEntry
*Dir
) {
1170 assert(File
&& "expected FileEntry");
1172 // Check whether we've already loaded this module map, and mark it as being
1173 // loaded in case we recursively try to load it from itself.
1174 auto AddResult
= LoadedModuleMaps
.insert(std::make_pair(File
, true));
1175 if (!AddResult
.second
)
1176 return AddResult
.first
->second
? LMM_AlreadyLoaded
: LMM_InvalidModuleMap
;
1178 if (ModMap
.parseModuleMapFile(File
, IsSystem
, Dir
)) {
1179 LoadedModuleMaps
[File
] = false;
1180 return LMM_InvalidModuleMap
;
1183 // Try to load a corresponding private module map.
1184 if (const FileEntry
*PMMFile
= getPrivateModuleMap(File
, FileMgr
)) {
1185 if (ModMap
.parseModuleMapFile(PMMFile
, IsSystem
, Dir
)) {
1186 LoadedModuleMaps
[File
] = false;
1187 return LMM_InvalidModuleMap
;
1191 // This directory has a module map.
1192 return LMM_NewlyLoaded
;
1196 HeaderSearch::lookupModuleMapFile(const DirectoryEntry
*Dir
, bool IsFramework
) {
1197 if (!LangOpts
.ModulesImplicitMaps
)
1199 // For frameworks, the preferred spelling is Modules/module.modulemap, but
1200 // module.map at the framework root is also accepted.
1201 SmallString
<128> ModuleMapFileName(Dir
->getName());
1203 llvm::sys::path::append(ModuleMapFileName
, "Modules");
1204 llvm::sys::path::append(ModuleMapFileName
, "module.modulemap");
1205 if (const FileEntry
*F
= FileMgr
.getFile(ModuleMapFileName
))
1208 // Continue to allow module.map
1209 ModuleMapFileName
= Dir
->getName();
1210 llvm::sys::path::append(ModuleMapFileName
, "module.map");
1211 return FileMgr
.getFile(ModuleMapFileName
);
1214 Module
*HeaderSearch::loadFrameworkModule(StringRef Name
,
1215 const DirectoryEntry
*Dir
,
1217 if (Module
*Module
= ModMap
.findModule(Name
))
1220 // Try to load a module map file.
1221 switch (loadModuleMapFile(Dir
, IsSystem
, /*IsFramework*/true)) {
1222 case LMM_InvalidModuleMap
:
1225 case LMM_AlreadyLoaded
:
1226 case LMM_NoDirectory
:
1229 case LMM_NewlyLoaded
:
1230 return ModMap
.findModule(Name
);
1234 // Try to infer a module map from the framework directory.
1235 if (LangOpts
.ModulesImplicitMaps
)
1236 return ModMap
.inferFrameworkModule(Name
, Dir
, IsSystem
, /*Parent=*/nullptr);
1242 HeaderSearch::LoadModuleMapResult
1243 HeaderSearch::loadModuleMapFile(StringRef DirName
, bool IsSystem
,
1245 if (const DirectoryEntry
*Dir
= FileMgr
.getDirectory(DirName
))
1246 return loadModuleMapFile(Dir
, IsSystem
, IsFramework
);
1248 return LMM_NoDirectory
;
1251 HeaderSearch::LoadModuleMapResult
1252 HeaderSearch::loadModuleMapFile(const DirectoryEntry
*Dir
, bool IsSystem
,
1254 auto KnownDir
= DirectoryHasModuleMap
.find(Dir
);
1255 if (KnownDir
!= DirectoryHasModuleMap
.end())
1256 return KnownDir
->second
? LMM_AlreadyLoaded
: LMM_InvalidModuleMap
;
1258 if (const FileEntry
*ModuleMapFile
= lookupModuleMapFile(Dir
, IsFramework
)) {
1259 LoadModuleMapResult Result
=
1260 loadModuleMapFileImpl(ModuleMapFile
, IsSystem
, Dir
);
1261 // Add Dir explicitly in case ModuleMapFile is in a subdirectory.
1262 // E.g. Foo.framework/Modules/module.modulemap
1263 // ^Dir ^ModuleMapFile
1264 if (Result
== LMM_NewlyLoaded
)
1265 DirectoryHasModuleMap
[Dir
] = true;
1266 else if (Result
== LMM_InvalidModuleMap
)
1267 DirectoryHasModuleMap
[Dir
] = false;
1270 return LMM_InvalidModuleMap
;
1273 void HeaderSearch::collectAllModules(SmallVectorImpl
<Module
*> &Modules
) {
1276 if (LangOpts
.ModulesImplicitMaps
) {
1277 // Load module maps for each of the header search directories.
1278 for (unsigned Idx
= 0, N
= SearchDirs
.size(); Idx
!= N
; ++Idx
) {
1279 bool IsSystem
= SearchDirs
[Idx
].isSystemHeaderDirectory();
1280 if (SearchDirs
[Idx
].isFramework()) {
1282 SmallString
<128> DirNative
;
1283 llvm::sys::path::native(SearchDirs
[Idx
].getFrameworkDir()->getName(),
1286 // Search each of the ".framework" directories to load them as modules.
1287 for (llvm::sys::fs::directory_iterator
Dir(DirNative
.str(), EC
), DirEnd
;
1288 Dir
!= DirEnd
&& !EC
; Dir
.increment(EC
)) {
1289 if (llvm::sys::path::extension(Dir
->path()) != ".framework")
1292 const DirectoryEntry
*FrameworkDir
=
1293 FileMgr
.getDirectory(Dir
->path());
1297 // Load this framework module.
1298 loadFrameworkModule(llvm::sys::path::stem(Dir
->path()), FrameworkDir
,
1304 // FIXME: Deal with header maps.
1305 if (SearchDirs
[Idx
].isHeaderMap())
1308 // Try to load a module map file for the search directory.
1309 loadModuleMapFile(SearchDirs
[Idx
].getDir(), IsSystem
,
1310 /*IsFramework*/ false);
1312 // Try to load module map files for immediate subdirectories of this
1313 // search directory.
1314 loadSubdirectoryModuleMaps(SearchDirs
[Idx
]);
1318 // Populate the list of modules.
1319 for (ModuleMap::module_iterator M
= ModMap
.module_begin(),
1320 MEnd
= ModMap
.module_end();
1322 Modules
.push_back(M
->getValue());
1326 void HeaderSearch::loadTopLevelSystemModules() {
1327 if (!LangOpts
.ModulesImplicitMaps
)
1330 // Load module maps for each of the header search directories.
1331 for (unsigned Idx
= 0, N
= SearchDirs
.size(); Idx
!= N
; ++Idx
) {
1332 // We only care about normal header directories.
1333 if (!SearchDirs
[Idx
].isNormalDir()) {
1337 // Try to load a module map file for the search directory.
1338 loadModuleMapFile(SearchDirs
[Idx
].getDir(),
1339 SearchDirs
[Idx
].isSystemHeaderDirectory(),
1340 SearchDirs
[Idx
].isFramework());
1344 void HeaderSearch::loadSubdirectoryModuleMaps(DirectoryLookup
&SearchDir
) {
1345 assert(LangOpts
.ModulesImplicitMaps
&&
1346 "Should not be loading subdirectory module maps");
1348 if (SearchDir
.haveSearchedAllModuleMaps())
1352 SmallString
<128> DirNative
;
1353 llvm::sys::path::native(SearchDir
.getDir()->getName(), DirNative
);
1354 for (llvm::sys::fs::directory_iterator
Dir(DirNative
.str(), EC
), DirEnd
;
1355 Dir
!= DirEnd
&& !EC
; Dir
.increment(EC
)) {
1356 loadModuleMapFile(Dir
->path(), SearchDir
.isSystemHeaderDirectory(),
1357 SearchDir
.isFramework());
1360 SearchDir
.setSearchedAllModuleMaps(true);