Pavel Labath e264317b45
[lldb] Fix RangeDataVector::CombineConsecutiveEntriesWithEqualData (#127059)
Function was merging equal data even if they weren't adjecant. This
caused a problem in command-disassemble.s test because the two ranges
describing the function would be merged and "swallow" the function
between them.

This PR copies/adapts the algorithm from
RangeVector::CombineConsecutiveEntries (which does not have the same
problem) and also adds a call to ComputeUpperBounds as moving entries
around invalidates the binary tree. (The lack of this call wasn't
noticed until now either because we were not calling methods which rely
on upper bounds (right now, it's only the ill-named FindEntryIndexes
method), or because we weren't merging anything.
2025-02-20 10:25:59 +01:00

262 lines
7.9 KiB
C++

//===-- RangeTest.cpp -----------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Utility/RangeMap.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
using namespace lldb_private;
TEST(RangeVector, SignedBaseType) {
using RangeVector = RangeVector<int32_t, uint32_t>;
using Entry = RangeVector::Entry;
RangeVector V;
V.Append(10, 5);
V.Append(-3, 6);
V.Append(-10, 3);
V.Sort();
EXPECT_THAT(V,
testing::ElementsAre(Entry(-10, 3), Entry(-3, 6), Entry(10, 5)));
Entry e = *V.begin();
EXPECT_EQ(e.GetRangeBase(), -10);
EXPECT_EQ(e.GetByteSize(), 3u);
EXPECT_EQ(e.GetRangeEnd(), -7);
EXPECT_TRUE(e.Contains(-10));
EXPECT_TRUE(e.Contains(-8));
EXPECT_FALSE(e.Contains(-7));
EXPECT_TRUE(e.Union(Entry(-8, 2)));
EXPECT_EQ(e, Entry(-10, 4));
EXPECT_EQ(e.Intersect(Entry(-7, 3)), Entry(-7, 1));
}
TEST(RangeVector, CombineConsecutiveRanges) {
using RangeVector = RangeVector<uint32_t, uint32_t>;
using Entry = RangeVector::Entry;
RangeVector V;
V.Append(0, 1);
V.Append(5, 1);
V.Append(6, 1);
V.Append(10, 9);
V.Append(15, 1);
V.Append(20, 9);
V.Append(21, 9);
V.Sort();
V.CombineConsecutiveRanges();
EXPECT_THAT(V, testing::ElementsAre(Entry(0, 1), Entry(5, 2), Entry(10, 9),
Entry(20, 10)));
V.Clear();
V.Append(0, 20);
V.Append(5, 1);
V.Append(10, 1);
V.Sort();
V.CombineConsecutiveRanges();
EXPECT_THAT(V, testing::ElementsAre(Entry(0, 20)));
}
TEST(RangeVector, GetOverlaps) {
using RangeVector = RangeVector<uint32_t, uint32_t>;
RangeVector V1;
RangeVector V2;
RangeVector Expected;
// same range
V1.Append(0, 1);
V2.Append(0, 1);
Expected.Append(0, 1);
// no overlap
V1.Append(2, 2);
V2.Append(4, 1);
// same base overlap
V1.Append(10, 5);
V2.Append(10, 3);
Expected.Append(10, 3);
// same end overlap
V1.Append(27, 1);
V2.Append(20, 8);
Expected.Append(27, 1);
// smaller base overlap
V1.Append(33, 4);
V2.Append(30, 5);
Expected.Append(33, 2);
// larger base overlap
V1.Append(46, 3);
V2.Append(40, 7);
Expected.Append(46, 1);
// encompass 1 range
V1.Append(50, 9);
V2.Append(51, 7);
Expected.Append(51, 7);
// encompass 2 ranges
V1.Append(60, 9);
V2.Append(60, 3);
V2.Append(65, 3);
Expected.Append(60, 3);
Expected.Append(65, 3);
V1.Sort();
V2.Sort();
Expected.Sort();
EXPECT_EQ(RangeVector::GetOverlaps(V1, V2), Expected);
EXPECT_EQ(RangeVector::GetOverlaps(V2, V1), Expected);
}
using RangeDataVectorT = RangeDataVector<uint32_t, uint32_t, uint32_t>;
using EntryT = RangeDataVectorT::Entry;
static testing::Matcher<const EntryT *> EntryIs(uint32_t ID) {
return testing::Pointee(testing::Field(&EntryT::data, ID));
}
std::vector<uint32_t> FindEntryIndexes(uint32_t address, RangeDataVectorT map) {
std::vector<uint32_t> result;
map.FindEntryIndexesThatContain(address, result);
return result;
}
TEST(RangeDataVector, FindEntryThatContains) {
RangeDataVectorT Map;
uint32_t NextID = 0;
Map.Append(EntryT(0, 10, NextID++));
Map.Append(EntryT(10, 10, NextID++));
Map.Append(EntryT(20, 10, NextID++));
Map.Sort();
EXPECT_THAT(Map.FindEntryThatContains(0), EntryIs(0));
EXPECT_THAT(Map.FindEntryThatContains(9), EntryIs(0));
EXPECT_THAT(Map.FindEntryThatContains(10), EntryIs(1));
EXPECT_THAT(Map.FindEntryThatContains(19), EntryIs(1));
EXPECT_THAT(Map.FindEntryThatContains(20), EntryIs(2));
EXPECT_THAT(Map.FindEntryThatContains(29), EntryIs(2));
EXPECT_THAT(Map.FindEntryThatContains(30), nullptr);
}
TEST(RangeDataVector, FindEntryThatContains_Overlap) {
RangeDataVectorT Map;
uint32_t NextID = 0;
Map.Append(EntryT(0, 40, NextID++));
Map.Append(EntryT(10, 20, NextID++));
Map.Append(EntryT(20, 10, NextID++));
Map.Sort();
// With overlapping intervals, the intention seems to be to return the first
// interval which contains the address.
EXPECT_THAT(Map.FindEntryThatContains(25), EntryIs(0));
// However, this does not always succeed.
// TODO: This should probably return the range (0, 40) as well.
EXPECT_THAT(Map.FindEntryThatContains(35), nullptr);
}
TEST(RangeDataVector, CustomSort) {
// First the default ascending order sorting of the data field.
auto Map = RangeDataVectorT();
Map.Append(EntryT(0, 10, 50));
Map.Append(EntryT(0, 10, 52));
Map.Append(EntryT(0, 10, 53));
Map.Append(EntryT(0, 10, 51));
Map.Sort();
EXPECT_THAT(Map.GetSize(), 4);
EXPECT_THAT(Map.GetEntryRef(0).data, 50);
EXPECT_THAT(Map.GetEntryRef(1).data, 51);
EXPECT_THAT(Map.GetEntryRef(2).data, 52);
EXPECT_THAT(Map.GetEntryRef(3).data, 53);
// And then a custom descending order sorting of the data field.
class CtorParam {};
class CustomSort {
public:
CustomSort(CtorParam) {}
bool operator()(const uint32_t a_data, const uint32_t b_data) {
return a_data > b_data;
}
};
using RangeDataVectorCustomSortT =
RangeDataVector<uint32_t, uint32_t, uint32_t, 0, CustomSort>;
using EntryT = RangeDataVectorT::Entry;
auto MapC = RangeDataVectorCustomSortT(CtorParam());
MapC.Append(EntryT(0, 10, 50));
MapC.Append(EntryT(0, 10, 52));
MapC.Append(EntryT(0, 10, 53));
MapC.Append(EntryT(0, 10, 51));
MapC.Sort();
EXPECT_THAT(MapC.GetSize(), 4);
EXPECT_THAT(MapC.GetEntryRef(0).data, 53);
EXPECT_THAT(MapC.GetEntryRef(1).data, 52);
EXPECT_THAT(MapC.GetEntryRef(2).data, 51);
EXPECT_THAT(MapC.GetEntryRef(3).data, 50);
}
TEST(RangeDataVector, FindEntryIndexesThatContain) {
RangeDataVectorT Map;
Map.Append(EntryT(0, 10, 10));
Map.Append(EntryT(10, 10, 11));
Map.Append(EntryT(20, 10, 12));
Map.Sort();
EXPECT_THAT(FindEntryIndexes(0, Map), testing::ElementsAre(10));
EXPECT_THAT(FindEntryIndexes(9, Map), testing::ElementsAre(10));
EXPECT_THAT(FindEntryIndexes(10, Map), testing::ElementsAre(11));
EXPECT_THAT(FindEntryIndexes(19, Map), testing::ElementsAre(11));
EXPECT_THAT(FindEntryIndexes(20, Map), testing::ElementsAre(12));
EXPECT_THAT(FindEntryIndexes(29, Map), testing::ElementsAre(12));
EXPECT_THAT(FindEntryIndexes(30, Map), testing::ElementsAre());
}
TEST(RangeDataVector, FindEntryIndexesThatContain_Overlap) {
RangeDataVectorT Map;
Map.Append(EntryT(0, 40, 10));
Map.Append(EntryT(10, 20, 11));
Map.Append(EntryT(20, 10, 12));
Map.Sort();
EXPECT_THAT(FindEntryIndexes(0, Map), testing::ElementsAre(10));
EXPECT_THAT(FindEntryIndexes(9, Map), testing::ElementsAre(10));
EXPECT_THAT(FindEntryIndexes(10, Map), testing::ElementsAre(10, 11));
EXPECT_THAT(FindEntryIndexes(19, Map), testing::ElementsAre(10, 11));
EXPECT_THAT(FindEntryIndexes(20, Map), testing::ElementsAre(10, 11, 12));
EXPECT_THAT(FindEntryIndexes(29, Map), testing::ElementsAre(10, 11, 12));
EXPECT_THAT(FindEntryIndexes(30, Map), testing::ElementsAre(10));
EXPECT_THAT(FindEntryIndexes(39, Map), testing::ElementsAre(10));
EXPECT_THAT(FindEntryIndexes(40, Map), testing::ElementsAre());
}
TEST(RangeDataVector, CombineConsecutiveEntriesWithEqualData) {
RangeDataVectorT Map;
Map.Append(EntryT(0, 10, 47));
Map.Append(EntryT(10, 10, 47));
Map.Sort();
Map.CombineConsecutiveEntriesWithEqualData();
EXPECT_THAT(FindEntryIndexes(5, Map), testing::ElementsAre(47));
EXPECT_THAT(FindEntryIndexes(15, Map), testing::ElementsAre(47));
EXPECT_THAT(FindEntryIndexes(25, Map), testing::ElementsAre());
Map.Clear();
Map.Append(EntryT(0, 10, 47));
Map.Append(EntryT(20, 10, 47));
Map.Sort();
Map.CombineConsecutiveEntriesWithEqualData();
EXPECT_THAT(FindEntryIndexes(5, Map), testing::ElementsAre(47));
EXPECT_THAT(FindEntryIndexes(15, Map), testing::ElementsAre());
EXPECT_THAT(FindEntryIndexes(25, Map), testing::ElementsAre(47));
EXPECT_THAT(FindEntryIndexes(35, Map), testing::ElementsAre());
}