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/Diagnostic.h"
16 #include "clang/Basic/FileManager.h"
17 #include "clang/Basic/IdentifierTable.h"
18 #include "clang/Lex/HeaderMap.h"
19 #include "clang/Lex/HeaderSearchOptions.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), FileMgr(SourceMgr.getFileManager()), FrameworkMap(64),
51 ModMap(SourceMgr, *Diags.getClient(), LangOpts, Target, *this)
55 NoCurDirSearch = false;
60 NumMultiIncludeFileOptzn = 0;
61 NumFrameworkLookups = NumSubFrameworkLookups = 0;
64 HeaderSearch::~HeaderSearch() {
66 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
67 delete HeaderMaps[i].second;
70 void HeaderSearch::PrintStats() {
71 fprintf(stderr, "\n*** HeaderSearch Stats:\n");
72 fprintf(stderr, "%d files tracked.\n", (int)FileInfo.size());
73 unsigned NumOnceOnlyFiles = 0, MaxNumIncludes = 0, NumSingleIncludedFiles = 0;
74 for (unsigned i = 0, e = FileInfo.size(); i != e; ++i) {
75 NumOnceOnlyFiles += FileInfo[i].isImport;
76 if (MaxNumIncludes < FileInfo[i].NumIncludes)
77 MaxNumIncludes = FileInfo[i].NumIncludes;
78 NumSingleIncludedFiles += FileInfo[i].NumIncludes == 1;
80 fprintf(stderr, " %d #import/#pragma once files.\n", NumOnceOnlyFiles);
81 fprintf(stderr, " %d included exactly once.\n", NumSingleIncludedFiles);
82 fprintf(stderr, " %d max times a file is included.\n", MaxNumIncludes);
84 fprintf(stderr, " %d #include/#include_next/#import.\n", NumIncluded);
85 fprintf(stderr, " %d #includes skipped due to"
86 " the multi-include optimization.\n", NumMultiIncludeFileOptzn);
88 fprintf(stderr, "%d framework lookups.\n", NumFrameworkLookups);
89 fprintf(stderr, "%d subframework lookups.\n", NumSubFrameworkLookups);
92 /// CreateHeaderMap - This method returns a HeaderMap for the specified
93 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
94 const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) {
95 // We expect the number of headermaps to be small, and almost always empty.
96 // If it ever grows, use of a linear search should be re-evaluated.
97 if (!HeaderMaps.empty()) {
98 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
99 // Pointer equality comparison of FileEntries works because they are
100 // already uniqued by inode.
101 if (HeaderMaps[i].first == FE)
102 return HeaderMaps[i].second;
105 if (const HeaderMap *HM = HeaderMap::Create(FE, FileMgr)) {
106 HeaderMaps.push_back(std::make_pair(FE, HM));
113 std::string HeaderSearch::getModuleFileName(Module *Module) {
114 // If we don't have a module cache path, we can't do anything.
115 if (ModuleCachePath.empty())
116 return std::string();
119 SmallString<256> Result(ModuleCachePath);
120 llvm::sys::path::append(Result, Module->getTopLevelModule()->Name + ".pcm");
121 return Result.str().str();
124 std::string HeaderSearch::getModuleFileName(StringRef ModuleName) {
125 // If we don't have a module cache path, we can't do anything.
126 if (ModuleCachePath.empty())
127 return std::string();
130 SmallString<256> Result(ModuleCachePath);
131 llvm::sys::path::append(Result, ModuleName + ".pcm");
132 return Result.str().str();
135 Module *HeaderSearch::lookupModule(StringRef ModuleName, bool AllowSearch) {
136 // Look in the module map to determine if there is a module by this name.
137 Module *Module = ModMap.findModule(ModuleName);
138 if (Module || !AllowSearch)
141 // Look through the various header search paths to load any available module
142 // maps, searching for a module map that describes this module.
143 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
144 if (SearchDirs[Idx].isFramework()) {
145 // Search for or infer a module map for a framework.
146 SmallString<128> FrameworkDirName;
147 FrameworkDirName += SearchDirs[Idx].getFrameworkDir()->getName();
148 llvm::sys::path::append(FrameworkDirName, ModuleName + ".framework");
149 if (const DirectoryEntry *FrameworkDir
150 = FileMgr.getDirectory(FrameworkDirName)) {
152 = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
153 Module = loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
159 // FIXME: Figure out how header maps and module maps will work together.
161 // Only deal with normal search directories.
162 if (!SearchDirs[Idx].isNormalDir())
165 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
166 // Search for a module map file in this directory.
167 if (loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem)
168 == LMM_NewlyLoaded) {
169 // We just loaded a module map file; check whether the module is
171 Module = ModMap.findModule(ModuleName);
176 // Search for a module map in a subdirectory with the same name as the
178 SmallString<128> NestedModuleMapDirName;
179 NestedModuleMapDirName = SearchDirs[Idx].getDir()->getName();
180 llvm::sys::path::append(NestedModuleMapDirName, ModuleName);
181 if (loadModuleMapFile(NestedModuleMapDirName, IsSystem) == LMM_NewlyLoaded){
182 // If we just loaded a module map file, look for the module again.
183 Module = ModMap.findModule(ModuleName);
188 // If we've already performed the exhaustive search for module maps in this
189 // search directory, don't do it again.
190 if (SearchDirs[Idx].haveSearchedAllModuleMaps())
193 // Load all module maps in the immediate subdirectories of this search
195 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
197 // Look again for the module.
198 Module = ModMap.findModule(ModuleName);
206 //===----------------------------------------------------------------------===//
207 // File lookup within a DirectoryLookup scope
208 //===----------------------------------------------------------------------===//
210 /// getName - Return the directory or filename corresponding to this lookup
212 const char *DirectoryLookup::getName() const {
214 return getDir()->getName();
216 return getFrameworkDir()->getName();
217 assert(isHeaderMap() && "Unknown DirectoryLookup");
218 return getHeaderMap()->getFileName();
222 /// LookupFile - Lookup the specified file in this search path, returning it
223 /// if it exists or returning null if not.
224 const FileEntry *DirectoryLookup::LookupFile(
227 SmallVectorImpl<char> *SearchPath,
228 SmallVectorImpl<char> *RelativePath,
229 ModuleMap::KnownHeader *SuggestedModule,
230 bool &InUserSpecifiedSystemFramework) const {
231 InUserSpecifiedSystemFramework = false;
233 SmallString<1024> TmpDir;
235 // Concatenate the requested file onto the directory.
236 TmpDir = getDir()->getName();
237 llvm::sys::path::append(TmpDir, Filename);
238 if (SearchPath != NULL) {
239 StringRef SearchPathRef(getDir()->getName());
241 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
243 if (RelativePath != NULL) {
244 RelativePath->clear();
245 RelativePath->append(Filename.begin(), Filename.end());
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(TmpDir, getDir(), isSystemHeaderDirectory());
251 if (SuggestedModule) {
252 const FileEntry *File = HS.getFileMgr().getFile(TmpDir.str(),
257 // If there is a module that corresponds to this header, suggest it.
258 *SuggestedModule = HS.findModuleForHeader(File);
259 if (!SuggestedModule->getModule() &&
260 HS.hasModuleMap(TmpDir, getDir(), isSystemHeaderDirectory()))
261 *SuggestedModule = HS.findModuleForHeader(File);
265 return HS.getFileMgr().getFile(TmpDir.str(), /*openFile=*/true);
269 return DoFrameworkLookup(Filename, HS, SearchPath, RelativePath,
270 SuggestedModule, InUserSpecifiedSystemFramework);
272 assert(isHeaderMap() && "Unknown directory lookup");
273 const FileEntry * const Result = getHeaderMap()->LookupFile(
274 Filename, HS.getFileMgr());
276 if (SearchPath != NULL) {
277 StringRef SearchPathRef(getName());
279 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
281 if (RelativePath != NULL) {
282 RelativePath->clear();
283 RelativePath->append(Filename.begin(), Filename.end());
289 /// \brief Given a framework directory, find the top-most framework directory.
291 /// \param FileMgr The file manager to use for directory lookups.
292 /// \param DirName The name of the framework directory.
293 /// \param SubmodulePath Will be populated with the submodule path from the
294 /// returned top-level module to the originally named framework.
295 static const DirectoryEntry *
296 getTopFrameworkDir(FileManager &FileMgr, StringRef DirName,
297 SmallVectorImpl<std::string> &SubmodulePath) {
298 assert(llvm::sys::path::extension(DirName) == ".framework" &&
299 "Not a framework directory");
301 // Note: as an egregious but useful hack we use the real path here, because
302 // frameworks moving between top-level frameworks to embedded frameworks tend
303 // to be symlinked, and we base the logical structure of modules on the
304 // physical layout. In particular, we need to deal with crazy includes like
306 // #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
308 // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
309 // which one should access with, e.g.,
311 // #include <Bar/Wibble.h>
313 // Similar issues occur when a top-level framework has moved into an
314 // embedded framework.
315 const DirectoryEntry *TopFrameworkDir = FileMgr.getDirectory(DirName);
316 DirName = FileMgr.getCanonicalName(TopFrameworkDir);
318 // Get the parent directory name.
319 DirName = llvm::sys::path::parent_path(DirName);
323 // Determine whether this directory exists.
324 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
328 // If this is a framework directory, then we're a subframework of this
330 if (llvm::sys::path::extension(DirName) == ".framework") {
331 SubmodulePath.push_back(llvm::sys::path::stem(DirName));
332 TopFrameworkDir = Dir;
336 return TopFrameworkDir;
339 /// DoFrameworkLookup - Do a lookup of the specified file in the current
340 /// DirectoryLookup, which is a framework directory.
341 const FileEntry *DirectoryLookup::DoFrameworkLookup(
344 SmallVectorImpl<char> *SearchPath,
345 SmallVectorImpl<char> *RelativePath,
346 ModuleMap::KnownHeader *SuggestedModule,
347 bool &InUserSpecifiedSystemFramework) const
349 FileManager &FileMgr = HS.getFileMgr();
351 // Framework names must have a '/' in the filename.
352 size_t SlashPos = Filename.find('/');
353 if (SlashPos == StringRef::npos) return 0;
355 // Find out if this is the home for the specified framework, by checking
356 // HeaderSearch. Possible answers are yes/no and unknown.
357 HeaderSearch::FrameworkCacheEntry &CacheEntry =
358 HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
360 // If it is known and in some other directory, fail.
361 if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
364 // Otherwise, construct the path to this framework dir.
366 // FrameworkName = "/System/Library/Frameworks/"
367 SmallString<1024> FrameworkName;
368 FrameworkName += getFrameworkDir()->getName();
369 if (FrameworkName.empty() || FrameworkName.back() != '/')
370 FrameworkName.push_back('/');
372 // FrameworkName = "/System/Library/Frameworks/Cocoa"
373 StringRef ModuleName(Filename.begin(), SlashPos);
374 FrameworkName += ModuleName;
376 // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
377 FrameworkName += ".framework/";
379 // If the cache entry was unresolved, populate it now.
380 if (CacheEntry.Directory == 0) {
381 HS.IncrementFrameworkLookupCount();
383 // If the framework dir doesn't exist, we fail.
384 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
385 if (Dir == 0) return 0;
387 // Otherwise, if it does, remember that this is the right direntry for this
389 CacheEntry.Directory = getFrameworkDir();
391 // If this is a user search directory, check if the framework has been
392 // user-specified as a system framework.
393 if (getDirCharacteristic() == SrcMgr::C_User) {
394 SmallString<1024> SystemFrameworkMarker(FrameworkName);
395 SystemFrameworkMarker += ".system_framework";
396 if (llvm::sys::fs::exists(SystemFrameworkMarker.str())) {
397 CacheEntry.IsUserSpecifiedSystemFramework = true;
402 // Set the 'user-specified system framework' flag.
403 InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
405 if (RelativePath != NULL) {
406 RelativePath->clear();
407 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
410 // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
411 unsigned OrigSize = FrameworkName.size();
413 FrameworkName += "Headers/";
415 if (SearchPath != NULL) {
417 // Without trailing '/'.
418 SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
421 FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
422 const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
423 /*openFile=*/!SuggestedModule);
425 // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
426 const char *Private = "Private";
427 FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
428 Private+strlen(Private));
429 if (SearchPath != NULL)
430 SearchPath->insert(SearchPath->begin()+OrigSize, Private,
431 Private+strlen(Private));
433 FE = FileMgr.getFile(FrameworkName.str(), /*openFile=*/!SuggestedModule);
436 // If we found the header and are allowed to suggest a module, do so now.
437 if (FE && SuggestedModule) {
438 // Find the framework in which this header occurs.
439 StringRef FrameworkPath = FE->getName();
440 bool FoundFramework = false;
442 // Get the parent directory name.
443 FrameworkPath = llvm::sys::path::parent_path(FrameworkPath);
444 if (FrameworkPath.empty())
447 // Determine whether this directory exists.
448 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkPath);
452 // If this is a framework directory, then we're a subframework of this
454 if (llvm::sys::path::extension(FrameworkPath) == ".framework") {
455 FoundFramework = true;
460 if (FoundFramework) {
461 // Find the top-level framework based on this framework.
462 SmallVector<std::string, 4> SubmodulePath;
463 const DirectoryEntry *TopFrameworkDir
464 = ::getTopFrameworkDir(FileMgr, FrameworkPath, SubmodulePath);
466 // Determine the name of the top-level framework.
467 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
469 // Load this framework module. If that succeeds, find the suggested module
470 // for this header, if any.
471 bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
472 if (HS.loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
473 *SuggestedModule = HS.findModuleForHeader(FE);
476 *SuggestedModule = HS.findModuleForHeader(FE);
482 void HeaderSearch::setTarget(const TargetInfo &Target) {
483 ModMap.setTarget(Target);
487 //===----------------------------------------------------------------------===//
488 // Header File Location.
489 //===----------------------------------------------------------------------===//
492 /// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
493 /// return null on failure. isAngled indicates whether the file reference is
494 /// for system \#include's or not (i.e. using <> instead of ""). CurFileEnt, if
495 /// non-null, indicates where the \#including file is, in case a relative search
497 const FileEntry *HeaderSearch::LookupFile(
500 const DirectoryLookup *FromDir,
501 const DirectoryLookup *&CurDir,
502 const FileEntry *CurFileEnt,
503 SmallVectorImpl<char> *SearchPath,
504 SmallVectorImpl<char> *RelativePath,
505 ModuleMap::KnownHeader *SuggestedModule,
508 if (!HSOpts->ModuleMapFiles.empty()) {
509 // Preload all explicitly specified module map files. This enables modules
510 // map files lying in a directory structure separate from the header files
511 // that they describe. These cannot be loaded lazily upon encountering a
512 // header file, as there is no other knwon mapping from a header file to its
514 for (llvm::SetVector<std::string>::iterator
515 I = HSOpts->ModuleMapFiles.begin(),
516 E = HSOpts->ModuleMapFiles.end();
518 const FileEntry *File = FileMgr.getFile(*I);
521 loadModuleMapFile(File, /*IsSystem=*/false);
523 HSOpts->ModuleMapFiles.clear();
527 *SuggestedModule = ModuleMap::KnownHeader();
529 // If 'Filename' is absolute, check to see if it exists and no searching.
530 if (llvm::sys::path::is_absolute(Filename)) {
533 // If this was an #include_next "/absolute/file", fail.
534 if (FromDir) return 0;
536 if (SearchPath != NULL)
538 if (RelativePath != NULL) {
539 RelativePath->clear();
540 RelativePath->append(Filename.begin(), Filename.end());
542 // Otherwise, just return the file.
543 return FileMgr.getFile(Filename, /*openFile=*/true);
546 // Unless disabled, check to see if the file is in the #includer's
547 // directory. This has to be based on CurFileEnt, not CurDir, because
548 // CurFileEnt could be a #include of a subdirectory (#include "foo/bar.h") and
549 // a subsequent include of "baz.h" should resolve to "whatever/foo/baz.h".
550 // This search is not done for <> headers.
551 if (CurFileEnt && !isAngled && !NoCurDirSearch) {
552 // Concatenate the requested file onto the directory.
553 SmallString<1024> TmpDir(CurFileEnt->getDir()->getName());
554 llvm::sys::path::append(TmpDir, Filename);
555 if (const FileEntry *FE = FileMgr.getFile(TmpDir.str(),/*openFile=*/true)) {
556 // Leave CurDir unset.
557 // This file is a system header or C++ unfriendly if the old file is.
559 // Note that we only use one of FromHFI/ToHFI at once, due to potential
560 // reallocation of the underlying vector potentially making the first
561 // reference binding dangling.
562 HeaderFileInfo &FromHFI = getFileInfo(CurFileEnt);
563 unsigned DirInfo = FromHFI.DirInfo;
564 bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
565 StringRef Framework = FromHFI.Framework;
567 HeaderFileInfo &ToHFI = getFileInfo(FE);
568 ToHFI.DirInfo = DirInfo;
569 ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
570 ToHFI.Framework = Framework;
572 if (SearchPath != NULL) {
573 StringRef SearchPathRef(CurFileEnt->getDir()->getName());
575 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
577 if (RelativePath != NULL) {
578 RelativePath->clear();
579 RelativePath->append(Filename.begin(), Filename.end());
587 // If this is a system #include, ignore the user #include locs.
588 unsigned i = isAngled ? AngledDirIdx : 0;
590 // If this is a #include_next request, start searching after the directory the
591 // file was found in.
593 i = FromDir-&SearchDirs[0];
595 // Cache all of the lookups performed by this method. Many headers are
596 // multiply included, and the "pragma once" optimization prevents them from
597 // being relex/pp'd, but they would still have to search through a
598 // (potentially huge) series of SearchDirs to find it.
599 std::pair<unsigned, unsigned> &CacheLookup =
600 LookupFileCache.GetOrCreateValue(Filename).getValue();
602 // If the entry has been previously looked up, the first value will be
603 // non-zero. If the value is equal to i (the start point of our search), then
604 // this is a matching hit.
605 if (!SkipCache && CacheLookup.first == i+1) {
606 // Skip querying potentially lots of directories for this lookup.
607 i = CacheLookup.second;
609 // Otherwise, this is the first query, or the previous query didn't match
610 // our search start. We will fill in our found location below, so prime the
611 // start point value.
612 CacheLookup.first = i+1;
615 // Check each directory in sequence to see if it contains this file.
616 for (; i != SearchDirs.size(); ++i) {
617 bool InUserSpecifiedSystemFramework = false;
618 const FileEntry *FE =
619 SearchDirs[i].LookupFile(Filename, *this, SearchPath, RelativePath,
620 SuggestedModule, InUserSpecifiedSystemFramework);
623 CurDir = &SearchDirs[i];
625 // This file is a system header or C++ unfriendly if the dir is.
626 HeaderFileInfo &HFI = getFileInfo(FE);
627 HFI.DirInfo = CurDir->getDirCharacteristic();
629 // If the directory characteristic is User but this framework was
630 // user-specified to be treated as a system framework, promote the
632 if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
633 HFI.DirInfo = SrcMgr::C_System;
635 // If the filename matches a known system header prefix, override
636 // whether the file is a system header.
637 for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
638 if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
639 HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
645 // If this file is found in a header map and uses the framework style of
646 // includes, then this header is part of a framework we're building.
647 if (CurDir->isIndexHeaderMap()) {
648 size_t SlashPos = Filename.find('/');
649 if (SlashPos != StringRef::npos) {
650 HFI.IndexHeaderMapHeader = 1;
651 HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
656 // Remember this location for the next lookup we do.
657 CacheLookup.second = i;
661 // If we are including a file with a quoted include "foo.h" from inside
662 // a header in a framework that is currently being built, and we couldn't
663 // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
664 // "Foo" is the name of the framework in which the including header was found.
665 if (CurFileEnt && !isAngled && Filename.find('/') == StringRef::npos) {
666 HeaderFileInfo &IncludingHFI = getFileInfo(CurFileEnt);
667 if (IncludingHFI.IndexHeaderMapHeader) {
668 SmallString<128> ScratchFilename;
669 ScratchFilename += IncludingHFI.Framework;
670 ScratchFilename += '/';
671 ScratchFilename += Filename;
673 const FileEntry *Result = LookupFile(ScratchFilename, /*isAngled=*/true,
674 FromDir, CurDir, CurFileEnt,
675 SearchPath, RelativePath,
677 std::pair<unsigned, unsigned> &CacheLookup
678 = LookupFileCache.GetOrCreateValue(Filename).getValue();
680 = LookupFileCache.GetOrCreateValue(ScratchFilename).getValue().second;
685 // Otherwise, didn't find it. Remember we didn't find this.
686 CacheLookup.second = SearchDirs.size();
690 /// LookupSubframeworkHeader - Look up a subframework for the specified
691 /// \#include file. For example, if \#include'ing <HIToolbox/HIToolbox.h> from
692 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
693 /// is a subframework within Carbon.framework. If so, return the FileEntry
694 /// for the designated file, otherwise return null.
695 const FileEntry *HeaderSearch::
696 LookupSubframeworkHeader(StringRef Filename,
697 const FileEntry *ContextFileEnt,
698 SmallVectorImpl<char> *SearchPath,
699 SmallVectorImpl<char> *RelativePath,
700 ModuleMap::KnownHeader *SuggestedModule) {
701 assert(ContextFileEnt && "No context file?");
703 // Framework names must have a '/' in the filename. Find it.
704 // FIXME: Should we permit '\' on Windows?
705 size_t SlashPos = Filename.find('/');
706 if (SlashPos == StringRef::npos) return 0;
708 // Look up the base framework name of the ContextFileEnt.
709 const char *ContextName = ContextFileEnt->getName();
711 // If the context info wasn't a framework, couldn't be a subframework.
712 const unsigned DotFrameworkLen = 10;
713 const char *FrameworkPos = strstr(ContextName, ".framework");
714 if (FrameworkPos == 0 ||
715 (FrameworkPos[DotFrameworkLen] != '/' &&
716 FrameworkPos[DotFrameworkLen] != '\\'))
719 SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
721 // Append Frameworks/HIToolbox.framework/
722 FrameworkName += "Frameworks/";
723 FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
724 FrameworkName += ".framework/";
726 llvm::StringMapEntry<FrameworkCacheEntry> &CacheLookup =
727 FrameworkMap.GetOrCreateValue(Filename.substr(0, SlashPos));
729 // Some other location?
730 if (CacheLookup.getValue().Directory &&
731 CacheLookup.getKeyLength() == FrameworkName.size() &&
732 memcmp(CacheLookup.getKeyData(), &FrameworkName[0],
733 CacheLookup.getKeyLength()) != 0)
736 // Cache subframework.
737 if (CacheLookup.getValue().Directory == 0) {
738 ++NumSubFrameworkLookups;
740 // If the framework dir doesn't exist, we fail.
741 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
742 if (Dir == 0) return 0;
744 // Otherwise, if it does, remember that this is the right direntry for this
746 CacheLookup.getValue().Directory = Dir;
749 const FileEntry *FE = 0;
751 if (RelativePath != NULL) {
752 RelativePath->clear();
753 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
756 // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
757 SmallString<1024> HeadersFilename(FrameworkName);
758 HeadersFilename += "Headers/";
759 if (SearchPath != NULL) {
761 // Without trailing '/'.
762 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
765 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
766 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true))) {
768 // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
769 HeadersFilename = FrameworkName;
770 HeadersFilename += "PrivateHeaders/";
771 if (SearchPath != NULL) {
773 // Without trailing '/'.
774 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
777 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
778 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true)))
782 // This file is a system header or C++ unfriendly if the old file is.
784 // Note that the temporary 'DirInfo' is required here, as either call to
785 // getFileInfo could resize the vector and we don't want to rely on order
787 unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
788 getFileInfo(FE).DirInfo = DirInfo;
790 // If we're supposed to suggest a module, look for one now.
791 if (SuggestedModule) {
792 // Find the top-level framework based on this framework.
793 FrameworkName.pop_back(); // remove the trailing '/'
794 SmallVector<std::string, 4> SubmodulePath;
795 const DirectoryEntry *TopFrameworkDir
796 = ::getTopFrameworkDir(FileMgr, FrameworkName, SubmodulePath);
798 // Determine the name of the top-level framework.
799 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
801 // Load this framework module. If that succeeds, find the suggested module
802 // for this header, if any.
803 bool IsSystem = false;
804 if (loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
805 *SuggestedModule = findModuleForHeader(FE);
812 /// \brief Helper static function to normalize a path for injection into
813 /// a synthetic header.
814 /*static*/ std::string
815 HeaderSearch::NormalizeDashIncludePath(StringRef File, FileManager &FileMgr) {
816 // Implicit include paths should be resolved relative to the current
817 // working directory first, and then use the regular header search
818 // mechanism. The proper way to handle this is to have the
819 // predefines buffer located at the current working directory, but
820 // it has no file entry. For now, workaround this by using an
821 // absolute path if we find the file here, and otherwise letting
822 // header search handle it.
823 SmallString<128> Path(File);
824 llvm::sys::fs::make_absolute(Path);
826 if (llvm::sys::fs::exists(Path.str(), exists) || !exists)
829 FileMgr.getFile(File);
831 return Lexer::Stringify(Path.str());
834 //===----------------------------------------------------------------------===//
835 // File Info Management.
836 //===----------------------------------------------------------------------===//
838 /// \brief Merge the header file info provided by \p OtherHFI into the current
839 /// header file info (\p HFI)
840 static void mergeHeaderFileInfo(HeaderFileInfo &HFI,
841 const HeaderFileInfo &OtherHFI) {
842 HFI.isImport |= OtherHFI.isImport;
843 HFI.isPragmaOnce |= OtherHFI.isPragmaOnce;
844 HFI.isModuleHeader |= OtherHFI.isModuleHeader;
845 HFI.NumIncludes += OtherHFI.NumIncludes;
847 if (!HFI.ControllingMacro && !HFI.ControllingMacroID) {
848 HFI.ControllingMacro = OtherHFI.ControllingMacro;
849 HFI.ControllingMacroID = OtherHFI.ControllingMacroID;
852 if (OtherHFI.External) {
853 HFI.DirInfo = OtherHFI.DirInfo;
854 HFI.External = OtherHFI.External;
855 HFI.IndexHeaderMapHeader = OtherHFI.IndexHeaderMapHeader;
858 if (HFI.Framework.empty())
859 HFI.Framework = OtherHFI.Framework;
864 /// getFileInfo - Return the HeaderFileInfo structure for the specified
866 HeaderFileInfo &HeaderSearch::getFileInfo(const FileEntry *FE) {
867 if (FE->getUID() >= FileInfo.size())
868 FileInfo.resize(FE->getUID()+1);
870 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
871 if (ExternalSource && !HFI.Resolved)
872 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(FE));
876 bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
877 // Check if we've ever seen this file as a header.
878 if (File->getUID() >= FileInfo.size())
881 // Resolve header file info from the external source, if needed.
882 HeaderFileInfo &HFI = FileInfo[File->getUID()];
883 if (ExternalSource && !HFI.Resolved)
884 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(File));
886 return HFI.isPragmaOnce || HFI.isImport ||
887 HFI.ControllingMacro || HFI.ControllingMacroID;
890 void HeaderSearch::MarkFileModuleHeader(const FileEntry *FE,
891 ModuleMap::ModuleHeaderRole Role,
892 bool isCompilingModuleHeader) {
893 if (FE->getUID() >= FileInfo.size())
894 FileInfo.resize(FE->getUID()+1);
896 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
897 HFI.isModuleHeader = true;
898 HFI.isCompilingModuleHeader = isCompilingModuleHeader;
899 HFI.setHeaderRole(Role);
902 bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry *File, bool isImport){
903 ++NumIncluded; // Count # of attempted #includes.
905 // Get information about this file.
906 HeaderFileInfo &FileInfo = getFileInfo(File);
908 // If this is a #import directive, check that we have not already imported
911 // If this has already been imported, don't import it again.
912 FileInfo.isImport = true;
914 // Has this already been #import'ed or #include'd?
915 if (FileInfo.NumIncludes) return false;
917 // Otherwise, if this is a #include of a file that was previously #import'd
918 // or if this is the second #include of a #pragma once file, ignore it.
919 if (FileInfo.isImport)
923 // Next, check to see if the file is wrapped with #ifndef guards. If so, and
924 // if the macro that guards it is defined, we know the #include has no effect.
925 if (const IdentifierInfo *ControllingMacro
926 = FileInfo.getControllingMacro(ExternalLookup))
927 if (ControllingMacro->hasMacroDefinition()) {
928 ++NumMultiIncludeFileOptzn;
932 // Increment the number of times this file has been included.
933 ++FileInfo.NumIncludes;
938 size_t HeaderSearch::getTotalMemory() const {
939 return SearchDirs.capacity()
940 + llvm::capacity_in_bytes(FileInfo)
941 + llvm::capacity_in_bytes(HeaderMaps)
942 + LookupFileCache.getAllocator().getTotalMemory()
943 + FrameworkMap.getAllocator().getTotalMemory();
946 StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
947 return FrameworkNames.GetOrCreateValue(Framework).getKey();
950 bool HeaderSearch::hasModuleMap(StringRef FileName,
951 const DirectoryEntry *Root,
953 SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
955 StringRef DirName = FileName;
957 // Get the parent directory name.
958 DirName = llvm::sys::path::parent_path(DirName);
962 // Determine whether this directory exists.
963 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
967 // Try to load the "module.map" file in this directory.
968 switch (loadModuleMapFile(Dir, IsSystem)) {
969 case LMM_NewlyLoaded:
970 case LMM_AlreadyLoaded:
971 // Success. All of the directories we stepped through inherit this module
973 for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
974 DirectoryHasModuleMap[FixUpDirectories[I]] = true;
977 case LMM_NoDirectory:
978 case LMM_InvalidModuleMap:
982 // If we hit the top of our search, we're done.
986 // Keep track of all of the directories we checked, so we can mark them as
987 // having module maps if we eventually do find a module map.
988 FixUpDirectories.push_back(Dir);
992 ModuleMap::KnownHeader
993 HeaderSearch::findModuleForHeader(const FileEntry *File) const {
994 if (ExternalSource) {
995 // Make sure the external source has handled header info about this file,
996 // which includes whether the file is part of a module.
997 (void)getFileInfo(File);
999 return ModMap.findModuleForHeader(File);
1002 bool HeaderSearch::loadModuleMapFile(const FileEntry *File, bool IsSystem) {
1003 const DirectoryEntry *Dir = File->getDir();
1005 llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1006 = DirectoryHasModuleMap.find(Dir);
1007 if (KnownDir != DirectoryHasModuleMap.end())
1008 return !KnownDir->second;
1010 bool Result = ModMap.parseModuleMapFile(File, IsSystem);
1011 if (!Result && llvm::sys::path::filename(File->getName()) == "module.map") {
1012 // If the file we loaded was a module.map, look for the corresponding
1013 // module_private.map.
1014 SmallString<128> PrivateFilename(Dir->getName());
1015 llvm::sys::path::append(PrivateFilename, "module_private.map");
1016 if (const FileEntry *PrivateFile = FileMgr.getFile(PrivateFilename))
1017 Result = ModMap.parseModuleMapFile(PrivateFile, IsSystem);
1020 DirectoryHasModuleMap[Dir] = !Result;
1024 Module *HeaderSearch::loadFrameworkModule(StringRef Name,
1025 const DirectoryEntry *Dir,
1027 if (Module *Module = ModMap.findModule(Name))
1030 // Try to load a module map file.
1031 switch (loadModuleMapFile(Dir, IsSystem)) {
1032 case LMM_InvalidModuleMap:
1035 case LMM_AlreadyLoaded:
1036 case LMM_NoDirectory:
1039 case LMM_NewlyLoaded:
1040 return ModMap.findModule(Name);
1043 // Figure out the top-level framework directory and the submodule path from
1044 // that top-level framework to the requested framework.
1045 SmallVector<std::string, 2> SubmodulePath;
1046 SubmodulePath.push_back(Name);
1047 const DirectoryEntry *TopFrameworkDir
1048 = ::getTopFrameworkDir(FileMgr, Dir->getName(), SubmodulePath);
1051 // Try to infer a module map from the top-level framework directory.
1052 Module *Result = ModMap.inferFrameworkModule(SubmodulePath.back(),
1059 // Follow the submodule path to find the requested (sub)framework module
1060 // within the top-level framework module.
1061 SubmodulePath.pop_back();
1062 while (!SubmodulePath.empty() && Result) {
1063 Result = ModMap.lookupModuleQualified(SubmodulePath.back(), Result);
1064 SubmodulePath.pop_back();
1070 HeaderSearch::LoadModuleMapResult
1071 HeaderSearch::loadModuleMapFile(StringRef DirName, bool IsSystem) {
1072 if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
1073 return loadModuleMapFile(Dir, IsSystem);
1075 return LMM_NoDirectory;
1078 HeaderSearch::LoadModuleMapResult
1079 HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir, bool IsSystem) {
1080 llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1081 = DirectoryHasModuleMap.find(Dir);
1082 if (KnownDir != DirectoryHasModuleMap.end())
1083 return KnownDir->second? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
1085 SmallString<128> ModuleMapFileName;
1086 ModuleMapFileName += Dir->getName();
1087 unsigned ModuleMapDirNameLen = ModuleMapFileName.size();
1088 llvm::sys::path::append(ModuleMapFileName, "module.map");
1089 if (const FileEntry *ModuleMapFile = FileMgr.getFile(ModuleMapFileName)) {
1090 // We have found a module map file. Try to parse it.
1091 if (ModMap.parseModuleMapFile(ModuleMapFile, IsSystem)) {
1092 // No suitable module map.
1093 DirectoryHasModuleMap[Dir] = false;
1094 return LMM_InvalidModuleMap;
1097 // This directory has a module map.
1098 DirectoryHasModuleMap[Dir] = true;
1100 // Check whether there is a private module map that we need to load as well.
1101 ModuleMapFileName.erase(ModuleMapFileName.begin() + ModuleMapDirNameLen,
1102 ModuleMapFileName.end());
1103 llvm::sys::path::append(ModuleMapFileName, "module_private.map");
1104 if (const FileEntry *PrivateModuleMapFile
1105 = FileMgr.getFile(ModuleMapFileName)) {
1106 if (ModMap.parseModuleMapFile(PrivateModuleMapFile, IsSystem)) {
1107 // No suitable module map.
1108 DirectoryHasModuleMap[Dir] = false;
1109 return LMM_InvalidModuleMap;
1113 return LMM_NewlyLoaded;
1116 // No suitable module map.
1117 DirectoryHasModuleMap[Dir] = false;
1118 return LMM_InvalidModuleMap;
1121 void HeaderSearch::collectAllModules(SmallVectorImpl<Module *> &Modules) {
1124 // Load module maps for each of the header search directories.
1125 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1126 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
1127 if (SearchDirs[Idx].isFramework()) {
1128 llvm::error_code EC;
1129 SmallString<128> DirNative;
1130 llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1133 // Search each of the ".framework" directories to load them as modules.
1134 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1135 Dir != DirEnd && !EC; Dir.increment(EC)) {
1136 if (llvm::sys::path::extension(Dir->path()) != ".framework")
1139 const DirectoryEntry *FrameworkDir = FileMgr.getDirectory(Dir->path());
1143 // Load this framework module.
1144 loadFrameworkModule(llvm::sys::path::stem(Dir->path()), FrameworkDir,
1150 // FIXME: Deal with header maps.
1151 if (SearchDirs[Idx].isHeaderMap())
1154 // Try to load a module map file for the search directory.
1155 loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem);
1157 // Try to load module map files for immediate subdirectories of this search
1159 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
1162 // Populate the list of modules.
1163 for (ModuleMap::module_iterator M = ModMap.module_begin(),
1164 MEnd = ModMap.module_end();
1166 Modules.push_back(M->getValue());
1170 void HeaderSearch::loadTopLevelSystemModules() {
1171 // Load module maps for each of the header search directories.
1172 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1173 // We only care about normal header directories.
1174 if (!SearchDirs[Idx].isNormalDir()) {
1178 // Try to load a module map file for the search directory.
1179 loadModuleMapFile(SearchDirs[Idx].getDir(),
1180 SearchDirs[Idx].isSystemHeaderDirectory());
1184 void HeaderSearch::loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir) {
1185 if (SearchDir.haveSearchedAllModuleMaps())
1188 llvm::error_code EC;
1189 SmallString<128> DirNative;
1190 llvm::sys::path::native(SearchDir.getDir()->getName(), DirNative);
1191 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1192 Dir != DirEnd && !EC; Dir.increment(EC)) {
1193 loadModuleMapFile(Dir->path(), SearchDir.isSystemHeaderDirectory());
1196 SearchDir.setSearchedAllModuleMaps(true);