Skip to content

Commit 71d7c8d

Browse files
committed
[clangd] Crash in __memcmp_avx2_movbe
There is a clangd crash at `__memcmp_avx2_movbe`. Short problem description is below. The method `HeaderIncludes::addExistingInclude` stores `Include` objects by reference at 2 places: `ExistingIncludes` (primary storage) and `IncludesByPriority` (pointer to the object's location at ExistingIncludes). `ExistingIncludes` is a map where value is a `SmallVector`. A new element is inserted by `push_back`. The operation might do resize. As result pointers stored at `IncludesByPriority` might become invalid. Typical stack trace ``` frame #0: 0x00007f11460dcd94 libc.so.6`__memcmp_avx2_movbe + 308 frame #1: 0x00000000004782b8 clangd`llvm::StringRef::compareMemory(Lhs=" \"t2.h\"", Rhs="", Length=6) at StringRef.h:76:22 frame #2: 0x0000000000701253 clangd`llvm::StringRef::compare(this=0x0000 7f10de7d8610, RHS=(Data = "", Length = 7166742329480737377)) const at String Ref.h:206:34 * frame #3: 0x00000000007603ab clangd`llvm::operator<(llvm::StringRef, llv m::StringRef)(LHS=(Data = "\"t2.h\"", Length = 6), RHS=(Data = "", Length = 7166742329480737377)) at StringRef.h:907:23 frame #4: 0x0000000002d0ad9f clangd`clang::tooling::HeaderIncludes::inse rt(this=0x00007f10de7fb1a0, IncludeName=(Data = "t2.h\"", Length = 4), IsAng led=false) const at HeaderIncludes.cpp:365:22 frame #5: 0x00000000012ebfdd clangd`clang::clangd::IncludeInserter::inse rt(this=0x00007f10de7fb148, VerbatimHeader=(Data = "\"t2.h\"", Length = 6)) const at Headers.cpp:262:70 ``` A unit test test for the crash was created (`HeaderIncludesTest.RepeatedIncludes`). The proposed solution is to use std::list instead of llvm::SmallVector Test Plan ``` ./tools/clang/unittests/Tooling/ToolingTests --gtest_filter=HeaderIncludesTest.RepeatedIncludes ``` Reviewed By: sammccall Differential Revision: https://reviews.llvm.org/D118755
1 parent b0e77d5 commit 71d7c8d

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

clang/include/clang/Tooling/Inclusions/HeaderIncludes.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
#include "clang/Tooling/Inclusions/IncludeStyle.h"
1515
#include "llvm/Support/Path.h"
1616
#include "llvm/Support/Regex.h"
17+
#include <list>
1718
#include <unordered_map>
1819

1920
namespace clang {
@@ -97,7 +98,8 @@ class HeaderIncludes {
9798
// Map from include name (quotation trimmed) to a list of existing includes
9899
// (in case there are more than one) with the name in the current file. <x>
99100
// and "x" will be treated as the same header when deleting #includes.
100-
llvm::StringMap<llvm::SmallVector<Include, 1>> ExistingIncludes;
101+
// std::list is used for pointers stability (see IncludesByPriority)
102+
llvm::StringMap<std::list<Include>> ExistingIncludes;
101103

102104
/// Map from priorities of #include categories to all #includes in the same
103105
/// category. This is used to find #includes of the same category when

clang/unittests/Tooling/HeaderIncludesTest.cpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,15 @@ TEST_F(HeaderIncludesTest, NoExistingIncludeWithoutDefine) {
5151
EXPECT_EQ(Expected, insert(Code, "\"a.h\""));
5252
}
5353

54+
TEST_F(HeaderIncludesTest, RepeatedIncludes) {
55+
std::string Code;
56+
for (int i = 0; i < 100; ++i) {
57+
Code += "#include \"a.h\"\n";
58+
}
59+
std::string Expected = Code + "#include \"a2.h\"\n";
60+
EXPECT_EQ(Expected, insert(Code, "\"a2.h\""));
61+
}
62+
5463
TEST_F(HeaderIncludesTest, NoExistingIncludeWithDefine) {
5564
std::string Code = "#ifndef A_H\n"
5665
"#define A_H\n"

0 commit comments

Comments
 (0)