granicus.if.org Git - clang/blob - lib/Lex/HeaderSearch.cpp

   1 //===--- HeaderSearch.cpp - Resolve Header File Locations ---===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file implements the DirectoryLookup and HeaderSearch interfaces.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  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 <cstdio>
  26 using namespace clang;
  27
  28 const IdentifierInfo *
  29 HeaderFileInfo::getControllingMacro(ExternalIdentifierLookup *External) {
  30   if (ControllingMacro)
  31     return ControllingMacro;
  32
  33   if (!ControllingMacroID || !External)
  34     return 0;
  35
  36   ControllingMacro = External->GetIdentifier(ControllingMacroID);
  37   return ControllingMacro;
  38 }
  39
  40 ExternalHeaderFileInfoSource::~ExternalHeaderFileInfoSource() {}
  41
  42 HeaderSearch::HeaderSearch(llvm::IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts,
  43                            FileManager &FM, DiagnosticsEngine &Diags,
  44                            const LangOptions &LangOpts,
  45                            const TargetInfo *Target)
  46   : HSOpts(HSOpts), FileMgr(FM), FrameworkMap(64),
  47     ModMap(FileMgr, *Diags.getClient(), LangOpts, Target)
  48 {
  49   AngledDirIdx = 0;
  50   SystemDirIdx = 0;
  51   NoCurDirSearch = false;
  52
  53   ExternalLookup = 0;
  54   ExternalSource = 0;
  55   NumIncluded = 0;
  56   NumMultiIncludeFileOptzn = 0;
  57   NumFrameworkLookups = NumSubFrameworkLookups = 0;
  58 }
  59
  60 HeaderSearch::~HeaderSearch() {
  61   // Delete headermaps.
  62   for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
  63     delete HeaderMaps[i].second;
  64 }
  65
  66 void HeaderSearch::PrintStats() {
  67   fprintf(stderr, "\n*** HeaderSearch Stats:\n");
  68   fprintf(stderr, "%d files tracked.\n", (int)FileInfo.size());
  69   unsigned NumOnceOnlyFiles = 0, MaxNumIncludes = 0, NumSingleIncludedFiles = 0;
  70   for (unsigned i = 0, e = FileInfo.size(); i != e; ++i) {
  71     NumOnceOnlyFiles += FileInfo[i].isImport;
  72     if (MaxNumIncludes < FileInfo[i].NumIncludes)
  73       MaxNumIncludes = FileInfo[i].NumIncludes;
  74     NumSingleIncludedFiles += FileInfo[i].NumIncludes == 1;
  75   }
  76   fprintf(stderr, "  %d #import/#pragma once files.\n", NumOnceOnlyFiles);
  77   fprintf(stderr, "  %d included exactly once.\n", NumSingleIncludedFiles);
  78   fprintf(stderr, "  %d max times a file is included.\n", MaxNumIncludes);
  79
  80   fprintf(stderr, "  %d #include/#include_next/#import.\n", NumIncluded);
  81   fprintf(stderr, "    %d #includes skipped due to"
  82           " the multi-include optimization.\n", NumMultiIncludeFileOptzn);
  83
  84   fprintf(stderr, "%d framework lookups.\n", NumFrameworkLookups);
  85   fprintf(stderr, "%d subframework lookups.\n", NumSubFrameworkLookups);
  86 }
  87
  88 /// CreateHeaderMap - This method returns a HeaderMap for the specified
  89 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
  90 const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) {
  91   // We expect the number of headermaps to be small, and almost always empty.
  92   // If it ever grows, use of a linear search should be re-evaluated.
  93   if (!HeaderMaps.empty()) {
  94     for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
  95       // Pointer equality comparison of FileEntries works because they are
  96       // already uniqued by inode.
  97       if (HeaderMaps[i].first == FE)
  98         return HeaderMaps[i].second;
  99   }
 100
 101   if (const HeaderMap *HM = HeaderMap::Create(FE, FileMgr)) {
 102     HeaderMaps.push_back(std::make_pair(FE, HM));
 103     return HM;
 104   }
 105
 106   return 0;
 107 }
 108
 109 std::string HeaderSearch::getModuleFileName(Module *Module) {
 110   // If we don't have a module cache path, we can't do anything.
 111   if (ModuleCachePath.empty())
 112     return std::string();
 113
 114
 115   SmallString<256> Result(ModuleCachePath);
 116   llvm::sys::path::append(Result, Module->getTopLevelModule()->Name + ".pcm");
 117   return Result.str().str();
 118 }
 119
 120 std::string HeaderSearch::getModuleFileName(StringRef ModuleName) {
 121   // If we don't have a module cache path, we can't do anything.
 122   if (ModuleCachePath.empty())
 123     return std::string();
 124
 125
 126   SmallString<256> Result(ModuleCachePath);
 127   llvm::sys::path::append(Result, ModuleName + ".pcm");
 128   return Result.str().str();
 129 }
 130
 131 Module *HeaderSearch::lookupModule(StringRef ModuleName, bool AllowSearch) {
 132   // Look in the module map to determine if there is a module by this name.
 133   Module *Module = ModMap.findModule(ModuleName);
 134   if (Module || !AllowSearch)
 135     return Module;
 136
 137   // Look through the various header search paths to load any available module
 138   // maps, searching for a module map that describes this module.
 139   for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
 140     if (SearchDirs[Idx].isFramework()) {
 141       // Search for or infer a module map for a framework.
 142       SmallString<128> FrameworkDirName;
 143       FrameworkDirName += SearchDirs[Idx].getFrameworkDir()->getName();
 144       llvm::sys::path::append(FrameworkDirName, ModuleName + ".framework");
 145       if (const DirectoryEntry *FrameworkDir
 146             = FileMgr.getDirectory(FrameworkDirName)) {
 147         bool IsSystem
 148           = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
 149         Module = loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
 150         if (Module)
 151           break;
 152       }
 153     }
 154
 155     // FIXME: Figure out how header maps and module maps will work together.
 156
 157     // Only deal with normal search directories.
 158     if (!SearchDirs[Idx].isNormalDir())
 159       continue;
 160
 161     // Search for a module map file in this directory.
 162     if (loadModuleMapFile(SearchDirs[Idx].getDir()) == LMM_NewlyLoaded) {
 163       // We just loaded a module map file; check whether the module is
 164       // available now.
 165       Module = ModMap.findModule(ModuleName);
 166       if (Module)
 167         break;
 168     }
 169
 170     // Search for a module map in a subdirectory with the same name as the
 171     // module.
 172     SmallString<128> NestedModuleMapDirName;
 173     NestedModuleMapDirName = SearchDirs[Idx].getDir()->getName();
 174     llvm::sys::path::append(NestedModuleMapDirName, ModuleName);
 175     if (loadModuleMapFile(NestedModuleMapDirName) == LMM_NewlyLoaded) {
 176       // If we just loaded a module map file, look for the module again.
 177       Module = ModMap.findModule(ModuleName);
 178       if (Module)
 179         break;
 180     }
 181   }
 182
 183   return Module;
 184 }
 185
 186 //===----------------------------------------------------------------------===//
 187 // File lookup within a DirectoryLookup scope
 188 //===----------------------------------------------------------------------===//
 189
 190 /// getName - Return the directory or filename corresponding to this lookup
 191 /// object.
 192 const char *DirectoryLookup::getName() const {
 193   if (isNormalDir())
 194     return getDir()->getName();
 195   if (isFramework())
 196     return getFrameworkDir()->getName();
 197   assert(isHeaderMap() && "Unknown DirectoryLookup");
 198   return getHeaderMap()->getFileName();
 199 }
 200
 201
 202 /// LookupFile - Lookup the specified file in this search path, returning it
 203 /// if it exists or returning null if not.
 204 const FileEntry *DirectoryLookup::LookupFile(
 205     StringRef Filename,
 206     HeaderSearch &HS,
 207     SmallVectorImpl<char> *SearchPath,
 208     SmallVectorImpl<char> *RelativePath,
 209     Module **SuggestedModule,
 210     bool &InUserSpecifiedSystemFramework) const {
 211   InUserSpecifiedSystemFramework = false;
 212
 213   SmallString<1024> TmpDir;
 214   if (isNormalDir()) {
 215     // Concatenate the requested file onto the directory.
 216     TmpDir = getDir()->getName();
 217     llvm::sys::path::append(TmpDir, Filename);
 218     if (SearchPath != NULL) {
 219       StringRef SearchPathRef(getDir()->getName());
 220       SearchPath->clear();
 221       SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
 222     }
 223     if (RelativePath != NULL) {
 224       RelativePath->clear();
 225       RelativePath->append(Filename.begin(), Filename.end());
 226     }
 227
 228     // If we have a module map that might map this header, load it and
 229     // check whether we'll have a suggestion for a module.
 230     if (SuggestedModule && HS.hasModuleMap(TmpDir, getDir())) {
 231       const FileEntry *File = HS.getFileMgr().getFile(TmpDir.str(),
 232                                                       /*openFile=*/false);
 233       if (!File)
 234         return File;
 235
 236       // If there is a module that corresponds to this header,
 237       // suggest it.
 238       *SuggestedModule = HS.findModuleForHeader(File);
 239       return File;
 240     }
 241
 242     return HS.getFileMgr().getFile(TmpDir.str(), /*openFile=*/true);
 243   }
 244
 245   if (isFramework())
 246     return DoFrameworkLookup(Filename, HS, SearchPath, RelativePath,
 247                              SuggestedModule, InUserSpecifiedSystemFramework);
 248
 249   assert(isHeaderMap() && "Unknown directory lookup");
 250   const FileEntry * const Result = getHeaderMap()->LookupFile(
 251       Filename, HS.getFileMgr());
 252   if (Result) {
 253     if (SearchPath != NULL) {
 254       StringRef SearchPathRef(getName());
 255       SearchPath->clear();
 256       SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
 257     }
 258     if (RelativePath != NULL) {
 259       RelativePath->clear();
 260       RelativePath->append(Filename.begin(), Filename.end());
 261     }
 262   }
 263   return Result;
 264 }
 265
 266 /// \brief Given a framework directory, find the top-most framework directory.
 267 ///
 268 /// \param FileMgr The file manager to use for directory lookups.
 269 /// \param DirName The name of the framework directory.
 270 /// \param SubmodulePath Will be populated with the submodule path from the
 271 /// returned top-level module to the originally named framework.
 272 static const DirectoryEntry *
 273 getTopFrameworkDir(FileManager &FileMgr, StringRef DirName,
 274                    SmallVectorImpl<std::string> &SubmodulePath) {
 275   assert(llvm::sys::path::extension(DirName) == ".framework" &&
 276          "Not a framework directory");
 277
 278 #ifdef LLVM_ON_UNIX
 279   // Note: as an egregious but useful hack we use the real path here, because
 280   // frameworks moving between top-level frameworks to embedded frameworks tend
 281   // to be symlinked, and we base the logical structure of modules on the
 282   // physical layout. In particular, we need to deal with crazy includes like
 283   //
 284   //   #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
 285   //
 286   // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
 287   // which one should access with, e.g.,
 288   //
 289   //   #include <Bar/Wibble.h>
 290   //
 291   // Similar issues occur when a top-level framework has moved into an
 292   // embedded framework.
 293   char RealDirName[PATH_MAX];
 294   if (realpath(DirName.str().c_str(), RealDirName))
 295     DirName = RealDirName;
 296 #endif
 297
 298   const DirectoryEntry *TopFrameworkDir = FileMgr.getDirectory(DirName);
 299   do {
 300     // Get the parent directory name.
 301     DirName = llvm::sys::path::parent_path(DirName);
 302     if (DirName.empty())
 303       break;
 304
 305     // Determine whether this directory exists.
 306     const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
 307     if (!Dir)
 308       break;
 309
 310     // If this is a framework directory, then we're a subframework of this
 311     // framework.
 312     if (llvm::sys::path::extension(DirName) == ".framework") {
 313       SubmodulePath.push_back(llvm::sys::path::stem(DirName));
 314       TopFrameworkDir = Dir;
 315     }
 316   } while (true);
 317
 318   return TopFrameworkDir;
 319 }
 320
 321 /// DoFrameworkLookup - Do a lookup of the specified file in the current
 322 /// DirectoryLookup, which is a framework directory.
 323 const FileEntry *DirectoryLookup::DoFrameworkLookup(
 324     StringRef Filename,
 325     HeaderSearch &HS,
 326     SmallVectorImpl<char> *SearchPath,
 327     SmallVectorImpl<char> *RelativePath,
 328     Module **SuggestedModule,
 329     bool &InUserSpecifiedSystemFramework) const
 330 {
 331   FileManager &FileMgr = HS.getFileMgr();
 332
 333   // Framework names must have a '/' in the filename.
 334   size_t SlashPos = Filename.find('/');
 335   if (SlashPos == StringRef::npos) return 0;
 336
 337   // Find out if this is the home for the specified framework, by checking
 338   // HeaderSearch.  Possible answers are yes/no and unknown.
 339   HeaderSearch::FrameworkCacheEntry &CacheEntry =
 340     HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
 341
 342   // If it is known and in some other directory, fail.
 343   if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
 344     return 0;
 345
 346   // Otherwise, construct the path to this framework dir.
 347
 348   // FrameworkName = "/System/Library/Frameworks/"
 349   SmallString<1024> FrameworkName;
 350   FrameworkName += getFrameworkDir()->getName();
 351   if (FrameworkName.empty() || FrameworkName.back() != '/')
 352     FrameworkName.push_back('/');
 353
 354   // FrameworkName = "/System/Library/Frameworks/Cocoa"
 355   StringRef ModuleName(Filename.begin(), SlashPos);
 356   FrameworkName += ModuleName;
 357
 358   // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
 359   FrameworkName += ".framework/";
 360
 361   // If the cache entry was unresolved, populate it now.
 362   if (CacheEntry.Directory == 0) {
 363     HS.IncrementFrameworkLookupCount();
 364
 365     // If the framework dir doesn't exist, we fail.
 366     const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
 367     if (Dir == 0) return 0;
 368
 369     // Otherwise, if it does, remember that this is the right direntry for this
 370     // framework.
 371     CacheEntry.Directory = getFrameworkDir();
 372
 373     // If this is a user search directory, check if the framework has been
 374     // user-specified as a system framework.
 375     if (getDirCharacteristic() == SrcMgr::C_User) {
 376       SmallString<1024> SystemFrameworkMarker(FrameworkName);
 377       SystemFrameworkMarker += ".system_framework";
 378       if (llvm::sys::fs::exists(SystemFrameworkMarker.str())) {
 379         CacheEntry.IsUserSpecifiedSystemFramework = true;
 380       }
 381     }
 382   }
 383
 384   // Set the 'user-specified system framework' flag.
 385   InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
 386
 387   if (RelativePath != NULL) {
 388     RelativePath->clear();
 389     RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
 390   }
 391
 392   // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
 393   unsigned OrigSize = FrameworkName.size();
 394
 395   FrameworkName += "Headers/";
 396
 397   if (SearchPath != NULL) {
 398     SearchPath->clear();
 399     // Without trailing '/'.
 400     SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
 401   }
 402
 403   FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
 404   const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
 405                                         /*openFile=*/!SuggestedModule);
 406   if (!FE) {
 407     // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
 408     const char *Private = "Private";
 409     FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
 410                          Private+strlen(Private));
 411     if (SearchPath != NULL)
 412       SearchPath->insert(SearchPath->begin()+OrigSize, Private,
 413                          Private+strlen(Private));
 414
 415     FE = FileMgr.getFile(FrameworkName.str(), /*openFile=*/!SuggestedModule);
 416   }
 417
 418   // If we found the header and are allowed to suggest a module, do so now.
 419   if (FE && SuggestedModule) {
 420     // Find the framework in which this header occurs.
 421     StringRef FrameworkPath = FE->getName();
 422     bool FoundFramework = false;
 423     do {
 424       // Get the parent directory name.
 425       FrameworkPath = llvm::sys::path::parent_path(FrameworkPath);
 426       if (FrameworkPath.empty())
 427         break;
 428
 429       // Determine whether this directory exists.
 430       const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkPath);
 431       if (!Dir)
 432         break;
 433
 434       // If this is a framework directory, then we're a subframework of this
 435       // framework.
 436       if (llvm::sys::path::extension(FrameworkPath) == ".framework") {
 437         FoundFramework = true;
 438         break;
 439       }
 440     } while (true);
 441
 442     if (FoundFramework) {
 443       // Find the top-level framework based on this framework.
 444       SmallVector<std::string, 4> SubmodulePath;
 445       const DirectoryEntry *TopFrameworkDir
 446         = ::getTopFrameworkDir(FileMgr, FrameworkPath, SubmodulePath);
 447
 448       // Determine the name of the top-level framework.
 449       StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
 450
 451       // Load this framework module. If that succeeds, find the suggested module
 452       // for this header, if any.
 453       bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
 454       if (HS.loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
 455         *SuggestedModule = HS.findModuleForHeader(FE);
 456       }
 457     } else {
 458       *SuggestedModule = HS.findModuleForHeader(FE);
 459     }
 460   }
 461   return FE;
 462 }
 463
 464 void HeaderSearch::setTarget(const TargetInfo &Target) {
 465   ModMap.setTarget(Target);
 466 }
 467
 468
 469 //===----------------------------------------------------------------------===//
 470 // Header File Location.
 471 //===----------------------------------------------------------------------===//
 472
 473
 474 /// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
 475 /// return null on failure.  isAngled indicates whether the file reference is
 476 /// for system \#include's or not (i.e. using <> instead of "").  CurFileEnt, if
 477 /// non-null, indicates where the \#including file is, in case a relative search
 478 /// is needed.
 479 const FileEntry *HeaderSearch::LookupFile(
 480     StringRef Filename,
 481     bool isAngled,
 482     const DirectoryLookup *FromDir,
 483     const DirectoryLookup *&CurDir,
 484     const FileEntry *CurFileEnt,
 485     SmallVectorImpl<char> *SearchPath,
 486     SmallVectorImpl<char> *RelativePath,
 487     Module **SuggestedModule,
 488     bool SkipCache)
 489 {
 490   if (SuggestedModule)
 491     *SuggestedModule = 0;
 492
 493   // If 'Filename' is absolute, check to see if it exists and no searching.
 494   if (llvm::sys::path::is_absolute(Filename)) {
 495     CurDir = 0;
 496
 497     // If this was an #include_next "/absolute/file", fail.
 498     if (FromDir) return 0;
 499
 500     if (SearchPath != NULL)
 501       SearchPath->clear();
 502     if (RelativePath != NULL) {
 503       RelativePath->clear();
 504       RelativePath->append(Filename.begin(), Filename.end());
 505     }
 506     // Otherwise, just return the file.
 507     return FileMgr.getFile(Filename, /*openFile=*/true);
 508   }
 509
 510   // Unless disabled, check to see if the file is in the #includer's
 511   // directory.  This has to be based on CurFileEnt, not CurDir, because
 512   // CurFileEnt could be a #include of a subdirectory (#include "foo/bar.h") and
 513   // a subsequent include of "baz.h" should resolve to "whatever/foo/baz.h".
 514   // This search is not done for <> headers.
 515   if (CurFileEnt && !isAngled && !NoCurDirSearch) {
 516     SmallString<1024> TmpDir;
 517     // Concatenate the requested file onto the directory.
 518     // FIXME: Portability.  Filename concatenation should be in sys::Path.
 519     TmpDir += CurFileEnt->getDir()->getName();
 520     TmpDir.push_back('/');
 521     TmpDir.append(Filename.begin(), Filename.end());
 522     if (const FileEntry *FE = FileMgr.getFile(TmpDir.str(),/*openFile=*/true)) {
 523       // Leave CurDir unset.
 524       // This file is a system header or C++ unfriendly if the old file is.
 525       //
 526       // Note that we only use one of FromHFI/ToHFI at once, due to potential
 527       // reallocation of the underlying vector potentially making the first
 528       // reference binding dangling.
 529       HeaderFileInfo &FromHFI = getFileInfo(CurFileEnt);
 530       unsigned DirInfo = FromHFI.DirInfo;
 531       bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
 532       StringRef Framework = FromHFI.Framework;
 533
 534       HeaderFileInfo &ToHFI = getFileInfo(FE);
 535       ToHFI.DirInfo = DirInfo;
 536       ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
 537       ToHFI.Framework = Framework;
 538
 539       if (SearchPath != NULL) {
 540         StringRef SearchPathRef(CurFileEnt->getDir()->getName());
 541         SearchPath->clear();
 542         SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
 543       }
 544       if (RelativePath != NULL) {
 545         RelativePath->clear();
 546         RelativePath->append(Filename.begin(), Filename.end());
 547       }
 548       return FE;
 549     }
 550   }
 551
 552   CurDir = 0;
 553
 554   // If this is a system #include, ignore the user #include locs.
 555   unsigned i = isAngled ? AngledDirIdx : 0;
 556
 557   // If this is a #include_next request, start searching after the directory the
 558   // file was found in.
 559   if (FromDir)
 560     i = FromDir-&SearchDirs[0];
 561
 562   // Cache all of the lookups performed by this method.  Many headers are
 563   // multiply included, and the "pragma once" optimization prevents them from
 564   // being relex/pp'd, but they would still have to search through a
 565   // (potentially huge) series of SearchDirs to find it.
 566   std::pair<unsigned, unsigned> &CacheLookup =
 567     LookupFileCache.GetOrCreateValue(Filename).getValue();
 568
 569   // If the entry has been previously looked up, the first value will be
 570   // non-zero.  If the value is equal to i (the start point of our search), then
 571   // this is a matching hit.
 572   if (!SkipCache && CacheLookup.first == i+1) {
 573     // Skip querying potentially lots of directories for this lookup.
 574     i = CacheLookup.second;
 575   } else {
 576     // Otherwise, this is the first query, or the previous query didn't match
 577     // our search start.  We will fill in our found location below, so prime the
 578     // start point value.
 579     CacheLookup.first = i+1;
 580   }
 581
 582   // Check each directory in sequence to see if it contains this file.
 583   for (; i != SearchDirs.size(); ++i) {
 584     bool InUserSpecifiedSystemFramework = false;
 585     const FileEntry *FE =
 586       SearchDirs[i].LookupFile(Filename, *this, SearchPath, RelativePath,
 587                                SuggestedModule, InUserSpecifiedSystemFramework);
 588     if (!FE) continue;
 589
 590     CurDir = &SearchDirs[i];
 591
 592     // This file is a system header or C++ unfriendly if the dir is.
 593     HeaderFileInfo &HFI = getFileInfo(FE);
 594     HFI.DirInfo = CurDir->getDirCharacteristic();
 595
 596     // If the directory characteristic is User but this framework was
 597     // user-specified to be treated as a system framework, promote the
 598     // characteristic.
 599     if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
 600       HFI.DirInfo = SrcMgr::C_System;
 601
 602     // If the filename matches a known system header prefix, override
 603     // whether the file is a system header.
 604     for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
 605       if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
 606         HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
 607                                                        : SrcMgr::C_User;
 608         break;
 609       }
 610     }
 611
 612     // If this file is found in a header map and uses the framework style of
 613     // includes, then this header is part of a framework we're building.
 614     if (CurDir->isIndexHeaderMap()) {
 615       size_t SlashPos = Filename.find('/');
 616       if (SlashPos != StringRef::npos) {
 617         HFI.IndexHeaderMapHeader = 1;
 618         HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
 619                                                          SlashPos));
 620       }
 621     }
 622
 623     // Remember this location for the next lookup we do.
 624     CacheLookup.second = i;
 625     return FE;
 626   }
 627
 628   // If we are including a file with a quoted include "foo.h" from inside
 629   // a header in a framework that is currently being built, and we couldn't
 630   // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
 631   // "Foo" is the name of the framework in which the including header was found.
 632   if (CurFileEnt && !isAngled && Filename.find('/') == StringRef::npos) {
 633     HeaderFileInfo &IncludingHFI = getFileInfo(CurFileEnt);
 634     if (IncludingHFI.IndexHeaderMapHeader) {
 635       SmallString<128> ScratchFilename;
 636       ScratchFilename += IncludingHFI.Framework;
 637       ScratchFilename += '/';
 638       ScratchFilename += Filename;
 639
 640       const FileEntry *Result = LookupFile(ScratchFilename, /*isAngled=*/true,
 641                                            FromDir, CurDir, CurFileEnt,
 642                                            SearchPath, RelativePath,
 643                                            SuggestedModule);
 644       std::pair<unsigned, unsigned> &CacheLookup
 645         = LookupFileCache.GetOrCreateValue(Filename).getValue();
 646       CacheLookup.second
 647         = LookupFileCache.GetOrCreateValue(ScratchFilename).getValue().second;
 648       return Result;
 649     }
 650   }
 651
 652   // Otherwise, didn't find it. Remember we didn't find this.
 653   CacheLookup.second = SearchDirs.size();
 654   return 0;
 655 }
 656
 657 /// LookupSubframeworkHeader - Look up a subframework for the specified
 658 /// \#include file.  For example, if \#include'ing <HIToolbox/HIToolbox.h> from
 659 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
 660 /// is a subframework within Carbon.framework.  If so, return the FileEntry
 661 /// for the designated file, otherwise return null.
 662 const FileEntry *HeaderSearch::
 663 LookupSubframeworkHeader(StringRef Filename,
 664                          const FileEntry *ContextFileEnt,
 665                          SmallVectorImpl<char> *SearchPath,
 666                          SmallVectorImpl<char> *RelativePath) {
 667   assert(ContextFileEnt && "No context file?");
 668
 669   // Framework names must have a '/' in the filename.  Find it.
 670   // FIXME: Should we permit '\' on Windows?
 671   size_t SlashPos = Filename.find('/');
 672   if (SlashPos == StringRef::npos) return 0;
 673
 674   // Look up the base framework name of the ContextFileEnt.
 675   const char *ContextName = ContextFileEnt->getName();
 676
 677   // If the context info wasn't a framework, couldn't be a subframework.
 678   const unsigned DotFrameworkLen = 10;
 679   const char *FrameworkPos = strstr(ContextName, ".framework");
 680   if (FrameworkPos == 0 ||
 681       (FrameworkPos[DotFrameworkLen] != '/' &&
 682        FrameworkPos[DotFrameworkLen] != '\\'))
 683     return 0;
 684
 685   SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
 686
 687   // Append Frameworks/HIToolbox.framework/
 688   FrameworkName += "Frameworks/";
 689   FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
 690   FrameworkName += ".framework/";
 691
 692   llvm::StringMapEntry<FrameworkCacheEntry> &CacheLookup =
 693     FrameworkMap.GetOrCreateValue(Filename.substr(0, SlashPos));
 694
 695   // Some other location?
 696   if (CacheLookup.getValue().Directory &&
 697       CacheLookup.getKeyLength() == FrameworkName.size() &&
 698       memcmp(CacheLookup.getKeyData(), &FrameworkName[0],
 699              CacheLookup.getKeyLength()) != 0)
 700     return 0;
 701
 702   // Cache subframework.
 703   if (CacheLookup.getValue().Directory == 0) {
 704     ++NumSubFrameworkLookups;
 705
 706     // If the framework dir doesn't exist, we fail.
 707     const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
 708     if (Dir == 0) return 0;
 709
 710     // Otherwise, if it does, remember that this is the right direntry for this
 711     // framework.
 712     CacheLookup.getValue().Directory = Dir;
 713   }
 714
 715   const FileEntry *FE = 0;
 716
 717   if (RelativePath != NULL) {
 718     RelativePath->clear();
 719     RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
 720   }
 721
 722   // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
 723   SmallString<1024> HeadersFilename(FrameworkName);
 724   HeadersFilename += "Headers/";
 725   if (SearchPath != NULL) {
 726     SearchPath->clear();
 727     // Without trailing '/'.
 728     SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
 729   }
 730
 731   HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
 732   if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true))) {
 733
 734     // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
 735     HeadersFilename = FrameworkName;
 736     HeadersFilename += "PrivateHeaders/";
 737     if (SearchPath != NULL) {
 738       SearchPath->clear();
 739       // Without trailing '/'.
 740       SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
 741     }
 742
 743     HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
 744     if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true)))
 745       return 0;
 746   }
 747
 748   // This file is a system header or C++ unfriendly if the old file is.
 749   //
 750   // Note that the temporary 'DirInfo' is required here, as either call to
 751   // getFileInfo could resize the vector and we don't want to rely on order
 752   // of evaluation.
 753   unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
 754   getFileInfo(FE).DirInfo = DirInfo;
 755   return FE;
 756 }
 757
 758 /// \brief Helper static function to normalize a path for injection into
 759 /// a synthetic header.
 760 /*static*/ std::string
 761 HeaderSearch::NormalizeDashIncludePath(StringRef File, FileManager &FileMgr) {
 762   // Implicit include paths should be resolved relative to the current
 763   // working directory first, and then use the regular header search
 764   // mechanism. The proper way to handle this is to have the
 765   // predefines buffer located at the current working directory, but
 766   // it has no file entry. For now, workaround this by using an
 767   // absolute path if we find the file here, and otherwise letting
 768   // header search handle it.
 769   SmallString<128> Path(File);
 770   llvm::sys::fs::make_absolute(Path);
 771   bool exists;
 772   if (llvm::sys::fs::exists(Path.str(), exists) || !exists)
 773     Path = File;
 774   else if (exists)
 775     FileMgr.getFile(File);
 776
 777   return Lexer::Stringify(Path.str());
 778 }
 779
 780 //===----------------------------------------------------------------------===//
 781 // File Info Management.
 782 //===----------------------------------------------------------------------===//
 783
 784 /// \brief Merge the header file info provided by \p OtherHFI into the current
 785 /// header file info (\p HFI)
 786 static void mergeHeaderFileInfo(HeaderFileInfo &HFI,
 787                                 const HeaderFileInfo &OtherHFI) {
 788   HFI.isImport |= OtherHFI.isImport;
 789   HFI.isPragmaOnce |= OtherHFI.isPragmaOnce;
 790   HFI.NumIncludes += OtherHFI.NumIncludes;
 791
 792   if (!HFI.ControllingMacro && !HFI.ControllingMacroID) {
 793     HFI.ControllingMacro = OtherHFI.ControllingMacro;
 794     HFI.ControllingMacroID = OtherHFI.ControllingMacroID;
 795   }
 796
 797   if (OtherHFI.External) {
 798     HFI.DirInfo = OtherHFI.DirInfo;
 799     HFI.External = OtherHFI.External;
 800     HFI.IndexHeaderMapHeader = OtherHFI.IndexHeaderMapHeader;
 801   }
 802
 803   if (HFI.Framework.empty())
 804     HFI.Framework = OtherHFI.Framework;
 805
 806   HFI.Resolved = true;
 807 }
 808
 809 /// getFileInfo - Return the HeaderFileInfo structure for the specified
 810 /// FileEntry.
 811 HeaderFileInfo &HeaderSearch::getFileInfo(const FileEntry *FE) {
 812   if (FE->getUID() >= FileInfo.size())
 813     FileInfo.resize(FE->getUID()+1);
 814
 815   HeaderFileInfo &HFI = FileInfo[FE->getUID()];
 816   if (ExternalSource && !HFI.Resolved)
 817     mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(FE));
 818   return HFI;
 819 }
 820
 821 bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
 822   // Check if we've ever seen this file as a header.
 823   if (File->getUID() >= FileInfo.size())
 824     return false;
 825
 826   // Resolve header file info from the external source, if needed.
 827   HeaderFileInfo &HFI = FileInfo[File->getUID()];
 828   if (ExternalSource && !HFI.Resolved)
 829     mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(File));
 830
 831   return HFI.isPragmaOnce || HFI.isImport ||
 832       HFI.ControllingMacro || HFI.ControllingMacroID;
 833 }
 834
 835 void HeaderSearch::setHeaderFileInfoForUID(HeaderFileInfo HFI, unsigned UID) {
 836   if (UID >= FileInfo.size())
 837     FileInfo.resize(UID+1);
 838   HFI.Resolved = true;
 839   FileInfo[UID] = HFI;
 840 }
 841
 842 bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry *File, bool isImport){
 843   ++NumIncluded; // Count # of attempted #includes.
 844
 845   // Get information about this file.
 846   HeaderFileInfo &FileInfo = getFileInfo(File);
 847
 848   // If this is a #import directive, check that we have not already imported
 849   // this header.
 850   if (isImport) {
 851     // If this has already been imported, don't import it again.
 852     FileInfo.isImport = true;
 853
 854     // Has this already been #import'ed or #include'd?
 855     if (FileInfo.NumIncludes) return false;
 856   } else {
 857     // Otherwise, if this is a #include of a file that was previously #import'd
 858     // or if this is the second #include of a #pragma once file, ignore it.
 859     if (FileInfo.isImport)
 860       return false;
 861   }
 862
 863   // Next, check to see if the file is wrapped with #ifndef guards.  If so, and
 864   // if the macro that guards it is defined, we know the #include has no effect.
 865   if (const IdentifierInfo *ControllingMacro
 866       = FileInfo.getControllingMacro(ExternalLookup))
 867     if (ControllingMacro->hasMacroDefinition()) {
 868       ++NumMultiIncludeFileOptzn;
 869       return false;
 870     }
 871
 872   // Increment the number of times this file has been included.
 873   ++FileInfo.NumIncludes;
 874
 875   return true;
 876 }
 877
 878 size_t HeaderSearch::getTotalMemory() const {
 879   return SearchDirs.capacity()
 880     + llvm::capacity_in_bytes(FileInfo)
 881     + llvm::capacity_in_bytes(HeaderMaps)
 882     + LookupFileCache.getAllocator().getTotalMemory()
 883     + FrameworkMap.getAllocator().getTotalMemory();
 884 }
 885
 886 StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
 887   return FrameworkNames.GetOrCreateValue(Framework).getKey();
 888 }
 889
 890 bool HeaderSearch::hasModuleMap(StringRef FileName,
 891                                 const DirectoryEntry *Root) {
 892   llvm::SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
 893
 894   StringRef DirName = FileName;
 895   do {
 896     // Get the parent directory name.
 897     DirName = llvm::sys::path::parent_path(DirName);
 898     if (DirName.empty())
 899       return false;
 900
 901     // Determine whether this directory exists.
 902     const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
 903     if (!Dir)
 904       return false;
 905
 906     // Try to load the module map file in this directory.
 907     switch (loadModuleMapFile(Dir)) {
 908     case LMM_NewlyLoaded:
 909     case LMM_AlreadyLoaded:
 910       // Success. All of the directories we stepped through inherit this module
 911       // map file.
 912       for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
 913         DirectoryHasModuleMap[FixUpDirectories[I]] = true;
 914
 915       return true;
 916
 917     case LMM_NoDirectory:
 918     case LMM_InvalidModuleMap:
 919       break;
 920     }
 921
 922     // If we hit the top of our search, we're done.
 923     if (Dir == Root)
 924       return false;
 925
 926     // Keep track of all of the directories we checked, so we can mark them as
 927     // having module maps if we eventually do find a module map.
 928     FixUpDirectories.push_back(Dir);
 929   } while (true);
 930 }
 931
 932 Module *HeaderSearch::findModuleForHeader(const FileEntry *File) {
 933   if (Module *Mod = ModMap.findModuleForHeader(File))
 934     return Mod;
 935
 936   return 0;
 937 }
 938
 939 bool HeaderSearch::loadModuleMapFile(const FileEntry *File) {
 940   const DirectoryEntry *Dir = File->getDir();
 941
 942   llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
 943     = DirectoryHasModuleMap.find(Dir);
 944   if (KnownDir != DirectoryHasModuleMap.end())
 945     return !KnownDir->second;
 946
 947   bool Result = ModMap.parseModuleMapFile(File);
 948   if (!Result && llvm::sys::path::filename(File->getName()) == "module.map") {
 949     // If the file we loaded was a module.map, look for the corresponding
 950     // module_private.map.
 951     SmallString<128> PrivateFilename(Dir->getName());
 952     llvm::sys::path::append(PrivateFilename, "module_private.map");
 953     if (const FileEntry *PrivateFile = FileMgr.getFile(PrivateFilename))
 954       Result = ModMap.parseModuleMapFile(PrivateFile);
 955   }
 956
 957   DirectoryHasModuleMap[Dir] = !Result;
 958   return Result;
 959 }
 960
 961 Module *HeaderSearch::loadFrameworkModule(StringRef Name,
 962                                           const DirectoryEntry *Dir,
 963                                           bool IsSystem) {
 964   if (Module *Module = ModMap.findModule(Name))
 965     return Module;
 966
 967   // Try to load a module map file.
 968   switch (loadModuleMapFile(Dir)) {
 969   case LMM_InvalidModuleMap:
 970     break;
 971
 972   case LMM_AlreadyLoaded:
 973   case LMM_NoDirectory:
 974     return 0;
 975
 976   case LMM_NewlyLoaded:
 977     return ModMap.findModule(Name);
 978   }
 979
 980   // Figure out the top-level framework directory and the submodule path from
 981   // that top-level framework to the requested framework.
 982   llvm::SmallVector<std::string, 2> SubmodulePath;
 983   SubmodulePath.push_back(Name);
 984   const DirectoryEntry *TopFrameworkDir
 985     = ::getTopFrameworkDir(FileMgr, Dir->getName(), SubmodulePath);
 986
 987
 988   // Try to infer a module map from the top-level framework directory.
 989   Module *Result = ModMap.inferFrameworkModule(SubmodulePath.back(),
 990                                                TopFrameworkDir,
 991                                                IsSystem,
 992                                                /*Parent=*/0);
 993   if (!Result)
 994     return 0;
 995
 996   // Follow the submodule path to find the requested (sub)framework module
 997   // within the top-level framework module.
 998   SubmodulePath.pop_back();
 999   while (!SubmodulePath.empty() && Result) {
1000     Result = ModMap.lookupModuleQualified(SubmodulePath.back(), Result);
1001     SubmodulePath.pop_back();
1002   }
1003   return Result;
1004 }
1005
1006
1007 HeaderSearch::LoadModuleMapResult
1008 HeaderSearch::loadModuleMapFile(StringRef DirName) {
1009   if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
1010     return loadModuleMapFile(Dir);
1011
1012   return LMM_NoDirectory;
1013 }
1014
1015 HeaderSearch::LoadModuleMapResult
1016 HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir) {
1017   llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1018     = DirectoryHasModuleMap.find(Dir);
1019   if (KnownDir != DirectoryHasModuleMap.end())
1020     return KnownDir->second? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
1021
1022   SmallString<128> ModuleMapFileName;
1023   ModuleMapFileName += Dir->getName();
1024   unsigned ModuleMapDirNameLen = ModuleMapFileName.size();
1025   llvm::sys::path::append(ModuleMapFileName, "module.map");
1026   if (const FileEntry *ModuleMapFile = FileMgr.getFile(ModuleMapFileName)) {
1027     // We have found a module map file. Try to parse it.
1028     if (ModMap.parseModuleMapFile(ModuleMapFile)) {
1029       // No suitable module map.
1030       DirectoryHasModuleMap[Dir] = false;
1031       return LMM_InvalidModuleMap;
1032     }
1033
1034     // This directory has a module map.
1035     DirectoryHasModuleMap[Dir] = true;
1036
1037     // Check whether there is a private module map that we need to load as well.
1038     ModuleMapFileName.erase(ModuleMapFileName.begin() + ModuleMapDirNameLen,
1039                             ModuleMapFileName.end());
1040     llvm::sys::path::append(ModuleMapFileName, "module_private.map");
1041     if (const FileEntry *PrivateModuleMapFile
1042                                         = FileMgr.getFile(ModuleMapFileName)) {
1043       if (ModMap.parseModuleMapFile(PrivateModuleMapFile)) {
1044         // No suitable module map.
1045         DirectoryHasModuleMap[Dir] = false;
1046         return LMM_InvalidModuleMap;
1047       }
1048     }
1049
1050     return LMM_NewlyLoaded;
1051   }
1052
1053   // No suitable module map.
1054   DirectoryHasModuleMap[Dir] = false;
1055   return LMM_InvalidModuleMap;
1056 }
1057
1058 void HeaderSearch::collectAllModules(llvm::SmallVectorImpl<Module *> &Modules) {
1059   Modules.clear();
1060
1061   // Load module maps for each of the header search directories.
1062   for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1063     if (SearchDirs[Idx].isFramework()) {
1064       llvm::error_code EC;
1065       SmallString<128> DirNative;
1066       llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1067                               DirNative);
1068
1069       // Search each of the ".framework" directories to load them as modules.
1070       bool IsSystem = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
1071       for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1072            Dir != DirEnd && !EC; Dir.increment(EC)) {
1073         if (llvm::sys::path::extension(Dir->path()) != ".framework")
1074           continue;
1075
1076         const DirectoryEntry *FrameworkDir = FileMgr.getDirectory(Dir->path());
1077         if (!FrameworkDir)
1078           continue;
1079
1080         // Load this framework module.
1081         loadFrameworkModule(llvm::sys::path::stem(Dir->path()), FrameworkDir,
1082                             IsSystem);
1083       }
1084       continue;
1085     }
1086
1087     // FIXME: Deal with header maps.
1088     if (SearchDirs[Idx].isHeaderMap())
1089       continue;
1090
1091     // Try to load a module map file for the search directory.
1092     loadModuleMapFile(SearchDirs[Idx].getDir());
1093
1094     // Try to load module map files for immediate subdirectories of this search
1095     // directory.
1096     llvm::error_code EC;
1097     SmallString<128> DirNative;
1098     llvm::sys::path::native(SearchDirs[Idx].getDir()->getName(), DirNative);
1099     for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1100          Dir != DirEnd && !EC; Dir.increment(EC)) {
1101       loadModuleMapFile(Dir->path());
1102     }
1103   }
1104
1105   // Populate the list of modules.
1106   for (ModuleMap::module_iterator M = ModMap.module_begin(),
1107                                MEnd = ModMap.module_end();
1108        M != MEnd; ++M) {
1109     Modules.push_back(M->getValue());
1110   }
1111 }