[clang] Cleanup IncludeLocMap

[kadircet]

CompilerInstance can re-use same SourceManager across multiple
frontendactions. During this process it calls
SourceManager::clearIDTables to reset any caches based on FileIDs.

It didn't reset IncludeLocMap, resulting in wrong include locations for
workflows that triggered multiple frontend-actions through same
CompilerInstance.

[llvmbot]

@llvm/pr-subscribers-clang

Author: kadir çetinkaya (kadircet)

Changes

CompilerInstance can re-use same SourceManager across multiple
frontendactions. During this process it calls
SourceManager::clearIDTables to reset any caches based on FileIDs.

It didn't reset IncludeLocMap, resulting in wrong include locations for
workflows that triggered multiple frontend-actions through same
CompilerInstance.

---

Full diff: https://github.com/llvm/llvm-project/pull/106241.diff

1 Files Affected:

• (modified) clang/lib/Basic/SourceManager.cpp (+1)

diff --git a/clang/lib/Basic/SourceManager.cpp b/clang/lib/Basic/SourceManager.cpp
index b0256a8ce9ed04..d6ec26af80aadd 100644
--- a/clang/lib/Basic/SourceManager.cpp
+++ b/clang/lib/Basic/SourceManager.cpp
@@ -350,6 +350,7 @@ void SourceManager::clearIDTables() {
   LastLineNoContentCache = nullptr;
   LastFileIDLookup = FileID();
 
+  IncludedLocMap.clear();
   if (LineTable)
     LineTable->clear();
 

[ilya-biryukov]

This looks good, but I wanted to explore if we could write a unit test for this...

[github-actions]

⚠️ C/C++ code formatter, clang-format found issues in your code. ⚠️

You can test this locally with the following command:

git-clang-format --diff b294951e3967730ffad14d51297694b1411d7af6 6f874afb3fac6a373c94897a5d17c4cd4d1653a6 --extensions cpp -- clang/lib/Basic/SourceManager.cpp clang/unittests/Basic/SourceManagerTest.cpp

View the diff from clang-format here.

diff --git a/clang/unittests/Basic/SourceManagerTest.cpp b/clang/unittests/Basic/SourceManagerTest.cpp
index c683bc2919..0f2476bd8b 100644
--- a/clang/unittests/Basic/SourceManagerTest.cpp
+++ b/clang/unittests/Basic/SourceManagerTest.cpp
@@ -474,13 +474,13 @@ TEST_F(SourceManagerTest, ResetsIncludeLocMap) {
   };
 
   auto Buf = llvm::MemoryBuffer::getMemBuffer("");
-  FileEntryRef HeaderFile = FileMgr.getVirtualFileRef(
-      "/foo.h", Buf->getBufferSize(), 0);
+  FileEntryRef HeaderFile =
+      FileMgr.getVirtualFileRef("/foo.h", Buf->getBufferSize(), 0);
   SourceMgr.overrideFileContents(HeaderFile, std::move(Buf));
 
   Buf = llvm::MemoryBuffer::getMemBuffer(R"cpp(#include "/foo.h")cpp");
-  FileEntryRef BarFile = FileMgr.getVirtualFileRef(
-      "/bar.h", Buf->getBufferSize(), 0);
+  FileEntryRef BarFile =
+      FileMgr.getVirtualFileRef("/bar.h", Buf->getBufferSize(), 0);
   SourceMgr.overrideFileContents(BarFile, std::move(Buf));
   SourceMgr.createFileID(BarFile, {}, clang::SrcMgr::C_User);
 

[ilya-biryukov]

LGMT with a small suggestion.

Thanks for getting the test in!