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/ExternalPreprocessorSource.h"
18 #include "clang/Lex/HeaderMap.h"
19 #include "clang/Lex/HeaderSearchOptions.h"
20 #include "clang/Lex/LexDiagnostic.h"
21 #include "clang/Lex/Lexer.h"
22 #include "clang/Lex/Preprocessor.h"
23 #include "llvm/ADT/APInt.h"
24 #include "llvm/ADT/Hashing.h"
25 #include "llvm/ADT/SmallString.h"
26 #include "llvm/Support/Capacity.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/raw_ostream.h"
32 #if defined(LLVM_ON_UNIX)
35 using namespace clang;
37 const IdentifierInfo *
38 HeaderFileInfo::getControllingMacro(ExternalPreprocessorSource *External) {
39 if (ControllingMacro) {
40 if (ControllingMacro->isOutOfDate())
41 External->updateOutOfDateIdentifier(
42 *const_cast<IdentifierInfo *>(ControllingMacro));
43 return ControllingMacro;
46 if (!ControllingMacroID || !External)
49 ControllingMacro = External->GetIdentifier(ControllingMacroID);
50 return ControllingMacro;
53 ExternalHeaderFileInfoSource::~ExternalHeaderFileInfoSource() {}
55 HeaderSearch::HeaderSearch(IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts,
56 SourceManager &SourceMgr, DiagnosticsEngine &Diags,
57 const LangOptions &LangOpts,
58 const TargetInfo *Target)
59 : HSOpts(std::move(HSOpts)), Diags(Diags),
60 FileMgr(SourceMgr.getFileManager()), FrameworkMap(64),
61 ModMap(SourceMgr, Diags, LangOpts, Target, *this) {
64 NoCurDirSearch = false;
66 ExternalLookup = nullptr;
67 ExternalSource = nullptr;
69 NumMultiIncludeFileOptzn = 0;
70 NumFrameworkLookups = NumSubFrameworkLookups = 0;
73 HeaderSearch::~HeaderSearch() {
75 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
76 delete HeaderMaps[i].second;
79 void HeaderSearch::PrintStats() {
80 fprintf(stderr, "\n*** HeaderSearch Stats:\n");
81 fprintf(stderr, "%d files tracked.\n", (int)FileInfo.size());
82 unsigned NumOnceOnlyFiles = 0, MaxNumIncludes = 0, NumSingleIncludedFiles = 0;
83 for (unsigned i = 0, e = FileInfo.size(); i != e; ++i) {
84 NumOnceOnlyFiles += FileInfo[i].isImport;
85 if (MaxNumIncludes < FileInfo[i].NumIncludes)
86 MaxNumIncludes = FileInfo[i].NumIncludes;
87 NumSingleIncludedFiles += FileInfo[i].NumIncludes == 1;
89 fprintf(stderr, " %d #import/#pragma once files.\n", NumOnceOnlyFiles);
90 fprintf(stderr, " %d included exactly once.\n", NumSingleIncludedFiles);
91 fprintf(stderr, " %d max times a file is included.\n", MaxNumIncludes);
93 fprintf(stderr, " %d #include/#include_next/#import.\n", NumIncluded);
94 fprintf(stderr, " %d #includes skipped due to"
95 " the multi-include optimization.\n", NumMultiIncludeFileOptzn);
97 fprintf(stderr, "%d framework lookups.\n", NumFrameworkLookups);
98 fprintf(stderr, "%d subframework lookups.\n", NumSubFrameworkLookups);
101 /// CreateHeaderMap - This method returns a HeaderMap for the specified
102 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
103 const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) {
104 // We expect the number of headermaps to be small, and almost always empty.
105 // If it ever grows, use of a linear search should be re-evaluated.
106 if (!HeaderMaps.empty()) {
107 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
108 // Pointer equality comparison of FileEntries works because they are
109 // already uniqued by inode.
110 if (HeaderMaps[i].first == FE)
111 return HeaderMaps[i].second;
114 if (const HeaderMap *HM = HeaderMap::Create(FE, FileMgr)) {
115 HeaderMaps.push_back(std::make_pair(FE, HM));
122 std::string HeaderSearch::getModuleFileName(Module *Module) {
123 const FileEntry *ModuleMap =
124 getModuleMap().getModuleMapFileForUniquing(Module);
125 return getModuleFileName(Module->Name, ModuleMap->getName());
128 std::string HeaderSearch::getModuleFileName(StringRef ModuleName,
129 StringRef ModuleMapPath) {
130 // If we don't have a module cache path or aren't supposed to use one, we
131 // can't do anything.
132 if (getModuleCachePath().empty())
133 return std::string();
135 SmallString<256> Result(getModuleCachePath());
136 llvm::sys::fs::make_absolute(Result);
138 if (HSOpts->DisableModuleHash) {
139 llvm::sys::path::append(Result, ModuleName + ".pcm");
141 // Construct the name <ModuleName>-<hash of ModuleMapPath>.pcm which should
142 // ideally be globally unique to this particular module. Name collisions
143 // in the hash are safe (because any translation unit can only import one
144 // module with each name), but result in a loss of caching.
146 // To avoid false-negatives, we form as canonical a path as we can, and map
147 // to lower-case in case we're on a case-insensitive file system.
149 FileMgr.getDirectory(llvm::sys::path::parent_path(ModuleMapPath));
151 return std::string();
152 auto DirName = FileMgr.getCanonicalName(Dir);
153 auto FileName = llvm::sys::path::filename(ModuleMapPath);
155 llvm::hash_code Hash =
156 llvm::hash_combine(DirName.lower(), FileName.lower());
158 SmallString<128> HashStr;
159 llvm::APInt(64, size_t(Hash)).toStringUnsigned(HashStr, /*Radix*/36);
160 llvm::sys::path::append(Result, ModuleName + "-" + HashStr + ".pcm");
162 return Result.str().str();
165 Module *HeaderSearch::lookupModule(StringRef ModuleName, bool AllowSearch) {
166 // Look in the module map to determine if there is a module by this name.
167 Module *Module = ModMap.findModule(ModuleName);
168 if (Module || !AllowSearch || !HSOpts->ImplicitModuleMaps)
171 // Look through the various header search paths to load any available module
172 // maps, searching for a module map that describes this module.
173 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
174 if (SearchDirs[Idx].isFramework()) {
175 // Search for or infer a module map for a framework.
176 SmallString<128> FrameworkDirName;
177 FrameworkDirName += SearchDirs[Idx].getFrameworkDir()->getName();
178 llvm::sys::path::append(FrameworkDirName, ModuleName + ".framework");
179 if (const DirectoryEntry *FrameworkDir
180 = FileMgr.getDirectory(FrameworkDirName)) {
182 = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
183 Module = loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
189 // FIXME: Figure out how header maps and module maps will work together.
191 // Only deal with normal search directories.
192 if (!SearchDirs[Idx].isNormalDir())
195 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
196 // Search for a module map file in this directory.
197 if (loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem,
198 /*IsFramework*/false) == LMM_NewlyLoaded) {
199 // We just loaded a module map file; check whether the module is
201 Module = ModMap.findModule(ModuleName);
206 // Search for a module map in a subdirectory with the same name as the
208 SmallString<128> NestedModuleMapDirName;
209 NestedModuleMapDirName = SearchDirs[Idx].getDir()->getName();
210 llvm::sys::path::append(NestedModuleMapDirName, ModuleName);
211 if (loadModuleMapFile(NestedModuleMapDirName, IsSystem,
212 /*IsFramework*/false) == LMM_NewlyLoaded){
213 // If we just loaded a module map file, look for the module again.
214 Module = ModMap.findModule(ModuleName);
219 // If we've already performed the exhaustive search for module maps in this
220 // search directory, don't do it again.
221 if (SearchDirs[Idx].haveSearchedAllModuleMaps())
224 // Load all module maps in the immediate subdirectories of this search
226 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
228 // Look again for the module.
229 Module = ModMap.findModule(ModuleName);
237 //===----------------------------------------------------------------------===//
238 // File lookup within a DirectoryLookup scope
239 //===----------------------------------------------------------------------===//
241 /// getName - Return the directory or filename corresponding to this lookup
243 const char *DirectoryLookup::getName() const {
245 return getDir()->getName();
247 return getFrameworkDir()->getName();
248 assert(isHeaderMap() && "Unknown DirectoryLookup");
249 return getHeaderMap()->getFileName();
252 const FileEntry *HeaderSearch::getFileAndSuggestModule(
253 StringRef FileName, const DirectoryEntry *Dir, bool IsSystemHeaderDir,
254 Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule) {
255 // If we have a module map that might map this header, load it and
256 // check whether we'll have a suggestion for a module.
257 const FileEntry *File = getFileMgr().getFile(FileName, /*OpenFile=*/true);
261 // If there is a module that corresponds to this header, suggest it.
262 if (!findUsableModuleForHeader(File, Dir ? Dir : File->getDir(),
263 RequestingModule, SuggestedModule,
270 /// LookupFile - Lookup the specified file in this search path, returning it
271 /// if it exists or returning null if not.
272 const FileEntry *DirectoryLookup::LookupFile(
275 SmallVectorImpl<char> *SearchPath,
276 SmallVectorImpl<char> *RelativePath,
277 Module *RequestingModule,
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 HS.getFileAndSuggestModule(TmpDir, getDir(),
301 isSystemHeaderDirectory(),
302 RequestingModule, SuggestedModule);
306 return DoFrameworkLookup(Filename, HS, SearchPath, RelativePath,
307 RequestingModule, SuggestedModule,
308 InUserSpecifiedSystemFramework);
310 assert(isHeaderMap() && "Unknown directory lookup");
311 const HeaderMap *HM = getHeaderMap();
312 SmallString<1024> Path;
313 StringRef Dest = HM->lookupFilename(Filename, Path);
317 const FileEntry *Result;
319 // Check if the headermap maps the filename to a framework include
320 // ("Foo.h" -> "Foo/Foo.h"), in which case continue header lookup using the
321 // framework include.
322 if (llvm::sys::path::is_relative(Dest)) {
324 MappedName.append(Dest.begin(), Dest.end());
325 Filename = StringRef(MappedName.begin(), MappedName.size());
326 HasBeenMapped = true;
327 Result = HM->LookupFile(Filename, HS.getFileMgr());
330 Result = HS.getFileMgr().getFile(Dest);
335 StringRef SearchPathRef(getName());
337 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
340 RelativePath->clear();
341 RelativePath->append(Filename.begin(), Filename.end());
347 /// \brief Given a framework directory, find the top-most framework directory.
349 /// \param FileMgr The file manager to use for directory lookups.
350 /// \param DirName The name of the framework directory.
351 /// \param SubmodulePath Will be populated with the submodule path from the
352 /// returned top-level module to the originally named framework.
353 static const DirectoryEntry *
354 getTopFrameworkDir(FileManager &FileMgr, StringRef DirName,
355 SmallVectorImpl<std::string> &SubmodulePath) {
356 assert(llvm::sys::path::extension(DirName) == ".framework" &&
357 "Not a framework directory");
359 // Note: as an egregious but useful hack we use the real path here, because
360 // frameworks moving between top-level frameworks to embedded frameworks tend
361 // to be symlinked, and we base the logical structure of modules on the
362 // physical layout. In particular, we need to deal with crazy includes like
364 // #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
366 // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
367 // which one should access with, e.g.,
369 // #include <Bar/Wibble.h>
371 // Similar issues occur when a top-level framework has moved into an
372 // embedded framework.
373 const DirectoryEntry *TopFrameworkDir = FileMgr.getDirectory(DirName);
374 DirName = FileMgr.getCanonicalName(TopFrameworkDir);
376 // Get the parent directory name.
377 DirName = llvm::sys::path::parent_path(DirName);
381 // Determine whether this directory exists.
382 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
386 // If this is a framework directory, then we're a subframework of this
388 if (llvm::sys::path::extension(DirName) == ".framework") {
389 SubmodulePath.push_back(llvm::sys::path::stem(DirName));
390 TopFrameworkDir = Dir;
394 return TopFrameworkDir;
397 /// DoFrameworkLookup - Do a lookup of the specified file in the current
398 /// DirectoryLookup, which is a framework directory.
399 const FileEntry *DirectoryLookup::DoFrameworkLookup(
400 StringRef Filename, HeaderSearch &HS, SmallVectorImpl<char> *SearchPath,
401 SmallVectorImpl<char> *RelativePath, Module *RequestingModule,
402 ModuleMap::KnownHeader *SuggestedModule,
403 bool &InUserSpecifiedSystemFramework) const {
404 FileManager &FileMgr = HS.getFileMgr();
406 // Framework names must have a '/' in the filename.
407 size_t SlashPos = Filename.find('/');
408 if (SlashPos == StringRef::npos) return nullptr;
410 // Find out if this is the home for the specified framework, by checking
411 // HeaderSearch. Possible answers are yes/no and unknown.
412 HeaderSearch::FrameworkCacheEntry &CacheEntry =
413 HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
415 // If it is known and in some other directory, fail.
416 if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
419 // Otherwise, construct the path to this framework dir.
421 // FrameworkName = "/System/Library/Frameworks/"
422 SmallString<1024> FrameworkName;
423 FrameworkName += getFrameworkDir()->getName();
424 if (FrameworkName.empty() || FrameworkName.back() != '/')
425 FrameworkName.push_back('/');
427 // FrameworkName = "/System/Library/Frameworks/Cocoa"
428 StringRef ModuleName(Filename.begin(), SlashPos);
429 FrameworkName += ModuleName;
431 // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
432 FrameworkName += ".framework/";
434 // If the cache entry was unresolved, populate it now.
435 if (!CacheEntry.Directory) {
436 HS.IncrementFrameworkLookupCount();
438 // If the framework dir doesn't exist, we fail.
439 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName);
440 if (!Dir) return nullptr;
442 // Otherwise, if it does, remember that this is the right direntry for this
444 CacheEntry.Directory = getFrameworkDir();
446 // If this is a user search directory, check if the framework has been
447 // user-specified as a system framework.
448 if (getDirCharacteristic() == SrcMgr::C_User) {
449 SmallString<1024> SystemFrameworkMarker(FrameworkName);
450 SystemFrameworkMarker += ".system_framework";
451 if (llvm::sys::fs::exists(SystemFrameworkMarker)) {
452 CacheEntry.IsUserSpecifiedSystemFramework = true;
457 // Set the 'user-specified system framework' flag.
458 InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
461 RelativePath->clear();
462 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
465 // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
466 unsigned OrigSize = FrameworkName.size();
468 FrameworkName += "Headers/";
472 // Without trailing '/'.
473 SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
476 FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
477 const FileEntry *FE = FileMgr.getFile(FrameworkName,
478 /*openFile=*/!SuggestedModule);
480 // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
481 const char *Private = "Private";
482 FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
483 Private+strlen(Private));
485 SearchPath->insert(SearchPath->begin()+OrigSize, Private,
486 Private+strlen(Private));
488 FE = FileMgr.getFile(FrameworkName, /*openFile=*/!SuggestedModule);
491 // If we found the header and are allowed to suggest a module, do so now.
492 if (FE && SuggestedModule) {
493 // Find the framework in which this header occurs.
494 StringRef FrameworkPath = FE->getDir()->getName();
495 bool FoundFramework = false;
497 // Determine whether this directory exists.
498 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkPath);
502 // If this is a framework directory, then we're a subframework of this
504 if (llvm::sys::path::extension(FrameworkPath) == ".framework") {
505 FoundFramework = true;
509 // Get the parent directory name.
510 FrameworkPath = llvm::sys::path::parent_path(FrameworkPath);
511 if (FrameworkPath.empty())
515 bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
516 if (FoundFramework) {
517 if (!HS.findUsableModuleForFrameworkHeader(
518 FE, FrameworkPath, RequestingModule, SuggestedModule, IsSystem))
521 if (!HS.findUsableModuleForHeader(FE, getDir(), RequestingModule,
522 SuggestedModule, IsSystem))
529 void HeaderSearch::setTarget(const TargetInfo &Target) {
530 ModMap.setTarget(Target);
534 //===----------------------------------------------------------------------===//
535 // Header File Location.
536 //===----------------------------------------------------------------------===//
538 /// \brief Return true with a diagnostic if the file that MSVC would have found
539 /// fails to match the one that Clang would have found with MSVC header search
541 static bool checkMSVCHeaderSearch(DiagnosticsEngine &Diags,
542 const FileEntry *MSFE, const FileEntry *FE,
543 SourceLocation IncludeLoc) {
544 if (MSFE && FE != MSFE) {
545 Diags.Report(IncludeLoc, diag::ext_pp_include_search_ms) << MSFE->getName();
551 static const char *copyString(StringRef Str, llvm::BumpPtrAllocator &Alloc) {
552 assert(!Str.empty());
553 char *CopyStr = Alloc.Allocate<char>(Str.size()+1);
554 std::copy(Str.begin(), Str.end(), CopyStr);
555 CopyStr[Str.size()] = '\0';
559 /// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
560 /// return null on failure. isAngled indicates whether the file reference is
561 /// for system \#include's or not (i.e. using <> instead of ""). Includers, if
562 /// non-empty, indicates where the \#including file(s) are, in case a relative
563 /// search is needed. Microsoft mode will pass all \#including files.
564 const FileEntry *HeaderSearch::LookupFile(
565 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
566 const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
567 ArrayRef<std::pair<const FileEntry *, const DirectoryEntry *>> Includers,
568 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
569 Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule,
570 bool SkipCache, bool BuildSystemModule) {
572 *SuggestedModule = ModuleMap::KnownHeader();
574 // If 'Filename' is absolute, check to see if it exists and no searching.
575 if (llvm::sys::path::is_absolute(Filename)) {
578 // If this was an #include_next "/absolute/file", fail.
579 if (FromDir) return nullptr;
584 RelativePath->clear();
585 RelativePath->append(Filename.begin(), Filename.end());
587 // Otherwise, just return the file.
588 return getFileAndSuggestModule(Filename, nullptr,
589 /*IsSystemHeaderDir*/false,
590 RequestingModule, SuggestedModule);
593 // This is the header that MSVC's header search would have found.
594 const FileEntry *MSFE = nullptr;
595 ModuleMap::KnownHeader MSSuggestedModule;
597 // Unless disabled, check to see if the file is in the #includer's
598 // directory. This cannot be based on CurDir, because each includer could be
599 // a #include of a subdirectory (#include "foo/bar.h") and a subsequent
600 // include of "baz.h" should resolve to "whatever/foo/baz.h".
601 // This search is not done for <> headers.
602 if (!Includers.empty() && !isAngled && !NoCurDirSearch) {
603 SmallString<1024> TmpDir;
605 for (const auto &IncluderAndDir : Includers) {
606 const FileEntry *Includer = IncluderAndDir.first;
608 // Concatenate the requested file onto the directory.
609 // FIXME: Portability. Filename concatenation should be in sys::Path.
610 TmpDir = IncluderAndDir.second->getName();
611 TmpDir.push_back('/');
612 TmpDir.append(Filename.begin(), Filename.end());
614 // FIXME: We don't cache the result of getFileInfo across the call to
615 // getFileAndSuggestModule, because it's a reference to an element of
616 // a container that could be reallocated across this call.
618 // If we have no includer, that means we're processing a #include
619 // from a module build. We should treat this as a system header if we're
620 // building a [system] module.
621 bool IncluderIsSystemHeader =
622 Includer ? getFileInfo(Includer).DirInfo != SrcMgr::C_User :
624 if (const FileEntry *FE = getFileAndSuggestModule(
625 TmpDir, IncluderAndDir.second, IncluderIsSystemHeader,
626 RequestingModule, SuggestedModule)) {
628 assert(First && "only first includer can have no file");
632 // Leave CurDir unset.
633 // This file is a system header or C++ unfriendly if the old file is.
635 // Note that we only use one of FromHFI/ToHFI at once, due to potential
636 // reallocation of the underlying vector potentially making the first
637 // reference binding dangling.
638 HeaderFileInfo &FromHFI = getFileInfo(Includer);
639 unsigned DirInfo = FromHFI.DirInfo;
640 bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
641 StringRef Framework = FromHFI.Framework;
643 HeaderFileInfo &ToHFI = getFileInfo(FE);
644 ToHFI.DirInfo = DirInfo;
645 ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
646 ToHFI.Framework = Framework;
649 StringRef SearchPathRef(IncluderAndDir.second->getName());
651 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
654 RelativePath->clear();
655 RelativePath->append(Filename.begin(), Filename.end());
660 // Otherwise, we found the path via MSVC header search rules. If
661 // -Wmsvc-include is enabled, we have to keep searching to see if we
662 // would've found this header in -I or -isystem directories.
663 if (Diags.isIgnored(diag::ext_pp_include_search_ms, IncludeLoc)) {
667 if (SuggestedModule) {
668 MSSuggestedModule = *SuggestedModule;
669 *SuggestedModule = ModuleMap::KnownHeader();
680 // If this is a system #include, ignore the user #include locs.
681 unsigned i = isAngled ? AngledDirIdx : 0;
683 // If this is a #include_next request, start searching after the directory the
684 // file was found in.
686 i = FromDir-&SearchDirs[0];
688 // Cache all of the lookups performed by this method. Many headers are
689 // multiply included, and the "pragma once" optimization prevents them from
690 // being relex/pp'd, but they would still have to search through a
691 // (potentially huge) series of SearchDirs to find it.
692 LookupFileCacheInfo &CacheLookup = LookupFileCache[Filename];
694 // If the entry has been previously looked up, the first value will be
695 // non-zero. If the value is equal to i (the start point of our search), then
696 // this is a matching hit.
697 if (!SkipCache && CacheLookup.StartIdx == i+1) {
698 // Skip querying potentially lots of directories for this lookup.
699 i = CacheLookup.HitIdx;
700 if (CacheLookup.MappedName)
701 Filename = CacheLookup.MappedName;
703 // Otherwise, this is the first query, or the previous query didn't match
704 // our search start. We will fill in our found location below, so prime the
705 // start point value.
706 CacheLookup.reset(/*StartIdx=*/i+1);
709 SmallString<64> MappedName;
711 // Check each directory in sequence to see if it contains this file.
712 for (; i != SearchDirs.size(); ++i) {
713 bool InUserSpecifiedSystemFramework = false;
714 bool HasBeenMapped = false;
715 const FileEntry *FE = SearchDirs[i].LookupFile(
716 Filename, *this, SearchPath, RelativePath, RequestingModule,
717 SuggestedModule, InUserSpecifiedSystemFramework, HasBeenMapped,
720 CacheLookup.MappedName =
721 copyString(Filename, LookupFileCache.getAllocator());
725 CurDir = &SearchDirs[i];
727 // This file is a system header or C++ unfriendly if the dir is.
728 HeaderFileInfo &HFI = getFileInfo(FE);
729 HFI.DirInfo = CurDir->getDirCharacteristic();
731 // If the directory characteristic is User but this framework was
732 // user-specified to be treated as a system framework, promote the
734 if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
735 HFI.DirInfo = SrcMgr::C_System;
737 // If the filename matches a known system header prefix, override
738 // whether the file is a system header.
739 for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
740 if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
741 HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
747 // If this file is found in a header map and uses the framework style of
748 // includes, then this header is part of a framework we're building.
749 if (CurDir->isIndexHeaderMap()) {
750 size_t SlashPos = Filename.find('/');
751 if (SlashPos != StringRef::npos) {
752 HFI.IndexHeaderMapHeader = 1;
753 HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
758 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc)) {
760 *SuggestedModule = MSSuggestedModule;
764 // Remember this location for the next lookup we do.
765 CacheLookup.HitIdx = i;
769 // If we are including a file with a quoted include "foo.h" from inside
770 // a header in a framework that is currently being built, and we couldn't
771 // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
772 // "Foo" is the name of the framework in which the including header was found.
773 if (!Includers.empty() && Includers.front().first && !isAngled &&
774 Filename.find('/') == StringRef::npos) {
775 HeaderFileInfo &IncludingHFI = getFileInfo(Includers.front().first);
776 if (IncludingHFI.IndexHeaderMapHeader) {
777 SmallString<128> ScratchFilename;
778 ScratchFilename += IncludingHFI.Framework;
779 ScratchFilename += '/';
780 ScratchFilename += Filename;
782 const FileEntry *FE =
783 LookupFile(ScratchFilename, IncludeLoc, /*isAngled=*/true, FromDir,
784 CurDir, Includers.front(), SearchPath, RelativePath,
785 RequestingModule, SuggestedModule);
787 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc)) {
789 *SuggestedModule = MSSuggestedModule;
793 LookupFileCacheInfo &CacheLookup = LookupFileCache[Filename];
794 CacheLookup.HitIdx = LookupFileCache[ScratchFilename].HitIdx;
795 // FIXME: SuggestedModule.
800 if (checkMSVCHeaderSearch(Diags, MSFE, nullptr, IncludeLoc)) {
802 *SuggestedModule = MSSuggestedModule;
806 // Otherwise, didn't find it. Remember we didn't find this.
807 CacheLookup.HitIdx = SearchDirs.size();
811 /// LookupSubframeworkHeader - Look up a subframework for the specified
812 /// \#include file. For example, if \#include'ing <HIToolbox/HIToolbox.h> from
813 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
814 /// is a subframework within Carbon.framework. If so, return the FileEntry
815 /// for the designated file, otherwise return null.
816 const FileEntry *HeaderSearch::
817 LookupSubframeworkHeader(StringRef Filename,
818 const FileEntry *ContextFileEnt,
819 SmallVectorImpl<char> *SearchPath,
820 SmallVectorImpl<char> *RelativePath,
821 Module *RequestingModule,
822 ModuleMap::KnownHeader *SuggestedModule) {
823 assert(ContextFileEnt && "No context file?");
825 // Framework names must have a '/' in the filename. Find it.
826 // FIXME: Should we permit '\' on Windows?
827 size_t SlashPos = Filename.find('/');
828 if (SlashPos == StringRef::npos) return nullptr;
830 // Look up the base framework name of the ContextFileEnt.
831 const char *ContextName = ContextFileEnt->getName();
833 // If the context info wasn't a framework, couldn't be a subframework.
834 const unsigned DotFrameworkLen = 10;
835 const char *FrameworkPos = strstr(ContextName, ".framework");
836 if (FrameworkPos == nullptr ||
837 (FrameworkPos[DotFrameworkLen] != '/' &&
838 FrameworkPos[DotFrameworkLen] != '\\'))
841 SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
843 // Append Frameworks/HIToolbox.framework/
844 FrameworkName += "Frameworks/";
845 FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
846 FrameworkName += ".framework/";
849 *FrameworkMap.insert(std::make_pair(Filename.substr(0, SlashPos),
850 FrameworkCacheEntry())).first;
852 // Some other location?
853 if (CacheLookup.second.Directory &&
854 CacheLookup.first().size() == FrameworkName.size() &&
855 memcmp(CacheLookup.first().data(), &FrameworkName[0],
856 CacheLookup.first().size()) != 0)
859 // Cache subframework.
860 if (!CacheLookup.second.Directory) {
861 ++NumSubFrameworkLookups;
863 // If the framework dir doesn't exist, we fail.
864 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName);
865 if (!Dir) return nullptr;
867 // Otherwise, if it does, remember that this is the right direntry for this
869 CacheLookup.second.Directory = Dir;
872 const FileEntry *FE = nullptr;
875 RelativePath->clear();
876 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
879 // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
880 SmallString<1024> HeadersFilename(FrameworkName);
881 HeadersFilename += "Headers/";
884 // Without trailing '/'.
885 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
888 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
889 if (!(FE = FileMgr.getFile(HeadersFilename, /*openFile=*/true))) {
891 // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
892 HeadersFilename = FrameworkName;
893 HeadersFilename += "PrivateHeaders/";
896 // Without trailing '/'.
897 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
900 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
901 if (!(FE = FileMgr.getFile(HeadersFilename, /*openFile=*/true)))
905 // This file is a system header or C++ unfriendly if the old file is.
907 // Note that the temporary 'DirInfo' is required here, as either call to
908 // getFileInfo could resize the vector and we don't want to rely on order
910 unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
911 getFileInfo(FE).DirInfo = DirInfo;
913 FrameworkName.pop_back(); // remove the trailing '/'
914 if (!findUsableModuleForFrameworkHeader(FE, FrameworkName, RequestingModule,
915 SuggestedModule, /*IsSystem*/ false))
921 //===----------------------------------------------------------------------===//
922 // File Info Management.
923 //===----------------------------------------------------------------------===//
925 /// \brief Merge the header file info provided by \p OtherHFI into the current
926 /// header file info (\p HFI)
927 static void mergeHeaderFileInfo(HeaderFileInfo &HFI,
928 const HeaderFileInfo &OtherHFI) {
929 assert(OtherHFI.External && "expected to merge external HFI");
931 HFI.isImport |= OtherHFI.isImport;
932 HFI.isPragmaOnce |= OtherHFI.isPragmaOnce;
933 HFI.isModuleHeader |= OtherHFI.isModuleHeader;
934 HFI.NumIncludes += OtherHFI.NumIncludes;
936 if (!HFI.ControllingMacro && !HFI.ControllingMacroID) {
937 HFI.ControllingMacro = OtherHFI.ControllingMacro;
938 HFI.ControllingMacroID = OtherHFI.ControllingMacroID;
941 HFI.DirInfo = OtherHFI.DirInfo;
942 HFI.External = (!HFI.IsValid || HFI.External);
944 HFI.IndexHeaderMapHeader = OtherHFI.IndexHeaderMapHeader;
946 if (HFI.Framework.empty())
947 HFI.Framework = OtherHFI.Framework;
950 /// getFileInfo - Return the HeaderFileInfo structure for the specified
952 HeaderFileInfo &HeaderSearch::getFileInfo(const FileEntry *FE) {
953 if (FE->getUID() >= FileInfo.size())
954 FileInfo.resize(FE->getUID() + 1);
956 HeaderFileInfo *HFI = &FileInfo[FE->getUID()];
957 // FIXME: Use a generation count to check whether this is really up to date.
958 if (ExternalSource && !HFI->Resolved) {
959 HFI->Resolved = true;
960 auto ExternalHFI = ExternalSource->GetHeaderFileInfo(FE);
962 HFI = &FileInfo[FE->getUID()];
963 if (ExternalHFI.External)
964 mergeHeaderFileInfo(*HFI, ExternalHFI);
968 // We have local information about this header file, so it's no longer
969 // strictly external.
970 HFI->External = false;
974 const HeaderFileInfo *
975 HeaderSearch::getExistingFileInfo(const FileEntry *FE,
976 bool WantExternal) const {
977 // If we have an external source, ensure we have the latest information.
978 // FIXME: Use a generation count to check whether this is really up to date.
980 if (ExternalSource) {
981 if (FE->getUID() >= FileInfo.size()) {
984 FileInfo.resize(FE->getUID() + 1);
987 HFI = &FileInfo[FE->getUID()];
988 if (!WantExternal && (!HFI->IsValid || HFI->External))
990 if (!HFI->Resolved) {
991 HFI->Resolved = true;
992 auto ExternalHFI = ExternalSource->GetHeaderFileInfo(FE);
994 HFI = &FileInfo[FE->getUID()];
995 if (ExternalHFI.External)
996 mergeHeaderFileInfo(*HFI, ExternalHFI);
998 } else if (FE->getUID() >= FileInfo.size()) {
1001 HFI = &FileInfo[FE->getUID()];
1004 if (!HFI->IsValid || (HFI->External && !WantExternal))
1010 bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
1011 // Check if we've ever seen this file as a header.
1012 if (auto *HFI = getExistingFileInfo(File))
1013 return HFI->isPragmaOnce || HFI->isImport || HFI->ControllingMacro ||
1014 HFI->ControllingMacroID;
1018 void HeaderSearch::MarkFileModuleHeader(const FileEntry *FE,
1019 ModuleMap::ModuleHeaderRole Role,
1020 bool isCompilingModuleHeader) {
1021 bool isModularHeader = !(Role & ModuleMap::TextualHeader);
1023 // Don't mark the file info as non-external if there's nothing to change.
1024 if (!isCompilingModuleHeader) {
1025 if (!isModularHeader)
1027 auto *HFI = getExistingFileInfo(FE);
1028 if (HFI && HFI->isModuleHeader)
1032 auto &HFI = getFileInfo(FE);
1033 HFI.isModuleHeader |= isModularHeader;
1034 HFI.isCompilingModuleHeader |= isCompilingModuleHeader;
1037 bool HeaderSearch::ShouldEnterIncludeFile(Preprocessor &PP,
1038 const FileEntry *File,
1039 bool isImport, Module *M) {
1040 ++NumIncluded; // Count # of attempted #includes.
1042 // Get information about this file.
1043 HeaderFileInfo &FileInfo = getFileInfo(File);
1045 // If this is a #import directive, check that we have not already imported
1048 // If this has already been imported, don't import it again.
1049 FileInfo.isImport = true;
1051 // Has this already been #import'ed or #include'd?
1052 if (FileInfo.NumIncludes) return false;
1054 // Otherwise, if this is a #include of a file that was previously #import'd
1055 // or if this is the second #include of a #pragma once file, ignore it.
1056 if (FileInfo.isImport)
1060 // Next, check to see if the file is wrapped with #ifndef guards. If so, and
1061 // if the macro that guards it is defined, we know the #include has no effect.
1062 if (const IdentifierInfo *ControllingMacro
1063 = FileInfo.getControllingMacro(ExternalLookup)) {
1064 // If the header corresponds to a module, check whether the macro is already
1065 // defined in that module rather than checking in the current set of visible
1067 if (M ? PP.isMacroDefinedInLocalModule(ControllingMacro, M)
1068 : PP.isMacroDefined(ControllingMacro)) {
1069 ++NumMultiIncludeFileOptzn;
1074 // Increment the number of times this file has been included.
1075 ++FileInfo.NumIncludes;
1080 size_t HeaderSearch::getTotalMemory() const {
1081 return SearchDirs.capacity()
1082 + llvm::capacity_in_bytes(FileInfo)
1083 + llvm::capacity_in_bytes(HeaderMaps)
1084 + LookupFileCache.getAllocator().getTotalMemory()
1085 + FrameworkMap.getAllocator().getTotalMemory();
1088 StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
1089 return FrameworkNames.insert(Framework).first->first();
1092 bool HeaderSearch::hasModuleMap(StringRef FileName,
1093 const DirectoryEntry *Root,
1095 if (!HSOpts->ImplicitModuleMaps)
1098 SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
1100 StringRef DirName = FileName;
1102 // Get the parent directory name.
1103 DirName = llvm::sys::path::parent_path(DirName);
1104 if (DirName.empty())
1107 // Determine whether this directory exists.
1108 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
1112 // Try to load the module map file in this directory.
1113 switch (loadModuleMapFile(Dir, IsSystem,
1114 llvm::sys::path::extension(Dir->getName()) ==
1116 case LMM_NewlyLoaded:
1117 case LMM_AlreadyLoaded:
1118 // Success. All of the directories we stepped through inherit this module
1120 for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
1121 DirectoryHasModuleMap[FixUpDirectories[I]] = true;
1124 case LMM_NoDirectory:
1125 case LMM_InvalidModuleMap:
1129 // If we hit the top of our search, we're done.
1133 // Keep track of all of the directories we checked, so we can mark them as
1134 // having module maps if we eventually do find a module map.
1135 FixUpDirectories.push_back(Dir);
1139 ModuleMap::KnownHeader
1140 HeaderSearch::findModuleForHeader(const FileEntry *File) const {
1141 if (ExternalSource) {
1142 // Make sure the external source has handled header info about this file,
1143 // which includes whether the file is part of a module.
1144 (void)getExistingFileInfo(File);
1146 return ModMap.findModuleForHeader(File);
1149 bool HeaderSearch::findUsableModuleForHeader(
1150 const FileEntry *File, const DirectoryEntry *Root, Module *RequestingModule,
1151 ModuleMap::KnownHeader *SuggestedModule, bool IsSystemHeaderDir) {
1152 if (File && SuggestedModule) {
1153 // If there is a module that corresponds to this header, suggest it.
1154 hasModuleMap(File->getName(), Root, IsSystemHeaderDir);
1155 *SuggestedModule = findModuleForHeader(File);
1160 bool HeaderSearch::findUsableModuleForFrameworkHeader(
1161 const FileEntry *File, StringRef FrameworkName, Module *RequestingModule,
1162 ModuleMap::KnownHeader *SuggestedModule, bool IsSystemFramework) {
1163 // If we're supposed to suggest a module, look for one now.
1164 if (SuggestedModule) {
1165 // Find the top-level framework based on this framework.
1166 SmallVector<std::string, 4> SubmodulePath;
1167 const DirectoryEntry *TopFrameworkDir
1168 = ::getTopFrameworkDir(FileMgr, FrameworkName, SubmodulePath);
1170 // Determine the name of the top-level framework.
1171 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
1173 // Load this framework module. If that succeeds, find the suggested module
1174 // for this header, if any.
1175 loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystemFramework);
1177 // FIXME: This can find a module not part of ModuleName, which is
1178 // important so that we're consistent about whether this header
1179 // corresponds to a module. Possibly we should lock down framework modules
1180 // so that this is not possible.
1181 *SuggestedModule = findModuleForHeader(File);
1186 static const FileEntry *getPrivateModuleMap(const FileEntry *File,
1187 FileManager &FileMgr) {
1188 StringRef Filename = llvm::sys::path::filename(File->getName());
1189 SmallString<128> PrivateFilename(File->getDir()->getName());
1190 if (Filename == "module.map")
1191 llvm::sys::path::append(PrivateFilename, "module_private.map");
1192 else if (Filename == "module.modulemap")
1193 llvm::sys::path::append(PrivateFilename, "module.private.modulemap");
1196 return FileMgr.getFile(PrivateFilename);
1199 bool HeaderSearch::loadModuleMapFile(const FileEntry *File, bool IsSystem) {
1200 // Find the directory for the module. For frameworks, that may require going
1201 // up from the 'Modules' directory.
1202 const DirectoryEntry *Dir = nullptr;
1203 if (getHeaderSearchOpts().ModuleMapFileHomeIsCwd)
1204 Dir = FileMgr.getDirectory(".");
1206 Dir = File->getDir();
1207 StringRef DirName(Dir->getName());
1208 if (llvm::sys::path::filename(DirName) == "Modules") {
1209 DirName = llvm::sys::path::parent_path(DirName);
1210 if (DirName.endswith(".framework"))
1211 Dir = FileMgr.getDirectory(DirName);
1212 // FIXME: This assert can fail if there's a race between the above check
1213 // and the removal of the directory.
1214 assert(Dir && "parent must exist");
1218 switch (loadModuleMapFileImpl(File, IsSystem, Dir)) {
1219 case LMM_AlreadyLoaded:
1220 case LMM_NewlyLoaded:
1222 case LMM_NoDirectory:
1223 case LMM_InvalidModuleMap:
1226 llvm_unreachable("Unknown load module map result");
1229 HeaderSearch::LoadModuleMapResult
1230 HeaderSearch::loadModuleMapFileImpl(const FileEntry *File, bool IsSystem,
1231 const DirectoryEntry *Dir) {
1232 assert(File && "expected FileEntry");
1234 // Check whether we've already loaded this module map, and mark it as being
1235 // loaded in case we recursively try to load it from itself.
1236 auto AddResult = LoadedModuleMaps.insert(std::make_pair(File, true));
1237 if (!AddResult.second)
1238 return AddResult.first->second ? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
1240 if (ModMap.parseModuleMapFile(File, IsSystem, Dir)) {
1241 LoadedModuleMaps[File] = false;
1242 return LMM_InvalidModuleMap;
1245 // Try to load a corresponding private module map.
1246 if (const FileEntry *PMMFile = getPrivateModuleMap(File, FileMgr)) {
1247 if (ModMap.parseModuleMapFile(PMMFile, IsSystem, Dir)) {
1248 LoadedModuleMaps[File] = false;
1249 return LMM_InvalidModuleMap;
1253 // This directory has a module map.
1254 return LMM_NewlyLoaded;
1258 HeaderSearch::lookupModuleMapFile(const DirectoryEntry *Dir, bool IsFramework) {
1259 if (!HSOpts->ImplicitModuleMaps)
1261 // For frameworks, the preferred spelling is Modules/module.modulemap, but
1262 // module.map at the framework root is also accepted.
1263 SmallString<128> ModuleMapFileName(Dir->getName());
1265 llvm::sys::path::append(ModuleMapFileName, "Modules");
1266 llvm::sys::path::append(ModuleMapFileName, "module.modulemap");
1267 if (const FileEntry *F = FileMgr.getFile(ModuleMapFileName))
1270 // Continue to allow module.map
1271 ModuleMapFileName = Dir->getName();
1272 llvm::sys::path::append(ModuleMapFileName, "module.map");
1273 return FileMgr.getFile(ModuleMapFileName);
1276 Module *HeaderSearch::loadFrameworkModule(StringRef Name,
1277 const DirectoryEntry *Dir,
1279 if (Module *Module = ModMap.findModule(Name))
1282 // Try to load a module map file.
1283 switch (loadModuleMapFile(Dir, IsSystem, /*IsFramework*/true)) {
1284 case LMM_InvalidModuleMap:
1285 // Try to infer a module map from the framework directory.
1286 if (HSOpts->ImplicitModuleMaps)
1287 ModMap.inferFrameworkModule(Dir, IsSystem, /*Parent=*/nullptr);
1290 case LMM_AlreadyLoaded:
1291 case LMM_NoDirectory:
1294 case LMM_NewlyLoaded:
1298 return ModMap.findModule(Name);
1302 HeaderSearch::LoadModuleMapResult
1303 HeaderSearch::loadModuleMapFile(StringRef DirName, bool IsSystem,
1305 if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
1306 return loadModuleMapFile(Dir, IsSystem, IsFramework);
1308 return LMM_NoDirectory;
1311 HeaderSearch::LoadModuleMapResult
1312 HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir, bool IsSystem,
1314 auto KnownDir = DirectoryHasModuleMap.find(Dir);
1315 if (KnownDir != DirectoryHasModuleMap.end())
1316 return KnownDir->second ? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
1318 if (const FileEntry *ModuleMapFile = lookupModuleMapFile(Dir, IsFramework)) {
1319 LoadModuleMapResult Result =
1320 loadModuleMapFileImpl(ModuleMapFile, IsSystem, Dir);
1321 // Add Dir explicitly in case ModuleMapFile is in a subdirectory.
1322 // E.g. Foo.framework/Modules/module.modulemap
1323 // ^Dir ^ModuleMapFile
1324 if (Result == LMM_NewlyLoaded)
1325 DirectoryHasModuleMap[Dir] = true;
1326 else if (Result == LMM_InvalidModuleMap)
1327 DirectoryHasModuleMap[Dir] = false;
1330 return LMM_InvalidModuleMap;
1333 void HeaderSearch::collectAllModules(SmallVectorImpl<Module *> &Modules) {
1336 if (HSOpts->ImplicitModuleMaps) {
1337 // Load module maps for each of the header search directories.
1338 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1339 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
1340 if (SearchDirs[Idx].isFramework()) {
1342 SmallString<128> DirNative;
1343 llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1346 // Search each of the ".framework" directories to load them as modules.
1347 vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
1348 for (vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
1349 Dir != DirEnd && !EC; Dir.increment(EC)) {
1350 if (llvm::sys::path::extension(Dir->getName()) != ".framework")
1353 const DirectoryEntry *FrameworkDir =
1354 FileMgr.getDirectory(Dir->getName());
1358 // Load this framework module.
1359 loadFrameworkModule(llvm::sys::path::stem(Dir->getName()),
1360 FrameworkDir, IsSystem);
1365 // FIXME: Deal with header maps.
1366 if (SearchDirs[Idx].isHeaderMap())
1369 // Try to load a module map file for the search directory.
1370 loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem,
1371 /*IsFramework*/ false);
1373 // Try to load module map files for immediate subdirectories of this
1374 // search directory.
1375 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
1379 // Populate the list of modules.
1380 for (ModuleMap::module_iterator M = ModMap.module_begin(),
1381 MEnd = ModMap.module_end();
1383 Modules.push_back(M->getValue());
1387 void HeaderSearch::loadTopLevelSystemModules() {
1388 if (!HSOpts->ImplicitModuleMaps)
1391 // Load module maps for each of the header search directories.
1392 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1393 // We only care about normal header directories.
1394 if (!SearchDirs[Idx].isNormalDir()) {
1398 // Try to load a module map file for the search directory.
1399 loadModuleMapFile(SearchDirs[Idx].getDir(),
1400 SearchDirs[Idx].isSystemHeaderDirectory(),
1401 SearchDirs[Idx].isFramework());
1405 void HeaderSearch::loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir) {
1406 assert(HSOpts->ImplicitModuleMaps &&
1407 "Should not be loading subdirectory module maps");
1409 if (SearchDir.haveSearchedAllModuleMaps())
1413 SmallString<128> DirNative;
1414 llvm::sys::path::native(SearchDir.getDir()->getName(), DirNative);
1415 vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
1416 for (vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
1417 Dir != DirEnd && !EC; Dir.increment(EC)) {
1419 llvm::sys::path::extension(Dir->getName()) == ".framework";
1420 if (IsFramework == SearchDir.isFramework())
1421 loadModuleMapFile(Dir->getName(), SearchDir.isSystemHeaderDirectory(),
1422 SearchDir.isFramework());
1425 SearchDir.setSearchedAllModuleMaps(true);
1428 std::string HeaderSearch::suggestPathToFileForDiagnostics(const FileEntry *File,
1430 // FIXME: We assume that the path name currently cached in the FileEntry is
1431 // the most appropriate one for this analysis (and that it's spelled the same
1432 // way as the corresponding header search path).
1433 const char *Name = File->getName();
1435 unsigned BestPrefixLength = 0;
1436 unsigned BestSearchDir;
1438 for (unsigned I = 0; I != SearchDirs.size(); ++I) {
1439 // FIXME: Support this search within frameworks and header maps.
1440 if (!SearchDirs[I].isNormalDir())
1443 const char *Dir = SearchDirs[I].getDir()->getName();
1444 for (auto NI = llvm::sys::path::begin(Name),
1445 NE = llvm::sys::path::end(Name),
1446 DI = llvm::sys::path::begin(Dir),
1447 DE = llvm::sys::path::end(Dir);
1448 /*termination condition in loop*/; ++NI, ++DI) {
1449 // '.' components in Name are ignored.
1450 while (NI != NE && *NI == ".")
1455 // '.' components in Dir are ignored.
1456 while (DI != DE && *DI == ".")
1459 // Dir is a prefix of Name, up to '.' components and choice of path
1461 unsigned PrefixLength = NI - llvm::sys::path::begin(Name);
1462 if (PrefixLength > BestPrefixLength) {
1463 BestPrefixLength = PrefixLength;
1475 *IsSystem = BestPrefixLength ? BestSearchDir >= SystemDirIdx : false;
1476 return Name + BestPrefixLength;