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/SmallString.h"
22 #include "llvm/Support/Capacity.h"
23 #include "llvm/Support/FileSystem.h"
24 #include "llvm/Support/Path.h"
25 #include "llvm/Support/raw_ostream.h"
27 #if defined(LLVM_ON_UNIX)
30 using namespace clang;
32 const IdentifierInfo *
33 HeaderFileInfo::getControllingMacro(ExternalIdentifierLookup *External) {
35 return ControllingMacro;
37 if (!ControllingMacroID || !External)
40 ControllingMacro = External->GetIdentifier(ControllingMacroID);
41 return ControllingMacro;
44 ExternalHeaderFileInfoSource::~ExternalHeaderFileInfoSource() {}
46 HeaderSearch::HeaderSearch(IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts,
47 SourceManager &SourceMgr, DiagnosticsEngine &Diags,
48 const LangOptions &LangOpts,
49 const TargetInfo *Target)
50 : HSOpts(HSOpts), Diags(Diags), FileMgr(SourceMgr.getFileManager()),
51 FrameworkMap(64), ModMap(SourceMgr, Diags, LangOpts, Target, *this) {
54 NoCurDirSearch = false;
59 NumMultiIncludeFileOptzn = 0;
60 NumFrameworkLookups = NumSubFrameworkLookups = 0;
62 EnabledModules = LangOpts.Modules;
65 HeaderSearch::~HeaderSearch() {
67 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
68 delete HeaderMaps[i].second;
71 void HeaderSearch::PrintStats() {
72 fprintf(stderr, "\n*** HeaderSearch Stats:\n");
73 fprintf(stderr, "%d files tracked.\n", (int)FileInfo.size());
74 unsigned NumOnceOnlyFiles = 0, MaxNumIncludes = 0, NumSingleIncludedFiles = 0;
75 for (unsigned i = 0, e = FileInfo.size(); i != e; ++i) {
76 NumOnceOnlyFiles += FileInfo[i].isImport;
77 if (MaxNumIncludes < FileInfo[i].NumIncludes)
78 MaxNumIncludes = FileInfo[i].NumIncludes;
79 NumSingleIncludedFiles += FileInfo[i].NumIncludes == 1;
81 fprintf(stderr, " %d #import/#pragma once files.\n", NumOnceOnlyFiles);
82 fprintf(stderr, " %d included exactly once.\n", NumSingleIncludedFiles);
83 fprintf(stderr, " %d max times a file is included.\n", MaxNumIncludes);
85 fprintf(stderr, " %d #include/#include_next/#import.\n", NumIncluded);
86 fprintf(stderr, " %d #includes skipped due to"
87 " the multi-include optimization.\n", NumMultiIncludeFileOptzn);
89 fprintf(stderr, "%d framework lookups.\n", NumFrameworkLookups);
90 fprintf(stderr, "%d subframework lookups.\n", NumSubFrameworkLookups);
93 /// CreateHeaderMap - This method returns a HeaderMap for the specified
94 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
95 const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) {
96 // We expect the number of headermaps to be small, and almost always empty.
97 // If it ever grows, use of a linear search should be re-evaluated.
98 if (!HeaderMaps.empty()) {
99 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
100 // Pointer equality comparison of FileEntries works because they are
101 // already uniqued by inode.
102 if (HeaderMaps[i].first == FE)
103 return HeaderMaps[i].second;
106 if (const HeaderMap *HM = HeaderMap::Create(FE, FileMgr)) {
107 HeaderMaps.push_back(std::make_pair(FE, HM));
114 std::string HeaderSearch::getModuleFileName(Module *Module) {
115 // If we don't have a module cache path, we can't do anything.
116 if (ModuleCachePath.empty())
117 return std::string();
120 SmallString<256> Result(ModuleCachePath);
121 llvm::sys::path::append(Result, Module->getTopLevelModule()->Name + ".pcm");
122 return Result.str().str();
125 std::string HeaderSearch::getModuleFileName(StringRef ModuleName) {
126 // If we don't have a module cache path, we can't do anything.
127 if (ModuleCachePath.empty())
128 return std::string();
131 SmallString<256> Result(ModuleCachePath);
132 llvm::sys::path::append(Result, ModuleName + ".pcm");
133 return Result.str().str();
136 Module *HeaderSearch::lookupModule(StringRef ModuleName, bool AllowSearch) {
137 // Look in the module map to determine if there is a module by this name.
138 Module *Module = ModMap.findModule(ModuleName);
139 if (Module || !AllowSearch)
142 // Look through the various header search paths to load any available module
143 // maps, searching for a module map that describes this module.
144 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
145 if (SearchDirs[Idx].isFramework()) {
146 // Search for or infer a module map for a framework.
147 SmallString<128> FrameworkDirName;
148 FrameworkDirName += SearchDirs[Idx].getFrameworkDir()->getName();
149 llvm::sys::path::append(FrameworkDirName, ModuleName + ".framework");
150 if (const DirectoryEntry *FrameworkDir
151 = FileMgr.getDirectory(FrameworkDirName)) {
153 = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
154 Module = loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
160 // FIXME: Figure out how header maps and module maps will work together.
162 // Only deal with normal search directories.
163 if (!SearchDirs[Idx].isNormalDir())
166 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
167 // Search for a module map file in this directory.
168 if (loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem)
169 == LMM_NewlyLoaded) {
170 // We just loaded a module map file; check whether the module is
172 Module = ModMap.findModule(ModuleName);
177 // Search for a module map in a subdirectory with the same name as the
179 SmallString<128> NestedModuleMapDirName;
180 NestedModuleMapDirName = SearchDirs[Idx].getDir()->getName();
181 llvm::sys::path::append(NestedModuleMapDirName, ModuleName);
182 if (loadModuleMapFile(NestedModuleMapDirName, IsSystem) == LMM_NewlyLoaded){
183 // If we just loaded a module map file, look for the module again.
184 Module = ModMap.findModule(ModuleName);
189 // If we've already performed the exhaustive search for module maps in this
190 // search directory, don't do it again.
191 if (SearchDirs[Idx].haveSearchedAllModuleMaps())
194 // Load all module maps in the immediate subdirectories of this search
196 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
198 // Look again for the module.
199 Module = ModMap.findModule(ModuleName);
207 //===----------------------------------------------------------------------===//
208 // File lookup within a DirectoryLookup scope
209 //===----------------------------------------------------------------------===//
211 /// getName - Return the directory or filename corresponding to this lookup
213 const char *DirectoryLookup::getName() const {
215 return getDir()->getName();
217 return getFrameworkDir()->getName();
218 assert(isHeaderMap() && "Unknown DirectoryLookup");
219 return getHeaderMap()->getFileName();
223 /// LookupFile - Lookup the specified file in this search path, returning it
224 /// if it exists or returning null if not.
225 const FileEntry *DirectoryLookup::LookupFile(
228 SmallVectorImpl<char> *SearchPath,
229 SmallVectorImpl<char> *RelativePath,
230 ModuleMap::KnownHeader *SuggestedModule,
231 bool &InUserSpecifiedSystemFramework,
232 SmallVectorImpl<char> &MappedName) const {
233 InUserSpecifiedSystemFramework = false;
235 SmallString<1024> TmpDir;
237 // Concatenate the requested file onto the directory.
238 TmpDir = getDir()->getName();
239 llvm::sys::path::append(TmpDir, Filename);
240 if (SearchPath != NULL) {
241 StringRef SearchPathRef(getDir()->getName());
243 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
245 if (RelativePath != NULL) {
246 RelativePath->clear();
247 RelativePath->append(Filename.begin(), Filename.end());
250 // If we have a module map that might map this header, load it and
251 // check whether we'll have a suggestion for a module.
252 HS.hasModuleMap(TmpDir, getDir(), isSystemHeaderDirectory());
253 if (SuggestedModule) {
254 const FileEntry *File = HS.getFileMgr().getFile(TmpDir.str(),
259 // If there is a module that corresponds to this header, suggest it.
260 *SuggestedModule = HS.findModuleForHeader(File);
261 if (!SuggestedModule->getModule() &&
262 HS.hasModuleMap(TmpDir, getDir(), isSystemHeaderDirectory()))
263 *SuggestedModule = HS.findModuleForHeader(File);
267 return HS.getFileMgr().getFile(TmpDir.str(), /*openFile=*/true);
271 return DoFrameworkLookup(Filename, HS, SearchPath, RelativePath,
272 SuggestedModule, InUserSpecifiedSystemFramework);
274 assert(isHeaderMap() && "Unknown directory lookup");
275 const HeaderMap *HM = getHeaderMap();
276 SmallString<1024> Path;
277 StringRef Dest = HM->lookupFilename(Filename, Path);
281 const FileEntry *Result;
283 // Check if the headermap maps the filename to a framework include
284 // ("Foo.h" -> "Foo/Foo.h"), in which case continue header lookup using the
285 // framework include.
286 if (llvm::sys::path::is_relative(Dest)) {
288 MappedName.append(Dest.begin(), Dest.end());
289 Filename = StringRef(MappedName.begin(), MappedName.size());
290 Result = HM->LookupFile(Filename, HS.getFileMgr());
293 Result = HS.getFileMgr().getFile(Dest);
297 if (SearchPath != NULL) {
298 StringRef SearchPathRef(getName());
300 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
302 if (RelativePath != NULL) {
303 RelativePath->clear();
304 RelativePath->append(Filename.begin(), Filename.end());
310 /// \brief Given a framework directory, find the top-most framework directory.
312 /// \param FileMgr The file manager to use for directory lookups.
313 /// \param DirName The name of the framework directory.
314 /// \param SubmodulePath Will be populated with the submodule path from the
315 /// returned top-level module to the originally named framework.
316 static const DirectoryEntry *
317 getTopFrameworkDir(FileManager &FileMgr, StringRef DirName,
318 SmallVectorImpl<std::string> &SubmodulePath) {
319 assert(llvm::sys::path::extension(DirName) == ".framework" &&
320 "Not a framework directory");
322 // Note: as an egregious but useful hack we use the real path here, because
323 // frameworks moving between top-level frameworks to embedded frameworks tend
324 // to be symlinked, and we base the logical structure of modules on the
325 // physical layout. In particular, we need to deal with crazy includes like
327 // #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
329 // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
330 // which one should access with, e.g.,
332 // #include <Bar/Wibble.h>
334 // Similar issues occur when a top-level framework has moved into an
335 // embedded framework.
336 const DirectoryEntry *TopFrameworkDir = FileMgr.getDirectory(DirName);
337 DirName = FileMgr.getCanonicalName(TopFrameworkDir);
339 // Get the parent directory name.
340 DirName = llvm::sys::path::parent_path(DirName);
344 // Determine whether this directory exists.
345 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
349 // If this is a framework directory, then we're a subframework of this
351 if (llvm::sys::path::extension(DirName) == ".framework") {
352 SubmodulePath.push_back(llvm::sys::path::stem(DirName));
353 TopFrameworkDir = Dir;
357 return TopFrameworkDir;
360 /// DoFrameworkLookup - Do a lookup of the specified file in the current
361 /// DirectoryLookup, which is a framework directory.
362 const FileEntry *DirectoryLookup::DoFrameworkLookup(
365 SmallVectorImpl<char> *SearchPath,
366 SmallVectorImpl<char> *RelativePath,
367 ModuleMap::KnownHeader *SuggestedModule,
368 bool &InUserSpecifiedSystemFramework) const
370 FileManager &FileMgr = HS.getFileMgr();
372 // Framework names must have a '/' in the filename.
373 size_t SlashPos = Filename.find('/');
374 if (SlashPos == StringRef::npos) return 0;
376 // Find out if this is the home for the specified framework, by checking
377 // HeaderSearch. Possible answers are yes/no and unknown.
378 HeaderSearch::FrameworkCacheEntry &CacheEntry =
379 HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
381 // If it is known and in some other directory, fail.
382 if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
385 // Otherwise, construct the path to this framework dir.
387 // FrameworkName = "/System/Library/Frameworks/"
388 SmallString<1024> FrameworkName;
389 FrameworkName += getFrameworkDir()->getName();
390 if (FrameworkName.empty() || FrameworkName.back() != '/')
391 FrameworkName.push_back('/');
393 // FrameworkName = "/System/Library/Frameworks/Cocoa"
394 StringRef ModuleName(Filename.begin(), SlashPos);
395 FrameworkName += ModuleName;
397 // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
398 FrameworkName += ".framework/";
400 // If the cache entry was unresolved, populate it now.
401 if (CacheEntry.Directory == 0) {
402 HS.IncrementFrameworkLookupCount();
404 // If the framework dir doesn't exist, we fail.
405 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
406 if (Dir == 0) return 0;
408 // Otherwise, if it does, remember that this is the right direntry for this
410 CacheEntry.Directory = getFrameworkDir();
412 // If this is a user search directory, check if the framework has been
413 // user-specified as a system framework.
414 if (getDirCharacteristic() == SrcMgr::C_User) {
415 SmallString<1024> SystemFrameworkMarker(FrameworkName);
416 SystemFrameworkMarker += ".system_framework";
417 if (llvm::sys::fs::exists(SystemFrameworkMarker.str())) {
418 CacheEntry.IsUserSpecifiedSystemFramework = true;
423 // Set the 'user-specified system framework' flag.
424 InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
426 if (RelativePath != NULL) {
427 RelativePath->clear();
428 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
431 // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
432 unsigned OrigSize = FrameworkName.size();
434 FrameworkName += "Headers/";
436 if (SearchPath != NULL) {
438 // Without trailing '/'.
439 SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
442 FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
443 const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
444 /*openFile=*/!SuggestedModule);
446 // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
447 const char *Private = "Private";
448 FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
449 Private+strlen(Private));
450 if (SearchPath != NULL)
451 SearchPath->insert(SearchPath->begin()+OrigSize, Private,
452 Private+strlen(Private));
454 FE = FileMgr.getFile(FrameworkName.str(), /*openFile=*/!SuggestedModule);
457 // If we found the header and are allowed to suggest a module, do so now.
458 if (FE && SuggestedModule) {
459 // Find the framework in which this header occurs.
460 StringRef FrameworkPath = FE->getName();
461 bool FoundFramework = false;
463 // Get the parent directory name.
464 FrameworkPath = llvm::sys::path::parent_path(FrameworkPath);
465 if (FrameworkPath.empty())
468 // Determine whether this directory exists.
469 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkPath);
473 // If this is a framework directory, then we're a subframework of this
475 if (llvm::sys::path::extension(FrameworkPath) == ".framework") {
476 FoundFramework = true;
481 if (FoundFramework) {
482 // Find the top-level framework based on this framework.
483 SmallVector<std::string, 4> SubmodulePath;
484 const DirectoryEntry *TopFrameworkDir
485 = ::getTopFrameworkDir(FileMgr, FrameworkPath, SubmodulePath);
487 // Determine the name of the top-level framework.
488 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
490 // Load this framework module. If that succeeds, find the suggested module
491 // for this header, if any.
492 bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
493 if (HS.loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
494 *SuggestedModule = HS.findModuleForHeader(FE);
497 *SuggestedModule = HS.findModuleForHeader(FE);
503 void HeaderSearch::setTarget(const TargetInfo &Target) {
504 ModMap.setTarget(Target);
508 //===----------------------------------------------------------------------===//
509 // Header File Location.
510 //===----------------------------------------------------------------------===//
512 /// \brief Return true with a diagnostic if the file that MSVC would have found
513 /// fails to match the one that Clang would have found with MSVC header search
515 static bool checkMSVCHeaderSearch(DiagnosticsEngine &Diags,
516 const FileEntry *MSFE, const FileEntry *FE,
517 SourceLocation IncludeLoc) {
518 if (MSFE && FE != MSFE) {
519 Diags.Report(IncludeLoc, diag::ext_pp_include_search_ms) << MSFE->getName();
525 /// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
526 /// return null on failure. isAngled indicates whether the file reference is
527 /// for system \#include's or not (i.e. using <> instead of ""). Includers, if
528 /// non-empty, indicates where the \#including file(s) are, in case a relative
529 /// search is needed. Microsoft mode will pass all \#including files.
530 const FileEntry *HeaderSearch::LookupFile(
531 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
532 const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
533 ArrayRef<const FileEntry *> Includers, SmallVectorImpl<char> *SearchPath,
534 SmallVectorImpl<char> *RelativePath,
535 ModuleMap::KnownHeader *SuggestedModule, bool SkipCache) {
536 if (!HSOpts->ModuleMapFiles.empty()) {
537 // Preload all explicitly specified module map files. This enables modules
538 // map files lying in a directory structure separate from the header files
539 // that they describe. These cannot be loaded lazily upon encountering a
540 // header file, as there is no other known mapping from a header file to its
542 for (llvm::SetVector<std::string>::iterator
543 I = HSOpts->ModuleMapFiles.begin(),
544 E = HSOpts->ModuleMapFiles.end();
546 const FileEntry *File = FileMgr.getFile(*I);
549 loadModuleMapFile(File, /*IsSystem=*/false);
551 HSOpts->ModuleMapFiles.clear();
555 *SuggestedModule = ModuleMap::KnownHeader();
557 // If 'Filename' is absolute, check to see if it exists and no searching.
558 if (llvm::sys::path::is_absolute(Filename)) {
561 // If this was an #include_next "/absolute/file", fail.
562 if (FromDir) return 0;
564 if (SearchPath != NULL)
566 if (RelativePath != NULL) {
567 RelativePath->clear();
568 RelativePath->append(Filename.begin(), Filename.end());
570 // Otherwise, just return the file.
571 return FileMgr.getFile(Filename, /*openFile=*/true);
574 // This is the header that MSVC's header search would have found.
575 const FileEntry *MSFE = 0;
577 // Unless disabled, check to see if the file is in the #includer's
578 // directory. This cannot be based on CurDir, because each includer could be
579 // a #include of a subdirectory (#include "foo/bar.h") and a subsequent
580 // include of "baz.h" should resolve to "whatever/foo/baz.h".
581 // This search is not done for <> headers.
582 if (!Includers.empty() && !isAngled && !NoCurDirSearch) {
583 SmallString<1024> TmpDir;
584 for (ArrayRef<const FileEntry *>::iterator I = Includers.begin(),
587 const FileEntry *Includer = *I;
588 // Concatenate the requested file onto the directory.
589 // FIXME: Portability. Filename concatenation should be in sys::Path.
590 TmpDir = Includer->getDir()->getName();
591 TmpDir.push_back('/');
592 TmpDir.append(Filename.begin(), Filename.end());
593 if (const FileEntry *FE =
594 FileMgr.getFile(TmpDir.str(), /*openFile=*/true)) {
595 // Leave CurDir unset.
596 // This file is a system header or C++ unfriendly if the old file is.
598 // Note that we only use one of FromHFI/ToHFI at once, due to potential
599 // reallocation of the underlying vector potentially making the first
600 // reference binding dangling.
601 HeaderFileInfo &FromHFI = getFileInfo(Includer);
602 unsigned DirInfo = FromHFI.DirInfo;
603 bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
604 StringRef Framework = FromHFI.Framework;
606 HeaderFileInfo &ToHFI = getFileInfo(FE);
607 ToHFI.DirInfo = DirInfo;
608 ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
609 ToHFI.Framework = Framework;
611 if (SearchPath != NULL) {
612 StringRef SearchPathRef(Includer->getDir()->getName());
614 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
616 if (RelativePath != NULL) {
617 RelativePath->clear();
618 RelativePath->append(Filename.begin(), Filename.end());
620 if (I == Includers.begin())
623 // Otherwise, we found the path via MSVC header search rules. If
624 // -Wmsvc-include is enabled, we have to keep searching to see if we
625 // would've found this header in -I or -isystem directories.
626 if (Diags.getDiagnosticLevel(diag::ext_pp_include_search_ms,
628 DiagnosticsEngine::Ignored) {
640 // If this is a system #include, ignore the user #include locs.
641 unsigned i = isAngled ? AngledDirIdx : 0;
643 // If this is a #include_next request, start searching after the directory the
644 // file was found in.
646 i = FromDir-&SearchDirs[0];
648 // Cache all of the lookups performed by this method. Many headers are
649 // multiply included, and the "pragma once" optimization prevents them from
650 // being relex/pp'd, but they would still have to search through a
651 // (potentially huge) series of SearchDirs to find it.
652 std::pair<unsigned, unsigned> &CacheLookup =
653 LookupFileCache.GetOrCreateValue(Filename).getValue();
655 // If the entry has been previously looked up, the first value will be
656 // non-zero. If the value is equal to i (the start point of our search), then
657 // this is a matching hit.
658 if (!SkipCache && CacheLookup.first == i+1) {
659 // Skip querying potentially lots of directories for this lookup.
660 i = CacheLookup.second;
662 // Otherwise, this is the first query, or the previous query didn't match
663 // our search start. We will fill in our found location below, so prime the
664 // start point value.
665 CacheLookup.first = i+1;
668 SmallString<64> MappedName;
670 // Check each directory in sequence to see if it contains this file.
671 for (; i != SearchDirs.size(); ++i) {
672 bool InUserSpecifiedSystemFramework = false;
673 const FileEntry *FE =
674 SearchDirs[i].LookupFile(Filename, *this, SearchPath, RelativePath,
675 SuggestedModule, InUserSpecifiedSystemFramework,
679 CurDir = &SearchDirs[i];
681 // This file is a system header or C++ unfriendly if the dir is.
682 HeaderFileInfo &HFI = getFileInfo(FE);
683 HFI.DirInfo = CurDir->getDirCharacteristic();
685 // If the directory characteristic is User but this framework was
686 // user-specified to be treated as a system framework, promote the
688 if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
689 HFI.DirInfo = SrcMgr::C_System;
691 // If the filename matches a known system header prefix, override
692 // whether the file is a system header.
693 for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
694 if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
695 HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
701 // If this file is found in a header map and uses the framework style of
702 // includes, then this header is part of a framework we're building.
703 if (CurDir->isIndexHeaderMap()) {
704 size_t SlashPos = Filename.find('/');
705 if (SlashPos != StringRef::npos) {
706 HFI.IndexHeaderMapHeader = 1;
707 HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
712 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc))
715 // Remember this location for the next lookup we do.
716 CacheLookup.second = i;
720 // If we are including a file with a quoted include "foo.h" from inside
721 // a header in a framework that is currently being built, and we couldn't
722 // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
723 // "Foo" is the name of the framework in which the including header was found.
724 if (!Includers.empty() && !isAngled &&
725 Filename.find('/') == StringRef::npos) {
726 HeaderFileInfo &IncludingHFI = getFileInfo(Includers.front());
727 if (IncludingHFI.IndexHeaderMapHeader) {
728 SmallString<128> ScratchFilename;
729 ScratchFilename += IncludingHFI.Framework;
730 ScratchFilename += '/';
731 ScratchFilename += Filename;
733 const FileEntry *FE = LookupFile(
734 ScratchFilename, IncludeLoc, /*isAngled=*/true, FromDir, CurDir,
735 Includers.front(), SearchPath, RelativePath, SuggestedModule);
737 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc))
740 std::pair<unsigned, unsigned> &CacheLookup
741 = LookupFileCache.GetOrCreateValue(Filename).getValue();
743 = LookupFileCache.GetOrCreateValue(ScratchFilename).getValue().second;
748 if (checkMSVCHeaderSearch(Diags, MSFE, 0, IncludeLoc))
751 // Otherwise, didn't find it. Remember we didn't find this.
752 CacheLookup.second = SearchDirs.size();
756 /// LookupSubframeworkHeader - Look up a subframework for the specified
757 /// \#include file. For example, if \#include'ing <HIToolbox/HIToolbox.h> from
758 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
759 /// is a subframework within Carbon.framework. If so, return the FileEntry
760 /// for the designated file, otherwise return null.
761 const FileEntry *HeaderSearch::
762 LookupSubframeworkHeader(StringRef Filename,
763 const FileEntry *ContextFileEnt,
764 SmallVectorImpl<char> *SearchPath,
765 SmallVectorImpl<char> *RelativePath,
766 ModuleMap::KnownHeader *SuggestedModule) {
767 assert(ContextFileEnt && "No context file?");
769 // Framework names must have a '/' in the filename. Find it.
770 // FIXME: Should we permit '\' on Windows?
771 size_t SlashPos = Filename.find('/');
772 if (SlashPos == StringRef::npos) return 0;
774 // Look up the base framework name of the ContextFileEnt.
775 const char *ContextName = ContextFileEnt->getName();
777 // If the context info wasn't a framework, couldn't be a subframework.
778 const unsigned DotFrameworkLen = 10;
779 const char *FrameworkPos = strstr(ContextName, ".framework");
780 if (FrameworkPos == 0 ||
781 (FrameworkPos[DotFrameworkLen] != '/' &&
782 FrameworkPos[DotFrameworkLen] != '\\'))
785 SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
787 // Append Frameworks/HIToolbox.framework/
788 FrameworkName += "Frameworks/";
789 FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
790 FrameworkName += ".framework/";
792 llvm::StringMapEntry<FrameworkCacheEntry> &CacheLookup =
793 FrameworkMap.GetOrCreateValue(Filename.substr(0, SlashPos));
795 // Some other location?
796 if (CacheLookup.getValue().Directory &&
797 CacheLookup.getKeyLength() == FrameworkName.size() &&
798 memcmp(CacheLookup.getKeyData(), &FrameworkName[0],
799 CacheLookup.getKeyLength()) != 0)
802 // Cache subframework.
803 if (CacheLookup.getValue().Directory == 0) {
804 ++NumSubFrameworkLookups;
806 // If the framework dir doesn't exist, we fail.
807 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
808 if (Dir == 0) return 0;
810 // Otherwise, if it does, remember that this is the right direntry for this
812 CacheLookup.getValue().Directory = Dir;
815 const FileEntry *FE = 0;
817 if (RelativePath != NULL) {
818 RelativePath->clear();
819 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
822 // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
823 SmallString<1024> HeadersFilename(FrameworkName);
824 HeadersFilename += "Headers/";
825 if (SearchPath != NULL) {
827 // Without trailing '/'.
828 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
831 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
832 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true))) {
834 // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
835 HeadersFilename = FrameworkName;
836 HeadersFilename += "PrivateHeaders/";
837 if (SearchPath != NULL) {
839 // Without trailing '/'.
840 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
843 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
844 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true)))
848 // This file is a system header or C++ unfriendly if the old file is.
850 // Note that the temporary 'DirInfo' is required here, as either call to
851 // getFileInfo could resize the vector and we don't want to rely on order
853 unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
854 getFileInfo(FE).DirInfo = DirInfo;
856 // If we're supposed to suggest a module, look for one now.
857 if (SuggestedModule) {
858 // Find the top-level framework based on this framework.
859 FrameworkName.pop_back(); // remove the trailing '/'
860 SmallVector<std::string, 4> SubmodulePath;
861 const DirectoryEntry *TopFrameworkDir
862 = ::getTopFrameworkDir(FileMgr, FrameworkName, SubmodulePath);
864 // Determine the name of the top-level framework.
865 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
867 // Load this framework module. If that succeeds, find the suggested module
868 // for this header, if any.
869 bool IsSystem = false;
870 if (loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
871 *SuggestedModule = findModuleForHeader(FE);
878 /// \brief Helper static function to normalize a path for injection into
879 /// a synthetic header.
880 /*static*/ std::string
881 HeaderSearch::NormalizeDashIncludePath(StringRef File, FileManager &FileMgr) {
882 // Implicit include paths should be resolved relative to the current
883 // working directory first, and then use the regular header search
884 // mechanism. The proper way to handle this is to have the
885 // predefines buffer located at the current working directory, but
886 // it has no file entry. For now, workaround this by using an
887 // absolute path if we find the file here, and otherwise letting
888 // header search handle it.
889 SmallString<128> Path(File);
890 llvm::sys::fs::make_absolute(Path);
892 if (llvm::sys::fs::exists(Path.str(), exists) || !exists)
895 FileMgr.getFile(File);
897 return Lexer::Stringify(Path.str());
900 //===----------------------------------------------------------------------===//
901 // File Info Management.
902 //===----------------------------------------------------------------------===//
904 /// \brief Merge the header file info provided by \p OtherHFI into the current
905 /// header file info (\p HFI)
906 static void mergeHeaderFileInfo(HeaderFileInfo &HFI,
907 const HeaderFileInfo &OtherHFI) {
908 HFI.isImport |= OtherHFI.isImport;
909 HFI.isPragmaOnce |= OtherHFI.isPragmaOnce;
910 HFI.isModuleHeader |= OtherHFI.isModuleHeader;
911 HFI.NumIncludes += OtherHFI.NumIncludes;
913 if (!HFI.ControllingMacro && !HFI.ControllingMacroID) {
914 HFI.ControllingMacro = OtherHFI.ControllingMacro;
915 HFI.ControllingMacroID = OtherHFI.ControllingMacroID;
918 if (OtherHFI.External) {
919 HFI.DirInfo = OtherHFI.DirInfo;
920 HFI.External = OtherHFI.External;
921 HFI.IndexHeaderMapHeader = OtherHFI.IndexHeaderMapHeader;
924 if (HFI.Framework.empty())
925 HFI.Framework = OtherHFI.Framework;
930 /// getFileInfo - Return the HeaderFileInfo structure for the specified
932 HeaderFileInfo &HeaderSearch::getFileInfo(const FileEntry *FE) {
933 if (FE->getUID() >= FileInfo.size())
934 FileInfo.resize(FE->getUID()+1);
936 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
937 if (ExternalSource && !HFI.Resolved)
938 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(FE));
942 bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
943 // Check if we've ever seen this file as a header.
944 if (File->getUID() >= FileInfo.size())
947 // Resolve header file info from the external source, if needed.
948 HeaderFileInfo &HFI = FileInfo[File->getUID()];
949 if (ExternalSource && !HFI.Resolved)
950 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(File));
952 return HFI.isPragmaOnce || HFI.isImport ||
953 HFI.ControllingMacro || HFI.ControllingMacroID;
956 void HeaderSearch::MarkFileModuleHeader(const FileEntry *FE,
957 ModuleMap::ModuleHeaderRole Role,
958 bool isCompilingModuleHeader) {
959 if (FE->getUID() >= FileInfo.size())
960 FileInfo.resize(FE->getUID()+1);
962 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
963 HFI.isModuleHeader = true;
964 HFI.isCompilingModuleHeader = isCompilingModuleHeader;
965 HFI.setHeaderRole(Role);
968 bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry *File, bool isImport){
969 ++NumIncluded; // Count # of attempted #includes.
971 // Get information about this file.
972 HeaderFileInfo &FileInfo = getFileInfo(File);
974 // If this is a #import directive, check that we have not already imported
977 // If this has already been imported, don't import it again.
978 FileInfo.isImport = true;
980 // Has this already been #import'ed or #include'd?
981 if (FileInfo.NumIncludes) return false;
983 // Otherwise, if this is a #include of a file that was previously #import'd
984 // or if this is the second #include of a #pragma once file, ignore it.
985 if (FileInfo.isImport)
989 // Next, check to see if the file is wrapped with #ifndef guards. If so, and
990 // if the macro that guards it is defined, we know the #include has no effect.
991 if (const IdentifierInfo *ControllingMacro
992 = FileInfo.getControllingMacro(ExternalLookup))
993 if (ControllingMacro->hasMacroDefinition()) {
994 ++NumMultiIncludeFileOptzn;
998 // Increment the number of times this file has been included.
999 ++FileInfo.NumIncludes;
1004 size_t HeaderSearch::getTotalMemory() const {
1005 return SearchDirs.capacity()
1006 + llvm::capacity_in_bytes(FileInfo)
1007 + llvm::capacity_in_bytes(HeaderMaps)
1008 + LookupFileCache.getAllocator().getTotalMemory()
1009 + FrameworkMap.getAllocator().getTotalMemory();
1012 StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
1013 return FrameworkNames.GetOrCreateValue(Framework).getKey();
1016 bool HeaderSearch::hasModuleMap(StringRef FileName,
1017 const DirectoryEntry *Root,
1019 if (!enabledModules())
1022 SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
1024 StringRef DirName = FileName;
1026 // Get the parent directory name.
1027 DirName = llvm::sys::path::parent_path(DirName);
1028 if (DirName.empty())
1031 // Determine whether this directory exists.
1032 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
1036 // Try to load the "module.map" file in this directory.
1037 switch (loadModuleMapFile(Dir, IsSystem)) {
1038 case LMM_NewlyLoaded:
1039 case LMM_AlreadyLoaded:
1040 // Success. All of the directories we stepped through inherit this module
1042 for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
1043 DirectoryHasModuleMap[FixUpDirectories[I]] = true;
1046 case LMM_NoDirectory:
1047 case LMM_InvalidModuleMap:
1051 // If we hit the top of our search, we're done.
1055 // Keep track of all of the directories we checked, so we can mark them as
1056 // having module maps if we eventually do find a module map.
1057 FixUpDirectories.push_back(Dir);
1061 ModuleMap::KnownHeader
1062 HeaderSearch::findModuleForHeader(const FileEntry *File) const {
1063 if (ExternalSource) {
1064 // Make sure the external source has handled header info about this file,
1065 // which includes whether the file is part of a module.
1066 (void)getFileInfo(File);
1068 return ModMap.findModuleForHeader(File);
1071 bool HeaderSearch::loadModuleMapFile(const FileEntry *File, bool IsSystem) {
1072 const DirectoryEntry *Dir = File->getDir();
1074 llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1075 = DirectoryHasModuleMap.find(Dir);
1076 if (KnownDir != DirectoryHasModuleMap.end())
1077 return !KnownDir->second;
1079 bool Result = ModMap.parseModuleMapFile(File, IsSystem);
1080 if (!Result && llvm::sys::path::filename(File->getName()) == "module.map") {
1081 // If the file we loaded was a module.map, look for the corresponding
1082 // module_private.map.
1083 SmallString<128> PrivateFilename(Dir->getName());
1084 llvm::sys::path::append(PrivateFilename, "module_private.map");
1085 if (const FileEntry *PrivateFile = FileMgr.getFile(PrivateFilename))
1086 Result = ModMap.parseModuleMapFile(PrivateFile, IsSystem);
1089 DirectoryHasModuleMap[Dir] = !Result;
1093 Module *HeaderSearch::loadFrameworkModule(StringRef Name,
1094 const DirectoryEntry *Dir,
1096 if (Module *Module = ModMap.findModule(Name))
1099 // Try to load a module map file.
1100 switch (loadModuleMapFile(Dir, IsSystem)) {
1101 case LMM_InvalidModuleMap:
1104 case LMM_AlreadyLoaded:
1105 case LMM_NoDirectory:
1108 case LMM_NewlyLoaded:
1109 return ModMap.findModule(Name);
1112 // Figure out the top-level framework directory and the submodule path from
1113 // that top-level framework to the requested framework.
1114 SmallVector<std::string, 2> SubmodulePath;
1115 SubmodulePath.push_back(Name);
1116 const DirectoryEntry *TopFrameworkDir
1117 = ::getTopFrameworkDir(FileMgr, Dir->getName(), SubmodulePath);
1120 // Try to infer a module map from the top-level framework directory.
1121 Module *Result = ModMap.inferFrameworkModule(SubmodulePath.back(),
1128 // Follow the submodule path to find the requested (sub)framework module
1129 // within the top-level framework module.
1130 SubmodulePath.pop_back();
1131 while (!SubmodulePath.empty() && Result) {
1132 Result = ModMap.lookupModuleQualified(SubmodulePath.back(), Result);
1133 SubmodulePath.pop_back();
1139 HeaderSearch::LoadModuleMapResult
1140 HeaderSearch::loadModuleMapFile(StringRef DirName, bool IsSystem) {
1141 if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
1142 return loadModuleMapFile(Dir, IsSystem);
1144 return LMM_NoDirectory;
1147 HeaderSearch::LoadModuleMapResult
1148 HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir, bool IsSystem) {
1149 llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1150 = DirectoryHasModuleMap.find(Dir);
1151 if (KnownDir != DirectoryHasModuleMap.end())
1152 return KnownDir->second? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
1154 SmallString<128> ModuleMapFileName;
1155 ModuleMapFileName += Dir->getName();
1156 unsigned ModuleMapDirNameLen = ModuleMapFileName.size();
1157 llvm::sys::path::append(ModuleMapFileName, "module.map");
1158 if (const FileEntry *ModuleMapFile = FileMgr.getFile(ModuleMapFileName)) {
1159 // We have found a module map file. Try to parse it.
1160 if (ModMap.parseModuleMapFile(ModuleMapFile, IsSystem)) {
1161 // No suitable module map.
1162 DirectoryHasModuleMap[Dir] = false;
1163 return LMM_InvalidModuleMap;
1166 // This directory has a module map.
1167 DirectoryHasModuleMap[Dir] = true;
1169 // Check whether there is a private module map that we need to load as well.
1170 ModuleMapFileName.erase(ModuleMapFileName.begin() + ModuleMapDirNameLen,
1171 ModuleMapFileName.end());
1172 llvm::sys::path::append(ModuleMapFileName, "module_private.map");
1173 if (const FileEntry *PrivateModuleMapFile
1174 = FileMgr.getFile(ModuleMapFileName)) {
1175 if (ModMap.parseModuleMapFile(PrivateModuleMapFile, IsSystem)) {
1176 // No suitable module map.
1177 DirectoryHasModuleMap[Dir] = false;
1178 return LMM_InvalidModuleMap;
1182 return LMM_NewlyLoaded;
1185 // No suitable module map.
1186 DirectoryHasModuleMap[Dir] = false;
1187 return LMM_InvalidModuleMap;
1190 void HeaderSearch::collectAllModules(SmallVectorImpl<Module *> &Modules) {
1193 // Load module maps for each of the header search directories.
1194 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1195 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
1196 if (SearchDirs[Idx].isFramework()) {
1197 llvm::error_code EC;
1198 SmallString<128> DirNative;
1199 llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1202 // Search each of the ".framework" directories to load them as modules.
1203 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1204 Dir != DirEnd && !EC; Dir.increment(EC)) {
1205 if (llvm::sys::path::extension(Dir->path()) != ".framework")
1208 const DirectoryEntry *FrameworkDir = FileMgr.getDirectory(Dir->path());
1212 // Load this framework module.
1213 loadFrameworkModule(llvm::sys::path::stem(Dir->path()), FrameworkDir,
1219 // FIXME: Deal with header maps.
1220 if (SearchDirs[Idx].isHeaderMap())
1223 // Try to load a module map file for the search directory.
1224 loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem);
1226 // Try to load module map files for immediate subdirectories of this search
1228 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
1231 // Populate the list of modules.
1232 for (ModuleMap::module_iterator M = ModMap.module_begin(),
1233 MEnd = ModMap.module_end();
1235 Modules.push_back(M->getValue());
1239 void HeaderSearch::loadTopLevelSystemModules() {
1240 // Load module maps for each of the header search directories.
1241 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1242 // We only care about normal header directories.
1243 if (!SearchDirs[Idx].isNormalDir()) {
1247 // Try to load a module map file for the search directory.
1248 loadModuleMapFile(SearchDirs[Idx].getDir(),
1249 SearchDirs[Idx].isSystemHeaderDirectory());
1253 void HeaderSearch::loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir) {
1254 if (SearchDir.haveSearchedAllModuleMaps())
1257 llvm::error_code EC;
1258 SmallString<128> DirNative;
1259 llvm::sys::path::native(SearchDir.getDir()->getName(), DirNative);
1260 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1261 Dir != DirEnd && !EC; Dir.increment(EC)) {
1262 loadModuleMapFile(Dir->path(), SearchDir.isSystemHeaderDirectory());
1265 SearchDir.setSearchedAllModuleMaps(true);