Movatterモバイル変換

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//===----------------------------------------------------------------------===//

9#ifndef LLVM_DEBUGINFO_DWARF_DWARFDATAEXTRACTOR_H

10#define LLVM_DEBUGINFO_DWARF_DWARFDATAEXTRACTOR_H

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

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

14#include "llvm/Support/DataExtractor.h"

16namespacellvm {

17classDWARFObject;

19/// A DataExtractor (typically for an in-memory copy of an object-file section)

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

21classDWARFDataExtractor :publicDataExtractor {

22constDWARFObject *Obj =nullptr;

23constDWARFSection *Section =nullptr;

25public:

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

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

28DWARFDataExtractor(constDWARFObject &Obj,constDWARFSection &Section,

29bool IsLittleEndian,uint8_t AddressSize)

30 :DataExtractor(Section.Data, IsLittleEndian, AddressSize), Obj(&Obj),

31 Section(&Section) {}

33 /// Constructor for cases when there are no relocations.

34DWARFDataExtractor(StringRef Data,bool IsLittleEndian,uint8_t AddressSize)

35 :DataExtractor(Data, IsLittleEndian, AddressSize) {}

36DWARFDataExtractor(ArrayRef<uint8_t> Data,bool IsLittleEndian,

37uint8_t AddressSize)

38 :DataExtractor(

39StringRef(reinterpret_cast<const char *>(Data.data()), Data.size()),

40 IsLittleEndian, AddressSize) {}

42 /// Truncating constructor

43DWARFDataExtractor(constDWARFDataExtractor &Other,size_tLength)

44 :DataExtractor(Other.getData().substr(0,Length),Other.isLittleEndian(),

45Other.getAddressSize()),

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

48 /// Extracts the DWARF "initial length" field, which can either be a 32-bit

49 /// value smaller than 0xfffffff0, or the value 0xffffffff followed by a

50 /// 64-bit length. Returns the actual length, and the DWARF format which is

51 /// encoded in the field. In case of errors, it returns {0, DWARF32} and

52 /// leaves the offset unchanged.

53 std::pair<uint64_t, dwarf::DwarfFormat>

54getInitialLength(uint64_t *Off,Error *Err =nullptr)const;

56 std::pair<uint64_t, dwarf::DwarfFormat>getInitialLength(Cursor &C) const{

57returngetInitialLength(&getOffset(C), &getError(C));

58 }

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

61 /// one exists for the given offset.

62uint64_t getRelocatedValue(uint32_t Size,uint64_t *Off,

63uint64_t *SectionIndex =nullptr,

64Error *Err =nullptr)const;

65uint64_t getRelocatedValue(Cursor &C,uint32_t Size,

66uint64_t *SectionIndex =nullptr) const{

67returngetRelocatedValue(Size, &getOffset(C), SectionIndex, &getError(C));

68 }

70 /// Extracts an address-sized value and applies a relocation to the result if

71 /// one exists for the given offset.

72uint64_t getRelocatedAddress(uint64_t *Off,uint64_t *SecIx =nullptr) const{

73returngetRelocatedValue(getAddressSize(), Off, SecIx);

74 }

75uint64_t getRelocatedAddress(Cursor &C,uint64_t *SecIx =nullptr) const{

76returngetRelocatedValue(getAddressSize(), &getOffset(C), SecIx,

77 &getError(C));

78 }

80 /// Extracts a DWARF-encoded pointer in \p Offset using \p Encoding.

81 /// There is a DWARF encoding that uses a PC-relative adjustment.

82 /// For these values, \p AbsPosOffset is used to fix them, which should

83 /// reflect the absolute address of this pointer.

84 std::optional<uint64_t>getEncodedPointer(uint64_t *Offset,uint8_t Encoding,

85uint64_t AbsPosOffset = 0)const;

86};

88}// end namespace llvm

90#endif// LLVM_DEBUGINFO_DWARF_DWARFDATAEXTRACTOR_H

const

aarch64 promote const

Definition:AArch64PromoteConstant.cpp:230

DWARFSection.h

DataExtractor.h

Dwarf.h

This file contains constants used for implementing Dwarf debug support.

Size

uint64_t Size

Definition:ELFObjHandler.cpp:81

substr

static StringRef substr(StringRef Str, uint64_t Len)

Definition:SimplifyLibCalls.cpp:356

data

static Split data

Definition:StaticDataSplitter.cpp:176

char

llvm::ArrayRef

ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...

Definition:ArrayRef.h:41

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::DWARFDataExtractor::getRelocatedAddress

uint64_t getRelocatedAddress(uint64_t *Off, uint64_t *SecIx=nullptr) const

Extracts an address-sized value and applies a relocation to the result if one exists for the given of...

Definition:DWARFDataExtractor.h:72

llvm::DWARFDataExtractor::getRelocatedAddress

uint64_t getRelocatedAddress(Cursor &C, uint64_t *SecIx=nullptr) const

Definition:DWARFDataExtractor.h:75

llvm::DWARFDataExtractor::getInitialLength

std::pair< uint64_t, dwarf::DwarfFormat > getInitialLength(uint64_t *Off, Error *Err=nullptr) const

Extracts the DWARF "initial length" field, which can either be a 32-bit value smaller than 0xfffffff0...

Definition:DWARFDataExtractor.cpp:17

llvm::DWARFDataExtractor::getInitialLength

std::pair< uint64_t, dwarf::DwarfFormat > getInitialLength(Cursor &C) const

Definition:DWARFDataExtractor.h:56

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:28

llvm::DWARFDataExtractor::DWARFDataExtractor

DWARFDataExtractor(StringRef Data, bool IsLittleEndian, uint8_t AddressSize)

Constructor for cases when there are no relocations.

Definition:DWARFDataExtractor.h:34

llvm::DWARFDataExtractor::DWARFDataExtractor

DWARFDataExtractor(const DWARFDataExtractor &Other, size_t Length)

Truncating constructor.

Definition:DWARFDataExtractor.h:43

llvm::DWARFDataExtractor::getRelocatedValue

uint64_t getRelocatedValue(uint32_t Size, uint64_t *Off, uint64_t *SectionIndex=nullptr, Error *Err=nullptr) const

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

Definition:DWARFDataExtractor.cpp:48

llvm::DWARFDataExtractor::DWARFDataExtractor

DWARFDataExtractor(ArrayRef< uint8_t > Data, bool IsLittleEndian, uint8_t AddressSize)

Definition:DWARFDataExtractor.h:36

llvm::DWARFDataExtractor::getEncodedPointer

std::optional< uint64_t > getEncodedPointer(uint64_t *Offset, uint8_t Encoding, uint64_t AbsPosOffset=0) const

Extracts a DWARF-encoded pointer in Offset using Encoding.

Definition:DWARFDataExtractor.cpp:72

llvm::DWARFDataExtractor::getRelocatedValue

uint64_t getRelocatedValue(Cursor &C, uint32_t Size, uint64_t *SectionIndex=nullptr) const

Definition:DWARFDataExtractor.h:65

llvm::DWARFObject

Definition:DWARFObject.h:26

llvm::DataExtractor::Cursor

A class representing a position in a DataExtractor, as well as any error encountered during extractio...

Definition:DataExtractor.h:54

llvm::DataExtractor

Definition:DataExtractor.h:41

llvm::DataExtractor::size

size_t size() const

Return the number of bytes in the underlying buffer.

Definition:DataExtractor.h:688

llvm::DataExtractor::getOffset

static uint64_t & getOffset(Cursor &C)

Definition:DataExtractor.h:693

llvm::DataExtractor::getAddressSize

uint8_t getAddressSize() const

Get the address size for this extractor.

Definition:DataExtractor.h:99

llvm::DataExtractor::getData

StringRef getData() const

Get the data pointed to by this extractor.

Definition:DataExtractor.h:95

llvm::DataExtractor::getError

static Error & getError(Cursor &C)

Definition:DataExtractor.h:694

llvm::DataExtractor::isLittleEndian

bool isLittleEndian() const

Get the endianness for this extractor.

Definition:DataExtractor.h:97

llvm::Error

Lightweight error class with error context and mandatory checking.

Definition:Error.h:160

llvm::StringRef

StringRef - Represent a constant reference to a string, i.e.

Definition:StringRef.h:51

@ C

The default llvm calling convention, compatible with C.

Definition:CallingConv.h:34

llvm

This is an optimization pass for GlobalISel generic memory operations.

Definition:AddressRanges.h:18

llvm::Offset

@ Offset

Definition:DWP.cpp:480

llvm::Length

@ Length

Definition:DWP.cpp:480

llvm::IRMemLocation::Other

@ Other

Any other memory.

llvm::DWARFSection

Definition:DWARFSection.h:16