[lldb] Add SectionList::ContainsFileAddressRange

[labath]

Summary

This is similar to FindSectionContainingFileAddress, except it doesn't
return a section (because that would be ambiguous), and it checks for an
address range instead of a single address.

The idea is to use this for validating line tables (follow-up patch).

[JDevlieghere]

lldb/include/lldb/Core/Section.h

75

addr_t looks a bit weird for the size, but then offset_t also wouldn't make sense. uint64_t maybe? I'll leave it up to you.

[clayborg]

lldb/include/lldb/Core/Section.h

75

Can we use Range<AddrType, SizeType> from RangeMap.h here?

using Range = Range<lldb::addr_t, uint64_t>;
bool ContainsFileAddressRange(Range range) const;

[labath]

Waiting for the resolution of the discussion in the follow-up patch.

[MaskRay]

lldb/source/Core/Section.cpp

570

I am a bit concerned about the potential large time complexity here.FindSectionContainingFileAddress is O(|sections|) and this loop usually executes once but can take a lot of iterations in a pessimistic case. See my comment in D84402.

lldb/unittests/Core/SectionTest.cpp

43

Might be useful leaving a comment that there is a gap.

lldb/include/lldb/Core/Section.h

 //===-- Section.h -----------------------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLDB_CORE_SECTION_H
 #define LLDB_CORE_SECTION_H
 
 #include "lldb/Core/ModuleChild.h"
 #include "lldb/Utility/ConstString.h"
 #include "lldb/Utility/Flags.h"
 #include "lldb/Utility/UserID.h"
 #include "lldb/lldb-defines.h"
 #include "lldb/lldb-enumerations.h"
 #include "lldb/lldb-forward.h"
 #include "lldb/lldb-types.h"
 
public:
   lldb::SectionSP FindSectionByType(lldb::SectionType sect_type,
                                     bool check_children,
                                     size_t start_idx = 0) const;
 
   lldb::SectionSP
   FindSectionContainingFileAddress(lldb::addr_t addr,
                                    uint32_t depth = UINT32_MAX) const;
 
+  /// Return true iff every byte in the given range belongs to one of the
+  /// sections in this list.
+  bool ContainsFileAddressRange(lldb::addr_t addr, lldb::addr_t size) const;
+
   // Get the number of sections in this list only
   size_t GetSize() const { return m_sections.size(); }
 
   // Get the number of sections in this list, and any contained child sections
   size_t GetNumSections(uint32_t depth) const;
 
   bool ReplaceSection(lldb::user_id_t sect_id,
                       const lldb::SectionSP &section_sp,

lldb/source/Core/Section.cpp

 //===-- Section.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/Core/Section.h"
 #include "lldb/Core/Address.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Symbol/ObjectFile.h"
 #include "lldb/Target/SectionLoadList.h"
 #include "lldb/Target/Target.h"
 #include "lldb/Utility/FileSpec.h"
 #include "lldb/Utility/VMRange.h"
 
if (sect->ContainsFileAddress(vm_addr)) {
 
       if (sect_sp.get() == nullptr && !sect->IsFake())
         sect_sp = *sect_iter;
     }
   }
   return sect_sp;
 }
 
+bool SectionList::ContainsFileAddressRange(addr_t file_addr,
+                                           addr_t size) const {
+  addr_t end = file_addr + size;
+  while (file_addr < end) {
+    SectionSP sect_sp = FindSectionContainingFileAddress(file_addr);
+    if (!sect_sp)
+      return false;
+    file_addr = sect_sp->GetFileAddress() + sect_sp->GetByteSize();
+  }
+  return true;
+}
+
 bool SectionList::ContainsSection(user_id_t sect_id) const {
   return FindSectionByID(sect_id).get() != nullptr;
 }
 
 void SectionList::Dump(llvm::raw_ostream &s, unsigned indent, Target *target,
                        bool show_header, uint32_t depth) const {
   bool target_has_loaded_sections =
       target && !target->GetSectionLoadList().IsEmpty();

lldb/unittests/Core/CMakeLists.txt

 add_lldb_unittest(LLDBCoreTests
   CommunicationTest.cpp
   MangledTest.cpp
   ModuleSpecTest.cpp
   RichManglingContextTest.cpp
+  SectionTest.cpp
   SourceManagerTest.cpp
   StreamCallbackTest.cpp
   UniqueCStringMapTest.cpp
 
   LINK_LIBS
     lldbCore
     lldbHost
     lldbSymbol

lldb/unittests/Core/SectionTest.cpp

+//===-- ModuleSpecTest.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/Core/Section.h"
+#include "Plugins/ObjectFile/ELF/ObjectFileELF.h"
+#include "TestingSupport/SubsystemRAII.h"
+#include "TestingSupport/TestUtilities.h"
+#include "lldb/Core/Module.h"
+#include "gtest/gtest.h"
+
+using namespace lldb;
+using namespace lldb_private;
+
+TEST(SectionListTest, ContainsFileAddressRange) {
+  SubsystemRAII<ObjectFileELF> subsystems;
+
+  auto ExpectedFile = TestFile::fromYaml(R"(
+--- !ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .foo
+    Type:            SHT_PROGBITS
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0010
+    Size:            0x0010
+  - Name:            .bar
+    Type:            SHT_PROGBITS
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0020
+    Size:            0x0010
+  - Name:            .baz
+    Type:            SHT_PROGBITS
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0031
+    Size:            0x000f
+...
+)");
+  ASSERT_THAT_EXPECTED(ExpectedFile, llvm::Succeeded());
+
+  auto M = std::make_shared<Module>(ExpectedFile->moduleSpec());
+  SectionList *List = M->GetSectionList();
+  ASSERT_TRUE(List);
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x10, 0x1));
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x10, 0x10));
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x10, 0x11));
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x10, 0x20));
+  EXPECT_FALSE(List->ContainsFileAddressRange(0x10, 0x21));
+
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x08, 0x0));
+  EXPECT_FALSE(List->ContainsFileAddressRange(0x08, 0x1));
+  EXPECT_FALSE(List->ContainsFileAddressRange(0x08, 0x18));
+
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x2f, 0x1));
+  EXPECT_FALSE(List->ContainsFileAddressRange(0x2f, 0x2));
+  EXPECT_FALSE(List->ContainsFileAddressRange(0x2f, 0x3));
+  EXPECT_FALSE(List->ContainsFileAddressRange(0x30, 0x3));
+  EXPECT_TRUE(List->ContainsFileAddressRange(0x31, 0x3));
+}