[llvm-debuginfo-analyzer] (07/09) - Compare elements - Test case (AddressSanitizer: leaked in allocations)

[CarlosAlbertoEnciso]

Summary

The test case 'CompareElements' caused a failure in:

https://lab.llvm.org/buildbot#builders/5/builds/28502
https://lab.llvm.org/buildbot#builders/168/builds/9671
SUMMARY: AddressSanitizer: 2144 byte(s) leaked in 14 allocation(s).

The Insert function conditionally adds the Child logical
element to a logical scope. The not added logical elements,
caused the memory leak. Just record them to be destroyed
when the logical reader is destroyed.

Changed EXPECT_NE with ASSERT_NE.
Missing in the main review.

[CarlosAlbertoEnciso]

As this issue was causing build faiures in:

https://lab.llvm.org/buildbot#builders/5/builds/28502
https://lab.llvm.org/buildbot#builders/168/builds/9671

The same issues were reported and the patch discussed with @kda.
I landed the patch as https://github.com/llvm/llvm-project/commit/cddea67663655591b3d650d81d6546abbdc50ae5

After that commit the above bots build successful.

[jryans]

Seems like a reasonable fix, and it makes sense that you landed it quickly to fix the build issues. Thanks! 🙂

[CarlosAlbertoEnciso]

In D136593#3885534, @jryans wrote:

Seems like a reasonable fix, and it makes sense that you landed it quickly to fix the build issues. Thanks! 🙂

@jryans Thanks very much for your review.

[CarlosAlbertoEnciso]

Commit: https://reviews.llvm.org/rGcddea67663655591b3d650d81d6546abbdc50ae5

llvm/unittests/DebugInfo/LogicalView/CompareElementsTest.cpp

 using namespace llvm;
 using namespace llvm::logicalview;
 
 namespace {
 
 //===----------------------------------------------------------------------===//
 // Basic Reader functionality.
 class ReaderTestCompare : public LVReader {
+  // Elements created but not added to any logical scope. They are
+  // deleted when the logical Reader is destroyed.
+  LVAutoSmallVector<LVElement *> OrphanElements;
+
 public:
   // Types.
   LVType *IntegerType = nullptr;
   LVType *UnsignedType = nullptr;
   LVType *GlobalType = nullptr;
   LVType *LocalType = nullptr;
   LVType *NestedType = nullptr;
   LVTypeDefinition *TypeDefinitionOne = nullptr;

 
 //===----------------------------------------------------------------------===//
 // Create the logical elements.
 void ReaderTestCompare::createElements() {
   // Create scope root.
   Error Err = createScopes();
   ASSERT_THAT_ERROR(std::move(Err), Succeeded());
   Root = getScopesRoot();
-  EXPECT_NE(Root, nullptr);
+  ASSERT_NE(Root, nullptr);
 
   // Create the logical types.
   IntegerType = create<LVType, LVTypeSetFunction>(&LVType::setIsBase);
   UnsignedType = create<LVType, LVTypeSetFunction>(&LVType::setIsBase);
   GlobalType = create<LVType, LVTypeSetFunction>(&LVType::setIsBase);
   LocalType = create<LVType, LVTypeSetFunction>(&LVType::setIsBase);
   NestedType = create<LVType, LVTypeSetFunction>(&LVType::setIsBase);
   EnumeratorOne =

 
 // Create the logical view adding the created logical elements.
 void ReaderTestCompare::addElements(bool IsReference, bool IsTarget) {
   Root->setName(IsReference ? "Reference-Reader" : "Target-Reader");
 
   auto Insert = [&](bool Insert, auto *Parent, auto *Child) {
     if (Insert)
       add(Parent, Child);
+    else
+      OrphanElements.push_back(Child);
   };
 
   setCompileUnit(CompileUnit);
   add(Root, CompileUnit);
 
   // Add elements to CompileUnit.
   Insert(true, CompileUnit, IntegerType);
   Insert(true, CompileUnit, UnsignedType);