LLVM  14.0.0git
DWARFDebugRangeList.h
Go to the documentation of this file.
1 //===- DWARFDebugRangeList.h ------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_DEBUGINFO_DWARF_DWARFDEBUGRANGELIST_H
10 #define LLVM_DEBUGINFO_DWARF_DWARFDEBUGRANGELIST_H
11 
14 #include <cassert>
15 #include <cstdint>
16 #include <vector>
17 
18 namespace llvm {
19 
20 class raw_ostream;
21 
23 public:
24  struct RangeListEntry {
25  /// A beginning address offset. This address offset has the size of an
26  /// address and is relative to the applicable base address of the
27  /// compilation unit referencing this range list. It marks the beginning
28  /// of an address range.
30  /// An ending address offset. This address offset again has the size of
31  /// an address and is relative to the applicable base address of the
32  /// compilation unit referencing this range list. It marks the first
33  /// address past the end of the address range. The ending address must
34  /// be greater than or equal to the beginning address.
36  /// A section index this range belongs to.
38 
39  /// The end of any given range list is marked by an end of list entry,
40  /// which consists of a 0 for the beginning address offset
41  /// and a 0 for the ending address offset.
42  bool isEndOfListEntry() const {
43  return (StartAddress == 0) && (EndAddress == 0);
44  }
45 
46  /// A base address selection entry consists of:
47  /// 1. The value of the largest representable address offset
48  /// (for example, 0xffffffff when the size of an address is 32 bits).
49  /// 2. An address, which defines the appropriate base address for
50  /// use in interpreting the beginning and ending address offsets of
51  /// subsequent entries of the location list.
52  bool isBaseAddressSelectionEntry(uint8_t AddressSize) const;
53  };
54 
55 private:
56  /// Offset in .debug_ranges section.
57  uint64_t Offset;
58  uint8_t AddressSize;
59  std::vector<RangeListEntry> Entries;
60 
61 public:
63 
64  void clear();
65  void dump(raw_ostream &OS) const;
66  Error extract(const DWARFDataExtractor &data, uint64_t *offset_ptr);
67  const std::vector<RangeListEntry> &getEntries() { return Entries; }
68 
69  /// getAbsoluteRanges - Returns absolute address ranges defined by this range
70  /// list. Has to be passed base address of the compile unit referencing this
71  /// range list.
74 };
75 
76 } // end namespace llvm
77 
78 #endif // LLVM_DEBUGINFO_DWARF_DWARFDEBUGRANGELIST_H
llvm::DWARFDebugRangeList::RangeListEntry::EndAddress
uint64_t EndAddress
An ending address offset.
Definition: DWARFDebugRangeList.h:35
llvm::DWARFDebugRangeList::RangeListEntry::isBaseAddressSelectionEntry
bool isBaseAddressSelectionEntry(uint8_t AddressSize) const
A base address selection entry consists of:
Definition: DWARFDebugRangeList.cpp:19
llvm::DWARFDebugRangeList
Definition: DWARFDebugRangeList.h:22
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AllocatorList.h:23
llvm::DWARFDebugRangeList::clear
void clear()
Definition: DWARFDebugRangeList.cpp:25
DWARFAddressRange.h
llvm::Optional
Definition: APInt.h:33
llvm::DWARFDataExtractor
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
Definition: DWARFDataExtractor.h:21
llvm::DWARFDebugRangeList::RangeListEntry::SectionIndex
uint64_t SectionIndex
A section index this range belongs to.
Definition: DWARFDebugRangeList.h:37
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:53
llvm::DWARFDebugRangeList::extract
Error extract(const DWARFDataExtractor &data, uint64_t *offset_ptr)
Definition: DWARFDebugRangeList.cpp:31
uint64_t
llvm::DWARFDebugRangeList::RangeListEntry
Definition: DWARFDebugRangeList.h:24
llvm::DWARFDebugRangeList::getAbsoluteRanges
DWARFAddressRangesVector getAbsoluteRanges(llvm::Optional< object::SectionedAddress > BaseAddr) const
getAbsoluteRanges - Returns absolute address ranges defined by this range list.
Definition: DWARFDebugRangeList.cpp:87
llvm::DWARFAddressRangesVector
std::vector< DWARFAddressRange > DWARFAddressRangesVector
DWARFAddressRangesVector - represents a set of absolute address ranges.
Definition: DWARFAddressRange.h:85
llvm::DWARFDebugRangeList::getEntries
const std::vector< RangeListEntry > & getEntries()
Definition: DWARFDebugRangeList.h:67
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
llvm::DWARFDebugRangeList::RangeListEntry::StartAddress
uint64_t StartAddress
A beginning address offset.
Definition: DWARFDebugRangeList.h:29
llvm::DWARFDebugRangeList::RangeListEntry::isEndOfListEntry
bool isEndOfListEntry() const
The end of any given range list is marked by an end of list entry, which consists of a 0 for the begi...
Definition: DWARFDebugRangeList.h:42
llvm::DWARFDebugRangeList::DWARFDebugRangeList
DWARFDebugRangeList()
Definition: DWARFDebugRangeList.h:62
llvm::DWARFDebugRangeList::dump
void dump(raw_ostream &OS) const
Definition: DWARFDebugRangeList.cpp:67
DWARFDataExtractor.h