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