LLVM  15.0.0git
Classes | Typedefs | Functions | Variables
llvm::gsym Namespace Reference

Classes

struct  CUInfo
 
class  DwarfTransformer
 A class that transforms the DWARF in a DWARFContext into GSYM information by populating the GsymCreator object that it is constructed with. More...
 
struct  FileEntry
 Files in GSYM are contained in FileEntry structs where we split the directory and basename into two different strings in the string table. More...
 
class  FileWriter
 A simplified binary data writer class that doesn't require targets, target definitions, architectures, or require any other optional compile time libraries to be enabled via the build process. More...
 
struct  FunctionInfo
 Function information in GSYM files encodes information for one contiguous address range. More...
 
class  GsymCreator
 GsymCreator is used to emit GSYM data to a stand alone file or section within a file. More...
 
class  GsymReader
 GsymReader is used to read GSYM data from a file or buffer. More...
 
struct  Header
 The GSYM header. More...
 
struct  InlineInfo
 Inline information stores the name of the inline function along with an array of address ranges. More...
 
struct  LineEntry
 Line entries are used to encode the line tables in FunctionInfo objects. More...
 
class  LineTable
 LineTable class contains deserialized versions of line tables for each function's address ranges. More...
 
struct  LookupResult
 
class  ObjectFileTransformer
 
struct  SourceLocation
 
struct  StringTable
 String tables in GSYM files are required to start with an empty string at offset zero. More...
 

Typedefs

using SourceLocations = std::vector< SourceLocation >
 

Functions

void skipRange (DataExtractor &Data, uint64_t &Offset)
 Skip an address range object in the specified data a the specified offset. More...
 
uint64_t skipRanges (DataExtractor &Data, uint64_t &Offset)
 Skip an address range object in the specified data a the specified offset. More...
 
bool operator== (const FunctionInfo &LHS, const FunctionInfo &RHS)
 
bool operator!= (const FunctionInfo &LHS, const FunctionInfo &RHS)
 
bool operator< (const FunctionInfo &LHS, const FunctionInfo &RHS)
 This sorting will order things consistently by address range first, but then followed by inlining being valid and line tables. More...
 
raw_ostreamoperator<< (raw_ostream &OS, const FunctionInfo &R)
 
bool operator== (const Header &LHS, const Header &RHS)
 
raw_ostreamoperator<< (raw_ostream &OS, const llvm::gsym::Header &H)
 
bool operator== (const InlineInfo &LHS, const InlineInfo &RHS)
 
raw_ostreamoperator<< (raw_ostream &OS, const InlineInfo &FI)
 
raw_ostreamoperator<< (raw_ostream &OS, const LineEntry &LE)
 
bool operator== (const LineEntry &LHS, const LineEntry &RHS)
 
bool operator!= (const LineEntry &LHS, const LineEntry &RHS)
 
bool operator< (const LineEntry &LHS, const LineEntry &RHS)
 
raw_ostreamoperator<< (raw_ostream &OS, const gsym::LineTable &LT)
 
bool operator== (const SourceLocation &LHS, const SourceLocation &RHS)
 
raw_ostreamoperator<< (raw_ostream &OS, const SourceLocation &R)
 
raw_ostreamoperator<< (raw_ostream &OS, const LookupResult &R)
 
raw_ostreamoperator<< (raw_ostream &OS, const StringTable &S)
 

Variables

constexpr uint32_t GSYM_MAGIC = 0x4753594d
 
constexpr uint32_t GSYM_CIGAM = 0x4d595347
 
constexpr uint32_t GSYM_VERSION = 1
 
constexpr size_t GSYM_MAX_UUID_SIZE = 20
 

Typedef Documentation

◆ SourceLocations

using llvm::gsym::SourceLocations = typedef std::vector<SourceLocation>

Definition at line 36 of file LookupResult.h.

Function Documentation

◆ decodeRange()

AddressRange llvm::gsym::decodeRange ( DataExtractor Data,
uint64_t  BaseAddr,
uint64_t Offset 
)

AddressRange objects are encoded and decoded to be relative to a base address.

This will be the FunctionInfo's start address if the AddressRange is directly contained in a FunctionInfo, or a base address of the containing parent AddressRange or AddressRanges. This allows address ranges to be efficiently encoded using ULEB128 encodings as we encode the offset and size of each range instead of full addresses. This also makes encoded addresses easy to relocate as we just need to relocate one base address.

Definition at line 24 of file ExtractRanges.cpp.

References llvm::Data.

Referenced by decodeRanges().

◆ decodeRanges()

void llvm::gsym::decodeRanges ( AddressRanges Ranges,
DataExtractor Data,
uint64_t  BaseAddr,
uint64_t Offset 
)

Address ranges are decoded and encoded to be relative to a base address.

See the AddressRange comment for the encode and decode methods for full details.

Definition at line 42 of file ExtractRanges.cpp.

References llvm::AddressRanges::clear(), llvm::Data, decodeRange(), llvm::AddressRanges::insert(), and llvm::AddressRanges::reserve().

Referenced by decode().

◆ encodeRange()

void llvm::gsym::encodeRange ( const AddressRange Range,
FileWriter O,
uint64_t  BaseAddr 
)

◆ encodeRanges()

void llvm::gsym::encodeRanges ( const AddressRanges Ranges,
FileWriter O,
uint64_t  BaseAddr 
)

◆ operator!=() [1/2]

bool llvm::gsym::operator!= ( const FunctionInfo LHS,
const FunctionInfo RHS 
)
inline

Definition at line 187 of file FunctionInfo.h.

References LHS, and RHS.

◆ operator!=() [2/2]

bool llvm::gsym::operator!= ( const LineEntry LHS,
const LineEntry RHS 
)
inline

Definition at line 39 of file LineEntry.h.

References LHS, and RHS.

◆ operator<() [1/2]

bool llvm::gsym::operator< ( const FunctionInfo LHS,
const FunctionInfo RHS 
)
inline

This sorting will order things consistently by address range first, but then followed by inlining being valid and line tables.

We might end up with a FunctionInfo from debug info that will have the same range as one from the symbol table, but we want to quickly be able to sort and use the best version when creating the final GSYM file.

Definition at line 195 of file FunctionInfo.h.

References LHS, and RHS.

◆ operator<() [2/2]

bool llvm::gsym::operator< ( const LineEntry LHS,
const LineEntry RHS 
)
inline

Definition at line 42 of file LineEntry.h.

References LHS, and RHS.

◆ operator<<() [1/8]

raw_ostream & llvm::gsym::operator<< ( raw_ostream OS,
const FunctionInfo R 
)

◆ operator<<() [2/8]

raw_ostream & llvm::gsym::operator<< ( raw_ostream OS,
const gsym::LineTable LT 
)

Definition at line 289 of file LineTable.cpp.

References llvm::AArch64CC::LT.

◆ operator<<() [3/8]

raw_ostream & llvm::gsym::operator<< ( raw_ostream OS,
const InlineInfo FI 
)

◆ operator<<() [4/8]

raw_ostream& llvm::gsym::operator<< ( raw_ostream OS,
const LineEntry LE 
)
inline

Definition at line 31 of file LineEntry.h.

References llvm::format(), HEX64, and llvm::AArch64CC::LE.

◆ operator<<() [5/8]

raw_ostream & llvm::gsym::operator<< ( raw_ostream OS,
const llvm::gsym::Header H 
)

Definition at line 23 of file Header.cpp.

References llvm::format_hex_no_prefix(), H, HEX16, HEX32, HEX64, HEX8, and I.

◆ operator<<() [6/8]

raw_ostream & llvm::gsym::operator<< ( raw_ostream OS,
const LookupResult R 
)

◆ operator<<() [7/8]

raw_ostream & llvm::gsym::operator<< ( raw_ostream OS,
const SourceLocation R 
)

◆ operator<<() [8/8]

raw_ostream& llvm::gsym::operator<< ( raw_ostream OS,
const StringTable S 
)
inline

Definition at line 36 of file StringTable.h.

References HEX32, and S.

◆ operator==() [1/5]

bool llvm::gsym::operator== ( const FunctionInfo LHS,
const FunctionInfo RHS 
)
inline

Definition at line 183 of file FunctionInfo.h.

References LHS, and RHS.

◆ operator==() [2/5]

bool llvm::gsym::operator== ( const Header LHS,
const Header RHS 
)

Definition at line 101 of file Header.cpp.

References LHS, memcmp, and RHS.

◆ operator==() [3/5]

bool llvm::gsym::operator== ( const InlineInfo LHS,
const InlineInfo RHS 
)
inline

Definition at line 170 of file InlineInfo.h.

References LHS, and RHS.

◆ operator==() [4/5]

bool llvm::gsym::operator== ( const LineEntry LHS,
const LineEntry RHS 
)
inline

Definition at line 36 of file LineEntry.h.

References LHS, and RHS.

◆ operator==() [5/5]

bool llvm::gsym::operator== ( const SourceLocation LHS,
const SourceLocation RHS 
)
inline

Definition at line 29 of file LookupResult.h.

References LHS, and RHS.

◆ skipRange()

void llvm::gsym::skipRange ( DataExtractor Data,
uint64_t Offset 
)

Skip an address range object in the specified data a the specified offset.

Parameters
DataThe binary stream to read the data from.
OffsetThe byte offset within Data.

Definition at line 51 of file ExtractRanges.cpp.

References llvm::Data.

Referenced by skipRanges().

◆ skipRanges()

uint64_t llvm::gsym::skipRanges ( DataExtractor Data,
uint64_t Offset 
)

Skip an address range object in the specified data a the specified offset.

Parameters
DataThe binary stream to read the data from.
OffsetThe byte offset within Data.
Returns
The number of address ranges that were skipped.

Definition at line 56 of file ExtractRanges.cpp.

References llvm::Data, I, and skipRange().

Referenced by skip().

Variable Documentation

◆ GSYM_CIGAM

constexpr uint32_t llvm::gsym::GSYM_CIGAM = 0x4d595347
constexpr

Definition at line 25 of file Header.h.

◆ GSYM_MAGIC

constexpr uint32_t llvm::gsym::GSYM_MAGIC = 0x4753594d
constexpr

Definition at line 24 of file Header.h.

Referenced by llvm::gsym::Header::checkForError(), and llvm::gsym::GsymCreator::encode().

◆ GSYM_MAX_UUID_SIZE

constexpr size_t llvm::gsym::GSYM_MAX_UUID_SIZE = 20
constexpr

Definition at line 27 of file Header.h.

Referenced by llvm::gsym::Header::checkForError(), and llvm::gsym::Header::decode().

◆ GSYM_VERSION

constexpr uint32_t llvm::gsym::GSYM_VERSION = 1
constexpr

Definition at line 26 of file Header.h.

Referenced by llvm::gsym::Header::checkForError(), and llvm::gsym::GsymCreator::encode().