blob: 3c5eb0ead8ce12e1a9cf0ea50933e05c7dc33d9e [file] [log] [blame]
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001//===--- HeaderSearch.cpp - Resolve Header File Locations ---===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner59a9ebd2006-10-18 05:34:33 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the DirectoryLookup and HeaderSearch interfaces.
11//
12//===----------------------------------------------------------------------===//
13
Chris Lattner59a9ebd2006-10-18 05:34:33 +000014#include "clang/Lex/HeaderSearch.h"
Chris Lattneref6b1362007-10-07 08:58:51 +000015#include "clang/Basic/FileManager.h"
16#include "clang/Basic/IdentifierTable.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "clang/Lex/HeaderMap.h"
18#include "clang/Lex/HeaderSearchOptions.h"
Will Wilson0fafd342013-12-27 19:46:16 +000019#include "clang/Lex/LexDiagnostic.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000020#include "clang/Lex/Lexer.h"
Chris Lattner43fd42e2006-10-30 03:40:58 +000021#include "llvm/ADT/SmallString.h"
Ted Kremenekae63d102011-07-27 18:41:18 +000022#include "llvm/Support/Capacity.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000023#include "llvm/Support/FileSystem.h"
24#include "llvm/Support/Path.h"
Daniel Jasperba7f2f72013-09-24 09:14:14 +000025#include "llvm/Support/raw_ostream.h"
Chris Lattnerc25d8a72009-03-02 22:20:04 +000026#include <cstdio>
Douglas Gregor01c7cfa2013-01-22 23:49:45 +000027#if defined(LLVM_ON_UNIX)
Dmitri Gribenkoeadae012013-01-26 16:29:36 +000028#include <limits.h>
Douglas Gregor01c7cfa2013-01-22 23:49:45 +000029#endif
Chris Lattner59a9ebd2006-10-18 05:34:33 +000030using namespace clang;
31
Douglas Gregor99734e72009-04-25 23:30:02 +000032const IdentifierInfo *
33HeaderFileInfo::getControllingMacro(ExternalIdentifierLookup *External) {
34 if (ControllingMacro)
35 return ControllingMacro;
36
37 if (!ControllingMacroID || !External)
38 return 0;
39
40 ControllingMacro = External->GetIdentifier(ControllingMacroID);
41 return ControllingMacro;
42}
43
Douglas Gregor09b69892011-02-10 17:09:37 +000044ExternalHeaderFileInfoSource::~ExternalHeaderFileInfoSource() {}
45
Dmitri Gribenkof8579502013-01-12 19:30:44 +000046HeaderSearch::HeaderSearch(IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts,
Manuel Klimek1f76c4e2013-10-24 07:51:24 +000047 SourceManager &SourceMgr, DiagnosticsEngine &Diags,
Will Wilson0fafd342013-12-27 19:46:16 +000048 const LangOptions &LangOpts,
Douglas Gregor89929282012-01-30 06:01:29 +000049 const TargetInfo *Target)
Will Wilsonba2f1462013-12-27 20:02:27 +000050 : HSOpts(HSOpts), Diags(Diags), FileMgr(SourceMgr.getFileManager()),
51 FrameworkMap(64), ModMap(SourceMgr, Diags, LangOpts, Target, *this) {
Nico Weber3b1d1212011-05-24 04:31:14 +000052 AngledDirIdx = 0;
Chris Lattner641a0be2006-10-20 06:23:14 +000053 SystemDirIdx = 0;
54 NoCurDirSearch = false;
Mike Stump11289f42009-09-09 15:08:12 +000055
Douglas Gregor99734e72009-04-25 23:30:02 +000056 ExternalLookup = 0;
Douglas Gregor09b69892011-02-10 17:09:37 +000057 ExternalSource = 0;
Chris Lattner641a0be2006-10-20 06:23:14 +000058 NumIncluded = 0;
59 NumMultiIncludeFileOptzn = 0;
60 NumFrameworkLookups = NumSubFrameworkLookups = 0;
Argyrios Kyrtzidis9955dbc2013-12-12 16:08:33 +000061
62 EnabledModules = LangOpts.Modules;
Chris Lattner641a0be2006-10-20 06:23:14 +000063}
64
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000065HeaderSearch::~HeaderSearch() {
66 // Delete headermaps.
67 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
68 delete HeaderMaps[i].second;
69}
Mike Stump11289f42009-09-09 15:08:12 +000070
Chris Lattner59a9ebd2006-10-18 05:34:33 +000071void HeaderSearch::PrintStats() {
Chris Lattner23b7eb62007-06-15 23:05:46 +000072 fprintf(stderr, "\n*** HeaderSearch Stats:\n");
73 fprintf(stderr, "%d files tracked.\n", (int)FileInfo.size());
Chris Lattner59a9ebd2006-10-18 05:34:33 +000074 unsigned NumOnceOnlyFiles = 0, MaxNumIncludes = 0, NumSingleIncludedFiles = 0;
75 for (unsigned i = 0, e = FileInfo.size(); i != e; ++i) {
76 NumOnceOnlyFiles += FileInfo[i].isImport;
77 if (MaxNumIncludes < FileInfo[i].NumIncludes)
78 MaxNumIncludes = FileInfo[i].NumIncludes;
79 NumSingleIncludedFiles += FileInfo[i].NumIncludes == 1;
80 }
Chris Lattner23b7eb62007-06-15 23:05:46 +000081 fprintf(stderr, " %d #import/#pragma once files.\n", NumOnceOnlyFiles);
82 fprintf(stderr, " %d included exactly once.\n", NumSingleIncludedFiles);
83 fprintf(stderr, " %d max times a file is included.\n", MaxNumIncludes);
Mike Stump11289f42009-09-09 15:08:12 +000084
Chris Lattner23b7eb62007-06-15 23:05:46 +000085 fprintf(stderr, " %d #include/#include_next/#import.\n", NumIncluded);
86 fprintf(stderr, " %d #includes skipped due to"
87 " the multi-include optimization.\n", NumMultiIncludeFileOptzn);
Mike Stump11289f42009-09-09 15:08:12 +000088
Chris Lattner23b7eb62007-06-15 23:05:46 +000089 fprintf(stderr, "%d framework lookups.\n", NumFrameworkLookups);
90 fprintf(stderr, "%d subframework lookups.\n", NumSubFrameworkLookups);
Chris Lattner59a9ebd2006-10-18 05:34:33 +000091}
92
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000093/// CreateHeaderMap - This method returns a HeaderMap for the specified
Sylvestre Ledru830885c2012-07-23 08:59:39 +000094/// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
Chris Lattner4ffe46c2007-12-17 18:34:53 +000095const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) {
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000096 // We expect the number of headermaps to be small, and almost always empty.
Chris Lattnerf62f7582007-12-17 07:52:39 +000097 // If it ever grows, use of a linear search should be re-evaluated.
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000098 if (!HeaderMaps.empty()) {
99 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
Chris Lattnerf62f7582007-12-17 07:52:39 +0000100 // Pointer equality comparison of FileEntries works because they are
101 // already uniqued by inode.
Mike Stump11289f42009-09-09 15:08:12 +0000102 if (HeaderMaps[i].first == FE)
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000103 return HeaderMaps[i].second;
104 }
Mike Stump11289f42009-09-09 15:08:12 +0000105
Chris Lattner5159f612010-11-23 08:35:12 +0000106 if (const HeaderMap *HM = HeaderMap::Create(FE, FileMgr)) {
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000107 HeaderMaps.push_back(std::make_pair(FE, HM));
108 return HM;
109 }
Mike Stump11289f42009-09-09 15:08:12 +0000110
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000111 return 0;
112}
113
Douglas Gregor279a6c32012-01-29 17:08:11 +0000114std::string HeaderSearch::getModuleFileName(Module *Module) {
Douglas Gregor1e44e022011-09-12 20:41:59 +0000115 // If we don't have a module cache path, we can't do anything.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000116 if (ModuleCachePath.empty())
117 return std::string();
118
119
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000120 SmallString<256> Result(ModuleCachePath);
Douglas Gregor279a6c32012-01-29 17:08:11 +0000121 llvm::sys::path::append(Result, Module->getTopLevelModule()->Name + ".pcm");
122 return Result.str().str();
123}
124
125std::string HeaderSearch::getModuleFileName(StringRef ModuleName) {
126 // If we don't have a module cache path, we can't do anything.
127 if (ModuleCachePath.empty())
128 return std::string();
Douglas Gregor1735f4e2011-09-13 23:15:45 +0000129
Douglas Gregor279a6c32012-01-29 17:08:11 +0000130
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000131 SmallString<256> Result(ModuleCachePath);
Douglas Gregor279a6c32012-01-29 17:08:11 +0000132 llvm::sys::path::append(Result, ModuleName + ".pcm");
133 return Result.str().str();
134}
135
136Module *HeaderSearch::lookupModule(StringRef ModuleName, bool AllowSearch) {
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000137 // Look in the module map to determine if there is a module by this name.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000138 Module *Module = ModMap.findModule(ModuleName);
139 if (Module || !AllowSearch)
140 return Module;
141
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000142 // Look through the various header search paths to load any available module
Douglas Gregor279a6c32012-01-29 17:08:11 +0000143 // maps, searching for a module map that describes this module.
144 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
145 if (SearchDirs[Idx].isFramework()) {
146 // Search for or infer a module map for a framework.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000147 SmallString<128> FrameworkDirName;
Douglas Gregor279a6c32012-01-29 17:08:11 +0000148 FrameworkDirName += SearchDirs[Idx].getFrameworkDir()->getName();
149 llvm::sys::path::append(FrameworkDirName, ModuleName + ".framework");
150 if (const DirectoryEntry *FrameworkDir
151 = FileMgr.getDirectory(FrameworkDirName)) {
152 bool IsSystem
153 = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
154 Module = loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000155 if (Module)
156 break;
157 }
Douglas Gregor279a6c32012-01-29 17:08:11 +0000158 }
159
160 // FIXME: Figure out how header maps and module maps will work together.
161
162 // Only deal with normal search directories.
163 if (!SearchDirs[Idx].isNormalDir())
164 continue;
Douglas Gregor963c5532013-06-21 16:28:10 +0000165
166 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
Douglas Gregor279a6c32012-01-29 17:08:11 +0000167 // Search for a module map file in this directory.
Douglas Gregor963c5532013-06-21 16:28:10 +0000168 if (loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem)
169 == LMM_NewlyLoaded) {
Douglas Gregor279a6c32012-01-29 17:08:11 +0000170 // We just loaded a module map file; check whether the module is
171 // available now.
172 Module = ModMap.findModule(ModuleName);
173 if (Module)
174 break;
175 }
176
177 // Search for a module map in a subdirectory with the same name as the
178 // module.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000179 SmallString<128> NestedModuleMapDirName;
Douglas Gregor279a6c32012-01-29 17:08:11 +0000180 NestedModuleMapDirName = SearchDirs[Idx].getDir()->getName();
181 llvm::sys::path::append(NestedModuleMapDirName, ModuleName);
Douglas Gregor963c5532013-06-21 16:28:10 +0000182 if (loadModuleMapFile(NestedModuleMapDirName, IsSystem) == LMM_NewlyLoaded){
Douglas Gregor279a6c32012-01-29 17:08:11 +0000183 // If we just loaded a module map file, look for the module again.
184 Module = ModMap.findModule(ModuleName);
185 if (Module)
186 break;
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000187 }
Douglas Gregor0339a642013-03-21 01:08:50 +0000188
189 // If we've already performed the exhaustive search for module maps in this
190 // search directory, don't do it again.
191 if (SearchDirs[Idx].haveSearchedAllModuleMaps())
192 continue;
193
194 // Load all module maps in the immediate subdirectories of this search
195 // directory.
196 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
197
198 // Look again for the module.
199 Module = ModMap.findModule(ModuleName);
200 if (Module)
201 break;
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000202 }
Douglas Gregor0339a642013-03-21 01:08:50 +0000203
Douglas Gregor279a6c32012-01-29 17:08:11 +0000204 return Module;
Douglas Gregor1e44e022011-09-12 20:41:59 +0000205}
206
Chris Lattnerf62f7582007-12-17 07:52:39 +0000207//===----------------------------------------------------------------------===//
208// File lookup within a DirectoryLookup scope
209//===----------------------------------------------------------------------===//
210
Chris Lattner8d720d02007-12-17 17:57:27 +0000211/// getName - Return the directory or filename corresponding to this lookup
212/// object.
213const char *DirectoryLookup::getName() const {
214 if (isNormalDir())
215 return getDir()->getName();
216 if (isFramework())
217 return getFrameworkDir()->getName();
218 assert(isHeaderMap() && "Unknown DirectoryLookup");
219 return getHeaderMap()->getFileName();
220}
221
Richard Smith8c71eba2014-03-05 20:51:45 +0000222static const FileEntry *
223getFileAndSuggestModule(HeaderSearch &HS, StringRef FileName,
224 const DirectoryEntry *Dir, bool IsSystemHeaderDir,
225 ModuleMap::KnownHeader *SuggestedModule) {
226 // If we have a module map that might map this header, load it and
227 // check whether we'll have a suggestion for a module.
228 HS.hasModuleMap(FileName, Dir, IsSystemHeaderDir);
229 if (SuggestedModule) {
230 const FileEntry *File = HS.getFileMgr().getFile(FileName,
231 /*OpenFile=*/false);
232 if (File) {
233 // If there is a module that corresponds to this header, suggest it.
234 *SuggestedModule = HS.findModuleForHeader(File);
235
236 // FIXME: This appears to be a no-op. We loaded the module map for this
237 // directory at the start of this function.
238 if (!SuggestedModule->getModule() &&
239 HS.hasModuleMap(FileName, Dir, IsSystemHeaderDir))
240 *SuggestedModule = HS.findModuleForHeader(File);
241 }
242
243 return File;
244 }
245
246 return HS.getFileMgr().getFile(FileName, /*openFile=*/true);
247}
Chris Lattner8d720d02007-12-17 17:57:27 +0000248
Chris Lattnerf62f7582007-12-17 07:52:39 +0000249/// LookupFile - Lookup the specified file in this search path, returning it
250/// if it exists or returning null if not.
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000251const FileEntry *DirectoryLookup::LookupFile(
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000252 StringRef &Filename,
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000253 HeaderSearch &HS,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000254 SmallVectorImpl<char> *SearchPath,
Douglas Gregor97eec242011-09-15 22:00:41 +0000255 SmallVectorImpl<char> *RelativePath,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000256 ModuleMap::KnownHeader *SuggestedModule,
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000257 bool &InUserSpecifiedSystemFramework,
258 SmallVectorImpl<char> &MappedName) const {
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000259 InUserSpecifiedSystemFramework = false;
260
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000261 SmallString<1024> TmpDir;
Chris Lattner712e3872007-12-17 08:13:48 +0000262 if (isNormalDir()) {
263 // Concatenate the requested file onto the directory.
Eli Friedmanf7ca26a2011-07-08 20:17:28 +0000264 TmpDir = getDir()->getName();
265 llvm::sys::path::append(TmpDir, Filename);
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000266 if (SearchPath != NULL) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000267 StringRef SearchPathRef(getDir()->getName());
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000268 SearchPath->clear();
269 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
270 }
271 if (RelativePath != NULL) {
272 RelativePath->clear();
273 RelativePath->append(Filename.begin(), Filename.end());
274 }
Richard Smith8c71eba2014-03-05 20:51:45 +0000275
276 return getFileAndSuggestModule(HS, TmpDir.str(), getDir(),
277 isSystemHeaderDirectory(),
278 SuggestedModule);
Chris Lattner712e3872007-12-17 08:13:48 +0000279 }
Mike Stump11289f42009-09-09 15:08:12 +0000280
Chris Lattner712e3872007-12-17 08:13:48 +0000281 if (isFramework())
Douglas Gregor97eec242011-09-15 22:00:41 +0000282 return DoFrameworkLookup(Filename, HS, SearchPath, RelativePath,
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000283 SuggestedModule, InUserSpecifiedSystemFramework);
Mike Stump11289f42009-09-09 15:08:12 +0000284
Chris Lattner44bd21b2007-12-17 08:17:39 +0000285 assert(isHeaderMap() && "Unknown directory lookup");
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000286 const HeaderMap *HM = getHeaderMap();
287 SmallString<1024> Path;
288 StringRef Dest = HM->lookupFilename(Filename, Path);
289 if (Dest.empty())
290 return 0;
291
292 const FileEntry *Result;
293
294 // Check if the headermap maps the filename to a framework include
295 // ("Foo.h" -> "Foo/Foo.h"), in which case continue header lookup using the
296 // framework include.
297 if (llvm::sys::path::is_relative(Dest)) {
298 MappedName.clear();
299 MappedName.append(Dest.begin(), Dest.end());
300 Filename = StringRef(MappedName.begin(), MappedName.size());
301 Result = HM->LookupFile(Filename, HS.getFileMgr());
302
303 } else {
304 Result = HS.getFileMgr().getFile(Dest);
305 }
306
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000307 if (Result) {
308 if (SearchPath != NULL) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000309 StringRef SearchPathRef(getName());
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000310 SearchPath->clear();
311 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
312 }
313 if (RelativePath != NULL) {
314 RelativePath->clear();
315 RelativePath->append(Filename.begin(), Filename.end());
316 }
317 }
318 return Result;
Chris Lattnerf62f7582007-12-17 07:52:39 +0000319}
320
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000321/// \brief Given a framework directory, find the top-most framework directory.
322///
323/// \param FileMgr The file manager to use for directory lookups.
324/// \param DirName The name of the framework directory.
325/// \param SubmodulePath Will be populated with the submodule path from the
326/// returned top-level module to the originally named framework.
327static const DirectoryEntry *
328getTopFrameworkDir(FileManager &FileMgr, StringRef DirName,
329 SmallVectorImpl<std::string> &SubmodulePath) {
330 assert(llvm::sys::path::extension(DirName) == ".framework" &&
331 "Not a framework directory");
332
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000333 // Note: as an egregious but useful hack we use the real path here, because
334 // frameworks moving between top-level frameworks to embedded frameworks tend
335 // to be symlinked, and we base the logical structure of modules on the
336 // physical layout. In particular, we need to deal with crazy includes like
337 //
338 // #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
339 //
340 // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
341 // which one should access with, e.g.,
342 //
343 // #include <Bar/Wibble.h>
344 //
345 // Similar issues occur when a top-level framework has moved into an
346 // embedded framework.
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000347 const DirectoryEntry *TopFrameworkDir = FileMgr.getDirectory(DirName);
Douglas Gregore00c8b22013-01-26 00:55:12 +0000348 DirName = FileMgr.getCanonicalName(TopFrameworkDir);
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000349 do {
350 // Get the parent directory name.
351 DirName = llvm::sys::path::parent_path(DirName);
352 if (DirName.empty())
353 break;
354
355 // Determine whether this directory exists.
356 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
357 if (!Dir)
358 break;
359
360 // If this is a framework directory, then we're a subframework of this
361 // framework.
362 if (llvm::sys::path::extension(DirName) == ".framework") {
363 SubmodulePath.push_back(llvm::sys::path::stem(DirName));
364 TopFrameworkDir = Dir;
365 }
366 } while (true);
367
368 return TopFrameworkDir;
369}
Chris Lattnerf62f7582007-12-17 07:52:39 +0000370
Chris Lattner712e3872007-12-17 08:13:48 +0000371/// DoFrameworkLookup - Do a lookup of the specified file in the current
372/// DirectoryLookup, which is a framework directory.
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000373const FileEntry *DirectoryLookup::DoFrameworkLookup(
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000374 StringRef Filename,
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000375 HeaderSearch &HS,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000376 SmallVectorImpl<char> *SearchPath,
Douglas Gregor97eec242011-09-15 22:00:41 +0000377 SmallVectorImpl<char> *RelativePath,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000378 ModuleMap::KnownHeader *SuggestedModule,
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000379 bool &InUserSpecifiedSystemFramework) const
Douglas Gregor97eec242011-09-15 22:00:41 +0000380{
Chris Lattner712e3872007-12-17 08:13:48 +0000381 FileManager &FileMgr = HS.getFileMgr();
Mike Stump11289f42009-09-09 15:08:12 +0000382
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000383 // Framework names must have a '/' in the filename.
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000384 size_t SlashPos = Filename.find('/');
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000385 if (SlashPos == StringRef::npos) return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000386
Chris Lattner712e3872007-12-17 08:13:48 +0000387 // Find out if this is the home for the specified framework, by checking
Daniel Dunbar17138612012-04-05 17:09:40 +0000388 // HeaderSearch. Possible answers are yes/no and unknown.
389 HeaderSearch::FrameworkCacheEntry &CacheEntry =
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000390 HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
Mike Stump11289f42009-09-09 15:08:12 +0000391
Chris Lattner712e3872007-12-17 08:13:48 +0000392 // If it is known and in some other directory, fail.
Daniel Dunbar17138612012-04-05 17:09:40 +0000393 if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
Chris Lattner5ed76da2006-10-22 07:24:13 +0000394 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000395
Chris Lattner712e3872007-12-17 08:13:48 +0000396 // Otherwise, construct the path to this framework dir.
Mike Stump11289f42009-09-09 15:08:12 +0000397
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000398 // FrameworkName = "/System/Library/Frameworks/"
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000399 SmallString<1024> FrameworkName;
Chris Lattner712e3872007-12-17 08:13:48 +0000400 FrameworkName += getFrameworkDir()->getName();
Chris Lattnerb201d9b2006-10-30 05:09:49 +0000401 if (FrameworkName.empty() || FrameworkName.back() != '/')
402 FrameworkName.push_back('/');
Mike Stump11289f42009-09-09 15:08:12 +0000403
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000404 // FrameworkName = "/System/Library/Frameworks/Cocoa"
Douglas Gregor56c64012011-11-17 01:41:17 +0000405 StringRef ModuleName(Filename.begin(), SlashPos);
406 FrameworkName += ModuleName;
Mike Stump11289f42009-09-09 15:08:12 +0000407
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000408 // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
409 FrameworkName += ".framework/";
Mike Stump11289f42009-09-09 15:08:12 +0000410
Daniel Dunbar17138612012-04-05 17:09:40 +0000411 // If the cache entry was unresolved, populate it now.
412 if (CacheEntry.Directory == 0) {
Chris Lattner712e3872007-12-17 08:13:48 +0000413 HS.IncrementFrameworkLookupCount();
Mike Stump11289f42009-09-09 15:08:12 +0000414
Chris Lattner5ed76da2006-10-22 07:24:13 +0000415 // If the framework dir doesn't exist, we fail.
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000416 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
417 if (Dir == 0) return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000418
Chris Lattner5ed76da2006-10-22 07:24:13 +0000419 // Otherwise, if it does, remember that this is the right direntry for this
420 // framework.
Daniel Dunbar17138612012-04-05 17:09:40 +0000421 CacheEntry.Directory = getFrameworkDir();
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000422
423 // If this is a user search directory, check if the framework has been
424 // user-specified as a system framework.
425 if (getDirCharacteristic() == SrcMgr::C_User) {
426 SmallString<1024> SystemFrameworkMarker(FrameworkName);
427 SystemFrameworkMarker += ".system_framework";
428 if (llvm::sys::fs::exists(SystemFrameworkMarker.str())) {
429 CacheEntry.IsUserSpecifiedSystemFramework = true;
430 }
431 }
Chris Lattner5ed76da2006-10-22 07:24:13 +0000432 }
Mike Stump11289f42009-09-09 15:08:12 +0000433
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000434 // Set the 'user-specified system framework' flag.
435 InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
436
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000437 if (RelativePath != NULL) {
438 RelativePath->clear();
439 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
440 }
Douglas Gregor56c64012011-11-17 01:41:17 +0000441
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000442 // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
Chris Lattnerb201d9b2006-10-30 05:09:49 +0000443 unsigned OrigSize = FrameworkName.size();
Mike Stump11289f42009-09-09 15:08:12 +0000444
Chris Lattnerb201d9b2006-10-30 05:09:49 +0000445 FrameworkName += "Headers/";
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000446
447 if (SearchPath != NULL) {
448 SearchPath->clear();
449 // Without trailing '/'.
450 SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
451 }
452
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000453 FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000454 const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
455 /*openFile=*/!SuggestedModule);
456 if (!FE) {
457 // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
458 const char *Private = "Private";
459 FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
460 Private+strlen(Private));
461 if (SearchPath != NULL)
462 SearchPath->insert(SearchPath->begin()+OrigSize, Private,
463 Private+strlen(Private));
464
465 FE = FileMgr.getFile(FrameworkName.str(), /*openFile=*/!SuggestedModule);
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000466 }
Mike Stump11289f42009-09-09 15:08:12 +0000467
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000468 // If we found the header and are allowed to suggest a module, do so now.
469 if (FE && SuggestedModule) {
470 // Find the framework in which this header occurs.
471 StringRef FrameworkPath = FE->getName();
472 bool FoundFramework = false;
473 do {
474 // Get the parent directory name.
475 FrameworkPath = llvm::sys::path::parent_path(FrameworkPath);
476 if (FrameworkPath.empty())
477 break;
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000478
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000479 // Determine whether this directory exists.
480 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkPath);
481 if (!Dir)
482 break;
483
484 // If this is a framework directory, then we're a subframework of this
485 // framework.
486 if (llvm::sys::path::extension(FrameworkPath) == ".framework") {
487 FoundFramework = true;
488 break;
489 }
490 } while (true);
491
492 if (FoundFramework) {
493 // Find the top-level framework based on this framework.
494 SmallVector<std::string, 4> SubmodulePath;
495 const DirectoryEntry *TopFrameworkDir
496 = ::getTopFrameworkDir(FileMgr, FrameworkPath, SubmodulePath);
497
498 // Determine the name of the top-level framework.
499 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
500
501 // Load this framework module. If that succeeds, find the suggested module
502 // for this header, if any.
503 bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
504 if (HS.loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
505 *SuggestedModule = HS.findModuleForHeader(FE);
506 }
507 } else {
508 *SuggestedModule = HS.findModuleForHeader(FE);
509 }
510 }
Douglas Gregor97eec242011-09-15 22:00:41 +0000511 return FE;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000512}
513
Douglas Gregor89929282012-01-30 06:01:29 +0000514void HeaderSearch::setTarget(const TargetInfo &Target) {
515 ModMap.setTarget(Target);
516}
517
Chris Lattnerf62f7582007-12-17 07:52:39 +0000518
Chris Lattner712e3872007-12-17 08:13:48 +0000519//===----------------------------------------------------------------------===//
520// Header File Location.
521//===----------------------------------------------------------------------===//
522
Reid Klecknera97d4c02014-02-18 23:49:24 +0000523/// \brief Return true with a diagnostic if the file that MSVC would have found
524/// fails to match the one that Clang would have found with MSVC header search
525/// disabled.
526static bool checkMSVCHeaderSearch(DiagnosticsEngine &Diags,
527 const FileEntry *MSFE, const FileEntry *FE,
528 SourceLocation IncludeLoc) {
529 if (MSFE && FE != MSFE) {
530 Diags.Report(IncludeLoc, diag::ext_pp_include_search_ms) << MSFE->getName();
531 return true;
532 }
533 return false;
534}
Chris Lattner712e3872007-12-17 08:13:48 +0000535
James Dennettc07ab2c2012-06-20 00:56:32 +0000536/// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000537/// return null on failure. isAngled indicates whether the file reference is
Will Wilson0fafd342013-12-27 19:46:16 +0000538/// for system \#include's or not (i.e. using <> instead of ""). Includers, if
539/// non-empty, indicates where the \#including file(s) are, in case a relative
540/// search is needed. Microsoft mode will pass all \#including files.
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000541const FileEntry *HeaderSearch::LookupFile(
Will Wilson0fafd342013-12-27 19:46:16 +0000542 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
543 const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
544 ArrayRef<const FileEntry *> Includers, SmallVectorImpl<char> *SearchPath,
Douglas Gregor97eec242011-09-15 22:00:41 +0000545 SmallVectorImpl<char> *RelativePath,
Will Wilson0fafd342013-12-27 19:46:16 +0000546 ModuleMap::KnownHeader *SuggestedModule, bool SkipCache) {
Daniel Jasper97da9172013-10-22 08:09:47 +0000547 if (!HSOpts->ModuleMapFiles.empty()) {
548 // Preload all explicitly specified module map files. This enables modules
549 // map files lying in a directory structure separate from the header files
550 // that they describe. These cannot be loaded lazily upon encountering a
Will Wilson9ef61a72013-12-19 16:24:17 +0000551 // header file, as there is no other known mapping from a header file to its
Daniel Jasper97da9172013-10-22 08:09:47 +0000552 // module map file.
553 for (llvm::SetVector<std::string>::iterator
554 I = HSOpts->ModuleMapFiles.begin(),
555 E = HSOpts->ModuleMapFiles.end();
556 I != E; ++I) {
557 const FileEntry *File = FileMgr.getFile(*I);
558 if (!File)
559 continue;
560 loadModuleMapFile(File, /*IsSystem=*/false);
561 }
562 HSOpts->ModuleMapFiles.clear();
563 }
564
Douglas Gregor97eec242011-09-15 22:00:41 +0000565 if (SuggestedModule)
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000566 *SuggestedModule = ModuleMap::KnownHeader();
Douglas Gregor97eec242011-09-15 22:00:41 +0000567
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000568 // If 'Filename' is absolute, check to see if it exists and no searching.
Michael J. Spencerf28df4c2010-12-17 21:22:22 +0000569 if (llvm::sys::path::is_absolute(Filename)) {
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000570 CurDir = 0;
571
572 // If this was an #include_next "/absolute/file", fail.
573 if (FromDir) return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000574
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000575 if (SearchPath != NULL)
576 SearchPath->clear();
577 if (RelativePath != NULL) {
578 RelativePath->clear();
579 RelativePath->append(Filename.begin(), Filename.end());
580 }
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000581 // Otherwise, just return the file.
Argyrios Kyrtzidisd6278e32011-03-16 19:17:25 +0000582 return FileMgr.getFile(Filename, /*openFile=*/true);
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000583 }
Mike Stump11289f42009-09-09 15:08:12 +0000584
Reid Klecknera97d4c02014-02-18 23:49:24 +0000585 // This is the header that MSVC's header search would have found.
586 const FileEntry *MSFE = 0;
Richard Smith8c71eba2014-03-05 20:51:45 +0000587 ModuleMap::KnownHeader MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000588
Douglas Gregor9f93e382011-07-28 04:45:53 +0000589 // Unless disabled, check to see if the file is in the #includer's
Will Wilson0fafd342013-12-27 19:46:16 +0000590 // directory. This cannot be based on CurDir, because each includer could be
591 // a #include of a subdirectory (#include "foo/bar.h") and a subsequent
592 // include of "baz.h" should resolve to "whatever/foo/baz.h".
Chris Lattnerf62f7582007-12-17 07:52:39 +0000593 // This search is not done for <> headers.
Will Wilson0fafd342013-12-27 19:46:16 +0000594 if (!Includers.empty() && !isAngled && !NoCurDirSearch) {
NAKAMURA Takumi9cb62642013-12-10 02:36:28 +0000595 SmallString<1024> TmpDir;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000596 for (ArrayRef<const FileEntry *>::iterator I = Includers.begin(),
597 E = Includers.end();
Will Wilson0fafd342013-12-27 19:46:16 +0000598 I != E; ++I) {
599 const FileEntry *Includer = *I;
600 // Concatenate the requested file onto the directory.
601 // FIXME: Portability. Filename concatenation should be in sys::Path.
602 TmpDir = Includer->getDir()->getName();
603 TmpDir.push_back('/');
604 TmpDir.append(Filename.begin(), Filename.end());
Richard Smith8c71eba2014-03-05 20:51:45 +0000605
Richard Smith6f548ec2014-03-06 18:08:08 +0000606 // FIXME: We don't cache the result of getFileInfo across the call to
607 // getFileAndSuggestModule, because it's a reference to an element of
608 // a container that could be reallocated across this call.
609 bool IncluderIsSystemHeader =
610 getFileInfo(Includer).DirInfo != SrcMgr::C_User;
Will Wilson0fafd342013-12-27 19:46:16 +0000611 if (const FileEntry *FE =
Richard Smith8c71eba2014-03-05 20:51:45 +0000612 getFileAndSuggestModule(*this, TmpDir.str(), Includer->getDir(),
Richard Smith6f548ec2014-03-06 18:08:08 +0000613 IncluderIsSystemHeader,
Richard Smith8c71eba2014-03-05 20:51:45 +0000614 SuggestedModule)) {
Will Wilson0fafd342013-12-27 19:46:16 +0000615 // Leave CurDir unset.
616 // This file is a system header or C++ unfriendly if the old file is.
617 //
618 // Note that we only use one of FromHFI/ToHFI at once, due to potential
619 // reallocation of the underlying vector potentially making the first
620 // reference binding dangling.
Richard Smith6f548ec2014-03-06 18:08:08 +0000621 HeaderFileInfo &FromHFI = getFileInfo(Includer);
Will Wilson0fafd342013-12-27 19:46:16 +0000622 unsigned DirInfo = FromHFI.DirInfo;
623 bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
624 StringRef Framework = FromHFI.Framework;
Douglas Gregor03b5ebe2012-08-13 15:47:39 +0000625
Will Wilson0fafd342013-12-27 19:46:16 +0000626 HeaderFileInfo &ToHFI = getFileInfo(FE);
627 ToHFI.DirInfo = DirInfo;
628 ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
629 ToHFI.Framework = Framework;
Douglas Gregor03b5ebe2012-08-13 15:47:39 +0000630
Will Wilson0fafd342013-12-27 19:46:16 +0000631 if (SearchPath != NULL) {
632 StringRef SearchPathRef(Includer->getDir()->getName());
633 SearchPath->clear();
634 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
635 }
636 if (RelativePath != NULL) {
637 RelativePath->clear();
638 RelativePath->append(Filename.begin(), Filename.end());
639 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000640 if (I == Includers.begin())
641 return FE;
642
643 // Otherwise, we found the path via MSVC header search rules. If
644 // -Wmsvc-include is enabled, we have to keep searching to see if we
645 // would've found this header in -I or -isystem directories.
646 if (Diags.getDiagnosticLevel(diag::ext_pp_include_search_ms,
647 IncludeLoc) ==
648 DiagnosticsEngine::Ignored) {
649 return FE;
650 } else {
651 MSFE = FE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000652 if (SuggestedModule) {
653 MSSuggestedModule = *SuggestedModule;
654 *SuggestedModule = ModuleMap::KnownHeader();
655 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000656 break;
657 }
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000658 }
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000659 }
660 }
Mike Stump11289f42009-09-09 15:08:12 +0000661
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000662 CurDir = 0;
663
664 // If this is a system #include, ignore the user #include locs.
Nico Weber3b1d1212011-05-24 04:31:14 +0000665 unsigned i = isAngled ? AngledDirIdx : 0;
Mike Stump11289f42009-09-09 15:08:12 +0000666
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000667 // If this is a #include_next request, start searching after the directory the
668 // file was found in.
669 if (FromDir)
670 i = FromDir-&SearchDirs[0];
Mike Stump11289f42009-09-09 15:08:12 +0000671
Chris Lattnerd4275422007-07-22 07:28:00 +0000672 // Cache all of the lookups performed by this method. Many headers are
673 // multiply included, and the "pragma once" optimization prevents them from
674 // being relex/pp'd, but they would still have to search through a
675 // (potentially huge) series of SearchDirs to find it.
676 std::pair<unsigned, unsigned> &CacheLookup =
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000677 LookupFileCache.GetOrCreateValue(Filename).getValue();
Chris Lattnerd4275422007-07-22 07:28:00 +0000678
679 // If the entry has been previously looked up, the first value will be
680 // non-zero. If the value is equal to i (the start point of our search), then
681 // this is a matching hit.
Douglas Gregor8ad31c22011-11-20 17:46:46 +0000682 if (!SkipCache && CacheLookup.first == i+1) {
Chris Lattnerd4275422007-07-22 07:28:00 +0000683 // Skip querying potentially lots of directories for this lookup.
684 i = CacheLookup.second;
685 } else {
686 // Otherwise, this is the first query, or the previous query didn't match
687 // our search start. We will fill in our found location below, so prime the
688 // start point value.
689 CacheLookup.first = i+1;
690 }
Mike Stump11289f42009-09-09 15:08:12 +0000691
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000692 SmallString<64> MappedName;
693
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000694 // Check each directory in sequence to see if it contains this file.
695 for (; i != SearchDirs.size(); ++i) {
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000696 bool InUserSpecifiedSystemFramework = false;
Mike Stump11289f42009-09-09 15:08:12 +0000697 const FileEntry *FE =
Douglas Gregor97eec242011-09-15 22:00:41 +0000698 SearchDirs[i].LookupFile(Filename, *this, SearchPath, RelativePath,
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000699 SuggestedModule, InUserSpecifiedSystemFramework,
700 MappedName);
Chris Lattner712e3872007-12-17 08:13:48 +0000701 if (!FE) continue;
Mike Stump11289f42009-09-09 15:08:12 +0000702
Chris Lattner712e3872007-12-17 08:13:48 +0000703 CurDir = &SearchDirs[i];
Mike Stump11289f42009-09-09 15:08:12 +0000704
Chris Lattner712e3872007-12-17 08:13:48 +0000705 // This file is a system header or C++ unfriendly if the dir is.
Douglas Gregor9f93e382011-07-28 04:45:53 +0000706 HeaderFileInfo &HFI = getFileInfo(FE);
707 HFI.DirInfo = CurDir->getDirCharacteristic();
Mike Stump11289f42009-09-09 15:08:12 +0000708
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000709 // If the directory characteristic is User but this framework was
710 // user-specified to be treated as a system framework, promote the
711 // characteristic.
712 if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
713 HFI.DirInfo = SrcMgr::C_System;
714
Richard Smith8acadcb2012-06-13 20:27:03 +0000715 // If the filename matches a known system header prefix, override
716 // whether the file is a system header.
Richard Trieu871f5f32012-06-13 20:52:36 +0000717 for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
718 if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
719 HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
Richard Smith8acadcb2012-06-13 20:27:03 +0000720 : SrcMgr::C_User;
721 break;
722 }
723 }
724
Douglas Gregor9f93e382011-07-28 04:45:53 +0000725 // If this file is found in a header map and uses the framework style of
726 // includes, then this header is part of a framework we're building.
727 if (CurDir->isIndexHeaderMap()) {
728 size_t SlashPos = Filename.find('/');
729 if (SlashPos != StringRef::npos) {
730 HFI.IndexHeaderMapHeader = 1;
731 HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
732 SlashPos));
733 }
734 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000735
Richard Smith8c71eba2014-03-05 20:51:45 +0000736 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc)) {
737 if (SuggestedModule)
738 *SuggestedModule = MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000739 return MSFE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000740 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000741
Chris Lattner712e3872007-12-17 08:13:48 +0000742 // Remember this location for the next lookup we do.
743 CacheLookup.second = i;
744 return FE;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000745 }
Mike Stump11289f42009-09-09 15:08:12 +0000746
Douglas Gregord8575e12011-07-30 06:28:34 +0000747 // If we are including a file with a quoted include "foo.h" from inside
748 // a header in a framework that is currently being built, and we couldn't
749 // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
750 // "Foo" is the name of the framework in which the including header was found.
Will Wilson0fafd342013-12-27 19:46:16 +0000751 if (!Includers.empty() && !isAngled &&
752 Filename.find('/') == StringRef::npos) {
753 HeaderFileInfo &IncludingHFI = getFileInfo(Includers.front());
Douglas Gregord8575e12011-07-30 06:28:34 +0000754 if (IncludingHFI.IndexHeaderMapHeader) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000755 SmallString<128> ScratchFilename;
Douglas Gregord8575e12011-07-30 06:28:34 +0000756 ScratchFilename += IncludingHFI.Framework;
757 ScratchFilename += '/';
758 ScratchFilename += Filename;
Will Wilson0fafd342013-12-27 19:46:16 +0000759
Reid Klecknera97d4c02014-02-18 23:49:24 +0000760 const FileEntry *FE = LookupFile(
Will Wilson0fafd342013-12-27 19:46:16 +0000761 ScratchFilename, IncludeLoc, /*isAngled=*/true, FromDir, CurDir,
762 Includers.front(), SearchPath, RelativePath, SuggestedModule);
Reid Klecknera97d4c02014-02-18 23:49:24 +0000763
Richard Smith8c71eba2014-03-05 20:51:45 +0000764 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc)) {
765 if (SuggestedModule)
766 *SuggestedModule = MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000767 return MSFE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000768 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000769
Douglas Gregord8575e12011-07-30 06:28:34 +0000770 std::pair<unsigned, unsigned> &CacheLookup
771 = LookupFileCache.GetOrCreateValue(Filename).getValue();
772 CacheLookup.second
773 = LookupFileCache.GetOrCreateValue(ScratchFilename).getValue().second;
Richard Smith8c71eba2014-03-05 20:51:45 +0000774 // FIXME: SuggestedModule.
Reid Klecknera97d4c02014-02-18 23:49:24 +0000775 return FE;
Douglas Gregord8575e12011-07-30 06:28:34 +0000776 }
777 }
778
Richard Smith8c71eba2014-03-05 20:51:45 +0000779 if (checkMSVCHeaderSearch(Diags, MSFE, 0, IncludeLoc)) {
780 if (SuggestedModule)
781 *SuggestedModule = MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000782 return MSFE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000783 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000784
Chris Lattnerd4275422007-07-22 07:28:00 +0000785 // Otherwise, didn't find it. Remember we didn't find this.
786 CacheLookup.second = SearchDirs.size();
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000787 return 0;
788}
789
Chris Lattner63dd32b2006-10-20 04:42:40 +0000790/// LookupSubframeworkHeader - Look up a subframework for the specified
James Dennettc07ab2c2012-06-20 00:56:32 +0000791/// \#include file. For example, if \#include'ing <HIToolbox/HIToolbox.h> from
Chris Lattner63dd32b2006-10-20 04:42:40 +0000792/// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
793/// is a subframework within Carbon.framework. If so, return the FileEntry
794/// for the designated file, otherwise return null.
795const FileEntry *HeaderSearch::
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000796LookupSubframeworkHeader(StringRef Filename,
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000797 const FileEntry *ContextFileEnt,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000798 SmallVectorImpl<char> *SearchPath,
Douglas Gregorf5f94522013-02-08 00:10:48 +0000799 SmallVectorImpl<char> *RelativePath,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000800 ModuleMap::KnownHeader *SuggestedModule) {
Chris Lattner12261882008-02-01 05:34:02 +0000801 assert(ContextFileEnt && "No context file?");
Mike Stump11289f42009-09-09 15:08:12 +0000802
Chris Lattner63dd32b2006-10-20 04:42:40 +0000803 // Framework names must have a '/' in the filename. Find it.
Douglas Gregor5ca04bd2011-12-09 16:48:01 +0000804 // FIXME: Should we permit '\' on Windows?
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000805 size_t SlashPos = Filename.find('/');
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000806 if (SlashPos == StringRef::npos) return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000807
Chris Lattner63dd32b2006-10-20 04:42:40 +0000808 // Look up the base framework name of the ContextFileEnt.
Chris Lattner48043482006-10-27 05:12:36 +0000809 const char *ContextName = ContextFileEnt->getName();
Mike Stump11289f42009-09-09 15:08:12 +0000810
Chris Lattner63dd32b2006-10-20 04:42:40 +0000811 // If the context info wasn't a framework, couldn't be a subframework.
Douglas Gregor5ca04bd2011-12-09 16:48:01 +0000812 const unsigned DotFrameworkLen = 10;
813 const char *FrameworkPos = strstr(ContextName, ".framework");
814 if (FrameworkPos == 0 ||
815 (FrameworkPos[DotFrameworkLen] != '/' &&
816 FrameworkPos[DotFrameworkLen] != '\\'))
Chris Lattner63dd32b2006-10-20 04:42:40 +0000817 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000818
Daniel Dunbar17138612012-04-05 17:09:40 +0000819 SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
Chris Lattner5ed76da2006-10-22 07:24:13 +0000820
Chris Lattner63dd32b2006-10-20 04:42:40 +0000821 // Append Frameworks/HIToolbox.framework/
822 FrameworkName += "Frameworks/";
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000823 FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
Chris Lattner63dd32b2006-10-20 04:42:40 +0000824 FrameworkName += ".framework/";
Chris Lattner577377e2006-10-20 04:55:45 +0000825
Daniel Dunbar17138612012-04-05 17:09:40 +0000826 llvm::StringMapEntry<FrameworkCacheEntry> &CacheLookup =
Chris Lattner8afa6de2010-11-21 09:55:08 +0000827 FrameworkMap.GetOrCreateValue(Filename.substr(0, SlashPos));
Mike Stump11289f42009-09-09 15:08:12 +0000828
Chris Lattner5ed76da2006-10-22 07:24:13 +0000829 // Some other location?
Daniel Dunbar17138612012-04-05 17:09:40 +0000830 if (CacheLookup.getValue().Directory &&
Chris Lattner34d1f5a2007-02-08 19:08:49 +0000831 CacheLookup.getKeyLength() == FrameworkName.size() &&
832 memcmp(CacheLookup.getKeyData(), &FrameworkName[0],
833 CacheLookup.getKeyLength()) != 0)
Chris Lattner5ed76da2006-10-22 07:24:13 +0000834 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000835
Chris Lattner5ed76da2006-10-22 07:24:13 +0000836 // Cache subframework.
Daniel Dunbar17138612012-04-05 17:09:40 +0000837 if (CacheLookup.getValue().Directory == 0) {
Chris Lattner5ed76da2006-10-22 07:24:13 +0000838 ++NumSubFrameworkLookups;
Mike Stump11289f42009-09-09 15:08:12 +0000839
Chris Lattner5ed76da2006-10-22 07:24:13 +0000840 // If the framework dir doesn't exist, we fail.
Chris Lattner5159f612010-11-23 08:35:12 +0000841 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
Chris Lattner5ed76da2006-10-22 07:24:13 +0000842 if (Dir == 0) return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000843
Chris Lattner5ed76da2006-10-22 07:24:13 +0000844 // Otherwise, if it does, remember that this is the right direntry for this
845 // framework.
Daniel Dunbar17138612012-04-05 17:09:40 +0000846 CacheLookup.getValue().Directory = Dir;
Chris Lattner5ed76da2006-10-22 07:24:13 +0000847 }
Mike Stump11289f42009-09-09 15:08:12 +0000848
Chris Lattner577377e2006-10-20 04:55:45 +0000849 const FileEntry *FE = 0;
850
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000851 if (RelativePath != NULL) {
852 RelativePath->clear();
853 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
854 }
855
Chris Lattner63dd32b2006-10-20 04:42:40 +0000856 // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000857 SmallString<1024> HeadersFilename(FrameworkName);
Chris Lattner43fd42e2006-10-30 03:40:58 +0000858 HeadersFilename += "Headers/";
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000859 if (SearchPath != NULL) {
860 SearchPath->clear();
861 // Without trailing '/'.
862 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
863 }
864
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000865 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
Argyrios Kyrtzidisd6278e32011-03-16 19:17:25 +0000866 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true))) {
Mike Stump11289f42009-09-09 15:08:12 +0000867
Chris Lattner63dd32b2006-10-20 04:42:40 +0000868 // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
Chris Lattner43fd42e2006-10-30 03:40:58 +0000869 HeadersFilename = FrameworkName;
870 HeadersFilename += "PrivateHeaders/";
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000871 if (SearchPath != NULL) {
872 SearchPath->clear();
873 // Without trailing '/'.
874 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
875 }
876
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000877 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
Argyrios Kyrtzidisd6278e32011-03-16 19:17:25 +0000878 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true)))
Chris Lattner63dd32b2006-10-20 04:42:40 +0000879 return 0;
Chris Lattner63dd32b2006-10-20 04:42:40 +0000880 }
Mike Stump11289f42009-09-09 15:08:12 +0000881
Chris Lattner577377e2006-10-20 04:55:45 +0000882 // This file is a system header or C++ unfriendly if the old file is.
Ted Kremenek72be0682008-02-24 03:55:14 +0000883 //
Chris Lattnerf5c619f2008-02-25 21:38:21 +0000884 // Note that the temporary 'DirInfo' is required here, as either call to
885 // getFileInfo could resize the vector and we don't want to rely on order
886 // of evaluation.
887 unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
888 getFileInfo(FE).DirInfo = DirInfo;
Douglas Gregorf5f94522013-02-08 00:10:48 +0000889
890 // If we're supposed to suggest a module, look for one now.
891 if (SuggestedModule) {
892 // Find the top-level framework based on this framework.
893 FrameworkName.pop_back(); // remove the trailing '/'
894 SmallVector<std::string, 4> SubmodulePath;
895 const DirectoryEntry *TopFrameworkDir
896 = ::getTopFrameworkDir(FileMgr, FrameworkName, SubmodulePath);
897
898 // Determine the name of the top-level framework.
899 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
900
901 // Load this framework module. If that succeeds, find the suggested module
902 // for this header, if any.
903 bool IsSystem = false;
904 if (loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
905 *SuggestedModule = findModuleForHeader(FE);
906 }
907 }
908
Chris Lattner577377e2006-10-20 04:55:45 +0000909 return FE;
Chris Lattner63dd32b2006-10-20 04:42:40 +0000910}
911
Chandler Carruthb0ffe502011-12-09 01:33:57 +0000912/// \brief Helper static function to normalize a path for injection into
913/// a synthetic header.
914/*static*/ std::string
915HeaderSearch::NormalizeDashIncludePath(StringRef File, FileManager &FileMgr) {
916 // Implicit include paths should be resolved relative to the current
917 // working directory first, and then use the regular header search
918 // mechanism. The proper way to handle this is to have the
919 // predefines buffer located at the current working directory, but
920 // it has no file entry. For now, workaround this by using an
921 // absolute path if we find the file here, and otherwise letting
922 // header search handle it.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000923 SmallString<128> Path(File);
Chandler Carruthb0ffe502011-12-09 01:33:57 +0000924 llvm::sys::fs::make_absolute(Path);
925 bool exists;
926 if (llvm::sys::fs::exists(Path.str(), exists) || !exists)
927 Path = File;
928 else if (exists)
929 FileMgr.getFile(File);
930
931 return Lexer::Stringify(Path.str());
932}
933
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000934//===----------------------------------------------------------------------===//
935// File Info Management.
936//===----------------------------------------------------------------------===//
937
Douglas Gregor5d1bee22011-09-17 05:35:18 +0000938/// \brief Merge the header file info provided by \p OtherHFI into the current
939/// header file info (\p HFI)
940static void mergeHeaderFileInfo(HeaderFileInfo &HFI,
941 const HeaderFileInfo &OtherHFI) {
942 HFI.isImport |= OtherHFI.isImport;
943 HFI.isPragmaOnce |= OtherHFI.isPragmaOnce;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +0000944 HFI.isModuleHeader |= OtherHFI.isModuleHeader;
Douglas Gregor5d1bee22011-09-17 05:35:18 +0000945 HFI.NumIncludes += OtherHFI.NumIncludes;
946
947 if (!HFI.ControllingMacro && !HFI.ControllingMacroID) {
948 HFI.ControllingMacro = OtherHFI.ControllingMacro;
949 HFI.ControllingMacroID = OtherHFI.ControllingMacroID;
950 }
951
952 if (OtherHFI.External) {
953 HFI.DirInfo = OtherHFI.DirInfo;
954 HFI.External = OtherHFI.External;
955 HFI.IndexHeaderMapHeader = OtherHFI.IndexHeaderMapHeader;
956 }
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000957
Douglas Gregor5d1bee22011-09-17 05:35:18 +0000958 if (HFI.Framework.empty())
959 HFI.Framework = OtherHFI.Framework;
960
961 HFI.Resolved = true;
962}
963
Steve Naroff3fa455a2009-04-24 20:03:17 +0000964/// getFileInfo - Return the HeaderFileInfo structure for the specified
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000965/// FileEntry.
Steve Naroff3fa455a2009-04-24 20:03:17 +0000966HeaderFileInfo &HeaderSearch::getFileInfo(const FileEntry *FE) {
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000967 if (FE->getUID() >= FileInfo.size())
968 FileInfo.resize(FE->getUID()+1);
Douglas Gregor09b69892011-02-10 17:09:37 +0000969
970 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
Douglas Gregor5d1bee22011-09-17 05:35:18 +0000971 if (ExternalSource && !HFI.Resolved)
972 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(FE));
Douglas Gregor09b69892011-02-10 17:09:37 +0000973 return HFI;
Mike Stump11289f42009-09-09 15:08:12 +0000974}
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000975
Douglas Gregor37aa4932011-05-04 00:14:37 +0000976bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
977 // Check if we've ever seen this file as a header.
978 if (File->getUID() >= FileInfo.size())
979 return false;
980
981 // Resolve header file info from the external source, if needed.
982 HeaderFileInfo &HFI = FileInfo[File->getUID()];
Douglas Gregor5d1bee22011-09-17 05:35:18 +0000983 if (ExternalSource && !HFI.Resolved)
984 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(File));
Douglas Gregor37aa4932011-05-04 00:14:37 +0000985
Argyrios Kyrtzidis0d355df2012-12-10 20:08:37 +0000986 return HFI.isPragmaOnce || HFI.isImport ||
987 HFI.ControllingMacro || HFI.ControllingMacroID;
Douglas Gregor37aa4932011-05-04 00:14:37 +0000988}
989
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +0000990void HeaderSearch::MarkFileModuleHeader(const FileEntry *FE,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000991 ModuleMap::ModuleHeaderRole Role,
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +0000992 bool isCompilingModuleHeader) {
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +0000993 if (FE->getUID() >= FileInfo.size())
994 FileInfo.resize(FE->getUID()+1);
995
996 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
997 HFI.isModuleHeader = true;
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +0000998 HFI.isCompilingModuleHeader = isCompilingModuleHeader;
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000999 HFI.setHeaderRole(Role);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001000}
1001
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001002bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry *File, bool isImport){
1003 ++NumIncluded; // Count # of attempted #includes.
1004
1005 // Get information about this file.
Steve Naroff3fa455a2009-04-24 20:03:17 +00001006 HeaderFileInfo &FileInfo = getFileInfo(File);
Mike Stump11289f42009-09-09 15:08:12 +00001007
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001008 // If this is a #import directive, check that we have not already imported
1009 // this header.
1010 if (isImport) {
1011 // If this has already been imported, don't import it again.
1012 FileInfo.isImport = true;
Mike Stump11289f42009-09-09 15:08:12 +00001013
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001014 // Has this already been #import'ed or #include'd?
1015 if (FileInfo.NumIncludes) return false;
1016 } else {
1017 // Otherwise, if this is a #include of a file that was previously #import'd
1018 // or if this is the second #include of a #pragma once file, ignore it.
1019 if (FileInfo.isImport)
1020 return false;
1021 }
Mike Stump11289f42009-09-09 15:08:12 +00001022
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001023 // Next, check to see if the file is wrapped with #ifndef guards. If so, and
1024 // if the macro that guards it is defined, we know the #include has no effect.
Mike Stump11289f42009-09-09 15:08:12 +00001025 if (const IdentifierInfo *ControllingMacro
Douglas Gregor99734e72009-04-25 23:30:02 +00001026 = FileInfo.getControllingMacro(ExternalLookup))
1027 if (ControllingMacro->hasMacroDefinition()) {
1028 ++NumMultiIncludeFileOptzn;
1029 return false;
1030 }
Mike Stump11289f42009-09-09 15:08:12 +00001031
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001032 // Increment the number of times this file has been included.
1033 ++FileInfo.NumIncludes;
Mike Stump11289f42009-09-09 15:08:12 +00001034
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001035 return true;
1036}
1037
Ted Kremenekfbcce6f2011-07-26 23:46:11 +00001038size_t HeaderSearch::getTotalMemory() const {
1039 return SearchDirs.capacity()
Ted Kremenekae63d102011-07-27 18:41:18 +00001040 + llvm::capacity_in_bytes(FileInfo)
1041 + llvm::capacity_in_bytes(HeaderMaps)
Ted Kremenekfbcce6f2011-07-26 23:46:11 +00001042 + LookupFileCache.getAllocator().getTotalMemory()
1043 + FrameworkMap.getAllocator().getTotalMemory();
1044}
Douglas Gregor9f93e382011-07-28 04:45:53 +00001045
1046StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
1047 return FrameworkNames.GetOrCreateValue(Framework).getKey();
1048}
Douglas Gregor718292f2011-11-11 19:10:28 +00001049
1050bool HeaderSearch::hasModuleMap(StringRef FileName,
Douglas Gregor963c5532013-06-21 16:28:10 +00001051 const DirectoryEntry *Root,
1052 bool IsSystem) {
Argyrios Kyrtzidis9955dbc2013-12-12 16:08:33 +00001053 if (!enabledModules())
1054 return false;
1055
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001056 SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
Douglas Gregor718292f2011-11-11 19:10:28 +00001057
1058 StringRef DirName = FileName;
1059 do {
1060 // Get the parent directory name.
1061 DirName = llvm::sys::path::parent_path(DirName);
1062 if (DirName.empty())
1063 return false;
Daniel Jasperca9f7382013-09-24 09:27:13 +00001064
Douglas Gregor718292f2011-11-11 19:10:28 +00001065 // Determine whether this directory exists.
1066 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
1067 if (!Dir)
1068 return false;
Daniel Jasperca9f7382013-09-24 09:27:13 +00001069
1070 // Try to load the "module.map" file in this directory.
Douglas Gregor963c5532013-06-21 16:28:10 +00001071 switch (loadModuleMapFile(Dir, IsSystem)) {
Douglas Gregor80b69042011-11-12 00:22:19 +00001072 case LMM_NewlyLoaded:
1073 case LMM_AlreadyLoaded:
Daniel Jasperca9f7382013-09-24 09:27:13 +00001074 // Success. All of the directories we stepped through inherit this module
1075 // map file.
1076 for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
1077 DirectoryHasModuleMap[FixUpDirectories[I]] = true;
1078 return true;
Daniel Jasper97da9172013-10-22 08:09:47 +00001079
1080 case LMM_NoDirectory:
1081 case LMM_InvalidModuleMap:
1082 break;
Daniel Jasperca9f7382013-09-24 09:27:13 +00001083 }
1084
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001085 // If we hit the top of our search, we're done.
1086 if (Dir == Root)
1087 return false;
1088
Douglas Gregor718292f2011-11-11 19:10:28 +00001089 // Keep track of all of the directories we checked, so we can mark them as
1090 // having module maps if we eventually do find a module map.
1091 FixUpDirectories.push_back(Dir);
1092 } while (true);
Douglas Gregor718292f2011-11-11 19:10:28 +00001093}
1094
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001095ModuleMap::KnownHeader
1096HeaderSearch::findModuleForHeader(const FileEntry *File) const {
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001097 if (ExternalSource) {
1098 // Make sure the external source has handled header info about this file,
1099 // which includes whether the file is part of a module.
1100 (void)getFileInfo(File);
1101 }
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001102 return ModMap.findModuleForHeader(File);
Douglas Gregor718292f2011-11-11 19:10:28 +00001103}
1104
Douglas Gregor963c5532013-06-21 16:28:10 +00001105bool HeaderSearch::loadModuleMapFile(const FileEntry *File, bool IsSystem) {
Douglas Gregor2b20cb82011-11-16 00:09:06 +00001106 const DirectoryEntry *Dir = File->getDir();
1107
1108 llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1109 = DirectoryHasModuleMap.find(Dir);
1110 if (KnownDir != DirectoryHasModuleMap.end())
1111 return !KnownDir->second;
1112
Douglas Gregor963c5532013-06-21 16:28:10 +00001113 bool Result = ModMap.parseModuleMapFile(File, IsSystem);
Douglas Gregor80306772011-12-07 21:25:07 +00001114 if (!Result && llvm::sys::path::filename(File->getName()) == "module.map") {
1115 // If the file we loaded was a module.map, look for the corresponding
1116 // module_private.map.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001117 SmallString<128> PrivateFilename(Dir->getName());
Douglas Gregor80306772011-12-07 21:25:07 +00001118 llvm::sys::path::append(PrivateFilename, "module_private.map");
1119 if (const FileEntry *PrivateFile = FileMgr.getFile(PrivateFilename))
Douglas Gregor963c5532013-06-21 16:28:10 +00001120 Result = ModMap.parseModuleMapFile(PrivateFile, IsSystem);
Douglas Gregor80306772011-12-07 21:25:07 +00001121 }
1122
1123 DirectoryHasModuleMap[Dir] = !Result;
Douglas Gregor2b20cb82011-11-16 00:09:06 +00001124 return Result;
1125}
1126
Douglas Gregor279a6c32012-01-29 17:08:11 +00001127Module *HeaderSearch::loadFrameworkModule(StringRef Name,
1128 const DirectoryEntry *Dir,
1129 bool IsSystem) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00001130 if (Module *Module = ModMap.findModule(Name))
Douglas Gregor56c64012011-11-17 01:41:17 +00001131 return Module;
1132
1133 // Try to load a module map file.
Douglas Gregor963c5532013-06-21 16:28:10 +00001134 switch (loadModuleMapFile(Dir, IsSystem)) {
Douglas Gregor56c64012011-11-17 01:41:17 +00001135 case LMM_InvalidModuleMap:
1136 break;
1137
1138 case LMM_AlreadyLoaded:
1139 case LMM_NoDirectory:
1140 return 0;
1141
1142 case LMM_NewlyLoaded:
1143 return ModMap.findModule(Name);
1144 }
Douglas Gregor3a5999b2012-01-13 22:31:52 +00001145
Douglas Gregor4ddf2222013-01-10 01:43:00 +00001146 // Figure out the top-level framework directory and the submodule path from
1147 // that top-level framework to the requested framework.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001148 SmallVector<std::string, 2> SubmodulePath;
Douglas Gregor3a5999b2012-01-13 22:31:52 +00001149 SubmodulePath.push_back(Name);
Douglas Gregor4ddf2222013-01-10 01:43:00 +00001150 const DirectoryEntry *TopFrameworkDir
1151 = ::getTopFrameworkDir(FileMgr, Dir->getName(), SubmodulePath);
Douglas Gregor9194a912012-11-06 19:39:40 +00001152
Douglas Gregor9194a912012-11-06 19:39:40 +00001153
Douglas Gregor3a5999b2012-01-13 22:31:52 +00001154 // Try to infer a module map from the top-level framework directory.
1155 Module *Result = ModMap.inferFrameworkModule(SubmodulePath.back(),
Douglas Gregora686e1b2012-01-27 19:52:33 +00001156 TopFrameworkDir,
1157 IsSystem,
Douglas Gregor3a5999b2012-01-13 22:31:52 +00001158 /*Parent=*/0);
Douglas Gregor4ddf2222013-01-10 01:43:00 +00001159 if (!Result)
1160 return 0;
Douglas Gregor3a5999b2012-01-13 22:31:52 +00001161
1162 // Follow the submodule path to find the requested (sub)framework module
1163 // within the top-level framework module.
1164 SubmodulePath.pop_back();
1165 while (!SubmodulePath.empty() && Result) {
1166 Result = ModMap.lookupModuleQualified(SubmodulePath.back(), Result);
1167 SubmodulePath.pop_back();
1168 }
1169 return Result;
Douglas Gregor56c64012011-11-17 01:41:17 +00001170}
1171
Douglas Gregor2b20cb82011-11-16 00:09:06 +00001172
Douglas Gregor80b69042011-11-12 00:22:19 +00001173HeaderSearch::LoadModuleMapResult
Douglas Gregor963c5532013-06-21 16:28:10 +00001174HeaderSearch::loadModuleMapFile(StringRef DirName, bool IsSystem) {
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001175 if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
Douglas Gregor963c5532013-06-21 16:28:10 +00001176 return loadModuleMapFile(Dir, IsSystem);
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001177
Douglas Gregor80b69042011-11-12 00:22:19 +00001178 return LMM_NoDirectory;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001179}
1180
Douglas Gregor80b69042011-11-12 00:22:19 +00001181HeaderSearch::LoadModuleMapResult
Douglas Gregor963c5532013-06-21 16:28:10 +00001182HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir, bool IsSystem) {
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001183 llvm::DenseMap<const DirectoryEntry *, bool>::iterator KnownDir
1184 = DirectoryHasModuleMap.find(Dir);
1185 if (KnownDir != DirectoryHasModuleMap.end())
Douglas Gregor80b69042011-11-12 00:22:19 +00001186 return KnownDir->second? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001187
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001188 SmallString<128> ModuleMapFileName;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001189 ModuleMapFileName += Dir->getName();
Douglas Gregore7ab3662011-12-07 02:23:45 +00001190 unsigned ModuleMapDirNameLen = ModuleMapFileName.size();
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001191 llvm::sys::path::append(ModuleMapFileName, "module.map");
1192 if (const FileEntry *ModuleMapFile = FileMgr.getFile(ModuleMapFileName)) {
1193 // We have found a module map file. Try to parse it.
Douglas Gregor963c5532013-06-21 16:28:10 +00001194 if (ModMap.parseModuleMapFile(ModuleMapFile, IsSystem)) {
Douglas Gregore7ab3662011-12-07 02:23:45 +00001195 // No suitable module map.
1196 DirectoryHasModuleMap[Dir] = false;
1197 return LMM_InvalidModuleMap;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001198 }
Douglas Gregore7ab3662011-12-07 02:23:45 +00001199
1200 // This directory has a module map.
1201 DirectoryHasModuleMap[Dir] = true;
1202
1203 // Check whether there is a private module map that we need to load as well.
1204 ModuleMapFileName.erase(ModuleMapFileName.begin() + ModuleMapDirNameLen,
1205 ModuleMapFileName.end());
1206 llvm::sys::path::append(ModuleMapFileName, "module_private.map");
1207 if (const FileEntry *PrivateModuleMapFile
1208 = FileMgr.getFile(ModuleMapFileName)) {
Douglas Gregor963c5532013-06-21 16:28:10 +00001209 if (ModMap.parseModuleMapFile(PrivateModuleMapFile, IsSystem)) {
Douglas Gregore7ab3662011-12-07 02:23:45 +00001210 // No suitable module map.
1211 DirectoryHasModuleMap[Dir] = false;
1212 return LMM_InvalidModuleMap;
1213 }
1214 }
1215
1216 return LMM_NewlyLoaded;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001217 }
1218
1219 // No suitable module map.
1220 DirectoryHasModuleMap[Dir] = false;
Douglas Gregor80b69042011-11-12 00:22:19 +00001221 return LMM_InvalidModuleMap;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001222}
Douglas Gregor718292f2011-11-11 19:10:28 +00001223
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001224void HeaderSearch::collectAllModules(SmallVectorImpl<Module *> &Modules) {
Douglas Gregor07f43572012-01-29 18:15:03 +00001225 Modules.clear();
1226
1227 // Load module maps for each of the header search directories.
1228 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
Douglas Gregor963c5532013-06-21 16:28:10 +00001229 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
Douglas Gregor07f43572012-01-29 18:15:03 +00001230 if (SearchDirs[Idx].isFramework()) {
1231 llvm::error_code EC;
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001232 SmallString<128> DirNative;
Douglas Gregor07f43572012-01-29 18:15:03 +00001233 llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1234 DirNative);
1235
1236 // Search each of the ".framework" directories to load them as modules.
Douglas Gregor07f43572012-01-29 18:15:03 +00001237 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1238 Dir != DirEnd && !EC; Dir.increment(EC)) {
1239 if (llvm::sys::path::extension(Dir->path()) != ".framework")
1240 continue;
1241
1242 const DirectoryEntry *FrameworkDir = FileMgr.getDirectory(Dir->path());
1243 if (!FrameworkDir)
1244 continue;
1245
1246 // Load this framework module.
1247 loadFrameworkModule(llvm::sys::path::stem(Dir->path()), FrameworkDir,
1248 IsSystem);
1249 }
1250 continue;
1251 }
1252
1253 // FIXME: Deal with header maps.
1254 if (SearchDirs[Idx].isHeaderMap())
1255 continue;
1256
1257 // Try to load a module map file for the search directory.
Douglas Gregor963c5532013-06-21 16:28:10 +00001258 loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem);
Douglas Gregor07f43572012-01-29 18:15:03 +00001259
1260 // Try to load module map files for immediate subdirectories of this search
1261 // directory.
Douglas Gregor0339a642013-03-21 01:08:50 +00001262 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
Douglas Gregor07f43572012-01-29 18:15:03 +00001263 }
1264
1265 // Populate the list of modules.
1266 for (ModuleMap::module_iterator M = ModMap.module_begin(),
1267 MEnd = ModMap.module_end();
1268 M != MEnd; ++M) {
1269 Modules.push_back(M->getValue());
1270 }
1271}
Douglas Gregor0339a642013-03-21 01:08:50 +00001272
Douglas Gregor64a1fa52013-05-10 22:52:27 +00001273void HeaderSearch::loadTopLevelSystemModules() {
1274 // Load module maps for each of the header search directories.
1275 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
Douglas Gregor299787f2013-11-01 23:08:38 +00001276 // We only care about normal header directories.
1277 if (!SearchDirs[Idx].isNormalDir()) {
Douglas Gregor64a1fa52013-05-10 22:52:27 +00001278 continue;
1279 }
1280
1281 // Try to load a module map file for the search directory.
Douglas Gregor963c5532013-06-21 16:28:10 +00001282 loadModuleMapFile(SearchDirs[Idx].getDir(),
1283 SearchDirs[Idx].isSystemHeaderDirectory());
Douglas Gregor64a1fa52013-05-10 22:52:27 +00001284 }
1285}
1286
Douglas Gregor0339a642013-03-21 01:08:50 +00001287void HeaderSearch::loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir) {
1288 if (SearchDir.haveSearchedAllModuleMaps())
1289 return;
1290
1291 llvm::error_code EC;
1292 SmallString<128> DirNative;
1293 llvm::sys::path::native(SearchDir.getDir()->getName(), DirNative);
1294 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1295 Dir != DirEnd && !EC; Dir.increment(EC)) {
Douglas Gregor963c5532013-06-21 16:28:10 +00001296 loadModuleMapFile(Dir->path(), SearchDir.isSystemHeaderDirectory());
Douglas Gregor0339a642013-03-21 01:08:50 +00001297 }
1298
1299 SearchDir.setSearchedAllModuleMaps(true);
1300}