diff --git a/clang/include/clang/Basic/DiagnosticLexKinds.td b/clang/include/clang/Basic/DiagnosticLexKinds.td --- a/clang/include/clang/Basic/DiagnosticLexKinds.td +++ b/clang/include/clang/Basic/DiagnosticLexKinds.td @@ -423,6 +423,9 @@ "#pragma hdrstop filename not supported, " "/Fp can be used to specify precompiled header filename">, InGroup; +def remark_pp_include_header_search_usage : Remark< + "user-provided search path used: '%0'">, + InGroup>; def err_pp_file_not_found_angled_include_not_fatal : Error< "'%0' file not found with %select{include|import}1; " "use \"quotes\" instead">; diff --git a/clang/include/clang/Lex/HeaderSearch.h b/clang/include/clang/Lex/HeaderSearch.h --- a/clang/include/clang/Lex/HeaderSearch.h +++ b/clang/include/clang/Lex/HeaderSearch.h @@ -161,6 +161,9 @@ /// Header-search options used to initialize this header search. std::shared_ptr HSOpts; + /// Mapping from SearchDir to HeaderSearchOptions::UserEntries indices. + llvm::DenseMap SearchDirToHSEntry; + DiagnosticsEngine &Diags; FileManager &FileMgr; @@ -171,6 +174,9 @@ /// NoCurDirSearch is true, then the check for the file in the current /// directory is suppressed. std::vector SearchDirs; + /// Whether the DirectoryLookup at the corresponding index in SearchDirs has + /// been successfully used to lookup a file. + std::vector SearchDirsUsage; unsigned AngledDirIdx = 0; unsigned SystemDirIdx = 0; bool NoCurDirSearch = false; @@ -269,15 +275,17 @@ DiagnosticsEngine &getDiags() const { return Diags; } /// Interface for setting the file search paths. - void SetSearchPaths(const std::vector &dirs, - unsigned angledDirIdx, unsigned systemDirIdx, - bool noCurDirSearch) { + void SetSearchPaths(std::vector dirs, unsigned angledDirIdx, + unsigned systemDirIdx, bool noCurDirSearch, + llvm::DenseMap searchDirToHSEntry) { assert(angledDirIdx <= systemDirIdx && systemDirIdx <= dirs.size() && "Directory indices are unordered"); - SearchDirs = dirs; + SearchDirs = std::move(dirs); + SearchDirsUsage.assign(SearchDirs.size(), false); AngledDirIdx = angledDirIdx; SystemDirIdx = systemDirIdx; NoCurDirSearch = noCurDirSearch; + SearchDirToHSEntry = std::move(searchDirToHSEntry); //LookupFileCache.clear(); } @@ -285,6 +293,7 @@ void AddSearchPath(const DirectoryLookup &dir, bool isAngled) { unsigned idx = isAngled ? SystemDirIdx : AngledDirIdx; SearchDirs.insert(SearchDirs.begin() + idx, dir); + SearchDirsUsage.insert(SearchDirsUsage.begin() + idx, false); if (!isAngled) AngledDirIdx++; SystemDirIdx++; @@ -492,6 +501,10 @@ return FI && FI->isImport; } + /// Determine which HeaderSearchOptions::UserEntries have been successfully + /// used so far and mark their index with 'true' in the resulting bit vector. + std::vector computeUserEntryUsage() const; + /// This method returns a HeaderMap for the specified /// FileEntry, uniquing them through the 'HeaderMaps' datastructure. const HeaderMap *CreateHeaderMap(const FileEntry *FE); @@ -694,6 +707,9 @@ Module *RequestingModule, ModuleMap::KnownHeader *SuggestedModule); + /// Cache a successful lookup. + void cacheLookupSuccess(LookupFileCacheInfo &CacheLookup, unsigned HitIdx); + public: /// Retrieve the module map. ModuleMap &getModuleMap() { return ModMap; } diff --git a/clang/lib/Frontend/InitHeaderSearch.cpp b/clang/lib/Frontend/InitHeaderSearch.cpp --- a/clang/lib/Frontend/InitHeaderSearch.cpp +++ b/clang/lib/Frontend/InitHeaderSearch.cpp @@ -36,9 +36,11 @@ struct DirectoryLookupInfo { IncludeDirGroup Group; DirectoryLookup Lookup; + Optional UserEntryIdx; - DirectoryLookupInfo(IncludeDirGroup Group, DirectoryLookup Lookup) - : Group(Group), Lookup(Lookup) {} + DirectoryLookupInfo(IncludeDirGroup Group, DirectoryLookup Lookup, + Optional UserEntryIdx) + : Group(Group), Lookup(Lookup), UserEntryIdx(UserEntryIdx) {} }; /// InitHeaderSearch - This class makes it easier to set the search paths of @@ -60,13 +62,15 @@ /// AddPath - Add the specified path to the specified group list, prefixing /// the sysroot if used. /// Returns true if the path exists, false if it was ignored. - bool AddPath(const Twine &Path, IncludeDirGroup Group, bool isFramework); + bool AddPath(const Twine &Path, IncludeDirGroup Group, bool isFramework, + Optional UserEntryIdx = None); /// AddUnmappedPath - Add the specified path to the specified group list, /// without performing any sysroot remapping. /// Returns true if the path exists, false if it was ignored. bool AddUnmappedPath(const Twine &Path, IncludeDirGroup Group, - bool isFramework); + bool isFramework, + Optional UserEntryIdx = None); /// AddSystemHeaderPrefix - Add the specified prefix to the system header /// prefix list. @@ -119,22 +123,25 @@ } bool InitHeaderSearch::AddPath(const Twine &Path, IncludeDirGroup Group, - bool isFramework) { + bool isFramework, + Optional UserEntryIdx) { // Add the path with sysroot prepended, if desired and this is a system header // group. if (HasSysroot) { SmallString<256> MappedPathStorage; StringRef MappedPathStr = Path.toStringRef(MappedPathStorage); if (CanPrefixSysroot(MappedPathStr)) { - return AddUnmappedPath(IncludeSysroot + Path, Group, isFramework); + return AddUnmappedPath(IncludeSysroot + Path, Group, isFramework, + UserEntryIdx); } } - return AddUnmappedPath(Path, Group, isFramework); + return AddUnmappedPath(Path, Group, isFramework, UserEntryIdx); } bool InitHeaderSearch::AddUnmappedPath(const Twine &Path, IncludeDirGroup Group, - bool isFramework) { + bool isFramework, + Optional UserEntryIdx) { assert(!Path.isTriviallyEmpty() && "can't handle empty path here"); FileManager &FM = Headers.getFileMgr(); @@ -160,7 +167,8 @@ // If the directory exists, add it. if (auto DE = FM.getOptionalDirectoryRef(MappedPathStr)) { - IncludePath.emplace_back(Group, DirectoryLookup(*DE, Type, isFramework)); + IncludePath.emplace_back(Group, DirectoryLookup(*DE, Type, isFramework), + UserEntryIdx); return true; } @@ -171,7 +179,8 @@ if (const HeaderMap *HM = Headers.CreateHeaderMap(*FE)) { // It is a headermap, add it to the search path. IncludePath.emplace_back( - Group, DirectoryLookup(HM, Type, Group == IndexHeaderMap)); + Group, DirectoryLookup(HM, Type, Group == IndexHeaderMap), + UserEntryIdx); return true; } } @@ -471,7 +480,7 @@ /// RemoveDuplicates - If there are duplicate directory entries in the specified /// search list, remove the later (dead) ones. Returns the number of non-system /// headers removed, which is used to update NumAngled. -static unsigned RemoveDuplicates(std::vector &SearchList, +static unsigned RemoveDuplicates(std::vector &SearchList, unsigned First, bool Verbose) { llvm::SmallPtrSet SeenDirs; llvm::SmallPtrSet SeenFrameworkDirs; @@ -480,7 +489,7 @@ for (unsigned i = First; i != SearchList.size(); ++i) { unsigned DirToRemove = i; - const DirectoryLookup &CurEntry = SearchList[i]; + const DirectoryLookup &CurEntry = SearchList[i].Lookup; if (CurEntry.isNormalDir()) { // If this isn't the first time we've seen this dir, remove it. @@ -510,7 +519,7 @@ for (FirstDir = First;; ++FirstDir) { assert(FirstDir != i && "Didn't find dupe?"); - const DirectoryLookup &SearchEntry = SearchList[FirstDir]; + const DirectoryLookup &SearchEntry = SearchList[FirstDir].Lookup; // If these are different lookup types, then they can't be the dupe. if (SearchEntry.getLookupType() != CurEntry.getLookupType()) @@ -532,7 +541,7 @@ // If the first dir in the search path is a non-system dir, zap it // instead of the system one. - if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User) + if (SearchList[FirstDir].Lookup.getDirCharacteristic() == SrcMgr::C_User) DirToRemove = FirstDir; } @@ -554,16 +563,37 @@ return NonSystemRemoved; } +/// Extract DirectoryLookups from DirectoryLookupInfos. +static std::vector +extractLookups(const std::vector &Infos) { + std::vector Lookups; + Lookups.reserve(Infos.size()); + llvm::transform(Infos, std::back_inserter(Lookups), + [](const DirectoryLookupInfo &Info) { return Info.Lookup; }); + return Lookups; +} + +/// Collect the mapping between indices of DirectoryLookups and UserEntries. +static llvm::DenseMap +mapToUserEntries(const std::vector &Infos) { + llvm::DenseMap LookupsToUserEntries; + for (unsigned I = 0, E = Infos.size(); I < E; ++I) { + // Check whether this DirectoryLookup maps to a HeaderSearch::UserEntry. + if (Infos[I].UserEntryIdx) + LookupsToUserEntries.insert({I, *Infos[I].UserEntryIdx}); + } + return LookupsToUserEntries; +} void InitHeaderSearch::Realize(const LangOptions &Lang) { // Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList. - std::vector SearchList; + std::vector SearchList; SearchList.reserve(IncludePath.size()); // Quoted arguments go first. for (auto &Include : IncludePath) if (Include.Group == Quoted) - SearchList.push_back(Include.Lookup); + SearchList.push_back(Include); // Deduplicate and remember index. RemoveDuplicates(SearchList, 0, Verbose); @@ -571,7 +601,7 @@ for (auto &Include : IncludePath) if (Include.Group == Angled || Include.Group == IndexHeaderMap) - SearchList.push_back(Include.Lookup); + SearchList.push_back(Include); RemoveDuplicates(SearchList, NumQuoted, Verbose); unsigned NumAngled = SearchList.size(); @@ -583,11 +613,11 @@ Include.Group == CXXSystem) || (Lang.ObjC && !Lang.CPlusPlus && Include.Group == ObjCSystem) || (Lang.ObjC && Lang.CPlusPlus && Include.Group == ObjCXXSystem)) - SearchList.push_back(Include.Lookup); + SearchList.push_back(Include); for (auto &Include : IncludePath) if (Include.Group == After) - SearchList.push_back(Include.Lookup); + SearchList.push_back(Include); // Remove duplicates across both the Angled and System directories. GCC does // this and failing to remove duplicates across these two groups breaks @@ -596,7 +626,8 @@ NumAngled -= NonSystemRemoved; bool DontSearchCurDir = false; // TODO: set to true if -I- is set? - Headers.SetSearchPaths(SearchList, NumQuoted, NumAngled, DontSearchCurDir); + Headers.SetSearchPaths(extractLookups(SearchList), NumQuoted, NumAngled, + DontSearchCurDir, mapToUserEntries(SearchList)); Headers.SetSystemHeaderPrefixes(SystemHeaderPrefixes); @@ -606,14 +637,14 @@ for (unsigned i = 0, e = SearchList.size(); i != e; ++i) { if (i == NumQuoted) llvm::errs() << "#include <...> search starts here:\n"; - StringRef Name = SearchList[i].getName(); + StringRef Name = SearchList[i].Lookup.getName(); const char *Suffix; - if (SearchList[i].isNormalDir()) + if (SearchList[i].Lookup.isNormalDir()) Suffix = ""; - else if (SearchList[i].isFramework()) + else if (SearchList[i].Lookup.isFramework()) Suffix = " (framework directory)"; else { - assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup"); + assert(SearchList[i].Lookup.isHeaderMap() && "Unknown DirectoryLookup"); Suffix = " (headermap)"; } llvm::errs() << " " << Name << Suffix << "\n"; @@ -632,9 +663,9 @@ for (unsigned i = 0, e = HSOpts.UserEntries.size(); i != e; ++i) { const HeaderSearchOptions::Entry &E = HSOpts.UserEntries[i]; if (E.IgnoreSysRoot) { - Init.AddUnmappedPath(E.Path, E.Group, E.IsFramework); + Init.AddUnmappedPath(E.Path, E.Group, E.IsFramework, i); } else { - Init.AddPath(E.Path, E.Group, E.IsFramework); + Init.AddPath(E.Path, E.Group, E.IsFramework, i); } } diff --git a/clang/lib/Lex/HeaderSearch.cpp b/clang/lib/Lex/HeaderSearch.cpp --- a/clang/lib/Lex/HeaderSearch.cpp +++ b/clang/lib/Lex/HeaderSearch.cpp @@ -108,6 +108,20 @@ << NumSubFrameworkLookups << " subframework lookups.\n"; } +std::vector HeaderSearch::computeUserEntryUsage() const { + std::vector UserEntryUsage(HSOpts->UserEntries.size()); + for (unsigned I = 0, E = SearchDirsUsage.size(); I < E; ++I) { + // Check whether this DirectoryLookup has been successfully used. + if (SearchDirsUsage[I]) { + auto UserEntryIdxIt = SearchDirToHSEntry.find(I); + // Check whether this DirectoryLookup maps to a HeaderSearch::UserEntry. + if (UserEntryIdxIt != SearchDirToHSEntry.end()) + UserEntryUsage[UserEntryIdxIt->second] = true; + } + } + return UserEntryUsage; +} + /// CreateHeaderMap - This method returns a HeaderMap for the specified /// FileEntry, uniquing them through the 'HeaderMaps' datastructure. const HeaderMap *HeaderSearch::CreateHeaderMap(const FileEntry *FE) { @@ -649,6 +663,17 @@ return None; } +void HeaderSearch::cacheLookupSuccess(LookupFileCacheInfo &CacheLookup, + unsigned HitIdx) { + CacheLookup.HitIdx = HitIdx; + SearchDirsUsage[HitIdx] = true; + + auto UserEntryIdxIt = SearchDirToHSEntry.find(HitIdx); + if (UserEntryIdxIt != SearchDirToHSEntry.end()) + Diags.Report(diag::remark_pp_include_header_search_usage) + << HSOpts->UserEntries[UserEntryIdxIt->second].Path; +} + void HeaderSearch::setTarget(const TargetInfo &Target) { ModMap.setTarget(Target); } @@ -987,7 +1012,7 @@ &File->getFileEntry(), isAngled, FoundByHeaderMap); // Remember this location for the next lookup we do. - CacheLookup.HitIdx = i; + cacheLookupSuccess(CacheLookup, i); return File; } @@ -1017,8 +1042,8 @@ return MSFE; } - LookupFileCacheInfo &CacheLookup = LookupFileCache[Filename]; - CacheLookup.HitIdx = LookupFileCache[ScratchFilename].HitIdx; + cacheLookupSuccess(LookupFileCache[Filename], + LookupFileCache[ScratchFilename].HitIdx); // FIXME: SuggestedModule. return File; } diff --git a/clang/test/Preprocessor/Inputs/header-search-user-entries/a/a.h b/clang/test/Preprocessor/Inputs/header-search-user-entries/a/a.h new file mode 100644 --- /dev/null +++ b/clang/test/Preprocessor/Inputs/header-search-user-entries/a/a.h @@ -0,0 +1 @@ +#include_next "a.h" diff --git a/clang/test/Preprocessor/Inputs/header-search-user-entries/a_next/a.h b/clang/test/Preprocessor/Inputs/header-search-user-entries/a_next/a.h new file mode 100644 diff --git a/clang/test/Preprocessor/Inputs/header-search-user-entries/b/b.h b/clang/test/Preprocessor/Inputs/header-search-user-entries/b/b.h new file mode 100644 diff --git a/clang/test/Preprocessor/Inputs/header-search-user-entries/d/d.h b/clang/test/Preprocessor/Inputs/header-search-user-entries/d/d.h new file mode 100644 diff --git a/clang/test/Preprocessor/header-search-user-entries.c b/clang/test/Preprocessor/header-search-user-entries.c new file mode 100644 --- /dev/null +++ b/clang/test/Preprocessor/header-search-user-entries.c @@ -0,0 +1,11 @@ +// RUN: %clang_cc1 -fsyntax-only %s -Rinclude-header-search-usage \ +// RUN: -I%S/Inputs/header-search-user-entries/a -I%S/Inputs/header-search-user-entries/a_next \ +// RUN: -I%S/Inputs/header-search-user-entries/b -I%S/Inputs/header-search-user-entries/c \ +// RUN: -I%S/Inputs/header-search-user-entries/d 2>&1 | FileCheck %s + +#include "a.h" +#include "d.h" + +// CHECK: remark: user-provided search path used: '{{.*}}/header-search-user-entries/a' +// CHECK: remark: user-provided search path used: '{{.*}}/header-search-user-entries/a_next' +// CHECK: remark: user-provided search path used: '{{.*}}/header-search-user-entries/d'