blob: 259fbd57bb770c2fcac857290bc53c3cc1809e5d [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"
Ben Langmuirbeee15e2014-04-14 18:00:01 +000021#include "llvm/ADT/APInt.h"
22#include "llvm/ADT/Hashing.h"
Chris Lattner43fd42e2006-10-30 03:40:58 +000023#include "llvm/ADT/SmallString.h"
Ted Kremenekae63d102011-07-27 18:41:18 +000024#include "llvm/Support/Capacity.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "llvm/Support/FileSystem.h"
26#include "llvm/Support/Path.h"
Daniel Jasperba7f2f72013-09-24 09:14:14 +000027#include "llvm/Support/raw_ostream.h"
Chris Lattnerc25d8a72009-03-02 22:20:04 +000028#include <cstdio>
Douglas Gregor01c7cfa2013-01-22 23:49:45 +000029#if defined(LLVM_ON_UNIX)
Dmitri Gribenkoeadae012013-01-26 16:29:36 +000030#include <limits.h>
Douglas Gregor01c7cfa2013-01-22 23:49:45 +000031#endif
Chris Lattner59a9ebd2006-10-18 05:34:33 +000032using namespace clang;
33
Douglas Gregor99734e72009-04-25 23:30:02 +000034const IdentifierInfo *
35HeaderFileInfo::getControllingMacro(ExternalIdentifierLookup *External) {
36 if (ControllingMacro)
37 return ControllingMacro;
38
39 if (!ControllingMacroID || !External)
Craig Topperd2d442c2014-05-17 23:10:59 +000040 return nullptr;
Douglas Gregor99734e72009-04-25 23:30:02 +000041
42 ControllingMacro = External->GetIdentifier(ControllingMacroID);
43 return ControllingMacro;
44}
45
Douglas Gregor09b69892011-02-10 17:09:37 +000046ExternalHeaderFileInfoSource::~ExternalHeaderFileInfoSource() {}
47
Dmitri Gribenkof8579502013-01-12 19:30:44 +000048HeaderSearch::HeaderSearch(IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts,
Manuel Klimek1f76c4e2013-10-24 07:51:24 +000049 SourceManager &SourceMgr, DiagnosticsEngine &Diags,
Will Wilson0fafd342013-12-27 19:46:16 +000050 const LangOptions &LangOpts,
Douglas Gregor89929282012-01-30 06:01:29 +000051 const TargetInfo *Target)
Will Wilsonba2f1462013-12-27 20:02:27 +000052 : HSOpts(HSOpts), Diags(Diags), FileMgr(SourceMgr.getFileManager()),
53 FrameworkMap(64), ModMap(SourceMgr, Diags, LangOpts, Target, *this) {
Nico Weber3b1d1212011-05-24 04:31:14 +000054 AngledDirIdx = 0;
Chris Lattner641a0be2006-10-20 06:23:14 +000055 SystemDirIdx = 0;
56 NoCurDirSearch = false;
Mike Stump11289f42009-09-09 15:08:12 +000057
Craig Topperd2d442c2014-05-17 23:10:59 +000058 ExternalLookup = nullptr;
59 ExternalSource = nullptr;
Chris Lattner641a0be2006-10-20 06:23:14 +000060 NumIncluded = 0;
61 NumMultiIncludeFileOptzn = 0;
62 NumFrameworkLookups = NumSubFrameworkLookups = 0;
Argyrios Kyrtzidis9955dbc2013-12-12 16:08:33 +000063
64 EnabledModules = LangOpts.Modules;
Chris Lattner641a0be2006-10-20 06:23:14 +000065}
66
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000067HeaderSearch::~HeaderSearch() {
68 // Delete headermaps.
69 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
70 delete HeaderMaps[i].second;
71}
Mike Stump11289f42009-09-09 15:08:12 +000072
Chris Lattner59a9ebd2006-10-18 05:34:33 +000073void HeaderSearch::PrintStats() {
Chris Lattner23b7eb62007-06-15 23:05:46 +000074 fprintf(stderr, "\n*** HeaderSearch Stats:\n");
75 fprintf(stderr, "%d files tracked.\n", (int)FileInfo.size());
Chris Lattner59a9ebd2006-10-18 05:34:33 +000076 unsigned NumOnceOnlyFiles = 0, MaxNumIncludes = 0, NumSingleIncludedFiles = 0;
77 for (unsigned i = 0, e = FileInfo.size(); i != e; ++i) {
78 NumOnceOnlyFiles += FileInfo[i].isImport;
79 if (MaxNumIncludes < FileInfo[i].NumIncludes)
80 MaxNumIncludes = FileInfo[i].NumIncludes;
81 NumSingleIncludedFiles += FileInfo[i].NumIncludes == 1;
82 }
Chris Lattner23b7eb62007-06-15 23:05:46 +000083 fprintf(stderr, " %d #import/#pragma once files.\n", NumOnceOnlyFiles);
84 fprintf(stderr, " %d included exactly once.\n", NumSingleIncludedFiles);
85 fprintf(stderr, " %d max times a file is included.\n", MaxNumIncludes);
Mike Stump11289f42009-09-09 15:08:12 +000086
Chris Lattner23b7eb62007-06-15 23:05:46 +000087 fprintf(stderr, " %d #include/#include_next/#import.\n", NumIncluded);
88 fprintf(stderr, " %d #includes skipped due to"
89 " the multi-include optimization.\n", NumMultiIncludeFileOptzn);
Mike Stump11289f42009-09-09 15:08:12 +000090
Chris Lattner23b7eb62007-06-15 23:05:46 +000091 fprintf(stderr, "%d framework lookups.\n", NumFrameworkLookups);
92 fprintf(stderr, "%d subframework lookups.\n", NumSubFrameworkLookups);
Chris Lattner59a9ebd2006-10-18 05:34:33 +000093}
94
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000095/// CreateHeaderMap - This method returns a HeaderMap for the specified
Sylvestre Ledru830885c2012-07-23 08:59:39 +000096/// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
Chris Lattner4ffe46c2007-12-17 18:34:53 +000097const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) {
Chris Lattnerc4ba38e2007-12-17 06:36:45 +000098 // We expect the number of headermaps to be small, and almost always empty.
Chris Lattnerf62f7582007-12-17 07:52:39 +000099 // If it ever grows, use of a linear search should be re-evaluated.
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000100 if (!HeaderMaps.empty()) {
101 for (unsigned i = 0, e = HeaderMaps.size(); i != e; ++i)
Chris Lattnerf62f7582007-12-17 07:52:39 +0000102 // Pointer equality comparison of FileEntries works because they are
103 // already uniqued by inode.
Mike Stump11289f42009-09-09 15:08:12 +0000104 if (HeaderMaps[i].first == FE)
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000105 return HeaderMaps[i].second;
106 }
Mike Stump11289f42009-09-09 15:08:12 +0000107
Chris Lattner5159f612010-11-23 08:35:12 +0000108 if (const HeaderMap *HM = HeaderMap::Create(FE, FileMgr)) {
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000109 HeaderMaps.push_back(std::make_pair(FE, HM));
110 return HM;
111 }
Mike Stump11289f42009-09-09 15:08:12 +0000112
Craig Topperd2d442c2014-05-17 23:10:59 +0000113 return nullptr;
Chris Lattnerc4ba38e2007-12-17 06:36:45 +0000114}
115
Douglas Gregor279a6c32012-01-29 17:08:11 +0000116std::string HeaderSearch::getModuleFileName(Module *Module) {
Ben Langmuir9d6448b2014-08-09 00:57:23 +0000117 const FileEntry *ModuleMap =
118 getModuleMap().getModuleMapFileForUniquing(Module);
119 return getModuleFileName(Module->Name, ModuleMap->getName());
Douglas Gregor279a6c32012-01-29 17:08:11 +0000120}
121
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000122std::string HeaderSearch::getModuleFileName(StringRef ModuleName,
123 StringRef ModuleMapPath) {
Douglas Gregor279a6c32012-01-29 17:08:11 +0000124 // If we don't have a module cache path, we can't do anything.
125 if (ModuleCachePath.empty())
126 return std::string();
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000127
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000128 SmallString<256> Result(ModuleCachePath);
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000129 llvm::sys::fs::make_absolute(Result);
130
131 if (HSOpts->DisableModuleHash) {
132 llvm::sys::path::append(Result, ModuleName + ".pcm");
133 } else {
134 // Construct the name <ModuleName>-<hash of ModuleMapPath>.pcm which should
135 // be globally unique to this particular module. To avoid false-negatives
136 // on case-insensitive filesystems, we use lower-case, which is safe because
137 // to cause a collision the modules must have the same name, which is an
138 // error if they are imported in the same translation.
139 SmallString<256> AbsModuleMapPath(ModuleMapPath);
140 llvm::sys::fs::make_absolute(AbsModuleMapPath);
141 llvm::APInt Code(64, llvm::hash_value(AbsModuleMapPath.str().lower()));
142 SmallString<128> HashStr;
143 Code.toStringUnsigned(HashStr, /*Radix*/36);
144 llvm::sys::path::append(Result, ModuleName + "-" + HashStr.str() + ".pcm");
145 }
Douglas Gregor279a6c32012-01-29 17:08:11 +0000146 return Result.str().str();
147}
148
149Module *HeaderSearch::lookupModule(StringRef ModuleName, bool AllowSearch) {
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000150 // Look in the module map to determine if there is a module by this name.
Douglas Gregor279a6c32012-01-29 17:08:11 +0000151 Module *Module = ModMap.findModule(ModuleName);
152 if (Module || !AllowSearch)
153 return Module;
154
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000155 // Look through the various header search paths to load any available module
Douglas Gregor279a6c32012-01-29 17:08:11 +0000156 // maps, searching for a module map that describes this module.
157 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
158 if (SearchDirs[Idx].isFramework()) {
159 // Search for or infer a module map for a framework.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000160 SmallString<128> FrameworkDirName;
Douglas Gregor279a6c32012-01-29 17:08:11 +0000161 FrameworkDirName += SearchDirs[Idx].getFrameworkDir()->getName();
162 llvm::sys::path::append(FrameworkDirName, ModuleName + ".framework");
163 if (const DirectoryEntry *FrameworkDir
164 = FileMgr.getDirectory(FrameworkDirName)) {
165 bool IsSystem
166 = SearchDirs[Idx].getDirCharacteristic() != SrcMgr::C_User;
167 Module = loadFrameworkModule(ModuleName, FrameworkDir, IsSystem);
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000168 if (Module)
169 break;
170 }
Douglas Gregor279a6c32012-01-29 17:08:11 +0000171 }
172
173 // FIXME: Figure out how header maps and module maps will work together.
174
175 // Only deal with normal search directories.
176 if (!SearchDirs[Idx].isNormalDir())
177 continue;
Douglas Gregor963c5532013-06-21 16:28:10 +0000178
179 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
Douglas Gregor279a6c32012-01-29 17:08:11 +0000180 // Search for a module map file in this directory.
Ben Langmuir984e1df2014-03-19 20:23:34 +0000181 if (loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem,
182 /*IsFramework*/false) == LMM_NewlyLoaded) {
Douglas Gregor279a6c32012-01-29 17:08:11 +0000183 // We just loaded a module map file; check whether the module is
184 // available now.
185 Module = ModMap.findModule(ModuleName);
186 if (Module)
187 break;
188 }
189
190 // Search for a module map in a subdirectory with the same name as the
191 // module.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000192 SmallString<128> NestedModuleMapDirName;
Douglas Gregor279a6c32012-01-29 17:08:11 +0000193 NestedModuleMapDirName = SearchDirs[Idx].getDir()->getName();
194 llvm::sys::path::append(NestedModuleMapDirName, ModuleName);
Ben Langmuir984e1df2014-03-19 20:23:34 +0000195 if (loadModuleMapFile(NestedModuleMapDirName, IsSystem,
196 /*IsFramework*/false) == LMM_NewlyLoaded){
Douglas Gregor279a6c32012-01-29 17:08:11 +0000197 // If we just loaded a module map file, look for the module again.
198 Module = ModMap.findModule(ModuleName);
199 if (Module)
200 break;
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000201 }
Douglas Gregor0339a642013-03-21 01:08:50 +0000202
203 // If we've already performed the exhaustive search for module maps in this
204 // search directory, don't do it again.
205 if (SearchDirs[Idx].haveSearchedAllModuleMaps())
206 continue;
207
208 // Load all module maps in the immediate subdirectories of this search
209 // directory.
210 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
211
212 // Look again for the module.
213 Module = ModMap.findModule(ModuleName);
214 if (Module)
215 break;
Douglas Gregoraf28ec82011-11-12 00:05:07 +0000216 }
Douglas Gregor0339a642013-03-21 01:08:50 +0000217
Douglas Gregor279a6c32012-01-29 17:08:11 +0000218 return Module;
Douglas Gregor1e44e022011-09-12 20:41:59 +0000219}
220
Chris Lattnerf62f7582007-12-17 07:52:39 +0000221//===----------------------------------------------------------------------===//
222// File lookup within a DirectoryLookup scope
223//===----------------------------------------------------------------------===//
224
Chris Lattner8d720d02007-12-17 17:57:27 +0000225/// getName - Return the directory or filename corresponding to this lookup
226/// object.
227const char *DirectoryLookup::getName() const {
228 if (isNormalDir())
229 return getDir()->getName();
230 if (isFramework())
231 return getFrameworkDir()->getName();
232 assert(isHeaderMap() && "Unknown DirectoryLookup");
233 return getHeaderMap()->getFileName();
234}
235
Richard Smith8c71eba2014-03-05 20:51:45 +0000236static const FileEntry *
237getFileAndSuggestModule(HeaderSearch &HS, StringRef FileName,
238 const DirectoryEntry *Dir, bool IsSystemHeaderDir,
239 ModuleMap::KnownHeader *SuggestedModule) {
240 // If we have a module map that might map this header, load it and
241 // check whether we'll have a suggestion for a module.
242 HS.hasModuleMap(FileName, Dir, IsSystemHeaderDir);
243 if (SuggestedModule) {
244 const FileEntry *File = HS.getFileMgr().getFile(FileName,
245 /*OpenFile=*/false);
246 if (File) {
247 // If there is a module that corresponds to this header, suggest it.
248 *SuggestedModule = HS.findModuleForHeader(File);
249
250 // FIXME: This appears to be a no-op. We loaded the module map for this
251 // directory at the start of this function.
252 if (!SuggestedModule->getModule() &&
253 HS.hasModuleMap(FileName, Dir, IsSystemHeaderDir))
254 *SuggestedModule = HS.findModuleForHeader(File);
255 }
256
257 return File;
258 }
259
260 return HS.getFileMgr().getFile(FileName, /*openFile=*/true);
261}
Chris Lattner8d720d02007-12-17 17:57:27 +0000262
Chris Lattnerf62f7582007-12-17 07:52:39 +0000263/// LookupFile - Lookup the specified file in this search path, returning it
264/// if it exists or returning null if not.
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000265const FileEntry *DirectoryLookup::LookupFile(
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000266 StringRef &Filename,
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000267 HeaderSearch &HS,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000268 SmallVectorImpl<char> *SearchPath,
Douglas Gregor97eec242011-09-15 22:00:41 +0000269 SmallVectorImpl<char> *RelativePath,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000270 ModuleMap::KnownHeader *SuggestedModule,
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000271 bool &InUserSpecifiedSystemFramework,
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000272 bool &HasBeenMapped,
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000273 SmallVectorImpl<char> &MappedName) const {
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000274 InUserSpecifiedSystemFramework = false;
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000275 HasBeenMapped = false;
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000276
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000277 SmallString<1024> TmpDir;
Chris Lattner712e3872007-12-17 08:13:48 +0000278 if (isNormalDir()) {
279 // Concatenate the requested file onto the directory.
Eli Friedmanf7ca26a2011-07-08 20:17:28 +0000280 TmpDir = getDir()->getName();
281 llvm::sys::path::append(TmpDir, Filename);
Craig Topperd2d442c2014-05-17 23:10:59 +0000282 if (SearchPath) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000283 StringRef SearchPathRef(getDir()->getName());
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000284 SearchPath->clear();
285 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
286 }
Craig Topperd2d442c2014-05-17 23:10:59 +0000287 if (RelativePath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000288 RelativePath->clear();
289 RelativePath->append(Filename.begin(), Filename.end());
290 }
Richard Smith8c71eba2014-03-05 20:51:45 +0000291
292 return getFileAndSuggestModule(HS, TmpDir.str(), getDir(),
293 isSystemHeaderDirectory(),
294 SuggestedModule);
Chris Lattner712e3872007-12-17 08:13:48 +0000295 }
Mike Stump11289f42009-09-09 15:08:12 +0000296
Chris Lattner712e3872007-12-17 08:13:48 +0000297 if (isFramework())
Douglas Gregor97eec242011-09-15 22:00:41 +0000298 return DoFrameworkLookup(Filename, HS, SearchPath, RelativePath,
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000299 SuggestedModule, InUserSpecifiedSystemFramework);
Mike Stump11289f42009-09-09 15:08:12 +0000300
Chris Lattner44bd21b2007-12-17 08:17:39 +0000301 assert(isHeaderMap() && "Unknown directory lookup");
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000302 const HeaderMap *HM = getHeaderMap();
303 SmallString<1024> Path;
304 StringRef Dest = HM->lookupFilename(Filename, Path);
305 if (Dest.empty())
Craig Topperd2d442c2014-05-17 23:10:59 +0000306 return nullptr;
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000307
308 const FileEntry *Result;
309
310 // Check if the headermap maps the filename to a framework include
311 // ("Foo.h" -> "Foo/Foo.h"), in which case continue header lookup using the
312 // framework include.
313 if (llvm::sys::path::is_relative(Dest)) {
314 MappedName.clear();
315 MappedName.append(Dest.begin(), Dest.end());
316 Filename = StringRef(MappedName.begin(), MappedName.size());
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000317 HasBeenMapped = true;
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000318 Result = HM->LookupFile(Filename, HS.getFileMgr());
319
320 } else {
321 Result = HS.getFileMgr().getFile(Dest);
322 }
323
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000324 if (Result) {
Craig Topperd2d442c2014-05-17 23:10:59 +0000325 if (SearchPath) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000326 StringRef SearchPathRef(getName());
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000327 SearchPath->clear();
328 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
329 }
Craig Topperd2d442c2014-05-17 23:10:59 +0000330 if (RelativePath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000331 RelativePath->clear();
332 RelativePath->append(Filename.begin(), Filename.end());
333 }
334 }
335 return Result;
Chris Lattnerf62f7582007-12-17 07:52:39 +0000336}
337
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000338/// \brief Given a framework directory, find the top-most framework directory.
339///
340/// \param FileMgr The file manager to use for directory lookups.
341/// \param DirName The name of the framework directory.
342/// \param SubmodulePath Will be populated with the submodule path from the
343/// returned top-level module to the originally named framework.
344static const DirectoryEntry *
345getTopFrameworkDir(FileManager &FileMgr, StringRef DirName,
346 SmallVectorImpl<std::string> &SubmodulePath) {
347 assert(llvm::sys::path::extension(DirName) == ".framework" &&
348 "Not a framework directory");
349
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000350 // Note: as an egregious but useful hack we use the real path here, because
351 // frameworks moving between top-level frameworks to embedded frameworks tend
352 // to be symlinked, and we base the logical structure of modules on the
353 // physical layout. In particular, we need to deal with crazy includes like
354 //
355 // #include <Foo/Frameworks/Bar.framework/Headers/Wibble.h>
356 //
357 // where 'Bar' used to be embedded in 'Foo', is now a top-level framework
358 // which one should access with, e.g.,
359 //
360 // #include <Bar/Wibble.h>
361 //
362 // Similar issues occur when a top-level framework has moved into an
363 // embedded framework.
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000364 const DirectoryEntry *TopFrameworkDir = FileMgr.getDirectory(DirName);
Douglas Gregore00c8b22013-01-26 00:55:12 +0000365 DirName = FileMgr.getCanonicalName(TopFrameworkDir);
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000366 do {
367 // Get the parent directory name.
368 DirName = llvm::sys::path::parent_path(DirName);
369 if (DirName.empty())
370 break;
371
372 // Determine whether this directory exists.
373 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
374 if (!Dir)
375 break;
376
377 // If this is a framework directory, then we're a subframework of this
378 // framework.
379 if (llvm::sys::path::extension(DirName) == ".framework") {
380 SubmodulePath.push_back(llvm::sys::path::stem(DirName));
381 TopFrameworkDir = Dir;
382 }
383 } while (true);
384
385 return TopFrameworkDir;
386}
Chris Lattnerf62f7582007-12-17 07:52:39 +0000387
Chris Lattner712e3872007-12-17 08:13:48 +0000388/// DoFrameworkLookup - Do a lookup of the specified file in the current
389/// DirectoryLookup, which is a framework directory.
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000390const FileEntry *DirectoryLookup::DoFrameworkLookup(
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000391 StringRef Filename,
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000392 HeaderSearch &HS,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000393 SmallVectorImpl<char> *SearchPath,
Douglas Gregor97eec242011-09-15 22:00:41 +0000394 SmallVectorImpl<char> *RelativePath,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000395 ModuleMap::KnownHeader *SuggestedModule,
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000396 bool &InUserSpecifiedSystemFramework) const
Douglas Gregor97eec242011-09-15 22:00:41 +0000397{
Chris Lattner712e3872007-12-17 08:13:48 +0000398 FileManager &FileMgr = HS.getFileMgr();
Mike Stump11289f42009-09-09 15:08:12 +0000399
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000400 // Framework names must have a '/' in the filename.
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000401 size_t SlashPos = Filename.find('/');
Craig Topperd2d442c2014-05-17 23:10:59 +0000402 if (SlashPos == StringRef::npos) return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000403
Chris Lattner712e3872007-12-17 08:13:48 +0000404 // Find out if this is the home for the specified framework, by checking
Daniel Dunbar17138612012-04-05 17:09:40 +0000405 // HeaderSearch. Possible answers are yes/no and unknown.
406 HeaderSearch::FrameworkCacheEntry &CacheEntry =
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000407 HS.LookupFrameworkCache(Filename.substr(0, SlashPos));
Mike Stump11289f42009-09-09 15:08:12 +0000408
Chris Lattner712e3872007-12-17 08:13:48 +0000409 // If it is known and in some other directory, fail.
Daniel Dunbar17138612012-04-05 17:09:40 +0000410 if (CacheEntry.Directory && CacheEntry.Directory != getFrameworkDir())
Craig Topperd2d442c2014-05-17 23:10:59 +0000411 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000412
Chris Lattner712e3872007-12-17 08:13:48 +0000413 // Otherwise, construct the path to this framework dir.
Mike Stump11289f42009-09-09 15:08:12 +0000414
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000415 // FrameworkName = "/System/Library/Frameworks/"
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000416 SmallString<1024> FrameworkName;
Chris Lattner712e3872007-12-17 08:13:48 +0000417 FrameworkName += getFrameworkDir()->getName();
Chris Lattnerb201d9b2006-10-30 05:09:49 +0000418 if (FrameworkName.empty() || FrameworkName.back() != '/')
419 FrameworkName.push_back('/');
Mike Stump11289f42009-09-09 15:08:12 +0000420
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000421 // FrameworkName = "/System/Library/Frameworks/Cocoa"
Douglas Gregor56c64012011-11-17 01:41:17 +0000422 StringRef ModuleName(Filename.begin(), SlashPos);
423 FrameworkName += ModuleName;
Mike Stump11289f42009-09-09 15:08:12 +0000424
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000425 // FrameworkName = "/System/Library/Frameworks/Cocoa.framework/"
426 FrameworkName += ".framework/";
Mike Stump11289f42009-09-09 15:08:12 +0000427
Daniel Dunbar17138612012-04-05 17:09:40 +0000428 // If the cache entry was unresolved, populate it now.
Craig Topperd2d442c2014-05-17 23:10:59 +0000429 if (!CacheEntry.Directory) {
Chris Lattner712e3872007-12-17 08:13:48 +0000430 HS.IncrementFrameworkLookupCount();
Mike Stump11289f42009-09-09 15:08:12 +0000431
Chris Lattner5ed76da2006-10-22 07:24:13 +0000432 // If the framework dir doesn't exist, we fail.
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000433 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
Craig Topperd2d442c2014-05-17 23:10:59 +0000434 if (!Dir) return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000435
Chris Lattner5ed76da2006-10-22 07:24:13 +0000436 // Otherwise, if it does, remember that this is the right direntry for this
437 // framework.
Daniel Dunbar17138612012-04-05 17:09:40 +0000438 CacheEntry.Directory = getFrameworkDir();
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000439
440 // If this is a user search directory, check if the framework has been
441 // user-specified as a system framework.
442 if (getDirCharacteristic() == SrcMgr::C_User) {
443 SmallString<1024> SystemFrameworkMarker(FrameworkName);
444 SystemFrameworkMarker += ".system_framework";
445 if (llvm::sys::fs::exists(SystemFrameworkMarker.str())) {
446 CacheEntry.IsUserSpecifiedSystemFramework = true;
447 }
448 }
Chris Lattner5ed76da2006-10-22 07:24:13 +0000449 }
Mike Stump11289f42009-09-09 15:08:12 +0000450
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000451 // Set the 'user-specified system framework' flag.
452 InUserSpecifiedSystemFramework = CacheEntry.IsUserSpecifiedSystemFramework;
453
Craig Topperd2d442c2014-05-17 23:10:59 +0000454 if (RelativePath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000455 RelativePath->clear();
456 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
457 }
Douglas Gregor56c64012011-11-17 01:41:17 +0000458
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000459 // Check "/System/Library/Frameworks/Cocoa.framework/Headers/file.h"
Chris Lattnerb201d9b2006-10-30 05:09:49 +0000460 unsigned OrigSize = FrameworkName.size();
Mike Stump11289f42009-09-09 15:08:12 +0000461
Chris Lattnerb201d9b2006-10-30 05:09:49 +0000462 FrameworkName += "Headers/";
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000463
Craig Topperd2d442c2014-05-17 23:10:59 +0000464 if (SearchPath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000465 SearchPath->clear();
466 // Without trailing '/'.
467 SearchPath->append(FrameworkName.begin(), FrameworkName.end()-1);
468 }
469
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000470 FrameworkName.append(Filename.begin()+SlashPos+1, Filename.end());
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000471 const FileEntry *FE = FileMgr.getFile(FrameworkName.str(),
472 /*openFile=*/!SuggestedModule);
473 if (!FE) {
474 // Check "/System/Library/Frameworks/Cocoa.framework/PrivateHeaders/file.h"
475 const char *Private = "Private";
476 FrameworkName.insert(FrameworkName.begin()+OrigSize, Private,
477 Private+strlen(Private));
Craig Topperd2d442c2014-05-17 23:10:59 +0000478 if (SearchPath)
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000479 SearchPath->insert(SearchPath->begin()+OrigSize, Private,
480 Private+strlen(Private));
481
482 FE = FileMgr.getFile(FrameworkName.str(), /*openFile=*/!SuggestedModule);
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000483 }
Mike Stump11289f42009-09-09 15:08:12 +0000484
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000485 // If we found the header and are allowed to suggest a module, do so now.
486 if (FE && SuggestedModule) {
487 // Find the framework in which this header occurs.
Ben Langmuiref914b82014-05-15 16:20:33 +0000488 StringRef FrameworkPath = FE->getDir()->getName();
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000489 bool FoundFramework = false;
490 do {
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000491 // Determine whether this directory exists.
492 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkPath);
493 if (!Dir)
494 break;
495
496 // If this is a framework directory, then we're a subframework of this
497 // framework.
498 if (llvm::sys::path::extension(FrameworkPath) == ".framework") {
499 FoundFramework = true;
500 break;
501 }
Ben Langmuiref914b82014-05-15 16:20:33 +0000502
503 // Get the parent directory name.
504 FrameworkPath = llvm::sys::path::parent_path(FrameworkPath);
505 if (FrameworkPath.empty())
506 break;
Douglas Gregor4ddf2222013-01-10 01:43:00 +0000507 } while (true);
508
509 if (FoundFramework) {
510 // Find the top-level framework based on this framework.
511 SmallVector<std::string, 4> SubmodulePath;
512 const DirectoryEntry *TopFrameworkDir
513 = ::getTopFrameworkDir(FileMgr, FrameworkPath, SubmodulePath);
514
515 // Determine the name of the top-level framework.
516 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
517
518 // Load this framework module. If that succeeds, find the suggested module
519 // for this header, if any.
520 bool IsSystem = getDirCharacteristic() != SrcMgr::C_User;
521 if (HS.loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
522 *SuggestedModule = HS.findModuleForHeader(FE);
523 }
524 } else {
525 *SuggestedModule = HS.findModuleForHeader(FE);
526 }
527 }
Douglas Gregor97eec242011-09-15 22:00:41 +0000528 return FE;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000529}
530
Douglas Gregor89929282012-01-30 06:01:29 +0000531void HeaderSearch::setTarget(const TargetInfo &Target) {
532 ModMap.setTarget(Target);
533}
534
Chris Lattnerf62f7582007-12-17 07:52:39 +0000535
Chris Lattner712e3872007-12-17 08:13:48 +0000536//===----------------------------------------------------------------------===//
537// Header File Location.
538//===----------------------------------------------------------------------===//
539
Reid Klecknera97d4c02014-02-18 23:49:24 +0000540/// \brief Return true with a diagnostic if the file that MSVC would have found
541/// fails to match the one that Clang would have found with MSVC header search
542/// disabled.
543static bool checkMSVCHeaderSearch(DiagnosticsEngine &Diags,
544 const FileEntry *MSFE, const FileEntry *FE,
545 SourceLocation IncludeLoc) {
546 if (MSFE && FE != MSFE) {
547 Diags.Report(IncludeLoc, diag::ext_pp_include_search_ms) << MSFE->getName();
548 return true;
549 }
550 return false;
551}
Chris Lattner712e3872007-12-17 08:13:48 +0000552
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000553static const char *copyString(StringRef Str, llvm::BumpPtrAllocator &Alloc) {
554 assert(!Str.empty());
555 char *CopyStr = Alloc.Allocate<char>(Str.size()+1);
556 std::copy(Str.begin(), Str.end(), CopyStr);
557 CopyStr[Str.size()] = '\0';
558 return CopyStr;
559}
560
James Dennettc07ab2c2012-06-20 00:56:32 +0000561/// LookupFile - Given a "foo" or \<foo> reference, look up the indicated file,
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000562/// return null on failure. isAngled indicates whether the file reference is
Will Wilson0fafd342013-12-27 19:46:16 +0000563/// for system \#include's or not (i.e. using <> instead of ""). Includers, if
564/// non-empty, indicates where the \#including file(s) are, in case a relative
565/// search is needed. Microsoft mode will pass all \#including files.
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000566const FileEntry *HeaderSearch::LookupFile(
Will Wilson0fafd342013-12-27 19:46:16 +0000567 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
568 const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir,
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000569 ArrayRef<std::pair<const FileEntry *, const DirectoryEntry *>> Includers,
570 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
Will Wilson0fafd342013-12-27 19:46:16 +0000571 ModuleMap::KnownHeader *SuggestedModule, bool SkipCache) {
Daniel Jasper97da9172013-10-22 08:09:47 +0000572 if (!HSOpts->ModuleMapFiles.empty()) {
573 // Preload all explicitly specified module map files. This enables modules
574 // map files lying in a directory structure separate from the header files
575 // that they describe. These cannot be loaded lazily upon encountering a
Will Wilson9ef61a72013-12-19 16:24:17 +0000576 // header file, as there is no other known mapping from a header file to its
Daniel Jasper97da9172013-10-22 08:09:47 +0000577 // module map file.
Richard Smithd963ca62014-10-17 01:26:52 +0000578 for (const auto &Filename : HSOpts->ModuleMapFiles)
579 if (const FileEntry *File = FileMgr.getFile(Filename))
580 loadModuleMapFile(File, /*IsSystem=*/false);
Daniel Jasper97da9172013-10-22 08:09:47 +0000581 HSOpts->ModuleMapFiles.clear();
582 }
583
Douglas Gregor97eec242011-09-15 22:00:41 +0000584 if (SuggestedModule)
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000585 *SuggestedModule = ModuleMap::KnownHeader();
Douglas Gregor97eec242011-09-15 22:00:41 +0000586
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000587 // If 'Filename' is absolute, check to see if it exists and no searching.
Michael J. Spencerf28df4c2010-12-17 21:22:22 +0000588 if (llvm::sys::path::is_absolute(Filename)) {
Craig Topperd2d442c2014-05-17 23:10:59 +0000589 CurDir = nullptr;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000590
591 // If this was an #include_next "/absolute/file", fail.
Craig Topperd2d442c2014-05-17 23:10:59 +0000592 if (FromDir) return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000593
Craig Topperd2d442c2014-05-17 23:10:59 +0000594 if (SearchPath)
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000595 SearchPath->clear();
Craig Topperd2d442c2014-05-17 23:10:59 +0000596 if (RelativePath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000597 RelativePath->clear();
598 RelativePath->append(Filename.begin(), Filename.end());
599 }
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000600 // Otherwise, just return the file.
Argyrios Kyrtzidisd6278e32011-03-16 19:17:25 +0000601 return FileMgr.getFile(Filename, /*openFile=*/true);
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000602 }
Mike Stump11289f42009-09-09 15:08:12 +0000603
Reid Klecknera97d4c02014-02-18 23:49:24 +0000604 // This is the header that MSVC's header search would have found.
Craig Topperd2d442c2014-05-17 23:10:59 +0000605 const FileEntry *MSFE = nullptr;
Richard Smith8c71eba2014-03-05 20:51:45 +0000606 ModuleMap::KnownHeader MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000607
Douglas Gregor9f93e382011-07-28 04:45:53 +0000608 // Unless disabled, check to see if the file is in the #includer's
Will Wilson0fafd342013-12-27 19:46:16 +0000609 // directory. This cannot be based on CurDir, because each includer could be
610 // a #include of a subdirectory (#include "foo/bar.h") and a subsequent
611 // include of "baz.h" should resolve to "whatever/foo/baz.h".
Chris Lattnerf62f7582007-12-17 07:52:39 +0000612 // This search is not done for <> headers.
Will Wilson0fafd342013-12-27 19:46:16 +0000613 if (!Includers.empty() && !isAngled && !NoCurDirSearch) {
NAKAMURA Takumi9cb62642013-12-10 02:36:28 +0000614 SmallString<1024> TmpDir;
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000615 bool First = true;
616 for (const auto &IncluderAndDir : Includers) {
617 const FileEntry *Includer = IncluderAndDir.first;
618
Will Wilson0fafd342013-12-27 19:46:16 +0000619 // Concatenate the requested file onto the directory.
620 // FIXME: Portability. Filename concatenation should be in sys::Path.
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000621 TmpDir = IncluderAndDir.second->getName();
Will Wilson0fafd342013-12-27 19:46:16 +0000622 TmpDir.push_back('/');
623 TmpDir.append(Filename.begin(), Filename.end());
Richard Smith8c71eba2014-03-05 20:51:45 +0000624
Richard Smith6f548ec2014-03-06 18:08:08 +0000625 // FIXME: We don't cache the result of getFileInfo across the call to
626 // getFileAndSuggestModule, because it's a reference to an element of
627 // a container that could be reallocated across this call.
628 bool IncluderIsSystemHeader =
629 getFileInfo(Includer).DirInfo != SrcMgr::C_User;
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000630 if (const FileEntry *FE = getFileAndSuggestModule(
631 *this, TmpDir.str(), IncluderAndDir.second,
632 IncluderIsSystemHeader, SuggestedModule)) {
Will Wilson0fafd342013-12-27 19:46:16 +0000633 // Leave CurDir unset.
634 // This file is a system header or C++ unfriendly if the old file is.
635 //
636 // Note that we only use one of FromHFI/ToHFI at once, due to potential
637 // reallocation of the underlying vector potentially making the first
638 // reference binding dangling.
Richard Smith6f548ec2014-03-06 18:08:08 +0000639 HeaderFileInfo &FromHFI = getFileInfo(Includer);
Will Wilson0fafd342013-12-27 19:46:16 +0000640 unsigned DirInfo = FromHFI.DirInfo;
641 bool IndexHeaderMapHeader = FromHFI.IndexHeaderMapHeader;
642 StringRef Framework = FromHFI.Framework;
Douglas Gregor03b5ebe2012-08-13 15:47:39 +0000643
Will Wilson0fafd342013-12-27 19:46:16 +0000644 HeaderFileInfo &ToHFI = getFileInfo(FE);
645 ToHFI.DirInfo = DirInfo;
646 ToHFI.IndexHeaderMapHeader = IndexHeaderMapHeader;
647 ToHFI.Framework = Framework;
Douglas Gregor03b5ebe2012-08-13 15:47:39 +0000648
Craig Topperd2d442c2014-05-17 23:10:59 +0000649 if (SearchPath) {
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000650 StringRef SearchPathRef(IncluderAndDir.second->getName());
Will Wilson0fafd342013-12-27 19:46:16 +0000651 SearchPath->clear();
652 SearchPath->append(SearchPathRef.begin(), SearchPathRef.end());
653 }
Craig Topperd2d442c2014-05-17 23:10:59 +0000654 if (RelativePath) {
Will Wilson0fafd342013-12-27 19:46:16 +0000655 RelativePath->clear();
656 RelativePath->append(Filename.begin(), Filename.end());
657 }
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000658 if (First)
Reid Klecknera97d4c02014-02-18 23:49:24 +0000659 return FE;
660
661 // Otherwise, we found the path via MSVC header search rules. If
662 // -Wmsvc-include is enabled, we have to keep searching to see if we
663 // would've found this header in -I or -isystem directories.
Alp Tokerd4a3f0e2014-06-15 23:30:39 +0000664 if (Diags.isIgnored(diag::ext_pp_include_search_ms, IncludeLoc)) {
Reid Klecknera97d4c02014-02-18 23:49:24 +0000665 return FE;
666 } else {
667 MSFE = FE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000668 if (SuggestedModule) {
669 MSSuggestedModule = *SuggestedModule;
670 *SuggestedModule = ModuleMap::KnownHeader();
671 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000672 break;
673 }
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000674 }
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000675 First = false;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000676 }
677 }
Mike Stump11289f42009-09-09 15:08:12 +0000678
Craig Topperd2d442c2014-05-17 23:10:59 +0000679 CurDir = nullptr;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000680
681 // If this is a system #include, ignore the user #include locs.
Nico Weber3b1d1212011-05-24 04:31:14 +0000682 unsigned i = isAngled ? AngledDirIdx : 0;
Mike Stump11289f42009-09-09 15:08:12 +0000683
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000684 // If this is a #include_next request, start searching after the directory the
685 // file was found in.
686 if (FromDir)
687 i = FromDir-&SearchDirs[0];
Mike Stump11289f42009-09-09 15:08:12 +0000688
Chris Lattnerd4275422007-07-22 07:28:00 +0000689 // Cache all of the lookups performed by this method. Many headers are
690 // multiply included, and the "pragma once" optimization prevents them from
691 // being relex/pp'd, but they would still have to search through a
692 // (potentially huge) series of SearchDirs to find it.
David Blaikie13156b62014-11-19 03:06:06 +0000693 LookupFileCacheInfo &CacheLookup = LookupFileCache[Filename];
Chris Lattnerd4275422007-07-22 07:28:00 +0000694
695 // If the entry has been previously looked up, the first value will be
696 // non-zero. If the value is equal to i (the start point of our search), then
697 // this is a matching hit.
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000698 if (!SkipCache && CacheLookup.StartIdx == i+1) {
Chris Lattnerd4275422007-07-22 07:28:00 +0000699 // Skip querying potentially lots of directories for this lookup.
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000700 i = CacheLookup.HitIdx;
701 if (CacheLookup.MappedName)
702 Filename = CacheLookup.MappedName;
Chris Lattnerd4275422007-07-22 07:28:00 +0000703 } else {
704 // Otherwise, this is the first query, or the previous query didn't match
705 // our search start. We will fill in our found location below, so prime the
706 // start point value.
Argyrios Kyrtzidis7bd78a92014-03-29 03:22:54 +0000707 CacheLookup.reset(/*StartIdx=*/i+1);
Chris Lattnerd4275422007-07-22 07:28:00 +0000708 }
Mike Stump11289f42009-09-09 15:08:12 +0000709
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000710 SmallString<64> MappedName;
711
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000712 // Check each directory in sequence to see if it contains this file.
713 for (; i != SearchDirs.size(); ++i) {
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000714 bool InUserSpecifiedSystemFramework = false;
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000715 bool HasBeenMapped = false;
Mike Stump11289f42009-09-09 15:08:12 +0000716 const FileEntry *FE =
Douglas Gregor97eec242011-09-15 22:00:41 +0000717 SearchDirs[i].LookupFile(Filename, *this, SearchPath, RelativePath,
Argyrios Kyrtzidis75fa9ed2014-02-14 14:58:28 +0000718 SuggestedModule, InUserSpecifiedSystemFramework,
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000719 HasBeenMapped, MappedName);
720 if (HasBeenMapped) {
721 CacheLookup.MappedName =
722 copyString(Filename, LookupFileCache.getAllocator());
723 }
Chris Lattner712e3872007-12-17 08:13:48 +0000724 if (!FE) continue;
Mike Stump11289f42009-09-09 15:08:12 +0000725
Chris Lattner712e3872007-12-17 08:13:48 +0000726 CurDir = &SearchDirs[i];
Mike Stump11289f42009-09-09 15:08:12 +0000727
Chris Lattner712e3872007-12-17 08:13:48 +0000728 // This file is a system header or C++ unfriendly if the dir is.
Douglas Gregor9f93e382011-07-28 04:45:53 +0000729 HeaderFileInfo &HFI = getFileInfo(FE);
730 HFI.DirInfo = CurDir->getDirCharacteristic();
Mike Stump11289f42009-09-09 15:08:12 +0000731
Daniel Dunbar3c9bc4d2012-04-05 17:10:06 +0000732 // If the directory characteristic is User but this framework was
733 // user-specified to be treated as a system framework, promote the
734 // characteristic.
735 if (HFI.DirInfo == SrcMgr::C_User && InUserSpecifiedSystemFramework)
736 HFI.DirInfo = SrcMgr::C_System;
737
Richard Smith8acadcb2012-06-13 20:27:03 +0000738 // If the filename matches a known system header prefix, override
739 // whether the file is a system header.
Richard Trieu871f5f32012-06-13 20:52:36 +0000740 for (unsigned j = SystemHeaderPrefixes.size(); j; --j) {
741 if (Filename.startswith(SystemHeaderPrefixes[j-1].first)) {
742 HFI.DirInfo = SystemHeaderPrefixes[j-1].second ? SrcMgr::C_System
Richard Smith8acadcb2012-06-13 20:27:03 +0000743 : SrcMgr::C_User;
744 break;
745 }
746 }
747
Douglas Gregor9f93e382011-07-28 04:45:53 +0000748 // If this file is found in a header map and uses the framework style of
749 // includes, then this header is part of a framework we're building.
750 if (CurDir->isIndexHeaderMap()) {
751 size_t SlashPos = Filename.find('/');
752 if (SlashPos != StringRef::npos) {
753 HFI.IndexHeaderMapHeader = 1;
754 HFI.Framework = getUniqueFrameworkName(StringRef(Filename.begin(),
755 SlashPos));
756 }
757 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000758
Richard Smith8c71eba2014-03-05 20:51:45 +0000759 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc)) {
760 if (SuggestedModule)
761 *SuggestedModule = MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000762 return MSFE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000763 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000764
Chris Lattner712e3872007-12-17 08:13:48 +0000765 // Remember this location for the next lookup we do.
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000766 CacheLookup.HitIdx = i;
Chris Lattner712e3872007-12-17 08:13:48 +0000767 return FE;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000768 }
Mike Stump11289f42009-09-09 15:08:12 +0000769
Douglas Gregord8575e12011-07-30 06:28:34 +0000770 // If we are including a file with a quoted include "foo.h" from inside
771 // a header in a framework that is currently being built, and we couldn't
772 // resolve "foo.h" any other way, change the include to <Foo/foo.h>, where
773 // "Foo" is the name of the framework in which the including header was found.
Will Wilson0fafd342013-12-27 19:46:16 +0000774 if (!Includers.empty() && !isAngled &&
775 Filename.find('/') == StringRef::npos) {
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000776 HeaderFileInfo &IncludingHFI = getFileInfo(Includers.front().first);
Douglas Gregord8575e12011-07-30 06:28:34 +0000777 if (IncludingHFI.IndexHeaderMapHeader) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000778 SmallString<128> ScratchFilename;
Douglas Gregord8575e12011-07-30 06:28:34 +0000779 ScratchFilename += IncludingHFI.Framework;
780 ScratchFilename += '/';
781 ScratchFilename += Filename;
Will Wilson0fafd342013-12-27 19:46:16 +0000782
Reid Klecknera97d4c02014-02-18 23:49:24 +0000783 const FileEntry *FE = LookupFile(
Will Wilson0fafd342013-12-27 19:46:16 +0000784 ScratchFilename, IncludeLoc, /*isAngled=*/true, FromDir, CurDir,
785 Includers.front(), SearchPath, RelativePath, SuggestedModule);
Reid Klecknera97d4c02014-02-18 23:49:24 +0000786
Richard Smith8c71eba2014-03-05 20:51:45 +0000787 if (checkMSVCHeaderSearch(Diags, MSFE, FE, IncludeLoc)) {
788 if (SuggestedModule)
789 *SuggestedModule = MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000790 return MSFE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000791 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000792
David Blaikie13156b62014-11-19 03:06:06 +0000793 LookupFileCacheInfo &CacheLookup = LookupFileCache[Filename];
794 CacheLookup.HitIdx = LookupFileCache[ScratchFilename].HitIdx;
Richard Smith8c71eba2014-03-05 20:51:45 +0000795 // FIXME: SuggestedModule.
Reid Klecknera97d4c02014-02-18 23:49:24 +0000796 return FE;
Douglas Gregord8575e12011-07-30 06:28:34 +0000797 }
798 }
799
Craig Topperd2d442c2014-05-17 23:10:59 +0000800 if (checkMSVCHeaderSearch(Diags, MSFE, nullptr, IncludeLoc)) {
Richard Smith8c71eba2014-03-05 20:51:45 +0000801 if (SuggestedModule)
802 *SuggestedModule = MSSuggestedModule;
Reid Klecknera97d4c02014-02-18 23:49:24 +0000803 return MSFE;
Richard Smith8c71eba2014-03-05 20:51:45 +0000804 }
Reid Klecknera97d4c02014-02-18 23:49:24 +0000805
Chris Lattnerd4275422007-07-22 07:28:00 +0000806 // Otherwise, didn't find it. Remember we didn't find this.
Argyrios Kyrtzidis34fad422014-03-11 06:21:28 +0000807 CacheLookup.HitIdx = SearchDirs.size();
Craig Topperd2d442c2014-05-17 23:10:59 +0000808 return nullptr;
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000809}
810
Chris Lattner63dd32b2006-10-20 04:42:40 +0000811/// LookupSubframeworkHeader - Look up a subframework for the specified
James Dennettc07ab2c2012-06-20 00:56:32 +0000812/// \#include file. For example, if \#include'ing <HIToolbox/HIToolbox.h> from
Chris Lattner63dd32b2006-10-20 04:42:40 +0000813/// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox
814/// is a subframework within Carbon.framework. If so, return the FileEntry
815/// for the designated file, otherwise return null.
816const FileEntry *HeaderSearch::
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000817LookupSubframeworkHeader(StringRef Filename,
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000818 const FileEntry *ContextFileEnt,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000819 SmallVectorImpl<char> *SearchPath,
Douglas Gregorf5f94522013-02-08 00:10:48 +0000820 SmallVectorImpl<char> *RelativePath,
Lawrence Crowlb53e5482013-06-20 21:14:14 +0000821 ModuleMap::KnownHeader *SuggestedModule) {
Chris Lattner12261882008-02-01 05:34:02 +0000822 assert(ContextFileEnt && "No context file?");
Mike Stump11289f42009-09-09 15:08:12 +0000823
Chris Lattner63dd32b2006-10-20 04:42:40 +0000824 // Framework names must have a '/' in the filename. Find it.
Douglas Gregor5ca04bd2011-12-09 16:48:01 +0000825 // FIXME: Should we permit '\' on Windows?
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000826 size_t SlashPos = Filename.find('/');
Craig Topperd2d442c2014-05-17 23:10:59 +0000827 if (SlashPos == StringRef::npos) return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000828
Chris Lattner63dd32b2006-10-20 04:42:40 +0000829 // Look up the base framework name of the ContextFileEnt.
Chris Lattner48043482006-10-27 05:12:36 +0000830 const char *ContextName = ContextFileEnt->getName();
Mike Stump11289f42009-09-09 15:08:12 +0000831
Chris Lattner63dd32b2006-10-20 04:42:40 +0000832 // If the context info wasn't a framework, couldn't be a subframework.
Douglas Gregor5ca04bd2011-12-09 16:48:01 +0000833 const unsigned DotFrameworkLen = 10;
834 const char *FrameworkPos = strstr(ContextName, ".framework");
Craig Topperd2d442c2014-05-17 23:10:59 +0000835 if (FrameworkPos == nullptr ||
Douglas Gregor5ca04bd2011-12-09 16:48:01 +0000836 (FrameworkPos[DotFrameworkLen] != '/' &&
837 FrameworkPos[DotFrameworkLen] != '\\'))
Craig Topperd2d442c2014-05-17 23:10:59 +0000838 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000839
Daniel Dunbar17138612012-04-05 17:09:40 +0000840 SmallString<1024> FrameworkName(ContextName, FrameworkPos+DotFrameworkLen+1);
Chris Lattner5ed76da2006-10-22 07:24:13 +0000841
Chris Lattner63dd32b2006-10-20 04:42:40 +0000842 // Append Frameworks/HIToolbox.framework/
843 FrameworkName += "Frameworks/";
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000844 FrameworkName.append(Filename.begin(), Filename.begin()+SlashPos);
Chris Lattner63dd32b2006-10-20 04:42:40 +0000845 FrameworkName += ".framework/";
Chris Lattner577377e2006-10-20 04:55:45 +0000846
David Blaikie13156b62014-11-19 03:06:06 +0000847 auto &CacheLookup =
848 *FrameworkMap.insert(std::make_pair(Filename.substr(0, SlashPos),
849 FrameworkCacheEntry())).first;
Mike Stump11289f42009-09-09 15:08:12 +0000850
Chris Lattner5ed76da2006-10-22 07:24:13 +0000851 // Some other location?
David Blaikie13156b62014-11-19 03:06:06 +0000852 if (CacheLookup.second.Directory &&
853 CacheLookup.first().size() == FrameworkName.size() &&
854 memcmp(CacheLookup.first().data(), &FrameworkName[0],
855 CacheLookup.first().size()) != 0)
Craig Topperd2d442c2014-05-17 23:10:59 +0000856 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000857
Chris Lattner5ed76da2006-10-22 07:24:13 +0000858 // Cache subframework.
David Blaikie13156b62014-11-19 03:06:06 +0000859 if (!CacheLookup.second.Directory) {
Chris Lattner5ed76da2006-10-22 07:24:13 +0000860 ++NumSubFrameworkLookups;
Mike Stump11289f42009-09-09 15:08:12 +0000861
Chris Lattner5ed76da2006-10-22 07:24:13 +0000862 // If the framework dir doesn't exist, we fail.
Chris Lattner5159f612010-11-23 08:35:12 +0000863 const DirectoryEntry *Dir = FileMgr.getDirectory(FrameworkName.str());
Craig Topperd2d442c2014-05-17 23:10:59 +0000864 if (!Dir) return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +0000865
Chris Lattner5ed76da2006-10-22 07:24:13 +0000866 // Otherwise, if it does, remember that this is the right direntry for this
867 // framework.
David Blaikie13156b62014-11-19 03:06:06 +0000868 CacheLookup.second.Directory = Dir;
Chris Lattner5ed76da2006-10-22 07:24:13 +0000869 }
Mike Stump11289f42009-09-09 15:08:12 +0000870
Craig Topperd2d442c2014-05-17 23:10:59 +0000871 const FileEntry *FE = nullptr;
Chris Lattner577377e2006-10-20 04:55:45 +0000872
Craig Topperd2d442c2014-05-17 23:10:59 +0000873 if (RelativePath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000874 RelativePath->clear();
875 RelativePath->append(Filename.begin()+SlashPos+1, Filename.end());
876 }
877
Chris Lattner63dd32b2006-10-20 04:42:40 +0000878 // Check ".../Frameworks/HIToolbox.framework/Headers/HIToolbox.h"
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000879 SmallString<1024> HeadersFilename(FrameworkName);
Chris Lattner43fd42e2006-10-30 03:40:58 +0000880 HeadersFilename += "Headers/";
Craig Topperd2d442c2014-05-17 23:10:59 +0000881 if (SearchPath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000882 SearchPath->clear();
883 // Without trailing '/'.
884 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
885 }
886
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000887 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
Argyrios Kyrtzidisd6278e32011-03-16 19:17:25 +0000888 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true))) {
Mike Stump11289f42009-09-09 15:08:12 +0000889
Chris Lattner63dd32b2006-10-20 04:42:40 +0000890 // Check ".../Frameworks/HIToolbox.framework/PrivateHeaders/HIToolbox.h"
Chris Lattner43fd42e2006-10-30 03:40:58 +0000891 HeadersFilename = FrameworkName;
892 HeadersFilename += "PrivateHeaders/";
Craig Topperd2d442c2014-05-17 23:10:59 +0000893 if (SearchPath) {
Manuel Klimek0c69fd22011-04-26 21:50:03 +0000894 SearchPath->clear();
895 // Without trailing '/'.
896 SearchPath->append(HeadersFilename.begin(), HeadersFilename.end()-1);
897 }
898
Chris Lattnerd081f8c2010-01-10 01:35:12 +0000899 HeadersFilename.append(Filename.begin()+SlashPos+1, Filename.end());
Argyrios Kyrtzidisd6278e32011-03-16 19:17:25 +0000900 if (!(FE = FileMgr.getFile(HeadersFilename.str(), /*openFile=*/true)))
Craig Topperd2d442c2014-05-17 23:10:59 +0000901 return nullptr;
Chris Lattner63dd32b2006-10-20 04:42:40 +0000902 }
Mike Stump11289f42009-09-09 15:08:12 +0000903
Chris Lattner577377e2006-10-20 04:55:45 +0000904 // This file is a system header or C++ unfriendly if the old file is.
Ted Kremenek72be0682008-02-24 03:55:14 +0000905 //
Chris Lattnerf5c619f2008-02-25 21:38:21 +0000906 // Note that the temporary 'DirInfo' is required here, as either call to
907 // getFileInfo could resize the vector and we don't want to rely on order
908 // of evaluation.
909 unsigned DirInfo = getFileInfo(ContextFileEnt).DirInfo;
910 getFileInfo(FE).DirInfo = DirInfo;
Douglas Gregorf5f94522013-02-08 00:10:48 +0000911
912 // If we're supposed to suggest a module, look for one now.
913 if (SuggestedModule) {
914 // Find the top-level framework based on this framework.
915 FrameworkName.pop_back(); // remove the trailing '/'
916 SmallVector<std::string, 4> SubmodulePath;
917 const DirectoryEntry *TopFrameworkDir
918 = ::getTopFrameworkDir(FileMgr, FrameworkName, SubmodulePath);
919
920 // Determine the name of the top-level framework.
921 StringRef ModuleName = llvm::sys::path::stem(TopFrameworkDir->getName());
922
923 // Load this framework module. If that succeeds, find the suggested module
924 // for this header, if any.
925 bool IsSystem = false;
926 if (loadFrameworkModule(ModuleName, TopFrameworkDir, IsSystem)) {
927 *SuggestedModule = findModuleForHeader(FE);
928 }
929 }
930
Chris Lattner577377e2006-10-20 04:55:45 +0000931 return FE;
Chris Lattner63dd32b2006-10-20 04:42:40 +0000932}
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));
Ben Langmuird285c502014-03-13 16:46:36 +0000973 HFI.IsValid = 1;
Douglas Gregor09b69892011-02-10 17:09:37 +0000974 return HFI;
Mike Stump11289f42009-09-09 15:08:12 +0000975}
Chris Lattner59a9ebd2006-10-18 05:34:33 +0000976
Ben Langmuird285c502014-03-13 16:46:36 +0000977bool HeaderSearch::tryGetFileInfo(const FileEntry *FE, HeaderFileInfo &Result) const {
978 if (FE->getUID() >= FileInfo.size())
979 return false;
980 const HeaderFileInfo &HFI = FileInfo[FE->getUID()];
981 if (HFI.IsValid) {
982 Result = HFI;
983 return true;
984 }
985 return false;
986}
987
Douglas Gregor37aa4932011-05-04 00:14:37 +0000988bool HeaderSearch::isFileMultipleIncludeGuarded(const FileEntry *File) {
989 // Check if we've ever seen this file as a header.
990 if (File->getUID() >= FileInfo.size())
991 return false;
992
993 // Resolve header file info from the external source, if needed.
994 HeaderFileInfo &HFI = FileInfo[File->getUID()];
Douglas Gregor5d1bee22011-09-17 05:35:18 +0000995 if (ExternalSource && !HFI.Resolved)
996 mergeHeaderFileInfo(HFI, ExternalSource->GetHeaderFileInfo(File));
Douglas Gregor37aa4932011-05-04 00:14:37 +0000997
Argyrios Kyrtzidis0d355df2012-12-10 20:08:37 +0000998 return HFI.isPragmaOnce || HFI.isImport ||
999 HFI.ControllingMacro || HFI.ControllingMacroID;
Douglas Gregor37aa4932011-05-04 00:14:37 +00001000}
1001
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001002void HeaderSearch::MarkFileModuleHeader(const FileEntry *FE,
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001003 ModuleMap::ModuleHeaderRole Role,
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001004 bool isCompilingModuleHeader) {
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001005 if (FE->getUID() >= FileInfo.size())
1006 FileInfo.resize(FE->getUID()+1);
1007
1008 HeaderFileInfo &HFI = FileInfo[FE->getUID()];
1009 HFI.isModuleHeader = true;
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001010 HFI.isCompilingModuleHeader = isCompilingModuleHeader;
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001011 HFI.setHeaderRole(Role);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001012}
1013
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001014bool HeaderSearch::ShouldEnterIncludeFile(const FileEntry *File, bool isImport){
1015 ++NumIncluded; // Count # of attempted #includes.
1016
1017 // Get information about this file.
Steve Naroff3fa455a2009-04-24 20:03:17 +00001018 HeaderFileInfo &FileInfo = getFileInfo(File);
Mike Stump11289f42009-09-09 15:08:12 +00001019
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001020 // If this is a #import directive, check that we have not already imported
1021 // this header.
1022 if (isImport) {
1023 // If this has already been imported, don't import it again.
1024 FileInfo.isImport = true;
Mike Stump11289f42009-09-09 15:08:12 +00001025
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001026 // Has this already been #import'ed or #include'd?
1027 if (FileInfo.NumIncludes) return false;
1028 } else {
1029 // Otherwise, if this is a #include of a file that was previously #import'd
1030 // or if this is the second #include of a #pragma once file, ignore it.
1031 if (FileInfo.isImport)
1032 return false;
1033 }
Mike Stump11289f42009-09-09 15:08:12 +00001034
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001035 // Next, check to see if the file is wrapped with #ifndef guards. If so, and
1036 // if the macro that guards it is defined, we know the #include has no effect.
Mike Stump11289f42009-09-09 15:08:12 +00001037 if (const IdentifierInfo *ControllingMacro
Douglas Gregor99734e72009-04-25 23:30:02 +00001038 = FileInfo.getControllingMacro(ExternalLookup))
1039 if (ControllingMacro->hasMacroDefinition()) {
1040 ++NumMultiIncludeFileOptzn;
1041 return false;
1042 }
Mike Stump11289f42009-09-09 15:08:12 +00001043
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001044 // Increment the number of times this file has been included.
1045 ++FileInfo.NumIncludes;
Mike Stump11289f42009-09-09 15:08:12 +00001046
Chris Lattner59a9ebd2006-10-18 05:34:33 +00001047 return true;
1048}
1049
Ted Kremenekfbcce6f2011-07-26 23:46:11 +00001050size_t HeaderSearch::getTotalMemory() const {
1051 return SearchDirs.capacity()
Ted Kremenekae63d102011-07-27 18:41:18 +00001052 + llvm::capacity_in_bytes(FileInfo)
1053 + llvm::capacity_in_bytes(HeaderMaps)
Ted Kremenekfbcce6f2011-07-26 23:46:11 +00001054 + LookupFileCache.getAllocator().getTotalMemory()
1055 + FrameworkMap.getAllocator().getTotalMemory();
1056}
Douglas Gregor9f93e382011-07-28 04:45:53 +00001057
1058StringRef HeaderSearch::getUniqueFrameworkName(StringRef Framework) {
David Blaikie13156b62014-11-19 03:06:06 +00001059 return FrameworkNames.insert(Framework).first->first();
Douglas Gregor9f93e382011-07-28 04:45:53 +00001060}
Douglas Gregor718292f2011-11-11 19:10:28 +00001061
1062bool HeaderSearch::hasModuleMap(StringRef FileName,
Douglas Gregor963c5532013-06-21 16:28:10 +00001063 const DirectoryEntry *Root,
1064 bool IsSystem) {
Argyrios Kyrtzidis9955dbc2013-12-12 16:08:33 +00001065 if (!enabledModules())
1066 return false;
1067
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001068 SmallVector<const DirectoryEntry *, 2> FixUpDirectories;
Douglas Gregor718292f2011-11-11 19:10:28 +00001069
1070 StringRef DirName = FileName;
1071 do {
1072 // Get the parent directory name.
1073 DirName = llvm::sys::path::parent_path(DirName);
1074 if (DirName.empty())
1075 return false;
Daniel Jasperca9f7382013-09-24 09:27:13 +00001076
Douglas Gregor718292f2011-11-11 19:10:28 +00001077 // Determine whether this directory exists.
1078 const DirectoryEntry *Dir = FileMgr.getDirectory(DirName);
1079 if (!Dir)
1080 return false;
Daniel Jasperca9f7382013-09-24 09:27:13 +00001081
Ben Langmuir984e1df2014-03-19 20:23:34 +00001082 // Try to load the module map file in this directory.
1083 switch (loadModuleMapFile(Dir, IsSystem, /*IsFramework*/false)) {
Douglas Gregor80b69042011-11-12 00:22:19 +00001084 case LMM_NewlyLoaded:
1085 case LMM_AlreadyLoaded:
Daniel Jasperca9f7382013-09-24 09:27:13 +00001086 // Success. All of the directories we stepped through inherit this module
1087 // map file.
1088 for (unsigned I = 0, N = FixUpDirectories.size(); I != N; ++I)
1089 DirectoryHasModuleMap[FixUpDirectories[I]] = true;
1090 return true;
Daniel Jasper97da9172013-10-22 08:09:47 +00001091
1092 case LMM_NoDirectory:
1093 case LMM_InvalidModuleMap:
1094 break;
Daniel Jasperca9f7382013-09-24 09:27:13 +00001095 }
1096
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001097 // If we hit the top of our search, we're done.
1098 if (Dir == Root)
1099 return false;
1100
Douglas Gregor718292f2011-11-11 19:10:28 +00001101 // Keep track of all of the directories we checked, so we can mark them as
1102 // having module maps if we eventually do find a module map.
1103 FixUpDirectories.push_back(Dir);
1104 } while (true);
Douglas Gregor718292f2011-11-11 19:10:28 +00001105}
1106
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001107ModuleMap::KnownHeader
1108HeaderSearch::findModuleForHeader(const FileEntry *File) const {
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001109 if (ExternalSource) {
1110 // Make sure the external source has handled header info about this file,
1111 // which includes whether the file is part of a module.
1112 (void)getFileInfo(File);
1113 }
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001114 return ModMap.findModuleForHeader(File);
Douglas Gregor718292f2011-11-11 19:10:28 +00001115}
1116
Ben Langmuir984e1df2014-03-19 20:23:34 +00001117static const FileEntry *getPrivateModuleMap(StringRef ModuleMapPath,
1118 const DirectoryEntry *Directory,
1119 FileManager &FileMgr) {
1120 StringRef Filename = llvm::sys::path::filename(ModuleMapPath);
1121 SmallString<128> PrivateFilename(Directory->getName());
1122 if (Filename == "module.map")
Douglas Gregor80306772011-12-07 21:25:07 +00001123 llvm::sys::path::append(PrivateFilename, "module_private.map");
Ben Langmuir984e1df2014-03-19 20:23:34 +00001124 else if (Filename == "module.modulemap")
1125 llvm::sys::path::append(PrivateFilename, "module.private.modulemap");
1126 else
1127 return nullptr;
1128 return FileMgr.getFile(PrivateFilename);
Douglas Gregor2b20cb82011-11-16 00:09:06 +00001129}
1130
Ben Langmuir984e1df2014-03-19 20:23:34 +00001131bool HeaderSearch::loadModuleMapFile(const FileEntry *File, bool IsSystem) {
1132 switch (loadModuleMapFileImpl(File, IsSystem)) {
1133 case LMM_AlreadyLoaded:
1134 case LMM_NewlyLoaded:
1135 return false;
1136 case LMM_NoDirectory:
1137 case LMM_InvalidModuleMap:
1138 return true;
1139 }
Aaron Ballmand8de5b62014-03-20 14:22:33 +00001140 llvm_unreachable("Unknown load module map result");
Ben Langmuir984e1df2014-03-19 20:23:34 +00001141}
1142
1143HeaderSearch::LoadModuleMapResult
1144HeaderSearch::loadModuleMapFileImpl(const FileEntry *File, bool IsSystem) {
1145 assert(File && "expected FileEntry");
1146
Richard Smith9887d792014-10-17 01:42:53 +00001147 // Check whether we've already loaded this module map, and mark it as being
1148 // loaded in case we recursively try to load it from itself.
1149 auto AddResult = LoadedModuleMaps.insert(std::make_pair(File, true));
1150 if (!AddResult.second)
1151 return AddResult.first->second ? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
Ben Langmuir984e1df2014-03-19 20:23:34 +00001152
1153 if (ModMap.parseModuleMapFile(File, IsSystem)) {
Richard Smith9887d792014-10-17 01:42:53 +00001154 LoadedModuleMaps[File] = false;
Ben Langmuir984e1df2014-03-19 20:23:34 +00001155 return LMM_InvalidModuleMap;
1156 }
1157
1158 // Try to load a corresponding private module map.
1159 if (const FileEntry *PMMFile =
Richard Smith9887d792014-10-17 01:42:53 +00001160 getPrivateModuleMap(File->getName(), File->getDir(), FileMgr)) {
Ben Langmuir984e1df2014-03-19 20:23:34 +00001161 if (ModMap.parseModuleMapFile(PMMFile, IsSystem)) {
Richard Smith9887d792014-10-17 01:42:53 +00001162 LoadedModuleMaps[File] = false;
Ben Langmuir984e1df2014-03-19 20:23:34 +00001163 return LMM_InvalidModuleMap;
1164 }
1165 }
1166
1167 // This directory has a module map.
Ben Langmuir984e1df2014-03-19 20:23:34 +00001168 return LMM_NewlyLoaded;
1169}
1170
1171const FileEntry *
1172HeaderSearch::lookupModuleMapFile(const DirectoryEntry *Dir, bool IsFramework) {
1173 // For frameworks, the preferred spelling is Modules/module.modulemap, but
1174 // module.map at the framework root is also accepted.
1175 SmallString<128> ModuleMapFileName(Dir->getName());
1176 if (IsFramework)
1177 llvm::sys::path::append(ModuleMapFileName, "Modules");
1178 llvm::sys::path::append(ModuleMapFileName, "module.modulemap");
1179 if (const FileEntry *F = FileMgr.getFile(ModuleMapFileName))
1180 return F;
1181
1182 // Continue to allow module.map
1183 ModuleMapFileName = Dir->getName();
1184 llvm::sys::path::append(ModuleMapFileName, "module.map");
1185 return FileMgr.getFile(ModuleMapFileName);
1186}
1187
1188Module *HeaderSearch::loadFrameworkModule(StringRef Name,
Douglas Gregor279a6c32012-01-29 17:08:11 +00001189 const DirectoryEntry *Dir,
1190 bool IsSystem) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00001191 if (Module *Module = ModMap.findModule(Name))
Douglas Gregor56c64012011-11-17 01:41:17 +00001192 return Module;
1193
1194 // Try to load a module map file.
Ben Langmuir984e1df2014-03-19 20:23:34 +00001195 switch (loadModuleMapFile(Dir, IsSystem, /*IsFramework*/true)) {
Douglas Gregor56c64012011-11-17 01:41:17 +00001196 case LMM_InvalidModuleMap:
1197 break;
1198
1199 case LMM_AlreadyLoaded:
1200 case LMM_NoDirectory:
Craig Topperd2d442c2014-05-17 23:10:59 +00001201 return nullptr;
1202
Douglas Gregor56c64012011-11-17 01:41:17 +00001203 case LMM_NewlyLoaded:
1204 return ModMap.findModule(Name);
1205 }
Douglas Gregor3a5999b2012-01-13 22:31:52 +00001206
Douglas Gregor9194a912012-11-06 19:39:40 +00001207
Ben Langmuirc3ea5652014-03-20 18:27:26 +00001208 // Try to infer a module map from the framework directory.
Craig Topperd2d442c2014-05-17 23:10:59 +00001209 return ModMap.inferFrameworkModule(Name, Dir, IsSystem, /*Parent=*/nullptr);
Douglas Gregor56c64012011-11-17 01:41:17 +00001210}
1211
Douglas Gregor2b20cb82011-11-16 00:09:06 +00001212
Douglas Gregor80b69042011-11-12 00:22:19 +00001213HeaderSearch::LoadModuleMapResult
Ben Langmuir984e1df2014-03-19 20:23:34 +00001214HeaderSearch::loadModuleMapFile(StringRef DirName, bool IsSystem,
1215 bool IsFramework) {
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001216 if (const DirectoryEntry *Dir = FileMgr.getDirectory(DirName))
Ben Langmuir984e1df2014-03-19 20:23:34 +00001217 return loadModuleMapFile(Dir, IsSystem, IsFramework);
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001218
Douglas Gregor80b69042011-11-12 00:22:19 +00001219 return LMM_NoDirectory;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001220}
1221
Douglas Gregor80b69042011-11-12 00:22:19 +00001222HeaderSearch::LoadModuleMapResult
Ben Langmuir984e1df2014-03-19 20:23:34 +00001223HeaderSearch::loadModuleMapFile(const DirectoryEntry *Dir, bool IsSystem,
1224 bool IsFramework) {
1225 auto KnownDir = DirectoryHasModuleMap.find(Dir);
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001226 if (KnownDir != DirectoryHasModuleMap.end())
Richard Smith9887d792014-10-17 01:42:53 +00001227 return KnownDir->second ? LMM_AlreadyLoaded : LMM_InvalidModuleMap;
Douglas Gregore7ab3662011-12-07 02:23:45 +00001228
Ben Langmuir984e1df2014-03-19 20:23:34 +00001229 if (const FileEntry *ModuleMapFile = lookupModuleMapFile(Dir, IsFramework)) {
1230 LoadModuleMapResult Result = loadModuleMapFileImpl(ModuleMapFile, IsSystem);
1231 // Add Dir explicitly in case ModuleMapFile is in a subdirectory.
1232 // E.g. Foo.framework/Modules/module.modulemap
1233 // ^Dir ^ModuleMapFile
1234 if (Result == LMM_NewlyLoaded)
1235 DirectoryHasModuleMap[Dir] = true;
Richard Smith9887d792014-10-17 01:42:53 +00001236 else if (Result == LMM_InvalidModuleMap)
1237 DirectoryHasModuleMap[Dir] = false;
Ben Langmuir984e1df2014-03-19 20:23:34 +00001238 return Result;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001239 }
Douglas Gregor80b69042011-11-12 00:22:19 +00001240 return LMM_InvalidModuleMap;
Douglas Gregoraf28ec82011-11-12 00:05:07 +00001241}
Douglas Gregor718292f2011-11-11 19:10:28 +00001242
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001243void HeaderSearch::collectAllModules(SmallVectorImpl<Module *> &Modules) {
Douglas Gregor07f43572012-01-29 18:15:03 +00001244 Modules.clear();
1245
1246 // Load module maps for each of the header search directories.
1247 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
Douglas Gregor963c5532013-06-21 16:28:10 +00001248 bool IsSystem = SearchDirs[Idx].isSystemHeaderDirectory();
Douglas Gregor07f43572012-01-29 18:15:03 +00001249 if (SearchDirs[Idx].isFramework()) {
Rafael Espindolac0809172014-06-12 14:02:15 +00001250 std::error_code EC;
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001251 SmallString<128> DirNative;
Douglas Gregor07f43572012-01-29 18:15:03 +00001252 llvm::sys::path::native(SearchDirs[Idx].getFrameworkDir()->getName(),
1253 DirNative);
1254
1255 // Search each of the ".framework" directories to load them as modules.
Douglas Gregor07f43572012-01-29 18:15:03 +00001256 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1257 Dir != DirEnd && !EC; Dir.increment(EC)) {
1258 if (llvm::sys::path::extension(Dir->path()) != ".framework")
1259 continue;
1260
1261 const DirectoryEntry *FrameworkDir = FileMgr.getDirectory(Dir->path());
1262 if (!FrameworkDir)
1263 continue;
1264
1265 // Load this framework module.
1266 loadFrameworkModule(llvm::sys::path::stem(Dir->path()), FrameworkDir,
1267 IsSystem);
1268 }
1269 continue;
1270 }
1271
1272 // FIXME: Deal with header maps.
1273 if (SearchDirs[Idx].isHeaderMap())
1274 continue;
1275
1276 // Try to load a module map file for the search directory.
Ben Langmuir984e1df2014-03-19 20:23:34 +00001277 loadModuleMapFile(SearchDirs[Idx].getDir(), IsSystem, /*IsFramework*/false);
Douglas Gregor07f43572012-01-29 18:15:03 +00001278
1279 // Try to load module map files for immediate subdirectories of this search
1280 // directory.
Douglas Gregor0339a642013-03-21 01:08:50 +00001281 loadSubdirectoryModuleMaps(SearchDirs[Idx]);
Douglas Gregor07f43572012-01-29 18:15:03 +00001282 }
1283
1284 // Populate the list of modules.
1285 for (ModuleMap::module_iterator M = ModMap.module_begin(),
1286 MEnd = ModMap.module_end();
1287 M != MEnd; ++M) {
1288 Modules.push_back(M->getValue());
1289 }
1290}
Douglas Gregor0339a642013-03-21 01:08:50 +00001291
Douglas Gregor64a1fa52013-05-10 22:52:27 +00001292void HeaderSearch::loadTopLevelSystemModules() {
1293 // Load module maps for each of the header search directories.
1294 for (unsigned Idx = 0, N = SearchDirs.size(); Idx != N; ++Idx) {
Douglas Gregor299787f2013-11-01 23:08:38 +00001295 // We only care about normal header directories.
1296 if (!SearchDirs[Idx].isNormalDir()) {
Douglas Gregor64a1fa52013-05-10 22:52:27 +00001297 continue;
1298 }
1299
1300 // Try to load a module map file for the search directory.
Douglas Gregor963c5532013-06-21 16:28:10 +00001301 loadModuleMapFile(SearchDirs[Idx].getDir(),
Ben Langmuir984e1df2014-03-19 20:23:34 +00001302 SearchDirs[Idx].isSystemHeaderDirectory(),
1303 SearchDirs[Idx].isFramework());
Douglas Gregor64a1fa52013-05-10 22:52:27 +00001304 }
1305}
1306
Douglas Gregor0339a642013-03-21 01:08:50 +00001307void HeaderSearch::loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir) {
1308 if (SearchDir.haveSearchedAllModuleMaps())
1309 return;
Rafael Espindolac0809172014-06-12 14:02:15 +00001310
1311 std::error_code EC;
Douglas Gregor0339a642013-03-21 01:08:50 +00001312 SmallString<128> DirNative;
1313 llvm::sys::path::native(SearchDir.getDir()->getName(), DirNative);
1314 for (llvm::sys::fs::directory_iterator Dir(DirNative.str(), EC), DirEnd;
1315 Dir != DirEnd && !EC; Dir.increment(EC)) {
Ben Langmuir984e1df2014-03-19 20:23:34 +00001316 loadModuleMapFile(Dir->path(), SearchDir.isSystemHeaderDirectory(),
1317 SearchDir.isFramework());
Douglas Gregor0339a642013-03-21 01:08:50 +00001318 }
1319
1320 SearchDir.setSearchedAllModuleMaps(true);
1321}