contrib/llvm/tools/clang/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/Lex/HeaderSearchOptions.h"
  16 #include "clang/Lex/HeaderMap.h"
  17 #include "clang/Lex/Lexer.h"
  18 #include "clang/Basic/Diagnostic.h"
  19 #include "clang/Basic/FileManager.h"
  20 #include "clang/Basic/IdentifierTable.h"
  21 #include "llvm/Support/FileSystem.h"
  22 #include "llvm/Support/Path.h"
  23 #include "llvm/ADT/SmallString.h"
  24 #include "llvm/Support/Capacity.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 avai;able 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
 267 /// DoFrameworkLookup - Do a lookup of the specified file in the current
 268 /// DirectoryLookup, which is a framework directory.
 269 const FileEntry *DirectoryLookup::DoFrameworkLookup(
 270     StringRef Filename,
 271     HeaderSearch &HS,
 272     SmallVectorImpl<char> *SearchPath,
 273     SmallVectorImpl<char> *RelativePath,
 274     Module **SuggestedModule,
 275     bool &InUserSpecifiedSystemFramework) const
 276 {
 277   FileManager &FileMgr = HS.getFileMgr();
 278
 279   // Framework names must have a '/' in the filename.
 280   size_t SlashPos = Filename.find('/');
 281   if (SlashPos == StringRef::npos) return 0;
 282
 283   // Find out if this is the home for the specified framework, by checking
 284   // HeaderSearch.  Possible answers are yes/no and unknown.
 285   HeaderSearch::FrameworkCacheEntry &CacheEntry =
 286     HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
 287
 288   // If it is known and in some other directory, fail.
 289   if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
 290     return 0;
 291
 292   // Otherwise, construct the path to this framework dir.
 293
 294   // FrameworkName = "/System/Library/Frameworks/"
 295   SmallString<1024> FrameworkName;
 296   FrameworkName += getFrameworkDir()->getName();
 297   if (FrameworkName.empty() || FrameworkName.back() != '/')
 298     FrameworkName.push_back('/');
 299
 300   // FrameworkName = "/System/Library/Frameworks/Cocoa"
 301   StringRef ModuleName(Filename.begin(), SlashPos);
 302   FrameworkName += ModuleName;
 303
 304   // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
 305   FrameworkName += ".framework/";
 306
 307   // If the cache entry was unresolved, populate it now.
 308   if (CacheEntry.Directory == 0) {
 309     HS.IncrementFrameworkLookupCount();
 310
 311     // If the framework dir doesn't exist, we fail.
 312     const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
 313     if (Dir == 0) return 0;
 314
 315     // Otherwise, if it does, remember that this is the right direntry for this
 316     // framework.
 317     CacheEntry.Directory = getFrameworkDir();
 318
 319     // If this is a user search directory, check if the framework has been
 320     // user-specified as a system framework.
 321     if (getDirCharacteristic() == SrcMgr::C_User) {
 322       SmallString<1024> SystemFrameworkMarker(FrameworkName);
 323       SystemFrameworkMarker += ".system_framework";
 324       if (llvm::sys::fs::exists(SystemFrameworkMarker.str())) {
 325         CacheEntry.IsUserSpecifiedSystemFramework = true;
 326       }
 327     }
 328   }
 329
 330   // Set the 'user-specified system framework' flag.
 331   InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
 332
 333   if (RelativePath != NULL) {
 334     RelativePath->clear();
 335     RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
 336   }
 337
 338   // If we're allowed to look for modules, try to load or create the module
 339   // corresponding to this framework.
 340   Module *Module = 0;
 341   if (SuggestedModule) {
 342     if (const DirectoryEntry *FrameworkDir
 343                                         = FileMgr.getDirectory(FrameworkName)) {
 344       bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
 345       Module = HS.loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
 346     }
 347   }
 348
 349   // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
 350   unsigned OrigSize = FrameworkName.size();
 351
 352   FrameworkName += "Headers/";
 353
 354   if (SearchPath != NULL) {
 355     SearchPath->clear();
 356     // Without trailing '/'.
 357     SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
 358   }
 359
 360   // Determine whether this is the module we're building or not.
 361   bool AutomaticImport = Module;
 362   FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
 363   if (const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
 364                                             /*openFile=*/!AutomaticImport)) {
 365     if (AutomaticImport)
 366       *SuggestedModule = HS.findModuleForHeader(FE);
 367     return FE;
 368   }
 369
 370   // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
 371   const char *Private = "Private";
 372   FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
 373                        Private+strlen(Private));
 374   if (SearchPath != NULL)
 375     SearchPath->insert(SearchPath->begin()+OrigSize, Private,
 376                        Private+strlen(Private));
 377
 378   const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
 379                                         /*openFile=*/!AutomaticImport);
 380   if (FE && AutomaticImport)
 381     *SuggestedModule = HS.findModuleForHeader(FE);
 382   return FE;
 383 }
 384
 385 void HeaderSearch::setTarget(const TargetInfo &Target) {
 386   ModMap.setTarget(Target);
 387 }
 388
 389
 390 //===----------------------------------------------------------------------===//
 391 // Header File Location.
 392 //===----------------------------------------------------------------------===//
 393
 394
 395 /// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
 396 /// return null on failure.  isAngled indicates whether the file reference is
 397 /// for system \#include's or not (i.e. using <> instead of "").  CurFileEnt, if
 398 /// non-null, indicates where the \#including file is, in case a relative search
 399 /// is needed.
 400 const FileEntry *HeaderSearch::LookupFile(
 401     StringRef Filename,
 402     bool isAngled,
 403     const DirectoryLookup *FromDir,
 404     const DirectoryLookup *&CurDir,
 405     const FileEntry *CurFileEnt,
 406     SmallVectorImpl<char> *SearchPath,
 407     SmallVectorImpl<char> *RelativePath,
 408     Module **SuggestedModule,
 409     bool SkipCache)
 410 {
 411   if (SuggestedModule)
 412     *SuggestedModule = 0;
 413
 414   // If 'Filename' is absolute, check to see if it exists and no searching.
 415   if (llvm::sys::path::is_absolute(Filename)) {
 416     CurDir = 0;
 417
 418     // If this was an #include_next "/absolute/file", fail.
 419     if (FromDir) return 0;
 420
 421     if (SearchPath != NULL)
 422       SearchPath->clear();
 423     if (RelativePath != NULL) {
 424       RelativePath->clear();
 425       RelativePath->append(Filename.begin(), Filename.end());
 426     }
 427     // Otherwise, just return the file.
 428     return FileMgr.getFile(Filename, /*openFile=*/true);
 429   }
 430
 431   // Unless disabled, check to see if the file is in the #includer's
 432   // directory.  This has to be based on CurFileEnt, not CurDir, because
 433   // CurFileEnt could be a #include of a subdirectory (#include "foo/bar.h") and
 434   // a subsequent include of "baz.h" should resolve to "whatever/foo/baz.h".
 435   // This search is not done for <> headers.
 436   if (CurFileEnt && !isAngled && !NoCurDirSearch) {
 437     SmallString<1024> TmpDir;
 438     // Concatenate the requested file onto the directory.
 439     // FIXME: Portability.  Filename concatenation should be in sys::Path.
 440     TmpDir += CurFileEnt->getDir()->getName();
 441     TmpDir.push_back('/');
 442     TmpDir.append(Filename.begin(), Filename.end());
 443     if (const FileEntry *FE = FileMgr.getFile(TmpDir.str(),/*openFile=*/true)) {
 444       // Leave CurDir unset.
 445       // This file is a system header or C++ unfriendly if the old file is.
 446       //
 447       // Note that we only use one of FromHFI/ToHFI at once, due to potential
 448       // reallocation of the underlying vector potentially making the first
 449       // reference binding dangling.
 450       HeaderFileInfo &FromHFI = getFileInfo(CurFileEnt);
 451       unsigned DirInfo = FromHFI.DirInfo;
 452       bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
 453       StringRef Framework = FromHFI.Framework;
 454
 455       HeaderFileInfo &ToHFI = getFileInfo(FE);
 456       ToHFI.DirInfo = DirInfo;
 457       ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
 458       ToHFI.Framework = Framework;
 459
 460       if (SearchPath != NULL) {
 461         StringRef SearchPathRef(CurFileEnt->getDir()->getName());
 462         SearchPath->clear();
 463         SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
 464       }
 465       if (RelativePath != NULL) {
 466         RelativePath->clear();
 467         RelativePath->append(Filename.begin(), Filename.end());
 468       }
 469       return FE;
 470     }
 471   }
 472
 473   CurDir = 0;
 474
 475   // If this is a system #include, ignore the user #include locs.
 476   unsigned i = isAngled ? AngledDirIdx : 0;
 477
 478   // If this is a #include_next request, start searching after the directory the
 479   // file was found in.
 480   if (FromDir)
 481     i = FromDir-&SearchDirs[0];
 482
 483   // Cache all of the lookups performed by this method.  Many headers are
 484   // multiply included, and the "pragma once" optimization prevents them from
 485   // being relex/pp'd, but they would still have to search through a
 486   // (potentially huge) series of SearchDirs to find it.
 487   std::pair<unsigned, unsigned> &CacheLookup =
 488     LookupFileCache.GetOrCreateValue(Filename).getValue();
 489
 490   // If the entry has been previously looked up, the first value will be
 491   // non-zero.  If the value is equal to i (the start point of our search), then
 492   // this is a matching hit.
 493   if (!SkipCache && CacheLookup.first == i+1) {
 494     // Skip querying potentially lots of directories for this lookup.
 495     i = CacheLookup.second;
 496   } else {
 497     // Otherwise, this is the first query, or the previous query didn't match
 498     // our search start.  We will fill in our found location below, so prime the
 499     // start point value.
 500     CacheLookup.first = i+1;
 501   }
 502
 503   // Check each directory in sequence to see if it contains this file.
 504   for (; i != SearchDirs.size(); ++i) {
 505     bool InUserSpecifiedSystemFramework = false;
 506     const FileEntry *FE =
 507       SearchDirs[i].LookupFile(Filename, *this, SearchPath, RelativePath,
 508                                SuggestedModule, InUserSpecifiedSystemFramework);
 509     if (!FE) continue;
 510
 511     CurDir = &SearchDirs[i];
 512
 513     // This file is a system header or C++ unfriendly if the dir is.
 514     HeaderFileInfo &HFI = getFileInfo(FE);
 515     HFI.DirInfo = CurDir->getDirCharacteristic();
 516
 517     // If the directory characteristic is User but this framework was
 518     // user-specified to be treated as a system framework, promote the
 519     // characteristic.
 520     if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
 521       HFI.DirInfo = SrcMgr::C_System;
 522
 523     // If the filename matches a known system header prefix, override
 524     // whether the file is a system header.
 525     for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
 526       if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
 527         HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
 528                                                        : SrcMgr::C_User;
 529         break;
 530       }
 531     }
 532
 533     // If this file is found in a header map and uses the framework style of
 534     // includes, then this header is part of a framework we're building.
 535     if (CurDir->isIndexHeaderMap()) {
 536       size_t SlashPos = Filename.find('/');
 537       if (SlashPos != StringRef::npos) {
 538         HFI.IndexHeaderMapHeader = 1;
 539         HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
 540                                                          SlashPos));
 541       }
 542     }
 543
 544     // Remember this location for the next lookup we do.
 545     CacheLookup.second = i;
 546     return FE;
 547   }
 548
 549   // If we are including a file with a quoted include "foo.h" from inside
 550   // a header in a framework that is currently being built, and we couldn't
 551   // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
 552   // "Foo" is the name of the framework in which the including header was found.
 553   if (CurFileEnt && !isAngled && Filename.find('/') == StringRef::npos) {
 554     HeaderFileInfo &IncludingHFI = getFileInfo(CurFileEnt);
 555     if (IncludingHFI.IndexHeaderMapHeader) {
 556       SmallString<128> ScratchFilename;
 557       ScratchFilename += IncludingHFI.Framework;
 558       ScratchFilename += '/';
 559       ScratchFilename += Filename;
 560
 561       const FileEntry *Result = LookupFile(ScratchFilename, /*isAngled=*/true,
 562                                            FromDir, CurDir, CurFileEnt,
 563                                            SearchPath, RelativePath,
 564                                            SuggestedModule);
 565       std::pair<unsigned, unsigned> &CacheLookup
 566         = LookupFileCache.GetOrCreateValue(Filename).getValue();
 567       CacheLookup.second
 568         = LookupFileCache.GetOrCreateValue(ScratchFilename).getValue().second;
 569       return Result;
 570     }
 571   }
 572
 573   // Otherwise, didn't find it. Remember we didn't find this.
 574   CacheLookup.second = SearchDirs.size();
 575   return 0;
 576 }
 577
 578 /// LookupSubframeworkHeader - Look up a subframework for the specified
 579 /// \#include file.  For example, if \#include'ing <HIToolbox/HIToolbox.h> from
 580 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
 581 /// is a subframework within Carbon.framework.  If so, return the FileEntry
 582 /// for the designated file, otherwise return null.
 583 const FileEntry *HeaderSearch::
 584 LookupSubframeworkHeader(StringRef Filename,
 585                          const FileEntry *ContextFileEnt,
 586                          SmallVectorImpl<char> *SearchPath,
 587                          SmallVectorImpl<char> *RelativePath) {
 588   assert(ContextFileEnt && "No context file?");
 589
 590   // Framework names must have a '/' in the filename.  Find it.
 591   // FIXME: Should we permit '\' on Windows?
 592   size_t SlashPos = Filename.find('/');
 593   if (SlashPos == StringRef::npos) return 0;
 594
 595   // Look up the base framework name of the ContextFileEnt.
 596   const char *ContextName = ContextFileEnt->getName();
 597
 598   // If the context info wasn't a framework, couldn't be a subframework.
 599   const unsigned DotFrameworkLen = 10;
 600   const char *FrameworkPos = strstr(ContextName, ".framework");
 601   if (FrameworkPos == 0 ||
 602       (FrameworkPos[DotFrameworkLen] != '/' &&
 603        FrameworkPos[DotFrameworkLen] != '\\'))
 604     return 0;
 605
 606   SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
 607
 608   // Append Frameworks/HIToolbox.framework/
 609   FrameworkName += "Frameworks/";
 610   FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
 611   FrameworkName += ".framework/";
 612
 613   llvm::StringMapEntry<FrameworkCacheEntry> &CacheLookup =
 614     FrameworkMap.GetOrCreateValue(Filename.substr(0, SlashPos));
 615
 616   // Some other location?
 617   if (CacheLookup.getValue().Directory &&
 618       CacheLookup.getKeyLength() == FrameworkName.size() &&
 619       memcmp(CacheLookup.getKeyData(), &FrameworkName[0],
 620              CacheLookup.getKeyLength()) != 0)
 621     return 0;
 622
 623   // Cache subframework.
 624   if (CacheLookup.getValue().Directory == 0) {
 625     ++NumSubFrameworkLookups;
 626
 627     // If the framework dir doesn't exist, we fail.
 628     const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
 629     if (Dir == 0) return 0;
 630
 631     // Otherwise, if it does, remember that this is the right direntry for this
 632     // framework.
 633     CacheLookup.getValue().Directory = Dir;
 634   }
 635
 636   const FileEntry *FE = 0;
 637
 638   if (RelativePath != NULL) {
 639     RelativePath->clear();
 640     RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
 641   }
 642
 643   // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
 644   SmallString<1024> HeadersFilename(FrameworkName);
 645   HeadersFilename += "Headers/";
 646   if (SearchPath != NULL) {
 647     SearchPath->clear();
 648     // Without trailing '/'.
 649     SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
 650   }
 651
 652   HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
 653   if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true))) {
 654
 655     // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
 656     HeadersFilename = FrameworkName;
 657     HeadersFilename += "PrivateHeaders/";
 658     if (SearchPath != NULL) {
 659       SearchPath->clear();
 660       // Without trailing '/'.
 661       SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
 662     }
 663
 664     HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
 665     if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true)))
 666       return 0;
 667   }
 668
 669   // This file is a system header or C++ unfriendly if the old file is.
 670   //
 671   // Note that the temporary 'DirInfo' is required here, as either call to
 672   // getFileInfo could resize the vector and we don't want to rely on order
 673   // of evaluation.
 674   unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
 675   getFileInfo(FE).DirInfo = DirInfo;
 676   return FE;
 677 }
 678
 679 /// \brief Helper static function to normalize a path for injection into
 680 /// a synthetic header.
 681 /*static*/ std::string
 682 HeaderSearch::NormalizeDashIncludePath(StringRef File, FileManager &FileMgr) {
 683   // Implicit include paths should be resolved relative to the current
 684   // working directory first, and then use the regular header search
 685   // mechanism. The proper way to handle this is to have the
 686   // predefines buffer located at the current working directory, but
 687   // it has no file entry. For now, workaround this by using an
 688   // absolute path if we find the file here, and otherwise letting
 689   // header search handle it.
 690   SmallString<128> Path(File);
 691   llvm::sys::fs::make_absolute(Path);
 692   bool exists;
 693   if (llvm::sys::fs::exists(Path.str(), exists) || !exists)
 694     Path = File;
 695   else if (exists)
 696     FileMgr.getFile(File);
 697
 698   return Lexer::Stringify(Path.str());
 699 }
 700
 701 //===----------------------------------------------------------------------===//
 702 // File Info Management.
 703 //===----------------------------------------------------------------------===//
 704
 705 /// \brief Merge the header file info provided by \p OtherHFI into the current
 706 /// header file info (\p HFI)
 707 static void mergeHeaderFileInfo(HeaderFileInfo &HFI,
 708                                 const HeaderFileInfo &OtherHFI) {
 709   HFI.isImport |= OtherHFI.isImport;
 710   HFI.isPragmaOnce |= OtherHFI.isPragmaOnce;
 711   HFI.NumIncludes += OtherHFI.NumIncludes;
 712
 713   if (!HFI.ControllingMacro && !HFI.ControllingMacroID) {
 714     HFI.ControllingMacro = OtherHFI.ControllingMacro;
 715     HFI.ControllingMacroID = OtherHFI.ControllingMacroID;
 716   }
 717
 718   if (OtherHFI.External) {
 719     HFI.DirInfo = OtherHFI.DirInfo;
 720     HFI.External = OtherHFI.External;
 721     HFI.IndexHeaderMapHeader = OtherHFI.IndexHeaderMapHeader;
 722   }
 723
 724   if (HFI.Framework.empty())
 725     HFI.Framework = OtherHFI.Framework;
 726
 727   HFI.Resolved = true;
 728 }
 729
 730 /// getFileInfo - Return the HeaderFileInfo structure for the specified
 731 /// FileEntry.
 732 HeaderFileInfo &HeaderSearch::getFileInfo(const FileEntry *FE) {
 733   if (FE->getUID() >= FileInfo.size())
 734     FileInfo.resize(FE->getUID()+1);
 735
 736   HeaderFileInfo &HFI = FileInfo[FE->getUID()];
 737   if (ExternalSource && !HFI.Resolved)
 738     mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(FE));
 739   return HFI;
 740 }
 741
 742 bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
 743   // Check if we've ever seen this file as a header.
 744   if (File->getUID() >= FileInfo.size())
 745     return false;
 746
 747   // Resolve header file info from the external source, if needed.
 748   HeaderFileInfo &HFI = FileInfo[File->getUID()];
 749   if (ExternalSource && !HFI.Resolved)
 750     mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(File));
 751
 752   return HFI.isPragmaOnce || HFI.ControllingMacro || HFI.ControllingMacroID;
 753 }
 754
 755 void HeaderSearch::setHeaderFileInfoForUID(HeaderFileInfo HFI, unsigned UID) {
 756   if (UID >= FileInfo.size())
 757     FileInfo.resize(UID+1);
 758   HFI.Resolved = true;
 759   FileInfo[UID] = HFI;
 760 }
 761
 762 bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry *File, bool isImport){
 763   ++NumIncluded; // Count # of attempted #includes.
 764
 765   // Get information about this file.
 766   HeaderFileInfo &FileInfo = getFileInfo(File);
 767
 768   // If this is a #import directive, check that we have not already imported
 769   // this header.
 770   if (isImport) {
 771     // If this has already been imported, don't import it again.
 772     FileInfo.isImport = true;
 773
 774     // Has this already been #import'ed or #include'd?
 775     if (FileInfo.NumIncludes) return false;
 776   } else {
 777     // Otherwise, if this is a #include of a file that was previously #import'd
 778     // or if this is the second #include of a #pragma once file, ignore it.
 779     if (FileInfo.isImport)
 780       return false;
 781   }
 782
 783   // Next, check to see if the file is wrapped with #ifndef guards.  If so, and
 784   // if the macro that guards it is defined, we know the #include has no effect.
 785   if (const IdentifierInfo *ControllingMacro
 786       = FileInfo.getControllingMacro(ExternalLookup))
 787     if (ControllingMacro->hasMacroDefinition()) {
 788       ++NumMultiIncludeFileOptzn;
 789       return false;
 790     }
 791
 792   // Increment the number of times this file has been included.
 793   ++FileInfo.NumIncludes;
 794
 795   return true;
 796 }
 797
 798 size_t HeaderSearch::getTotalMemory() const {
 799   return SearchDirs.capacity()
 800     + llvm::capacity_in_bytes(FileInfo)
 801     + llvm::capacity_in_bytes(HeaderMaps)
 802     + LookupFileCache.getAllocator().getTotalMemory()
 803     + FrameworkMap.getAllocator().getTotalMemory();
 804 }
 805
 806 StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
 807   return FrameworkNames.GetOrCreateValue(Framework).getKey();
 808 }
 809
 810 bool HeaderSearch::hasModuleMap(StringRef FileName,
 811                                 const DirectoryEntry *Root) {
 812   llvm::SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
 813
 814   StringRef DirName = FileName;
 815   do {
 816     // Get the parent directory name.
 817     DirName = llvm::sys::path::parent_path(DirName);
 818     if (DirName.empty())
 819       return false;
 820
 821     // Determine whether this directory exists.
 822     const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
 823     if (!Dir)
 824       return false;
 825
 826     // Try to load the module map file in this directory.
 827     switch (loadModuleMapFile(Dir)) {
 828     case LMM_NewlyLoaded:
 829     case LMM_AlreadyLoaded:
 830       // Success. All of the directories we stepped through inherit this module
 831       // map file.
 832       for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
 833         DirectoryHasModuleMap[FixUpDirectories[I]] = true;
 834
 835       return true;
 836
 837     case LMM_NoDirectory:
 838     case LMM_InvalidModuleMap:
 839       break;
 840     }
 841
 842     // If we hit the top of our search, we're done.
 843     if (Dir == Root)
 844       return false;
 845
 846     // Keep track of all of the directories we checked, so we can mark them as
 847     // having module maps if we eventually do find a module map.
 848     FixUpDirectories.push_back(Dir);
 849   } while (true);
 850 }
 851
 852 Module *HeaderSearch::findModuleForHeader(const FileEntry *File) {
 853   if (Module *Mod = ModMap.findModuleForHeader(File))
 854     return Mod;
 855
 856   return 0;
 857 }
 858
 859 bool HeaderSearch::loadModuleMapFile(const FileEntry *File) {
 860   const DirectoryEntry *Dir = File->getDir();
 861
 862   llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
 863     = DirectoryHasModuleMap.find(Dir);
 864   if (KnownDir != DirectoryHasModuleMap.end())
 865     return !KnownDir->second;
 866
 867   bool Result = ModMap.parseModuleMapFile(File);
 868   if (!Result && llvm::sys::path::filename(File->getName()) == "module.map") {
 869     // If the file we loaded was a module.map, look for the corresponding
 870     // module_private.map.
 871     SmallString<128> PrivateFilename(Dir->getName());
 872     llvm::sys::path::append(PrivateFilename, "module_private.map");
 873     if (const FileEntry *PrivateFile = FileMgr.getFile(PrivateFilename))
 874       Result = ModMap.parseModuleMapFile(PrivateFile);
 875   }
 876
 877   DirectoryHasModuleMap[Dir] = !Result;
 878   return Result;
 879 }
 880
 881 Module *HeaderSearch::loadFrameworkModule(StringRef Name,
 882                                           const DirectoryEntry *Dir,
 883                                           bool IsSystem) {
 884   if (Module *Module = ModMap.findModule(Name))
 885     return Module;
 886
 887   // Try to load a module map file.
 888   switch (loadModuleMapFile(Dir)) {
 889   case LMM_InvalidModuleMap:
 890     break;
 891
 892   case LMM_AlreadyLoaded:
 893   case LMM_NoDirectory:
 894     return 0;
 895
 896   case LMM_NewlyLoaded:
 897     return ModMap.findModule(Name);
 898   }
 899
 900   // The top-level framework directory, from which we'll infer a framework
 901   // module.
 902   const DirectoryEntry *TopFrameworkDir = Dir;
 903
 904   // The path from the module we're actually looking for back to the top-level
 905   // framework name.
 906   llvm::SmallVector<StringRef, 2> SubmodulePath;
 907   SubmodulePath.push_back(Name);
 908
 909   // Walk the directory structure to find any enclosing frameworks.
 910 #ifdef LLVM_ON_UNIX
 911   // Note: as an egregious but useful hack we use the real path here, because
 912   // frameworks moving from top-level frameworks to embedded frameworks tend
 913   // to be symlinked from the top-level location to the embedded location,
 914   // and we need to resolve lookups as if we had found the embedded location.
 915   char RealDirName[PATH_MAX];
 916   StringRef DirName;
 917   if (realpath(Dir->getName(), RealDirName))
 918     DirName = RealDirName;
 919   else
 920     DirName = Dir->getName();
 921 #else
 922   StringRef DirName = Dir->getName();
 923 #endif
 924   do {
 925     // Get the parent directory name.
 926     DirName = llvm::sys::path::parent_path(DirName);
 927     if (DirName.empty())
 928       break;
 929
 930     // Determine whether this directory exists.
 931     Dir = FileMgr.getDirectory(DirName);
 932     if (!Dir)
 933       break;
 934
 935     // If this is a framework directory, then we're a subframework of this
 936     // framework.
 937     if (llvm::sys::path::extension(DirName) == ".framework") {
 938       SubmodulePath.push_back(llvm::sys::path::stem(DirName));
 939       TopFrameworkDir = Dir;
 940     }
 941   } while (true);
 942
 943   // Determine whether we're allowed to infer a module map.
 944   bool canInfer = false;
 945   if (llvm::sys::path::has_parent_path(TopFrameworkDir->getName())) {
 946     // Figure out the parent path.
 947     StringRef Parent = llvm::sys::path::parent_path(TopFrameworkDir->getName());
 948     if (const DirectoryEntry *ParentDir = FileMgr.getDirectory(Parent)) {
 949       // If there's a module map file in the parent directory, it can
 950       // explicitly allow us to infer framework modules.
 951       switch (loadModuleMapFile(ParentDir)) {
 952         case LMM_AlreadyLoaded:
 953         case LMM_NewlyLoaded: {
 954           StringRef Name = llvm::sys::path::stem(TopFrameworkDir->getName());
 955           canInfer = ModMap.canInferFrameworkModule(ParentDir, Name, IsSystem);
 956           break;
 957         }
 958         case LMM_InvalidModuleMap:
 959         case LMM_NoDirectory:
 960           break;
 961       }
 962     }
 963   }
 964
 965   // If we're not allowed to infer a module map, we're done.
 966   if (!canInfer)
 967     return 0;
 968
 969   // Try to infer a module map from the top-level framework directory.
 970   Module *Result = ModMap.inferFrameworkModule(SubmodulePath.back(),
 971                                                TopFrameworkDir,
 972                                                IsSystem,
 973                                                /*Parent=*/0);
 974
 975   // Follow the submodule path to find the requested (sub)framework module
 976   // within the top-level framework module.
 977   SubmodulePath.pop_back();
 978   while (!SubmodulePath.empty() && Result) {
 979     Result = ModMap.lookupModuleQualified(SubmodulePath.back(), Result);
 980     SubmodulePath.pop_back();
 981   }
 982   return Result;
 983 }
 984
 985
 986 HeaderSearch::LoadModuleMapResult
 987 HeaderSearch::loadModuleMapFile(StringRef DirName) {
 988   if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
 989     return loadModuleMapFile(Dir);
 990
 991   return LMM_NoDirectory;
 992 }
 993
 994 HeaderSearch::LoadModuleMapResult
 995 HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir) {
 996   llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
 997     = DirectoryHasModuleMap.find(Dir);
 998   if (KnownDir != DirectoryHasModuleMap.end())
 999     return KnownDir->second? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
1000
1001   SmallString<128> ModuleMapFileName;
1002   ModuleMapFileName += Dir->getName();
1003   unsigned ModuleMapDirNameLen = ModuleMapFileName.size();
1004   llvm::sys::path::append(ModuleMapFileName, "module.map");
1005   if (const FileEntry *ModuleMapFile = FileMgr.getFile(ModuleMapFileName)) {
1006     // We have found a module map file. Try to parse it.
1007     if (ModMap.parseModuleMapFile(ModuleMapFile)) {
1008       // No suitable module map.
1009       DirectoryHasModuleMap[Dir] = false;
1010       return LMM_InvalidModuleMap;
1011     }
1012
1013     // This directory has a module map.
1014     DirectoryHasModuleMap[Dir] = true;
1015
1016     // Check whether there is a private module map that we need to load as well.
1017     ModuleMapFileName.erase(ModuleMapFileName.begin() + ModuleMapDirNameLen,
1018                             ModuleMapFileName.end());
1019     llvm::sys::path::append(ModuleMapFileName, "module_private.map");
1020     if (const FileEntry *PrivateModuleMapFile
1021                                         = FileMgr.getFile(ModuleMapFileName)) {
1022       if (ModMap.parseModuleMapFile(PrivateModuleMapFile)) {
1023         // No suitable module map.
1024         DirectoryHasModuleMap[Dir] = false;
1025         return LMM_InvalidModuleMap;
1026       }
1027     }
1028
1029     return LMM_NewlyLoaded;
1030   }
1031
1032   // No suitable module map.
1033   DirectoryHasModuleMap[Dir] = false;
1034   return LMM_InvalidModuleMap;
1035 }
1036
1037 void HeaderSearch::collectAllModules(llvm::SmallVectorImpl<Module *> &Modules) {
1038   Modules.clear();
1039
1040   // Load module maps for each of the header search directories.
1041   for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
1042     if (SearchDirs[Idx].isFramework()) {
1043       llvm::error_code EC;
1044       SmallString<128> DirNative;
1045       llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1046                               DirNative);
1047
1048       // Search each of the ".framework" directories to load them as modules.
1049       bool IsSystem = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
1050       for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1051            Dir != DirEnd && !EC; Dir.increment(EC)) {
1052         if (llvm::sys::path::extension(Dir->path()) != ".framework")
1053           continue;
1054
1055         const DirectoryEntry *FrameworkDir = FileMgr.getDirectory(Dir->path());
1056         if (!FrameworkDir)
1057           continue;
1058
1059         // Load this framework module.
1060         loadFrameworkModule(llvm::sys::path::stem(Dir->path()), FrameworkDir,
1061                             IsSystem);
1062       }
1063       continue;
1064     }
1065
1066     // FIXME: Deal with header maps.
1067     if (SearchDirs[Idx].isHeaderMap())
1068       continue;
1069
1070     // Try to load a module map file for the search directory.
1071     loadModuleMapFile(SearchDirs[Idx].getDir());
1072
1073     // Try to load module map files for immediate subdirectories of this search
1074     // directory.
1075     llvm::error_code EC;
1076     SmallString<128> DirNative;
1077     llvm::sys::path::native(SearchDirs[Idx].getDir()->getName(), DirNative);
1078     for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1079          Dir != DirEnd && !EC; Dir.increment(EC)) {
1080       loadModuleMapFile(Dir->path());
1081     }
1082   }
1083
1084   // Populate the list of modules.
1085   for (ModuleMap::module_iterator M = ModMap.module_begin(),
1086                                MEnd = ModMap.module_end();
1087        M != MEnd; ++M) {
1088     Modules.push_back(M->getValue());
1089   }
1090 }