llvm::CodeViewContext Class Reference

Holds state from .cv_file and .cv_loc directives for later emission. More...

#include "llvm/MC/MCCodeView.h"

Public Member Functions
	CodeViewContext (MCContext *MCCtx)
CodeViewContext &	operator= (const CodeViewContext &other)=delete
	CodeViewContext (const CodeViewContext &other)=delete
LLVM_ABI void	finish ()
LLVM_ABI bool	isValidFileNumber (unsigned FileNumber) const
	This is a valid number for use with .cv_loc if we've already seen a .cv_file for it.
LLVM_ABI bool	addFile (MCStreamer &OS, unsigned FileNumber, StringRef Filename, ArrayRef< uint8_t > ChecksumBytes, uint8_t ChecksumKind)
LLVM_ABI bool	recordFunctionId (unsigned FuncId)
	Records the function id of a normal function.
LLVM_ABI bool	recordInlinedCallSiteId (unsigned FuncId, unsigned IAFunc, unsigned IAFile, unsigned IALine, unsigned IACol)
	Records the function id of an inlined call site.
LLVM_ABI MCCVFunctionInfo *	getCVFunctionInfo (unsigned FuncId)
	Retreive the function info if this is a valid function id, or nullptr.
LLVM_ABI void	recordCVLoc (MCContext &Ctx, const MCSymbol *Label, unsigned FunctionId, unsigned FileNo, unsigned Line, unsigned Column, bool PrologueEnd, bool IsStmt)
	Saves the information from the currently parsed .cv_loc directive and sets CVLocSeen.
LLVM_ABI void	addLineEntry (const MCCVLoc &LineEntry)
	Add a line entry.
LLVM_ABI std::vector< MCCVLoc >	getFunctionLineEntries (unsigned FuncId)
LLVM_ABI std::pair< size_t, size_t >	getLineExtent (unsigned FuncId)
LLVM_ABI std::pair< size_t, size_t >	getLineExtentIncludingInlinees (unsigned FuncId)
LLVM_ABI ArrayRef< MCCVLoc >	getLinesForExtent (size_t L, size_t R)
LLVM_ABI void	emitLineTableForFunction (MCObjectStreamer &OS, unsigned FuncId, const MCSymbol *FuncBegin, const MCSymbol *FuncEnd)
	Emits a line table substream.
LLVM_ABI void	emitInlineLineTableForFunction (MCObjectStreamer &OS, unsigned PrimaryFunctionId, unsigned SourceFileId, unsigned SourceLineNum, const MCSymbol *FnStartSym, const MCSymbol *FnEndSym)
LLVM_ABI void	encodeInlineLineTable (const MCAssembler &Asm, MCCVInlineLineTableFragment &F)
	Encodes the binary annotations once we have a layout.
LLVM_ABI void	emitDefRange (MCObjectStreamer &OS, ArrayRef< std::pair< const MCSymbol *, const MCSymbol * > > Ranges, StringRef FixedSizePortion)
LLVM_ABI void	encodeDefRange (const MCAssembler &Asm, MCCVDefRangeFragment &F)
LLVM_ABI void	emitStringTable (MCObjectStreamer &OS)
	Emits the string table substream.
LLVM_ABI void	emitFileChecksums (MCObjectStreamer &OS)
	Emits the file checksum substream.
LLVM_ABI void	emitFileChecksumOffset (MCObjectStreamer &OS, unsigned FileNo)
	Emits the offset into the checksum table of the given file number.
LLVM_ABI std::pair< StringRef, unsigned >	addToStringTable (StringRef S)
	Add something to the string table.

Detailed Description

Holds state from .cv_file and .cv_loc directives for later emission.

Definition at line 144 of file MCCodeView.h.

Constructor & Destructor Documentation

CodeViewContext() [1/2]

llvm::CodeViewContext::CodeViewContext ( MCContext * MCCtx )

inline

Definition at line 146 of file MCCodeView.h.

Referenced by CodeViewContext(), and operator=().

CodeViewContext() [2/2]

llvm::CodeViewContext::CodeViewContext ( const CodeViewContext & other )

delete

References CodeViewContext(), F, Filename, and LLVM_ABI.

Member Function Documentation

addFile()

bool CodeViewContext::addFile	(	MCStreamer &	OS,
		unsigned	FileNumber,
		StringRef	Filename,
		ArrayRef< uint8_t >	ChecksumBytes,
		uint8_t	ChecksumKind )

Definition at line 44 of file MCCodeView.cpp.

References addToStringTable(), assert(), llvm::MCContext::createTempSymbol(), Filename, llvm::MCStreamer::getContext(), and llvm::Offset.

Referenced by llvm::MCStreamer::emitCVFileDirective().

addLineEntry()

void CodeViewContext::addLineEntry

(

const MCCVLoc &

LineEntry

)

Add a line entry.

Definition at line 254 of file MCCodeView.cpp.

References llvm::MCCVLoc::getFunctionId(), I, and llvm::Offset.

Referenced by recordCVLoc().

addToStringTable()

std::pair< StringRef, unsigned > CodeViewContext::addToStringTable

(

StringRef

S

)

Add something to the string table.

Returns the final string as well as offset into the string table.

Definition at line 136 of file MCCodeView.cpp.

Referenced by addFile().

emitDefRange()

void CodeViewContext::emitDefRange	(	MCObjectStreamer &	OS,
		ArrayRef< std::pair< const MCSymbol *, const MCSymbol * > >	Ranges,
		StringRef	FixedSizePortion )

Definition at line 443 of file MCCodeView.cpp.

References llvm::MCObjectStreamer::newSpecialFragment(), and Saved.

Referenced by llvm::MCObjectStreamer::emitCVDefRangeDirective().

emitFileChecksumOffset()

void CodeViewContext::emitFileChecksumOffset	(	MCObjectStreamer &	OS,
		unsigned	FileNo )

Emits the offset into the checksum table of the given file number.

Definition at line 236 of file MCCodeView.cpp.

References llvm::MCSymbolRefExpr::create(), llvm::MCStreamer::emitSymbolValue(), llvm::MCObjectStreamer::emitValueImpl(), and llvm::MCStreamer::getContext().

Referenced by llvm::MCObjectStreamer::emitCVFileChecksumOffsetDirective().

emitFileChecksums()

void CodeViewContext::emitFileChecksums

(

MCObjectStreamer &

OS

)

Emits the file checksum substream.

Definition at line 181 of file MCCodeView.cpp.

References llvm::alignTo(), llvm::MCConstantExpr::create(), llvm::MCObjectStreamer::emitAbsoluteSymbolDiff(), llvm::MCObjectStreamer::emitAssignment(), llvm::MCObjectStreamer::emitBytes(), llvm::MCStreamer::emitInt32(), llvm::MCStreamer::emitInt8(), llvm::MCObjectStreamer::emitLabel(), llvm::MCObjectStreamer::emitValueToAlignment(), llvm::codeview::FileChecksums, llvm::MCStreamer::getContext(), and llvm::toStringRef().

Referenced by llvm::MCObjectStreamer::emitCVFileChecksumsDirective().

emitInlineLineTableForFunction()

void CodeViewContext::emitInlineLineTableForFunction	(	MCObjectStreamer &	OS,
		unsigned	PrimaryFunctionId,
		unsigned	SourceFileId,
		unsigned	SourceLineNum,
		const MCSymbol *	FnStartSym,
		const MCSymbol *	FnEndSym )

Definition at line 431 of file MCCodeView.cpp.

References llvm::MCObjectStreamer::newSpecialFragment().

Referenced by llvm::MCObjectStreamer::emitCVInlineLinetableDirective().

emitLineTableForFunction()

void CodeViewContext::emitLineTableForFunction	(	MCObjectStreamer &	OS,
		unsigned	FuncId,
		const MCSymbol *	FuncBegin,
		const MCSymbol *	FuncEnd )

Emits a line table substream.

Definition at line 338 of file MCCodeView.cpp.

References llvm::MCStreamer::AddComment(), llvm::any_of(), llvm::MCObjectStreamer::emitAbsoluteSymbolDiff(), llvm::MCStreamer::emitCOFFSecRel32(), llvm::MCStreamer::emitCOFFSectionIndex(), llvm::MCObjectStreamer::emitCVFileChecksumOffsetDirective(), llvm::MCStreamer::emitInt16(), llvm::MCStreamer::emitInt32(), llvm::MCObjectStreamer::emitLabel(), llvm::MCCVLoc::getColumn(), llvm::MCStreamer::getContext(), getFunctionLineEntries(), I, llvm::codeview::LF_HaveColumns, llvm::codeview::Lines, and llvm::codeview::LineInfo::StatementFlag.

Referenced by llvm::MCObjectStreamer::emitCVLinetableDirective().

emitStringTable()

void CodeViewContext::emitStringTable

(

MCObjectStreamer &

OS

)

Emits the string table substream.

Definition at line 158 of file MCCodeView.cpp.

References llvm::MCObjectStreamer::emitAbsoluteSymbolDiff(), llvm::MCStreamer::emitInt32(), llvm::MCObjectStreamer::emitLabel(), llvm::MCObjectStreamer::emitValueToAlignment(), llvm::MCStreamer::getContext(), llvm::MCStreamer::getCurrentFragment(), llvm::MCObjectStreamer::newFragment(), and llvm::codeview::StringTable.

Referenced by llvm::MCObjectStreamer::emitCVStringTableDirective().

encodeDefRange()

void CodeViewContext::encodeDefRange	(	const MCAssembler &	Asm,
		MCCVDefRangeFragment &	F )

Definition at line 609 of file MCCodeView.cpp.

References assert(), computeLabelDiff(), llvm::MCConstantExpr::create(), llvm::MCFixup::create(), llvm::MCSymbolRefExpr::create(), llvm::MCBinaryExpr::createAdd(), llvm::FK_SecRel_2, llvm::FK_SecRel_4, llvm::MCCVDefRangeFragment::getFixedSizePortion(), llvm::MCCVDefRangeFragment::getRanges(), I, llvm::little, llvm::codeview::MaxDefRange, llvm::SmallVectorTemplateBase< T, bool >::push_back(), Range, llvm::MCFragment::setVarContents(), llvm::MCFragment::setVarFixups(), llvm::SmallVectorTemplateCommon< T, typename >::size(), llvm::StringRef::size(), and llvm::support::endian::Writer::write().

encodeInlineLineTable()

void CodeViewContext::encodeInlineLineTable	(	const MCAssembler &	Asm,
		MCCVInlineLineTableFragment &	F )

Encodes the binary annotations once we have a layout.

Definition at line 472 of file MCCodeView.cpp.

References assert(), llvm::codeview::ChangeCodeLength, llvm::codeview::ChangeCodeOffset, llvm::codeview::ChangeCodeOffsetAndLineOffset, llvm::codeview::ChangeFile, llvm::codeview::ChangeLineOffset, compressAnnotation(), computeLabelDiff(), llvm::ArrayRef< T >::empty(), encodeSignedNumber(), llvm::errs(), llvm::MCCVFunctionInfo::LineInfo::File, llvm::ArrayRef< T >::front(), getCVFunctionInfo(), llvm::MCCVInlineLineTableFragment::getFnEndSym(), llvm::MCCVInlineLineTableFragment::getFnStartSym(), getLineExtentIncludingInlinees(), getLinesForExtent(), llvm::MCSymbol::getSection(), llvm::MCConstantExpr::getValue(), I, llvm::MCCVFunctionInfo::InlinedAtMap, llvm::Length, llvm::MCCVFunctionInfo::LineInfo::Line, llvm_unreachable, llvm::codeview::MaxRecordLength, llvm::MCCVLoc::setFileNum(), llvm::MCCVLoc::setLabel(), llvm::MCCVLoc::setLine(), llvm::MCFragment::setVarContents(), and llvm::SmallVectorTemplateCommon< T, typename >::size().

finish()

void CodeViewContext::finish

(

)

Definition at line 28 of file MCCodeView.cpp.

References assert(), and llvm::MCFragment::FT_Data.

Referenced by llvm::MCWinCOFFStreamer::finishImpl().

getCVFunctionInfo()

MCCVFunctionInfo * CodeViewContext::getCVFunctionInfo

(

unsigned

FuncId

)

Retreive the function info if this is a valid function id, or nullptr.

Definition at line 76 of file MCCodeView.cpp.

Referenced by llvm::MCStreamer::checkCVLocSection(), encodeInlineLineTable(), getFunctionLineEntries(), getLineExtentIncludingInlinees(), and recordInlinedCallSiteId().

getFunctionLineEntries()

std::vector< MCCVLoc > CodeViewContext::getFunctionLineEntries

(

unsigned

FuncId

)

Definition at line 264 of file MCCodeView.cpp.

References getCVFunctionInfo(), getLineExtentIncludingInlinees(), I, and llvm::MCCVFunctionInfo::InlinedAtMap.

Referenced by emitLineTableForFunction().

getLineExtent()

std::pair< size_t, size_t > CodeViewContext::getLineExtent

(

unsigned

FuncId

)

Definition at line 302 of file MCCodeView.cpp.

References I.

Referenced by getLineExtentIncludingInlinees().

getLineExtentIncludingInlinees()

std::pair< size_t, size_t > CodeViewContext::getLineExtentIncludingInlinees

(

unsigned

FuncId

)

Definition at line 311 of file MCCodeView.cpp.

References getCVFunctionInfo(), getLineExtent(), and llvm::MCCVFunctionInfo::InlinedAtMap.

Referenced by encodeInlineLineTable(), and getFunctionLineEntries().

getLinesForExtent()

ArrayRef< MCCVLoc > CodeViewContext::getLinesForExtent	(	size_t	L,
		size_t	R )

Definition at line 330 of file MCCodeView.cpp.

References llvm::ArrayRef().

Referenced by encodeInlineLineTable().

isValidFileNumber()

bool CodeViewContext::isValidFileNumber

(

unsigned

FileNumber

)

const

This is a valid number for use with .cv_loc if we've already seen a .cv_file for it.

Definition at line 37 of file MCCodeView.cpp.

operator=()

CodeViewContext & llvm::CodeViewContext::operator= ( const CodeViewContext & other )

delete

References CodeViewContext().

recordCVLoc()

void CodeViewContext::recordCVLoc	(	MCContext &	Ctx,
		const MCSymbol *	Label,
		unsigned	FunctionId,
		unsigned	FileNo,
		unsigned	Line,
		unsigned	Column,
		bool	PrologueEnd,
		bool	IsStmt )

Saves the information from the currently parsed .cv_loc directive and sets CVLocSeen.

When the next instruction is assembled an entry in the line number table with this information and the address of the instruction will be created.

Definition at line 128 of file MCCodeView.cpp.

References addLineEntry().

Referenced by llvm::MCObjectStreamer::emitCVLocDirective().

recordFunctionId()

bool CodeViewContext::recordFunctionId

(

unsigned

FuncId

)

Records the function id of a normal function.

Returns false if the function id has already been used, and true otherwise.

Definition at line 84 of file MCCodeView.cpp.

References llvm::MCCVFunctionInfo::FunctionSentinel.

Referenced by llvm::MCStreamer::emitCVFuncIdDirective().

recordInlinedCallSiteId()

bool CodeViewContext::recordInlinedCallSiteId	(	unsigned	FuncId,
		unsigned	IAFunc,
		unsigned	IAFile,
		unsigned	IALine,
		unsigned	IACol )

Records the function id of an inlined call site.

Records the "inlined at" location info of the call site, including what function or inlined call site it was inlined into. Returns false if the function id has already been used, and true otherwise.

Definition at line 97 of file MCCodeView.cpp.

References llvm::MCCVFunctionInfo::LineInfo::Col, llvm::MCCVFunctionInfo::LineInfo::File, getCVFunctionInfo(), llvm::MCCVFunctionInfo::LineInfo::Line, and llvm::MCCVFunctionInfo::ParentFuncIdPlusOne.

Referenced by llvm::MCStreamer::emitCVInlineSiteIdDirective().

---

The documentation for this class was generated from the following files:

• include/llvm/MC/MCCodeView.h
• lib/MC/MCCodeView.cpp