DWARFEmitter.cpp File Reference

The DWARF component of yaml2obj. More...

#include "llvm/ObjectYAML/DWARFEmitter.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/BinaryFormat/Dwarf.h"
#include "llvm/ObjectYAML/DWARFYAML.h"
#include "llvm/Support/Errc.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/LEB128.h"
#include "llvm/Support/MathExtras.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/SourceMgr.h"
#include "llvm/Support/SwapByteOrder.h"
#include "llvm/Support/YAMLTraits.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/TargetParser/Host.h"
#include <algorithm>
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>

Go to the source code of this file.

Functions
template<typename T >
static void	writeInteger (T Integer, raw_ostream &OS, bool IsLittleEndian)
static Error	writeVariableSizedInteger (uint64_t Integer, size_t Size, raw_ostream &OS, bool IsLittleEndian)
static void	ZeroFillBytes (raw_ostream &OS, size_t Size)
static void	writeInitialLength (const dwarf::DwarfFormat Format, const uint64_t Length, raw_ostream &OS, bool IsLittleEndian)
static void	writeDWARFOffset (uint64_t Offset, dwarf::DwarfFormat Format, raw_ostream &OS, bool IsLittleEndian)
static Error	emitPubSection (raw_ostream &OS, const DWARFYAML::PubSection &Sect, bool IsLittleEndian, bool IsGNUPubSec=false)
static Expected< uint64_t >	writeDIE (const DWARFYAML::Data &DI, uint64_t CUIndex, uint64_t AbbrevTableID, const dwarf::FormParams &Params, const DWARFYAML::Entry &Entry, raw_ostream &OS, bool IsLittleEndian)
static void	emitFileEntry (raw_ostream &OS, const DWARFYAML::File &File)
static void	writeExtendedOpcode (const DWARFYAML::LineTableOpcode &Op, uint8_t AddrSize, bool IsLittleEndian, raw_ostream &OS)
static void	writeLineTableOpcode (const DWARFYAML::LineTableOpcode &Op, uint8_t OpcodeBase, uint8_t AddrSize, raw_ostream &OS, bool IsLittleEndian)
static std::vector< uint8_t >	getStandardOpcodeLengths (uint16_t Version, std::optional< uint8_t > OpcodeBase)
static Error	checkOperandCount (StringRef EncodingString, ArrayRef< yaml::Hex64 > Values, uint64_t ExpectedOperands)
static Error	writeListEntryAddress (StringRef EncodingName, raw_ostream &OS, uint64_t Addr, uint8_t AddrSize, bool IsLittleEndian)
static Expected< uint64_t >	writeDWARFExpression (raw_ostream &OS, const DWARFYAML::DWARFOperation &Operation, uint8_t AddrSize, bool IsLittleEndian)
static Expected< uint64_t >	writeListEntry (raw_ostream &OS, const DWARFYAML::RnglistEntry &Entry, uint8_t AddrSize, bool IsLittleEndian)
static Expected< uint64_t >	writeListEntry (raw_ostream &OS, const DWARFYAML::LoclistEntry &Entry, uint8_t AddrSize, bool IsLittleEndian)
template<typename EntryType >
static Error	writeDWARFLists (raw_ostream &OS, ArrayRef< DWARFYAML::ListTable< EntryType > > Tables, bool IsLittleEndian, bool Is64BitAddrSize)
static Error	emitDebugSectionImpl (const DWARFYAML::Data &DI, StringRef Sec, StringMap< std::unique_ptr< MemoryBuffer > > &OutputBuffers)

Detailed Description

The DWARF component of yaml2obj.

Provided as library code for tests.

Definition in file DWARFEmitter.cpp.

Function Documentation

checkOperandCount()

static Error checkOperandCount ( StringRef  EncodingString, ArrayRef< yaml::Hex64 >  Values, uint64_t  ExpectedOperands  )

static

Definition at line 913 of file DWARFEmitter.cpp.

References llvm::createStringError(), llvm::invalid_argument, llvm::ArrayRef< T >::size(), llvm::StringRef::str(), and llvm::Error::success().

Referenced by writeDWARFExpression(), and writeListEntry().

emitDebugSectionImpl()

static Error emitDebugSectionImpl ( const DWARFYAML::Data &  DI, StringRef  Sec, StringMap< std::unique_ptr< MemoryBuffer > > &  OutputBuffers  )

static

Definition at line 1256 of file DWARFEmitter.cpp.

References llvm::raw_ostream::flush(), llvm::DWARFYAML::getDWARFEmitterByName(), llvm::MemoryBuffer::getMemBufferCopy(), and llvm::Error::success().

Referenced by llvm::DWARFYAML::emitDebugSections().

emitFileEntry()

static void emitFileEntry ( raw_ostream &  OS, const DWARFYAML::File &  File  )

static

Definition at line 506 of file DWARFEmitter.cpp.

References llvm::encodeULEB128(), OS, and llvm::raw_ostream::write().

Referenced by llvm::DWARFYAML::emitDebugLine(), and writeExtendedOpcode().

emitPubSection()

static Error emitPubSection ( raw_ostream &  OS, const DWARFYAML::PubSection &  Sect, bool  IsLittleEndian, bool  IsGNUPubSec = false  )

static

Definition at line 227 of file DWARFEmitter.cpp.

References llvm::DWARFYAML::PubSection::Entries, llvm::DWARFYAML::PubSection::Format, llvm::DWARFYAML::PubSection::Length, OS, llvm::Error::success(), llvm::DWARFYAML::PubSection::UnitOffset, llvm::DWARFYAML::PubSection::UnitSize, llvm::DWARFYAML::PubSection::Version, llvm::raw_ostream::write(), writeInitialLength(), and writeInteger().

Referenced by llvm::DWARFYAML::emitDebugGNUPubnames(), llvm::DWARFYAML::emitDebugGNUPubtypes(), llvm::DWARFYAML::emitDebugPubnames(), and llvm::DWARFYAML::emitDebugPubtypes().

getStandardOpcodeLengths()

static std::vector< uint8_t > getStandardOpcodeLengths ( uint16_t  Version, std::optional< uint8_t >  OpcodeBase  )

static

Definition at line 587 of file DWARFEmitter.cpp.

References llvm::Version.

Referenced by llvm::DWARFYAML::emitDebugLine().

writeDIE()

static Expected< uint64_t > writeDIE ( const DWARFYAML::Data &  DI, uint64_t  CUIndex, uint64_t  AbbrevTableID, const dwarf::FormParams &  Params, const DWARFYAML::Entry &  Entry, raw_ostream &  OS, bool  IsLittleEndian  )

static

Definition at line 265 of file DWARFEmitter.cpp.

References llvm::dwarf::FormParams::AddrSize, llvm::DWARFYAML::Abbrev::Attributes, llvm::cantFail(), llvm::createStringError(), llvm::DWARFYAML::Data::DebugAbbrev, llvm::encodeSLEB128(), llvm::encodeULEB128(), llvm::DWARFYAML::Data::getAbbrevTableInfoByID(), llvm::dwarf::FormParams::getDwarfOffsetByteSize(), llvm::dwarf::FormParams::getRefAddrByteSize(), llvm::invalid_argument, OS, llvm::ArrayRef< T >::size(), llvm::Expected< T >::takeError(), llvm::raw_ostream::tell(), llvm::dwarf::toString(), llvm::raw_ostream::write(), writeInteger(), and writeVariableSizedInteger().

Referenced by llvm::DWARFYAML::emitDebugInfo().

writeDWARFExpression()

static Expected< uint64_t > writeDWARFExpression ( raw_ostream &  OS, const DWARFYAML::DWARFOperation &  Operation, uint8_t  AddrSize, bool  IsLittleEndian  )

static

Definition at line 939 of file DWARFEmitter.cpp.

References checkOperandCount(), llvm::createStringError(), llvm::StringRef::empty(), llvm::encodeSLEB128(), llvm::not_supported, Operation, llvm::dwarf::OperationEncodingString(), OS, llvm::raw_ostream::tell(), and writeInteger().

Referenced by writeListEntry().

writeDWARFLists()

template<typename EntryType >

static Error writeDWARFLists ( raw_ostream &  OS, ArrayRef< DWARFYAML::ListTable< EntryType > >  Tables, bool  IsLittleEndian, bool  Is64BitAddrSize  )

static

Definition at line 1130 of file DWARFEmitter.cpp.

References llvm::dwarf::DWARF64, llvm::Length, llvm::List, llvm::Offset, OS, llvm::Error::success(), llvm::Expected< T >::takeError(), llvm::raw_ostream::tell(), UINT64_MAX, llvm::raw_ostream::write(), writeDWARFOffset(), writeInitialLength(), writeInteger(), and writeListEntry().

writeDWARFOffset()

static void writeDWARFOffset ( uint64_t  Offset, dwarf::DwarfFormat  Format, raw_ostream &  OS, bool  IsLittleEndian  )

static

Definition at line 82 of file DWARFEmitter.cpp.

References llvm::cantFail(), llvm::dwarf::DWARF64, llvm::Offset, OS, and writeVariableSizedInteger().

Referenced by llvm::DWARFYAML::emitDebugAranges(), llvm::DWARFYAML::emitDebugInfo(), llvm::DWARFYAML::emitDebugLine(), llvm::DWARFYAML::emitDebugStrOffsets(), and writeDWARFLists().

writeExtendedOpcode()

static void writeExtendedOpcode ( const DWARFYAML::LineTableOpcode &  Op, uint8_t  AddrSize, bool  IsLittleEndian, raw_ostream &  OS  )

static

Definition at line 514 of file DWARFEmitter.cpp.

References llvm::cantFail(), emitFileEntry(), llvm::encodeULEB128(), OS, llvm::raw_ostream::write(), writeInteger(), and writeVariableSizedInteger().

Referenced by writeLineTableOpcode().

writeInitialLength()

static void writeInitialLength ( const dwarf::DwarfFormat  Format, const uint64_t  Length, raw_ostream &  OS, bool  IsLittleEndian  )

static

Definition at line 71 of file DWARFEmitter.cpp.

References llvm::cantFail(), llvm::dwarf::DW_LENGTH_DWARF64, llvm::dwarf::DWARF64, llvm::Length, OS, and writeVariableSizedInteger().

Referenced by llvm::DWARFYAML::emitDebugAddr(), llvm::DWARFYAML::emitDebugAranges(), llvm::DWARFYAML::emitDebugInfo(), llvm::DWARFYAML::emitDebugLine(), llvm::DWARFYAML::emitDebugStrOffsets(), emitPubSection(), and writeDWARFLists().

writeInteger()

template<typename T >

static void writeInteger ( T  Integer, raw_ostream &  OS, bool  IsLittleEndian  )

static

Definition at line 43 of file DWARFEmitter.cpp.

References llvm::Integer, llvm::sys::IsLittleEndianHost, OS, llvm::sys::swapByteOrder(), and llvm::raw_ostream::write().

Referenced by llvm::DWARFYAML::emitDebugAddr(), llvm::DWARFYAML::emitDebugAranges(), llvm::DWARFYAML::emitDebugInfo(), llvm::DWARFYAML::emitDebugLine(), llvm::DWARFYAML::emitDebugStrOffsets(), emitPubSection(), writeDIE(), writeDWARFExpression(), writeDWARFLists(), writeExtendedOpcode(), writeLineTableOpcode(), writeListEntry(), and writeVariableSizedInteger().

writeLineTableOpcode()

static void writeLineTableOpcode ( const DWARFYAML::LineTableOpcode &  Op, uint8_t  OpcodeBase, uint8_t  AddrSize, raw_ostream &  OS, bool  IsLittleEndian  )

static

Definition at line 547 of file DWARFEmitter.cpp.

References llvm::encodeSLEB128(), llvm::encodeULEB128(), OS, writeExtendedOpcode(), and writeInteger().

Referenced by llvm::DWARFYAML::emitDebugLine().

writeListEntry() [1/2]

static Expected< uint64_t > writeListEntry ( raw_ostream &  OS, const DWARFYAML::LoclistEntry &  Entry, uint8_t  AddrSize, bool  IsLittleEndian  )

static

Definition at line 1032 of file DWARFEmitter.cpp.

References Addr, llvm::cantFail(), checkOperandCount(), llvm::encodeULEB128(), llvm::dwarf::LocListEncodingString(), OS, llvm::Error::success(), llvm::raw_ostream::tell(), llvm::raw_ostream::write(), writeDWARFExpression(), writeInteger(), and writeListEntryAddress().

writeListEntry() [2/2]

static Expected< uint64_t > writeListEntry ( raw_ostream &  OS, const DWARFYAML::RnglistEntry &  Entry, uint8_t  AddrSize, bool  IsLittleEndian  )

static

Definition at line 971 of file DWARFEmitter.cpp.

References Addr, llvm::cantFail(), checkOperandCount(), llvm::encodeULEB128(), OS, llvm::dwarf::RangeListEncodingString(), llvm::raw_ostream::tell(), writeInteger(), and writeListEntryAddress().

Referenced by writeDWARFLists().

writeListEntryAddress()

static Error writeListEntryAddress ( StringRef  EncodingName, raw_ostream &  OS, uint64_t  Addr, uint8_t  AddrSize, bool  IsLittleEndian  )

static

Definition at line 926 of file DWARFEmitter.cpp.

References Addr, llvm::c_str(), llvm::createStringError(), llvm::invalid_argument, OS, llvm::StringRef::str(), llvm::Error::success(), llvm::dwarf::toString(), and writeVariableSizedInteger().

Referenced by writeListEntry().

writeVariableSizedInteger()

static Error writeVariableSizedInteger ( uint64_t  Integer, size_t  Size, raw_ostream &  OS, bool  IsLittleEndian  )

static

Definition at line 49 of file DWARFEmitter.cpp.

References llvm::createStringError(), llvm::Integer, OS, Size, llvm::Error::success(), and writeInteger().

Referenced by llvm::DWARFYAML::emitDebugAddr(), llvm::DWARFYAML::emitDebugAranges(), llvm::DWARFYAML::emitDebugRanges(), writeDIE(), writeDWARFOffset(), writeExtendedOpcode(), writeInitialLength(), and writeListEntryAddress().

ZeroFillBytes()

static void ZeroFillBytes ( raw_ostream &  OS, size_t  Size  )

static

Definition at line 66 of file DWARFEmitter.cpp.

References OS, Size, and llvm::raw_ostream::write().

Referenced by llvm::DWARFYAML::emitDebugAranges(), and llvm::DWARFYAML::emitDebugRanges().