1//===- HeaderSearch.h - Resolve Header File Locations -----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the HeaderSearch interface.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_LEX_HEADERSEARCH_H
14#define LLVM_CLANG_LEX_HEADERSEARCH_H
15
16#include "clang/Basic/SourceLocation.h"
17#include "clang/Basic/SourceManager.h"
18#include "clang/Lex/DirectoryLookup.h"
19#include "clang/Lex/ExternalPreprocessorSource.h"
20#include "clang/Lex/HeaderMap.h"
21#include "clang/Lex/ModuleMap.h"
22#include "llvm/ADT/ArrayRef.h"
23#include "llvm/ADT/DenseMap.h"
24#include "llvm/ADT/SmallString.h"
25#include "llvm/ADT/StringMap.h"
26#include "llvm/ADT/StringRef.h"
27#include "llvm/ADT/StringSet.h"
28#include "llvm/Support/Allocator.h"
29#include <cassert>
30#include <cstddef>
31#include <memory>
32#include <string>
33#include <utility>
34#include <vector>
35
36namespace llvm {
37
38class Triple;
39
40} // namespace llvm
41
42namespace clang {
43
44class DiagnosticsEngine;
45class DirectoryEntry;
46class ExternalPreprocessorSource;
47class FileEntry;
48class FileManager;
49class HeaderSearch;
50class HeaderSearchOptions;
51class IdentifierInfo;
52class LangOptions;
53class Module;
54class Preprocessor;
55class TargetInfo;
56
57/// The preprocessor keeps track of this information for each
58/// file that is \#included.
59struct HeaderFileInfo {
60 // TODO: Whether the file was included is not a property of the file itself.
61 // It's a preprocessor state, move it there.
62 /// True if this file has been included (or imported) **locally**.
63 LLVM_PREFERRED_TYPE(bool)
64 unsigned IsLocallyIncluded : 1;
65
66 // TODO: Whether the file was imported is not a property of the file itself.
67 // It's a preprocessor state, move it there.
68 /// True if this is a \#import'd file.
69 LLVM_PREFERRED_TYPE(bool)
70 unsigned isImport : 1;
71
72 /// True if this is a \#pragma once file.
73 LLVM_PREFERRED_TYPE(bool)
74 unsigned isPragmaOnce : 1;
75
76 /// Keep track of whether this is a system header, and if so,
77 /// whether it is C++ clean or not. This can be set by the include paths or
78 /// by \#pragma gcc system_header. This is an instance of
79 /// SrcMgr::CharacteristicKind.
80 LLVM_PREFERRED_TYPE(SrcMgr::CharacteristicKind)
81 unsigned DirInfo : 3;
82
83 /// Whether this header file info was supplied by an external source,
84 /// and has not changed since.
85 LLVM_PREFERRED_TYPE(bool)
86 unsigned External : 1;
87
88 /// Whether this header is part of and built with a module. i.e. it is listed
89 /// in a module map, and is not `excluded` or `textual`. (same meaning as
90 /// `ModuleMap::isModular()`).
91 LLVM_PREFERRED_TYPE(bool)
92 unsigned isModuleHeader : 1;
93
94 /// Whether this header is a `textual header` in a module. If a header is
95 /// textual in one module and normal in another module, this bit will not be
96 /// set, only `isModuleHeader`.
97 LLVM_PREFERRED_TYPE(bool)
98 unsigned isTextualModuleHeader : 1;
99
100 /// Whether this header is part of the module that we are building, even if it
101 /// doesn't build with the module. i.e. this will include `excluded` and
102 /// `textual` headers as well as normal headers.
103 LLVM_PREFERRED_TYPE(bool)
104 unsigned isCompilingModuleHeader : 1;
105
106 /// Whether this structure is considered to already have been
107 /// "resolved", meaning that it was loaded from the external source.
108 LLVM_PREFERRED_TYPE(bool)
109 unsigned Resolved : 1;
110
111 /// Whether this file has been looked up as a header.
112 LLVM_PREFERRED_TYPE(bool)
113 unsigned IsValid : 1;
114
115 /// If this file has a \#ifndef XXX (or equivalent) guard that
116 /// protects the entire contents of the file, this is the identifier
117 /// for the macro that controls whether or not it has any effect.
118 ///
119 /// Note: Most clients should use getControllingMacro() to access
120 /// the controlling macro of this header, since
121 /// getControllingMacro() is able to load a controlling macro from
122 /// external storage.
123 LazyIdentifierInfoPtr LazyControllingMacro;
124
125 HeaderFileInfo()
126 : IsLocallyIncluded(false), isImport(false), isPragmaOnce(false),
127 DirInfo(SrcMgr::C_User), External(false), isModuleHeader(false),
128 isTextualModuleHeader(false), isCompilingModuleHeader(false),
129 Resolved(false), IsValid(false) {}
130
131 /// Retrieve the controlling macro for this header file, if
132 /// any.
133 const IdentifierInfo *
134 getControllingMacro(ExternalPreprocessorSource *External);
135
136 /// Update the module membership bits based on the header role.
137 ///
138 /// isModuleHeader will potentially be set, but not cleared.
139 /// isTextualModuleHeader will be set or cleared based on the role update.
140 void mergeModuleMembership(ModuleMap::ModuleHeaderRole Role);
141};
142
143static_assert(sizeof(HeaderFileInfo) <= 16);
144
145/// An external source of header file information, which may supply
146/// information about header files already included.
147class ExternalHeaderFileInfoSource {
148public:
149 virtual ~ExternalHeaderFileInfoSource();
150
151 /// Retrieve the header file information for the given file entry.
152 ///
153 /// \returns Header file information for the given file entry, with the
154 /// \c External bit set. If the file entry is not known, return a
155 /// default-constructed \c HeaderFileInfo.
156 virtual HeaderFileInfo GetHeaderFileInfo(FileEntryRef FE) = 0;
157};
158
159/// This structure is used to record entries in our framework cache.
160struct FrameworkCacheEntry {
161 /// The directory entry which should be used for the cached framework.
162 OptionalDirectoryEntryRef Directory;
163
164 /// Whether this framework has been "user-specified" to be treated as if it
165 /// were a system framework (even if it was found outside a system framework
166 /// directory).
167 bool IsUserSpecifiedSystemFramework;
168};
169
170namespace detail {
171template <bool Const, typename T>
172using Qualified = std::conditional_t<Const, const T, T>;
173
174/// Forward iterator over the search directories of \c HeaderSearch.
175template <bool IsConst>
176struct SearchDirIteratorImpl
177 : llvm::iterator_facade_base<SearchDirIteratorImpl<IsConst>,
178 std::forward_iterator_tag,
179 Qualified<IsConst, DirectoryLookup>> {
180 /// Const -> non-const iterator conversion.
181 template <typename Enable = std::enable_if<IsConst, bool>>
182 SearchDirIteratorImpl(const SearchDirIteratorImpl<false> &Other)
183 : HS(Other.HS), Idx(Other.Idx) {}
184
185 SearchDirIteratorImpl(const SearchDirIteratorImpl &) = default;
186
187 SearchDirIteratorImpl &operator=(const SearchDirIteratorImpl &) = default;
188
189 bool operator==(const SearchDirIteratorImpl &RHS) const {
190 return HS == RHS.HS && Idx == RHS.Idx;
191 }
192
193 SearchDirIteratorImpl &operator++() {
194 assert(*this && "Invalid iterator.");
195 ++Idx;
196 return *this;
197 }
198
199 Qualified<IsConst, DirectoryLookup> &operator*() const {
200 assert(*this && "Invalid iterator.");
201 return HS->SearchDirs[Idx];
202 }
203
204 /// Creates an invalid iterator.
205 SearchDirIteratorImpl(std::nullptr_t) : HS(nullptr), Idx(0) {}
206
207 /// Checks whether the iterator is valid.
208 explicit operator bool() const { return HS != nullptr; }
209
210private:
211 /// The parent \c HeaderSearch. This is \c nullptr for invalid iterator.
212 Qualified<IsConst, HeaderSearch> *HS;
213
214 /// The index of the current element.
215 size_t Idx;
216
217 /// The constructor that creates a valid iterator.
218 SearchDirIteratorImpl(Qualified<IsConst, HeaderSearch> &HS, size_t Idx)
219 : HS(&HS), Idx(Idx) {}
220
221 /// Only HeaderSearch is allowed to instantiate valid iterators.
222 friend HeaderSearch;
223
224 /// Enables const -> non-const conversion.
225 friend SearchDirIteratorImpl<!IsConst>;
226};
227} // namespace detail
228
229using ConstSearchDirIterator = detail::SearchDirIteratorImpl<true>;
230using SearchDirIterator = detail::SearchDirIteratorImpl<false>;
231
232using ConstSearchDirRange = llvm::iterator_range<ConstSearchDirIterator>;
233using SearchDirRange = llvm::iterator_range<SearchDirIterator>;
234
235/// Encapsulates the information needed to find the file referenced
236/// by a \#include or \#include_next, (sub-)framework lookup, etc.
237class HeaderSearch {
238 friend class DirectoryLookup;
239
240 friend ConstSearchDirIterator;
241 friend SearchDirIterator;
242
243 /// Header-search options used to initialize this header search.
244 const HeaderSearchOptions &HSOpts;
245
246 /// Mapping from SearchDir to HeaderSearchOptions::UserEntries indices.
247 llvm::DenseMap<unsigned, unsigned> SearchDirToHSEntry;
248
249 DiagnosticsEngine &Diags;
250 FileManager &FileMgr;
251
252 /// \#include search path information. Requests for \#include "x" search the
253 /// directory of the \#including file first, then each directory in SearchDirs
254 /// consecutively. Requests for <x> search the current dir first, then each
255 /// directory in SearchDirs, starting at AngledDirIdx, consecutively.
256 std::vector<DirectoryLookup> SearchDirs;
257 /// Whether the DirectoryLookup at the corresponding index in SearchDirs has
258 /// been successfully used to lookup a file.
259 std::vector<bool> SearchDirsUsage;
260 unsigned AngledDirIdx = 0;
261 unsigned SystemDirIdx = 0;
262
263 /// Maps HeaderMap keys to SearchDir indices. When HeaderMaps are used
264 /// heavily, SearchDirs can start with thousands of HeaderMaps, so this Index
265 /// lets us avoid scanning them all to find a match.
266 llvm::StringMap<unsigned, llvm::BumpPtrAllocator> SearchDirHeaderMapIndex;
267
268 /// The index of the first SearchDir that isn't a header map.
269 unsigned FirstNonHeaderMapSearchDirIdx = 0;
270
271 /// \#include prefixes for which the 'system header' property is
272 /// overridden.
273 ///
274 /// For a \#include "x" or \#include \<x> directive, the last string in this
275 /// list which is a prefix of 'x' determines whether the file is treated as
276 /// a system header.
277 std::vector<std::pair<std::string, bool>> SystemHeaderPrefixes;
278
279 /// The context hash used in SpecificModuleCachePath (unless suppressed).
280 std::string ContextHash;
281
282 /// The specific module cache path containing ContextHash (unless suppressed).
283 std::string SpecificModuleCachePath;
284
285 /// All of the preprocessor-specific data about files that are
286 /// included, indexed by the FileEntry's UID.
287 mutable std::vector<HeaderFileInfo> FileInfo;
288
289 /// Keeps track of each lookup performed by LookupFile.
290 struct LookupFileCacheInfo {
291 // The requesting module for the lookup we cached.
292 const Module *RequestingModule = nullptr;
293
294 /// Starting search directory iterator that the cached search was performed
295 /// from. If there is a hit and this value doesn't match the current query,
296 /// the cache has to be ignored.
297 ConstSearchDirIterator StartIt = nullptr;
298
299 /// The search directory iterator that satisfied the query.
300 ConstSearchDirIterator HitIt = nullptr;
301
302 /// This is non-null if the original filename was mapped to a framework
303 /// include via a headermap.
304 const char *MappedName = nullptr;
305
306 /// Default constructor -- Initialize all members with zero.
307 LookupFileCacheInfo() = default;
308
309 void reset(const Module *NewRequestingModule,
310 ConstSearchDirIterator NewStartIt) {
311 RequestingModule = NewRequestingModule;
312 StartIt = NewStartIt;
313 MappedName = nullptr;
314 }
315 };
316 llvm::StringMap<LookupFileCacheInfo, llvm::BumpPtrAllocator> LookupFileCache;
317
318 /// Collection mapping a framework or subframework
319 /// name like "Carbon" to the Carbon.framework directory.
320 llvm::StringMap<FrameworkCacheEntry, llvm::BumpPtrAllocator> FrameworkMap;
321
322 /// Maps include file names (including the quotes or
323 /// angle brackets) to other include file names. This is used to support the
324 /// include_alias pragma for Microsoft compatibility.
325 using IncludeAliasMap =
326 llvm::StringMap<std::string, llvm::BumpPtrAllocator>;
327 std::unique_ptr<IncludeAliasMap> IncludeAliases;
328
329 /// This is a mapping from FileEntry -> HeaderMap, uniquing headermaps.
330 std::vector<std::pair<FileEntryRef, std::unique_ptr<HeaderMap>>> HeaderMaps;
331
332 /// The mapping between modules and headers.
333 mutable ModuleMap ModMap;
334
335 struct ModuleMapDirectoryState {
336 OptionalFileEntryRef ModuleMapFile;
337 enum {
338 Parsed,
339 Loaded,
340 Invalid,
341 } Status;
342 };
343
344 /// Describes whether a given directory has a module map in it.
345 llvm::DenseMap<const DirectoryEntry *, ModuleMapDirectoryState>
346 DirectoryModuleMap;
347
348 /// Set of module map files we've already loaded, and a flag indicating
349 /// whether they were valid or not.
350 llvm::DenseMap<const FileEntry *, bool> LoadedModuleMaps;
351
352 /// Set of module map files we've already parsed, and a flag indicating
353 /// whether they were valid or not.
354 llvm::DenseMap<const FileEntry *, bool> ParsedModuleMaps;
355
356 // A map of discovered headers with their associated include file name.
357 llvm::DenseMap<const FileEntry *, llvm::SmallString<64>> IncludeNames;
358
359 /// Uniqued set of framework names, which is used to track which
360 /// headers were included as framework headers.
361 llvm::StringSet<llvm::BumpPtrAllocator> FrameworkNames;
362
363 /// Entity used to resolve the identifier IDs of controlling
364 /// macros into IdentifierInfo pointers, and keep the identifire up to date,
365 /// as needed.
366 ExternalPreprocessorSource *ExternalLookup = nullptr;
367
368 /// Entity used to look up stored header file information.
369 ExternalHeaderFileInfoSource *ExternalSource = nullptr;
370
371 /// Scan all of the header maps at the beginning of SearchDirs and
372 /// map their keys to the SearchDir index of their header map.
373 void indexInitialHeaderMaps();
374
375public:
376 HeaderSearch(const HeaderSearchOptions &HSOpts, SourceManager &SourceMgr,
377 DiagnosticsEngine &Diags, const LangOptions &LangOpts,
378 const TargetInfo *Target);
379 HeaderSearch(const HeaderSearch &) = delete;
380 HeaderSearch &operator=(const HeaderSearch &) = delete;
381
382 /// Retrieve the header-search options with which this header search
383 /// was initialized.
384 const HeaderSearchOptions &getHeaderSearchOpts() const { return HSOpts; }
385
386 FileManager &getFileMgr() const { return FileMgr; }
387
388 DiagnosticsEngine &getDiags() const { return Diags; }
389
390 /// Interface for setting the file search paths.
391 void SetSearchPaths(std::vector<DirectoryLookup> dirs, unsigned angledDirIdx,
392 unsigned systemDirIdx,
393 llvm::DenseMap<unsigned, unsigned> searchDirToHSEntry);
394
395 /// Add an additional search path.
396 void AddSearchPath(const DirectoryLookup &dir, bool isAngled);
397
398 /// Add an additional system search path.
399 void AddSystemSearchPath(const DirectoryLookup &dir) {
400 SearchDirs.push_back(x: dir);
401 SearchDirsUsage.push_back(x: false);
402 }
403
404 /// Set the list of system header prefixes.
405 void SetSystemHeaderPrefixes(ArrayRef<std::pair<std::string, bool>> P) {
406 SystemHeaderPrefixes.assign(first: P.begin(), last: P.end());
407 }
408
409 /// Checks whether the map exists or not.
410 bool HasIncludeAliasMap() const { return (bool)IncludeAliases; }
411
412 /// Map the source include name to the dest include name.
413 ///
414 /// The Source should include the angle brackets or quotes, the dest
415 /// should not. This allows for distinction between <> and "" headers.
416 void AddIncludeAlias(StringRef Source, StringRef Dest) {
417 if (!IncludeAliases)
418 IncludeAliases.reset(p: new IncludeAliasMap);
419 (*IncludeAliases)[Source] = std::string(Dest);
420 }
421
422 /// Maps one header file name to a different header
423 /// file name, for use with the include_alias pragma. Note that the source
424 /// file name should include the angle brackets or quotes. Returns StringRef
425 /// as null if the header cannot be mapped.
426 StringRef MapHeaderToIncludeAlias(StringRef Source) {
427 assert(IncludeAliases && "Trying to map headers when there's no map");
428
429 // Do any filename replacements before anything else
430 IncludeAliasMap::const_iterator Iter = IncludeAliases->find(Key: Source);
431 if (Iter != IncludeAliases->end())
432 return Iter->second;
433 return {};
434 }
435
436 /// Set the context hash to use for module cache paths.
437 void setContextHash(StringRef Hash) { ContextHash = std::string(Hash); }
438
439 /// Set the module cache path with the context hash (unless suppressed).
440 void setSpecificModuleCachePath(StringRef Path) {
441 SpecificModuleCachePath = std::string(Path);
442 }
443
444 /// Retrieve the context hash.
445 StringRef getContextHash() const { return ContextHash; }
446
447 /// Retrieve the module cache path with the context hash (unless suppressed).
448 StringRef getSpecificModuleCachePath() const {
449 return SpecificModuleCachePath;
450 }
451
452 /// Forget everything we know about headers so far.
453 void ClearFileInfo() {
454 FileInfo.clear();
455 }
456
457 void SetExternalLookup(ExternalPreprocessorSource *EPS) {
458 ExternalLookup = EPS;
459 }
460
461 ExternalPreprocessorSource *getExternalLookup() const {
462 return ExternalLookup;
463 }
464
465 /// Set the external source of header information.
466 void SetExternalSource(ExternalHeaderFileInfoSource *ES) {
467 ExternalSource = ES;
468 }
469
470 void diagnoseHeaderShadowing(
471 StringRef Filename, OptionalFileEntryRef FE, bool &DiagnosedShadowing,
472 SourceLocation IncludeLoc, ConstSearchDirIterator FromDir,
473 ArrayRef<std::pair<OptionalFileEntryRef, DirectoryEntryRef>> Includers,
474 bool isAngled, int IncluderLoopIndex, ConstSearchDirIterator MainLoopIt);
475
476 /// Set the target information for the header search, if not
477 /// already known.
478 void setTarget(const TargetInfo &Target);
479
480 /// Given a "foo" or \<foo> reference, look up the indicated file,
481 /// return null on failure.
482 ///
483 /// \returns If successful, this returns 'UsedDir', the DirectoryLookup member
484 /// the file was found in, or null if not applicable.
485 ///
486 /// \param IncludeLoc Used for diagnostics if valid.
487 ///
488 /// \param isAngled indicates whether the file reference is a <> reference.
489 ///
490 /// \param CurDir If non-null, the file was found in the specified directory
491 /// search location. This is used to implement \#include_next.
492 ///
493 /// \param Includers Indicates where the \#including file(s) are, in case
494 /// relative searches are needed. In reverse order of inclusion.
495 ///
496 /// \param SearchPath If non-null, will be set to the search path relative
497 /// to which the file was found. If the include path is absolute, SearchPath
498 /// will be set to an empty string.
499 ///
500 /// \param RelativePath If non-null, will be set to the path relative to
501 /// SearchPath at which the file was found. This only differs from the
502 /// Filename for framework includes.
503 ///
504 /// \param SuggestedModule If non-null, and the file found is semantically
505 /// part of a known module, this will be set to the module that should
506 /// be imported instead of preprocessing/parsing the file found.
507 ///
508 /// \param IsMapped If non-null, and the search involved header maps, set to
509 /// true.
510 ///
511 /// \param IsFrameworkFound If non-null, will be set to true if a framework is
512 /// found in any of searched SearchDirs. Will be set to false if a framework
513 /// is found only through header maps. Doesn't guarantee the requested file is
514 /// found.
515 OptionalFileEntryRef LookupFile(
516 StringRef Filename, SourceLocation IncludeLoc, bool isAngled,
517 ConstSearchDirIterator FromDir, ConstSearchDirIterator *CurDir,
518 ArrayRef<std::pair<OptionalFileEntryRef, DirectoryEntryRef>> Includers,
519 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
520 Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule,
521 bool *IsMapped, bool *IsFrameworkFound, bool SkipCache = false,
522 bool BuildSystemModule = false, bool OpenFile = true,
523 bool CacheFailures = true);
524
525 /// Look up a subframework for the specified \#include file.
526 ///
527 /// For example, if \#include'ing <HIToolbox/HIToolbox.h> from
528 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if
529 /// HIToolbox is a subframework within Carbon.framework. If so, return
530 /// the FileEntry for the designated file, otherwise return null.
531 OptionalFileEntryRef LookupSubframeworkHeader(
532 StringRef Filename, FileEntryRef ContextFileEnt,
533 SmallVectorImpl<char> *SearchPath, SmallVectorImpl<char> *RelativePath,
534 Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule);
535
536 /// Look up the specified framework name in our framework cache.
537 /// \returns The DirectoryEntry it is in if we know, null otherwise.
538 FrameworkCacheEntry &LookupFrameworkCache(StringRef FWName) {
539 return FrameworkMap[FWName];
540 }
541
542 /// Mark the specified file as a target of a \#include,
543 /// \#include_next, or \#import directive.
544 ///
545 /// \return false if \#including the file will have no effect or true
546 /// if we should include it.
547 ///
548 /// \param M The module to which `File` belongs (this should usually be the
549 /// SuggestedModule returned by LookupFile/LookupSubframeworkHeader)
550 bool ShouldEnterIncludeFile(Preprocessor &PP, FileEntryRef File,
551 bool isImport, bool ModulesEnabled, Module *M,
552 bool &IsFirstIncludeOfFile);
553
554 /// Return whether the specified file is a normal header,
555 /// a system header, or a C++ friendly system header.
556 SrcMgr::CharacteristicKind getFileDirFlavor(FileEntryRef File) {
557 if (const HeaderFileInfo *HFI = getExistingFileInfo(FE: File))
558 return (SrcMgr::CharacteristicKind)HFI->DirInfo;
559 return (SrcMgr::CharacteristicKind)HeaderFileInfo().DirInfo;
560 }
561
562 /// Mark the specified file as a "once only" file due to
563 /// \#pragma once.
564 void MarkFileIncludeOnce(FileEntryRef File) {
565 getFileInfo(FE: File).isPragmaOnce = true;
566 }
567
568 /// Mark the specified file as a system header, e.g. due to
569 /// \#pragma GCC system_header.
570 void MarkFileSystemHeader(FileEntryRef File) {
571 getFileInfo(FE: File).DirInfo = SrcMgr::C_System;
572 }
573
574 /// Mark the specified file as part of a module.
575 void MarkFileModuleHeader(FileEntryRef FE, ModuleMap::ModuleHeaderRole Role,
576 bool isCompilingModuleHeader);
577
578 /// Mark the specified file as having a controlling macro.
579 ///
580 /// This is used by the multiple-include optimization to eliminate
581 /// no-op \#includes.
582 void SetFileControllingMacro(FileEntryRef File,
583 const IdentifierInfo *ControllingMacro) {
584 getFileInfo(FE: File).LazyControllingMacro = ControllingMacro;
585 }
586
587 /// Determine whether this file is intended to be safe from
588 /// multiple inclusions, e.g., it has \#pragma once or a controlling
589 /// macro.
590 ///
591 /// This routine does not consider the effect of \#import
592 bool isFileMultipleIncludeGuarded(FileEntryRef File) const;
593
594 /// Determine whether the given file is known to have ever been \#imported.
595 bool hasFileBeenImported(FileEntryRef File) const {
596 const HeaderFileInfo *FI = getExistingFileInfo(FE: File);
597 return FI && FI->isImport;
598 }
599
600 /// Determine which HeaderSearchOptions::UserEntries have been successfully
601 /// used so far and mark their index with 'true' in the resulting bit vector.
602 /// Note: implicit module maps don't contribute to entry usage.
603 std::vector<bool> computeUserEntryUsage() const;
604
605 /// Collect which HeaderSearchOptions::VFSOverlayFiles have been meaningfully
606 /// used so far and mark their index with 'true' in the resulting bit vector.
607 ///
608 /// Note: this ignores VFSs that redirect non-affecting files such as unused
609 /// modulemaps.
610 std::vector<bool> collectVFSUsageAndClear() const;
611
612 /// This method returns a HeaderMap for the specified
613 /// FileEntry, uniquing them through the 'HeaderMaps' datastructure.
614 const HeaderMap *CreateHeaderMap(FileEntryRef FE);
615
616 /// Get filenames for all registered header maps.
617 void getHeaderMapFileNames(SmallVectorImpl<std::string> &Names) const;
618
619 /// Retrieve the name of the cached module file that should be used
620 /// to load the given module.
621 ///
622 /// \param Module The module whose module file name will be returned.
623 ///
624 /// \returns The name of the module file that corresponds to this module,
625 /// or an empty string if this module does not correspond to any module file.
626 std::string getCachedModuleFileName(Module *Module);
627
628 /// Retrieve the name of the prebuilt module file that should be used
629 /// to load a module with the given name.
630 ///
631 /// \param ModuleName The module whose module file name will be returned.
632 ///
633 /// \param FileMapOnly If true, then only look in the explicit module name
634 // to file name map and skip the directory search.
635 ///
636 /// \returns The name of the module file that corresponds to this module,
637 /// or an empty string if this module does not correspond to any module file.
638 std::string getPrebuiltModuleFileName(StringRef ModuleName,
639 bool FileMapOnly = false);
640
641 /// Retrieve the name of the prebuilt module file that should be used
642 /// to load the given module.
643 ///
644 /// \param Module The module whose module file name will be returned.
645 ///
646 /// \returns The name of the module file that corresponds to this module,
647 /// or an empty string if this module does not correspond to any module file.
648 std::string getPrebuiltImplicitModuleFileName(Module *Module);
649
650 /// Retrieve the name of the (to-be-)cached module file that should
651 /// be used to load a module with the given name.
652 ///
653 /// \param ModuleName The module whose module file name will be returned.
654 ///
655 /// \param ModuleMapPath A path that when combined with \c ModuleName
656 /// uniquely identifies this module. See Module::ModuleMap.
657 ///
658 /// \returns The name of the module file that corresponds to this module,
659 /// or an empty string if this module does not correspond to any module file.
660 std::string getCachedModuleFileName(StringRef ModuleName,
661 StringRef ModuleMapPath);
662
663 /// Lookup a module Search for a module with the given name.
664 ///
665 /// \param ModuleName The name of the module we're looking for.
666 ///
667 /// \param ImportLoc Location of the module include/import.
668 ///
669 /// \param AllowSearch Whether we are allowed to search in the various
670 /// search directories to produce a module definition. If not, this lookup
671 /// will only return an already-known module.
672 ///
673 /// \param AllowExtraModuleMapSearch Whether we allow to search modulemaps
674 /// in subdirectories.
675 ///
676 /// \returns The module with the given name.
677 Module *lookupModule(StringRef ModuleName,
678 SourceLocation ImportLoc = SourceLocation(),
679 bool AllowSearch = true,
680 bool AllowExtraModuleMapSearch = false);
681
682 /// Try to find a module map file in the given directory, returning
683 /// \c nullopt if none is found.
684 OptionalFileEntryRef lookupModuleMapFile(DirectoryEntryRef Dir,
685 bool IsFramework);
686
687 /// Determine whether there is a module map that may map the header
688 /// with the given file name to a (sub)module.
689 /// Always returns false if modules are disabled.
690 ///
691 /// \param Filename The name of the file.
692 ///
693 /// \param Root The "root" directory, at which we should stop looking for
694 /// module maps.
695 ///
696 /// \param IsSystem Whether the directories we're looking at are system
697 /// header directories.
698 bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root,
699 bool IsSystem);
700
701 /// Retrieve the module that corresponds to the given file, if any.
702 ///
703 /// \param File The header that we wish to map to a module.
704 /// \param AllowTextual Whether we want to find textual headers too.
705 ModuleMap::KnownHeader findModuleForHeader(FileEntryRef File,
706 bool AllowTextual = false,
707 bool AllowExcluded = false) const;
708
709 /// Retrieve all the modules corresponding to the given file.
710 ///
711 /// \ref findModuleForHeader should typically be used instead of this.
712 ArrayRef<ModuleMap::KnownHeader>
713 findAllModulesForHeader(FileEntryRef File) const;
714
715 /// Like \ref findAllModulesForHeader, but do not attempt to infer module
716 /// ownership from umbrella headers if we've not already done so.
717 ArrayRef<ModuleMap::KnownHeader>
718 findResolvedModulesForHeader(FileEntryRef File) const;
719
720 /// Read the contents of the given module map file.
721 ///
722 /// \param File The module map file.
723 /// \param IsSystem Whether this file is in a system header directory.
724 /// \param ID If the module map file is already mapped (perhaps as part of
725 /// processing a preprocessed module), the ID of the file.
726 /// \param Offset [inout] An offset within ID to start parsing. On exit,
727 /// filled by the end of the parsed contents (either EOF or the
728 /// location of an end-of-module-map pragma).
729 /// \param OriginalModuleMapFile The original path to the module map file,
730 /// used to resolve paths within the module (this is required when
731 /// building the module from preprocessed source).
732 /// \returns true if an error occurred, false otherwise.
733 bool parseAndLoadModuleMapFile(FileEntryRef File, bool IsSystem,
734 FileID ID = FileID(),
735 unsigned *Offset = nullptr,
736 StringRef OriginalModuleMapFile = StringRef());
737
738 /// Collect the set of all known, top-level modules.
739 ///
740 /// \param Modules Will be filled with the set of known, top-level modules.
741 void collectAllModules(SmallVectorImpl<Module *> &Modules);
742
743 /// Load all known, top-level system modules.
744 void loadTopLevelSystemModules();
745
746private:
747 /// Lookup a module with the given module name and search-name.
748 ///
749 /// \param ModuleName The name of the module we're looking for.
750 ///
751 /// \param SearchName The "search-name" to derive filesystem paths from
752 /// when looking for the module map; this is usually equal to ModuleName,
753 /// but for compatibility with some buggy frameworks, additional attempts
754 /// may be made to find the module under a related-but-different search-name.
755 ///
756 /// \param ImportLoc Location of the module include/import.
757 ///
758 /// \param AllowExtraModuleMapSearch Whether we allow to search modulemaps
759 /// in subdirectories.
760 ///
761 /// \returns The module named ModuleName.
762 Module *lookupModule(StringRef ModuleName, StringRef SearchName,
763 SourceLocation ImportLoc,
764 bool AllowExtraModuleMapSearch = false);
765
766 /// Retrieve the name of the (to-be-)cached module file that should
767 /// be used to load a module with the given name.
768 ///
769 /// \param ModuleName The module whose module file name will be returned.
770 ///
771 /// \param ModuleMapPath A path that when combined with \c ModuleName
772 /// uniquely identifies this module. See Module::ModuleMap.
773 ///
774 /// \param CachePath A path to the module cache.
775 ///
776 /// \returns The name of the module file that corresponds to this module,
777 /// or an empty string if this module does not correspond to any module file.
778 std::string getCachedModuleFileNameImpl(StringRef ModuleName,
779 StringRef ModuleMapPath,
780 StringRef CachePath);
781
782 /// Retrieve a module with the given name, which may be part of the
783 /// given framework.
784 ///
785 /// \param Name The name of the module to retrieve.
786 ///
787 /// \param Dir The framework directory (e.g., ModuleName.framework).
788 ///
789 /// \param IsSystem Whether the framework directory is part of the system
790 /// frameworks.
791 ///
792 /// \returns The module, if found; otherwise, null.
793 Module *loadFrameworkModule(StringRef Name, DirectoryEntryRef Dir,
794 bool IsSystem);
795
796 /// Load all of the module maps within the immediate subdirectories
797 /// of the given search directory.
798 void loadSubdirectoryModuleMaps(DirectoryLookup &SearchDir);
799
800 /// Find and suggest a usable module for the given file.
801 ///
802 /// \return \c true if the file can be used, \c false if we are not permitted to
803 /// find this file due to requirements from \p RequestingModule.
804 bool findUsableModuleForHeader(FileEntryRef File, const DirectoryEntry *Root,
805 Module *RequestingModule,
806 ModuleMap::KnownHeader *SuggestedModule,
807 bool IsSystemHeaderDir);
808
809 /// Find and suggest a usable module for the given file, which is part of
810 /// the specified framework.
811 ///
812 /// \return \c true if the file can be used, \c false if we are not permitted to
813 /// find this file due to requirements from \p RequestingModule.
814 bool findUsableModuleForFrameworkHeader(
815 FileEntryRef File, StringRef FrameworkName, Module *RequestingModule,
816 ModuleMap::KnownHeader *SuggestedModule, bool IsSystemFramework);
817
818 /// Look up the file with the specified name and determine its owning
819 /// module.
820 OptionalFileEntryRef
821 getFileAndSuggestModule(StringRef FileName, SourceLocation IncludeLoc,
822 const DirectoryEntry *Dir, bool IsSystemHeaderDir,
823 Module *RequestingModule,
824 ModuleMap::KnownHeader *SuggestedModule,
825 bool OpenFile = true, bool CacheFailures = true);
826
827 /// Cache the result of a successful lookup at the given include location
828 /// using the search path at \c HitIt.
829 void cacheLookupSuccess(LookupFileCacheInfo &CacheLookup,
830 ConstSearchDirIterator HitIt,
831 SourceLocation IncludeLoc);
832
833 /// Note that a lookup at the given include location was successful using the
834 /// search path at index `HitIdx`.
835 void noteLookupUsage(unsigned HitIdx, SourceLocation IncludeLoc);
836
837public:
838 /// Retrieve the module map.
839 ModuleMap &getModuleMap() { return ModMap; }
840
841 /// Retrieve the module map.
842 const ModuleMap &getModuleMap() const { return ModMap; }
843
844 unsigned header_file_size() const { return FileInfo.size(); }
845
846 /// Return the HeaderFileInfo structure for the specified FileEntry, in
847 /// preparation for updating it in some way.
848 HeaderFileInfo &getFileInfo(FileEntryRef FE);
849
850 /// Return the HeaderFileInfo structure for the specified FileEntry, if it has
851 /// ever been filled in (either locally or externally).
852 const HeaderFileInfo *getExistingFileInfo(FileEntryRef FE) const;
853
854 /// Return the headerFileInfo structure for the specified FileEntry, if it has
855 /// ever been filled in locally.
856 const HeaderFileInfo *getExistingLocalFileInfo(FileEntryRef FE) const;
857
858 SearchDirIterator search_dir_begin() { return {*this, 0}; }
859 SearchDirIterator search_dir_end() { return {*this, SearchDirs.size()}; }
860 SearchDirRange search_dir_range() {
861 return {search_dir_begin(), search_dir_end()};
862 }
863
864 ConstSearchDirIterator search_dir_begin() const { return quoted_dir_begin(); }
865 ConstSearchDirIterator search_dir_nth(size_t n) const {
866 assert(n < SearchDirs.size());
867 return {*this, n};
868 }
869 ConstSearchDirIterator search_dir_end() const { return system_dir_end(); }
870 ConstSearchDirRange search_dir_range() const {
871 return {search_dir_begin(), search_dir_end()};
872 }
873
874 unsigned search_dir_size() const { return SearchDirs.size(); }
875
876 ConstSearchDirIterator quoted_dir_begin() const { return {*this, 0}; }
877 ConstSearchDirIterator quoted_dir_end() const { return angled_dir_begin(); }
878
879 ConstSearchDirIterator angled_dir_begin() const {
880 return {*this, AngledDirIdx};
881 }
882 ConstSearchDirIterator angled_dir_end() const { return system_dir_begin(); }
883
884 ConstSearchDirIterator system_dir_begin() const {
885 return {*this, SystemDirIdx};
886 }
887 ConstSearchDirIterator system_dir_end() const {
888 return {*this, SearchDirs.size()};
889 }
890
891 /// Get the index of the given search directory.
892 unsigned searchDirIdx(const DirectoryLookup &DL) const;
893
894 /// Retrieve a uniqued framework name.
895 StringRef getUniqueFrameworkName(StringRef Framework);
896
897 /// Retrieve the include name for the header.
898 ///
899 /// \param File The entry for a given header.
900 /// \returns The name of how the file was included when the header's location
901 /// was resolved.
902 StringRef getIncludeNameForHeader(const FileEntry *File) const;
903
904 /// Suggest a path by which the specified file could be found, for use in
905 /// diagnostics to suggest a #include. Returned path will only contain forward
906 /// slashes as separators. MainFile is the absolute path of the file that we
907 /// are generating the diagnostics for. It will try to shorten the path using
908 /// MainFile location, if none of the include search directories were prefix
909 /// of File.
910 ///
911 /// \param IsAngled If non-null, filled in to indicate whether the suggested
912 /// path should be referenced as <Header.h> instead of "Header.h".
913 std::string suggestPathToFileForDiagnostics(FileEntryRef File,
914 llvm::StringRef MainFile,
915 bool *IsAngled = nullptr) const;
916
917 /// Suggest a path by which the specified file could be found, for use in
918 /// diagnostics to suggest a #include. Returned path will only contain forward
919 /// slashes as separators. MainFile is the absolute path of the file that we
920 /// are generating the diagnostics for. It will try to shorten the path using
921 /// MainFile location, if none of the include search directories were prefix
922 /// of File.
923 ///
924 /// \param WorkingDir If non-empty, this will be prepended to search directory
925 /// paths that are relative.
926 std::string suggestPathToFileForDiagnostics(llvm::StringRef File,
927 llvm::StringRef WorkingDir,
928 llvm::StringRef MainFile,
929 bool *IsAngled = nullptr) const;
930
931 void PrintStats();
932
933 size_t getTotalMemory() const;
934
935private:
936 /// Describes what happened when we tried to load or parse a module map file.
937 enum ModuleMapResult {
938 /// The module map file had already been processed.
939 MMR_AlreadyProcessed,
940
941 /// The module map file was processed by this invocation.
942 MMR_NewlyProcessed,
943
944 /// There is was directory with the given name.
945 MMR_NoDirectory,
946
947 /// There was either no module map file or the module map file was
948 /// invalid.
949 MMR_InvalidModuleMap
950 };
951
952 ModuleMapResult parseAndLoadModuleMapFileImpl(FileEntryRef File,
953 bool IsSystem,
954 DirectoryEntryRef Dir,
955 FileID ID = FileID(),
956 unsigned *Offset = nullptr);
957
958 ModuleMapResult parseModuleMapFileImpl(FileEntryRef File, bool IsSystem,
959 DirectoryEntryRef Dir,
960 FileID ID = FileID());
961
962 /// Try to load the module map file in the given directory.
963 ///
964 /// \param DirName The name of the directory where we will look for a module
965 /// map file.
966 /// \param IsSystem Whether this is a system header directory.
967 /// \param IsFramework Whether this is a framework directory.
968 ///
969 /// \returns The result of attempting to load the module map file from the
970 /// named directory.
971 ModuleMapResult parseAndLoadModuleMapFile(StringRef DirName, bool IsSystem,
972 bool IsFramework);
973
974 /// Try to load the module map file in the given directory.
975 ///
976 /// \param Dir The directory where we will look for a module map file.
977 /// \param IsSystem Whether this is a system header directory.
978 /// \param IsFramework Whether this is a framework directory.
979 ///
980 /// \returns The result of attempting to load the module map file from the
981 /// named directory.
982 ModuleMapResult parseAndLoadModuleMapFile(DirectoryEntryRef Dir,
983 bool IsSystem, bool IsFramework);
984
985 ModuleMapResult parseModuleMapFile(StringRef DirName, bool IsSystem,
986 bool IsFramework);
987 ModuleMapResult parseModuleMapFile(DirectoryEntryRef Dir, bool IsSystem,
988 bool IsFramework);
989};
990
991/// Apply the header search options to get given HeaderSearch object.
992void ApplyHeaderSearchOptions(HeaderSearch &HS,
993 const HeaderSearchOptions &HSOpts,
994 const LangOptions &Lang,
995 const llvm::Triple &triple);
996
997void normalizeModuleCachePath(FileManager &FileMgr, StringRef Path,
998 SmallVectorImpl<char> &NormalizedPath);
999
1000} // namespace clang
1001
1002#endif // LLVM_CLANG_LEX_HEADERSEARCH_H
1003