14#ifndef LLVM_MC_MCDWARF_H
15#define LLVM_MC_MCDWARF_H
38class MCObjectStreamer;
56 bool UseRelocs =
false;
115#define DWARF2_LINE_DEFAULT_IS_STMT 1
117#define DWARF2_FLAG_IS_STMT (1 << 0)
118#define DWARF2_FLAG_BASIC_BLOCK (1 << 1)
119#define DWARF2_FLAG_PROLOGUE_END (1 << 2)
120#define DWARF2_FLAG_EPILOGUE_BEGIN (1 << 3)
126 MCDwarfLoc(
unsigned fileNum,
unsigned line,
unsigned column,
unsigned flags,
127 unsigned isa,
unsigned discriminator)
128 : FileNum(fileNum), Line(line), Column(column), Flags(flags), Isa(
isa),
129 Discriminator(discriminator) {}
161 assert(column <= UINT16_MAX);
167 assert(flags <= UINT8_MAX);
179 Discriminator = discriminator;
225 MCLineDivisions[Sec].push_back(LineEntry);
233 using iterator = MCDwarfLineEntryCollection::iterator;
244 return MCLineDivisions;
270 bool HasAllMD5 =
true;
271 bool HasAnyMD5 =
false;
277 std::optional<MD5::MD5Result> Checksum,
278 std::optional<StringRef> Source,
279 uint16_t DwarfVersion,
unsigned FileNumber = 0);
280 std::pair<MCSymbol *, MCSymbol *>
282 std::optional<MCDwarfLineStr> &LineStr)
const;
283 std::pair<MCSymbol *, MCSymbol *>
286 std::optional<MCDwarfLineStr> &LineStr)
const;
292 HasAllMD5 &= MD5Used;
293 HasAnyMD5 |= MD5Used;
296 return MCDwarfFiles.empty() || (HasAllMD5 == HasAnyMD5);
300 std::optional<MD5::MD5Result> Checksum,
301 std::optional<StringRef> Source) {
320 void emitV2FileDirTables(
MCStreamer *MCOS)
const;
322 std::optional<MCDwarfLineStr> &LineStr)
const;
327 bool HasSplitLineTable =
false;
331 std::optional<MD5::MD5Result> Checksum,
332 std::optional<StringRef> Source) {
333 if (!Header.RootFile.Name.empty())
335 Header.setRootFile(Directory, FileName, Checksum, Source);
339 std::optional<MD5::MD5Result> Checksum,
340 uint16_t DwarfVersion, std::optional<StringRef> Source) {
341 HasSplitLineTable =
true;
342 return cantFail(Header.tryGetFile(Directory, FileName, Checksum, Source,
360 std::optional<MCDwarfLineStr> &LineStr)
const;
368 std::optional<MD5::MD5Result> Checksum,
369 std::optional<StringRef> Source,
370 uint16_t DwarfVersion,
unsigned FileNumber = 0);
372 std::optional<MD5::MD5Result> Checksum,
373 std::optional<StringRef> Source,
uint16_t DwarfVersion,
374 unsigned FileNumber = 0) {
376 DwarfVersion, FileNumber));
380 std::optional<MD5::MD5Result> Checksum,
381 std::optional<StringRef> Source) {
382 Header.CompilationDir = std::string(Directory);
383 Header.RootFile.Name = std::string(FileName);
384 Header.RootFile.DirIndex = 0;
385 Header.RootFile.Checksum = Checksum;
386 Header.RootFile.Source = Source;
387 Header.trackMD5Usage(Checksum.has_value());
388 Header.HasSource = Source.has_value();
393 bool hasRootFile()
const {
return !Header.RootFile.Name.empty(); }
406 Header.Label = Label;
410 return Header.MCDwarfDirs;
414 return Header.MCDwarfDirs;
418 return Header.MCDwarfFiles;
422 return Header.MCDwarfFiles;
426 return MCLineSections;
429 return MCLineSections;
441 int64_t LineDelta,
uint64_t AddrDelta);
469 : Name(
name), FileNumber(fileNumber), LineNumber(lineNumber),
515 std::vector<char> Values;
521 Values(V.begin(), V.end()), Comment(Comment) {
525 MCCFIInstruction(
OpType Op, MCSymbol *L,
unsigned R1,
unsigned R2, SMLoc Loc)
530 MCCFIInstruction(
OpType Op, MCSymbol *L,
unsigned R,
int O,
unsigned AS,
689 return StringRef(&Values[0], Values.size());
710 unsigned RAReg =
static_cast<unsigned>(INT_MAX);
This file defines the StringMap class.
This file implements a map that provides insertion order iteration.
PowerPC Reduce CR logical Operation
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the SmallVector class.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Allocate memory in an ever growing pool, as if by bump-pointer.
This class represents an Operation in the Expression.
Tagged union holding either a T or a Error.
Generic interface to target specific assembler backends.
static MCCFIInstruction createDefCfaRegister(MCSymbol *L, unsigned Register, SMLoc Loc={})
.cfi_def_cfa_register modifies a rule for computing CFA.
static MCCFIInstruction createOffset(MCSymbol *L, unsigned Register, int Offset, SMLoc Loc={})
.cfi_offset Previous value of Register is saved at offset Offset from CFA.
MCSymbol * getLabel() const
static MCCFIInstruction createUndefined(MCSymbol *L, unsigned Register, SMLoc Loc={})
.cfi_undefined From now on the previous value of Register can't be restored anymore.
static MCCFIInstruction cfiDefCfaOffset(MCSymbol *L, int Offset, SMLoc Loc={})
.cfi_def_cfa_offset modifies a rule for computing CFA.
unsigned getAddressSpace() const
static MCCFIInstruction createRelOffset(MCSymbol *L, unsigned Register, int Offset, SMLoc Loc={})
.cfi_rel_offset Previous value of Register is saved at offset Offset from the current CFA register.
static MCCFIInstruction createRestore(MCSymbol *L, unsigned Register, SMLoc Loc={})
.cfi_restore says that the rule for Register is now the same as it was at the beginning of the functi...
unsigned getRegister2() const
unsigned getRegister() const
static MCCFIInstruction createRegister(MCSymbol *L, unsigned Register1, unsigned Register2, SMLoc Loc={})
.cfi_register Previous value of Register1 is saved in register Register2.
static MCCFIInstruction createLLVMDefAspaceCfa(MCSymbol *L, unsigned Register, int Offset, unsigned AddressSpace, SMLoc Loc)
.cfi_llvm_def_aspace_cfa defines the rule for computing the CFA to be the result of evaluating the DW...
static MCCFIInstruction createNegateRAState(MCSymbol *L, SMLoc Loc={})
.cfi_negate_ra_state AArch64 negate RA state.
static MCCFIInstruction createRememberState(MCSymbol *L, SMLoc Loc={})
.cfi_remember_state Save all current rules for all registers.
OpType getOperation() const
StringRef getComment() const
static MCCFIInstruction cfiDefCfa(MCSymbol *L, unsigned Register, int Offset, SMLoc Loc={})
.cfi_def_cfa defines a rule for computing CFA as: take address from Register and add Offset to it.
StringRef getValues() const
static MCCFIInstruction createAdjustCfaOffset(MCSymbol *L, int Adjustment, SMLoc Loc={})
.cfi_adjust_cfa_offset Same as .cfi_def_cfa_offset, but Offset is a relative value that is added/subt...
static MCCFIInstruction createEscape(MCSymbol *L, StringRef Vals, SMLoc Loc={}, StringRef Comment="")
.cfi_escape Allows the user to add arbitrary bytes to the unwind info.
static MCCFIInstruction createWindowSave(MCSymbol *L, SMLoc Loc={})
.cfi_window_save SPARC register window is saved.
static MCCFIInstruction createGnuArgsSize(MCSymbol *L, int Size, SMLoc Loc={})
A special wrapper for .cfi_escape that indicates GNU_ARGS_SIZE.
static MCCFIInstruction createRestoreState(MCSymbol *L, SMLoc Loc={})
.cfi_restore_state Restore the previously saved state.
static MCCFIInstruction createSameValue(MCSymbol *L, unsigned Register, SMLoc Loc={})
.cfi_same_value Current value of Register is the same as in the previous frame.
Context object for machine code objects.
void maybeSetRootFile(StringRef Directory, StringRef FileName, std::optional< MD5::MD5Result > Checksum, std::optional< StringRef > Source)
unsigned getFile(StringRef Directory, StringRef FileName, std::optional< MD5::MD5Result > Checksum, uint16_t DwarfVersion, std::optional< StringRef > Source)
static void encodeAdvanceLoc(MCContext &Context, uint64_t AddrDelta, SmallVectorImpl< char > &OS)
static void encode(MCContext &Context, MCDwarfLineTableParams Params, int64_t LineDelta, uint64_t AddrDelta, SmallVectorImpl< char > &OS)
Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
Instances of this class represent the line information for the dwarf line table entries.
void setEndLabel(MCSymbol *EndLabel)
MCDwarfLineEntry(MCSymbol *label, const MCDwarfLoc loc)
MCSymbol * getLabel() const
static void make(MCStreamer *MCOS, MCSection *Section)
Manage the .debug_line_str section contents, if we use it.
void emitSection(MCStreamer *MCOS)
Emit the .debug_line_str section if appropriate.
SmallString< 0 > getFinalizedData()
Returns finalized section.
void emitRef(MCStreamer *MCOS, StringRef Path)
Emit a reference to the string.
size_t addString(StringRef Path)
Adds path Path to the line string.
bool isMD5UsageConsistent() const
const MCDwarfFile & getRootFile() const
void setLabel(MCSymbol *Label)
const SmallVectorImpl< std::string > & getMCDwarfDirs() const
void setRootFile(StringRef Directory, StringRef FileName, std::optional< MD5::MD5Result > Checksum, std::optional< StringRef > Source)
MCDwarfFile & getRootFile()
const MCLineSection & getMCLineSections() const
unsigned getFile(StringRef &Directory, StringRef &FileName, std::optional< MD5::MD5Result > Checksum, std::optional< StringRef > Source, uint16_t DwarfVersion, unsigned FileNumber=0)
SmallVectorImpl< std::string > & getMCDwarfDirs()
SmallVectorImpl< MCDwarfFile > & getMCDwarfFiles()
MCLineSection & getMCLineSections()
MCSymbol * getLabel() const
static void emitOne(MCStreamer *MCOS, MCSection *Section, const MCLineSection::MCDwarfLineEntryCollection &LineEntries)
Expected< unsigned > tryGetFile(StringRef &Directory, StringRef &FileName, std::optional< MD5::MD5Result > Checksum, std::optional< StringRef > Source, uint16_t DwarfVersion, unsigned FileNumber=0)
void emitCU(MCStreamer *MCOS, MCDwarfLineTableParams Params, std::optional< MCDwarfLineStr > &LineStr) const
const SmallVectorImpl< MCDwarfFile > & getMCDwarfFiles() const
Instances of this class represent the information from a dwarf .loc directive.
unsigned getLine() const
Get the Line of this MCDwarfLoc.
void setLine(unsigned line)
Set the Line of this MCDwarfLoc.
unsigned getIsa() const
Get the Isa of this MCDwarfLoc.
void setIsa(unsigned isa)
Set the Isa of this MCDwarfLoc.
void setDiscriminator(unsigned discriminator)
Set the Discriminator of this MCDwarfLoc.
unsigned getFlags() const
Get the Flags of this MCDwarfLoc.
unsigned getColumn() const
Get the Column of this MCDwarfLoc.
void setFlags(unsigned flags)
Set the Flags of this MCDwarfLoc.
unsigned getDiscriminator() const
Get the Discriminator of this MCDwarfLoc.
void setColumn(unsigned column)
Set the Column of this MCDwarfLoc.
unsigned getFileNum() const
Get the FileNum of this MCDwarfLoc.
void setFileNum(unsigned fileNum)
Set the FileNum of this MCDwarfLoc.
MCGenDwarfLabelEntry(StringRef name, unsigned fileNumber, unsigned lineNumber, MCSymbol *label)
StringRef getName() const
static void Make(MCSymbol *Symbol, MCStreamer *MCOS, SourceMgr &SrcMgr, SMLoc &Loc)
MCSymbol * getLabel() const
unsigned getLineNumber() const
unsigned getFileNumber() const
Instances of this class represent the line information for a compile unit where machine instructions ...
const MCLineDivisionMap & getMCLineEntries() const
void addEndEntry(MCSymbol *EndLabel)
MCDwarfLineEntryCollection::const_iterator const_iterator
MCDwarfLineEntryCollection::iterator iterator
void addLineEntry(const MCDwarfLineEntry &LineEntry, MCSection *Sec)
std::vector< MCDwarfLineEntry > MCDwarfLineEntryCollection
Streaming object file generation interface.
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Streaming machine code generation interface.
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Wrapper class representing virtual and physical registers.
Represents a location in source code.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
This owns the files read by a parser, handles include stacks, and handles diagnostic wrangling.
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
StringRef - Represent a constant reference to a string, i.e.
Saves strings in the provided stable storage and returns a StringRef with a stable character pointer.
Utility for building string tables with deduplicated suffixes.
MCSymbol * emitListsTableHeaderStart(MCStreamer &S)
This is an optimization pass for GlobalISel generic memory operations.
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
void cantFail(Error Err, const char *Msg=nullptr)
Report a fatal error if Err is a failure value.
DWARFExpression::Operation Op
ArrayRef(const T &OneElt) -> ArrayRef< T >
Instances of this class represent the name of the dwarf .file directive and its associated dwarf file...
std::optional< MD5::MD5Result > Checksum
The MD5 checksum, if there is one.
std::optional< StringRef > Source
The source code of the file.
MCDwarfFrameInfo()=default
const MCSymbol * Personality
uint32_t CompactUnwindEncoding
unsigned PersonalityEncoding
std::vector< MCCFIInstruction > Instructions
unsigned CurrentCfaRegister
uint8_t DWARF2LineOpcodeBase
First special line opcode - leave room for the standard opcodes.
uint8_t DWARF2LineRange
Range of line offsets in a special line info. opcode.
int8_t DWARF2LineBase
Minimum line offset in a special line info.