DWARFDataExtractor.h

Go to the documentation of this file.

1//===- DWARFDataExtractor.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_DWARFDATAEXTRACTOR_H

10#define LLVM_DEBUGINFO_DWARF_DWARFDATAEXTRACTOR_H

11

12#include "llvm/BinaryFormat/Dwarf.h"

13#include "llvm/DebugInfo/DWARF/DWARFObject.h"

14#include "llvm/DebugInfo/DWARF/DWARFRelocMap.h"

15#include "llvm/DebugInfo/DWARF/DWARFSection.h"

16#include "llvm/DebugInfo/DWARF/LowLevel/DWARFDataExtractorSimple.h"

17#include "llvm/Support/Compiler.h"

18

19namespace llvm {

20

21/// A DWARFDataExtractor (typically for an in-memory copy of an object-file

22/// section) plus a relocation map for that section, if there is one.

23 class DWARFDataExtractor : public DWARFDataExtractorBase<DWARFDataExtractor> {

24 const DWARFObject *Obj = nullptr;

25 const DWARFSection *Section = nullptr;

26

27public:

28 using DWARFDataExtractorBase::DWARFDataExtractorBase;

29

30 /// Constructor for the normal case of extracting data from a DWARF section.

31 /// The DWARFSection's lifetime must be at least as long as the extractor's.

32 DWARFDataExtractor(const DWARFObject &Obj, const DWARFSection &Section,

33 bool IsLittleEndian, uint8_t AddressSize)

34 : DWARFDataExtractorBase(Section.Data, IsLittleEndian, AddressSize),

35 Obj(&Obj), Section(&Section) {}

36

37 /// Truncating constructor

38 DWARFDataExtractor(const DWARFDataExtractor &Other, size_t Length)

39 : DWARFDataExtractorBase(Other.getData().substr(0, Length),

40 Other.isLittleEndian(), Other.getAddressSize()),

41 Obj(Other.Obj), Section(Other.Section) {}

42

43 /// Extracts a value and applies a relocation to the result if

44 /// one exists for the given offset.

45 uint64_t getRelocatedValueImpl(uint32_t Size, uint64_t *Off, uint64_t *SecNdx,

46 Error *Err) const {

47 if (SecNdx)

48 *SecNdx = object::SectionedAddress::UndefSection;

49 if (!Section)

50 return getUnsigned(Off, Size, Err);

51 ErrorAsOutParameter ErrAsOut(Err);

52 std::optional<RelocAddrEntry> E = Obj->find(*Section, *Off);

53 uint64_t LocData = getUnsigned(Off, Size, Err);

54 if (!E || (Err && *Err))

55 return LocData;

56 if (SecNdx)

57 *SecNdx = E->SectionIndex;

58

59 uint64_t R = object::resolveRelocation(E->Resolver, E->Reloc,

60 E->SymbolValue, LocData);

61 if (E->Reloc2)

62 R = object::resolveRelocation(E->Resolver, *E->Reloc2, E->SymbolValue2,

63 R);

64 return R;

65 }

66};

67

68} // end namespace llvm

69

70#endif // LLVM_DEBUGINFO_DWARF_DWARFDATAEXTRACTOR_H

E

static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")

Compiler.h

DWARFDataExtractorSimple.h

This file contains constants used for implementing Dwarf debug support.

InlinePriorityMode::Size

@ Size

Definition InlineOrder.cpp:25

substr

static StringRef substr(StringRef Str, uint64_t Len)

Definition SimplifyLibCalls.cpp:366

llvm::DWARFDataExtractorBase::DWARFDataExtractorBase

DWARFDataExtractorBase(StringRef Data, bool IsLittleEndian, uint8_t AddressSize)

Definition DWARFDataExtractorSimple.h:27

llvm::DWARFDataExtractor::getRelocatedValueImpl

uint64_t getRelocatedValueImpl(uint32_t Size, uint64_t *Off, uint64_t *SecNdx, Error *Err) const

Extracts a value and applies a relocation to the result if one exists for the given offset.

Definition DWARFDataExtractor.h:45

llvm::DWARFDataExtractor::DWARFDataExtractorBase

DWARFDataExtractorBase(StringRef Data, bool IsLittleEndian, uint8_t AddressSize)

Definition DWARFDataExtractorSimple.h:27

llvm::DWARFDataExtractor::DWARFDataExtractor

DWARFDataExtractor(const DWARFObject &Obj, const DWARFSection &Section, bool IsLittleEndian, uint8_t AddressSize)

Constructor for the normal case of extracting data from a DWARF section.

Definition DWARFDataExtractor.h:32

llvm::DWARFDataExtractor::DWARFDataExtractor

DWARFDataExtractor(const DWARFDataExtractor &Other, size_t Length)

Truncating constructor.

Definition DWARFDataExtractor.h:38

llvm::DWARFObject

Definition DWARFObject.h:26

llvm::DataExtractor::getUnsigned

LLVM_ABI uint64_t getUnsigned(uint64_t *offset_ptr, uint32_t byte_size, Error *Err=nullptr) const

Extract an unsigned integer of size byte_size from *offset_ptr.

Definition DataExtractor.cpp:126

llvm::DataExtractor::getAddressSize

uint8_t getAddressSize() const

Get the address size for this extractor.

Definition DataExtractor.h:96

llvm::DataExtractor::getData

StringRef getData() const

Get the data pointed to by this extractor.

Definition DataExtractor.h:92

llvm::DataExtractor::isLittleEndian

bool isLittleEndian() const

Get the endianness for this extractor.

Definition DataExtractor.h:94

llvm::ErrorAsOutParameter

Helper for Errors used as out-parameters.

Definition Error.h:1144

llvm::Error

Lightweight error class with error context and mandatory checking.

Definition Error.h:159

uint32_t

uint64_t

uint8_t

llvm::object::resolveRelocation

LLVM_ABI uint64_t resolveRelocation(RelocationResolver Resolver, const RelocationRef &R, uint64_t S, uint64_t LocData)

Definition RelocationResolver.cpp:879

llvm

This is an optimization pass for GlobalISel generic memory operations.

Definition AddressRanges.h:18

llvm::Length

@ Length

Definition DWP.cpp:477

llvm::IRMemLocation::Other

@ Other

Any other memory.

Definition ModRef.h:68

llvm::Data

FunctionAddr VTableAddr uintptr_t uintptr_t Data

Definition InstrProf.h:189

llvm::DWARFSection

Definition DWARFSection.h:16

llvm::object::SectionedAddress::UndefSection

static const uint64_t UndefSection

Definition ObjectFile.h:148

Generated on for LLVM by doxygen 1.14.0

LLVM: include/llvm/DebugInfo/DWARF/DWARFDataExtractor.h Source File