LLVM  9.0.0svn
DWARFDebugAddr.h
Go to the documentation of this file.
1 //===- DWARFDebugAddr.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_DWARFDEBUGADDR_H
10 #define LLVM_DEBUGINFO_DWARFDEBUGADDR_H
11 
15 #include "llvm/Support/Errc.h"
16 #include "llvm/Support/Error.h"
17 #include <cstdint>
18 #include <map>
19 #include <vector>
20 
21 namespace llvm {
22 
23 class Error;
24 class raw_ostream;
25 
26 /// A class representing an address table as specified in DWARF v5.
27 /// The table consists of a header followed by an array of address values from
28 /// .debug_addr section.
30 public:
31  struct Header {
32  /// The total length of the entries for this table, not including the length
33  /// field itself.
35  /// The DWARF version number.
36  uint16_t Version = 5;
37  /// The size in bytes of an address on the target architecture. For
38  /// segmented addressing, this is the size of the offset portion of the
39  /// address.
40  uint8_t AddrSize;
41  /// The size in bytes of a segment selector on the target architecture.
42  /// If the target system uses a flat address space, this value is 0.
43  uint8_t SegSize = 0;
44  };
45 
46 private:
48  uint32_t HeaderOffset;
49  Header HeaderData;
50  uint32_t DataSize = 0;
51  std::vector<uint64_t> Addrs;
52 
53 public:
54  void clear();
55 
56  /// Extract an entire table, including all addresses.
58  uint16_t Version, uint8_t AddrSize,
59  std::function<void(Error)> WarnCallback);
60 
61  uint32_t getHeaderOffset() const { return HeaderOffset; }
62  uint8_t getAddrSize() const { return HeaderData.AddrSize; }
63  void dump(raw_ostream &OS, DIDumpOptions DumpOpts = {}) const;
64 
65  /// Return the address based on a given index.
67 
68  /// Return the size of the table header including the length
69  /// but not including the addresses.
70  uint8_t getHeaderSize() const {
71  switch (Format) {
73  return 8; // 4 + 2 + 1 + 1
75  return 16; // 12 + 2 + 1 + 1
76  }
77  llvm_unreachable("Invalid DWARF format (expected DWARF32 or DWARF64)");
78  }
79 
80  /// Returns the length of this table, including the length field, or 0 if the
81  /// length has not been determined (e.g. because the table has not yet been
82  /// parsed, or there was a problem in parsing).
83  uint32_t getLength() const;
84 
85  /// Verify that the given length is valid for this table.
86  bool hasValidLength() const { return getLength() != 0; }
87 
88  /// Invalidate Length field to stop further processing.
89  void invalidateLength() { HeaderData.Length = 0; }
90 
91  /// Returns the length of the array of addresses.
92  uint32_t getDataSize() const;
93 };
94 
95 } // end namespace llvm
96 
97 #endif // LLVM_DEBUGINFO_DWARFDEBUGADDR_H
uint8_t AddrSize
The size in bytes of an address on the target architecture.
uint8_t SegSize
The size in bytes of a segment selector on the target architecture.
This class represents lattice values for constants.
Definition: AllocatorList.h:23
uint8_t getHeaderSize() const
Return the size of the table header including the length but not including the addresses.
uint32_t getHeaderOffset() const
DwarfFormat
Constants that define the DWARF format as 32 or 64 bit.
Definition: Dwarf.h:65
A class representing an address table as specified in DWARF v5.
Tagged union holding either a T or a Error.
Definition: CachePruning.h:22
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:158
Expected< uint64_t > getAddrEntry(uint32_t Index) const
Return the address based on a given index.
uint8_t getAddrSize() const
Error extract(DWARFDataExtractor Data, uint32_t *OffsetPtr, uint16_t Version, uint8_t AddrSize, std::function< void(Error)> WarnCallback)
Extract an entire table, including all addresses.
uint32_t Length
The total length of the entries for this table, not including the length field itself.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
void dump(raw_ostream &OS, DIDumpOptions DumpOpts={}) const
uint32_t getLength() const
Returns the length of this table, including the length field, or 0 if the length has not been determi...
This file contains constants used for implementing Dwarf debug support.
uint16_t Version
The DWARF version number.
uint32_t getDataSize() const
Returns the length of the array of addresses.
void invalidateLength()
Invalidate Length field to stop further processing.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
print Print MemDeps of function
bool hasValidLength() const
Verify that the given length is valid for this table.