Defines the object file and target independent interfaces used by the assembler backend to write native file format object files. More...

#include "llvm/MC/MCObjectWriter.h"

Inheritance diagram for llvm::MCObjectWriter:

[legend]

Classes
struct	CGProfileEntry

Public Member Functions
	MCObjectWriter (const MCObjectWriter &)=delete

MCObjectWriter &	operator= (const MCObjectWriter &)=delete

virtual	~MCObjectWriter ()

virtual void	reset ()
	lifetime management

High-Level API
virtual void	executePostLayoutBinding (MCAssembler &Asm)
	Perform any late binding of symbols (for example, to assign symbol indices for use when generating relocations).

virtual void	recordRelocation (MCAssembler &Asm, const MCFragment *Fragment, const MCFixup &Fixup, MCValue Target, uint64_t &FixedValue)=0
	Record a relocation entry.

bool	isSymbolRefDifferenceFullyResolved (const MCAssembler &Asm, const MCSymbolRefExpr A, const MCSymbolRefExpr B, bool InSet) const
	Check whether the difference (A - B) between two symbol references is fully resolved.

virtual bool	isSymbolRefDifferenceFullyResolvedImpl (const MCAssembler &Asm, const MCSymbol &SymA, const MCFragment &FB, bool InSet, bool IsPCRel) const

MutableArrayRef< std::pair< std::string, size_t > >	getFileNames ()

void	addFileName (MCAssembler &Asm, StringRef FileName)

void	setCompilerVersion (StringRef CompilerVers)

void	emitAddrsigSection ()
	Tell the object writer to emit an address-significance table during writeObject().

bool	getEmitAddrsigSection ()

void	addAddrsigSymbol (const MCSymbol *Sym)
	Record the given symbol in the address-significance table to be written diring writeObject().

std::vector< const MCSymbol * > &	getAddrsigSyms ()

SmallVector< CGProfileEntry, 0 > &	getCGProfile ()

bool	getSubsectionsViaSymbols () const

void	setSubsectionsViaSymbols (bool Value)

virtual uint64_t	writeObject (MCAssembler &Asm)=0
	Write the object file and returns the number of bytes written.

Protected Member Functions
	MCObjectWriter ()=default

Protected Attributes
SmallVector< std::pair< std::string, size_t >, 0 >	FileNames
	List of declared file names.

std::string	CompilerVersion

std::vector< const MCSymbol * >	AddrsigSyms

bool	EmitAddrsigSection = false

bool	SubsectionsViaSymbols = false

SmallVector< CGProfileEntry, 0 >	CGProfile

Detailed Description

Defines the object file and target independent interfaces used by the assembler backend to write native file format object files.

The object writer contains a few callbacks used by the assembler to allow the object writer to modify the assembler data structures at appropriate points. Once assembly is complete, the object writer is given the MCAssembler instance, which contains all the symbol and section data which should be emitted as part of writeObject().

Definition at line 33 of file MCObjectWriter.h.

Constructor & Destructor Documentation

◆ MCObjectWriter() [1/2]

llvm::MCObjectWriter::MCObjectWriter ( )

protecteddefault

◆ MCObjectWriter() [2/2]

llvm::MCObjectWriter::MCObjectWriter ( const MCObjectWriter & )

delete

◆ ~MCObjectWriter()

MCObjectWriter::~MCObjectWriter ( )

virtualdefault

Member Function Documentation

◆ addAddrsigSymbol()

void llvm::MCObjectWriter::addAddrsigSymbol ( const MCSymbol * Sym )

inline

Record the given symbol in the address-significance table to be written diring writeObject().

Definition at line 113 of file MCObjectWriter.h.

References AddrsigSyms, and Sym.

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

◆ addFileName()

void MCObjectWriter::addFileName	(	MCAssembler &	Asm,
		StringRef	FileName
	)

Definition at line 54 of file MCObjectWriter.cpp.

References llvm::SmallVectorImpl< T >::emplace_back(), and FileNames.

◆ emitAddrsigSection()

void llvm::MCObjectWriter::emitAddrsigSection ( )

inline

Tell the object writer to emit an address-significance table during writeObject().

If this function is not called, all symbols are treated as address-significant.

Definition at line 107 of file MCObjectWriter.h.

References EmitAddrsigSection.

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

◆ executePostLayoutBinding()

virtual void llvm::MCObjectWriter::executePostLayoutBinding ( MCAssembler & Asm )

inlinevirtual

Perform any late binding of symbols (for example, to assign symbol indices for use when generating relocations).

This routine is called by the assembler after layout and relaxation is complete.

Reimplemented in llvm::ELFObjectWriter, llvm::MachObjectWriter, and llvm::WinCOFFObjectWriter.

Definition at line 68 of file MCObjectWriter.h.

Referenced by llvm::MCAssembler::layout().

◆ getAddrsigSyms()

std::vector< const MCSymbol * > & llvm::MCObjectWriter::getAddrsigSyms ( )

inline

Definition at line 115 of file MCObjectWriter.h.

References AddrsigSyms.

Referenced by llvm::MachObjectWriter::populateAddrSigSection().

◆ getCGProfile()

SmallVector< CGProfileEntry, 0 > & llvm::MCObjectWriter::getCGProfile ( )

inline

Definition at line 116 of file MCObjectWriter.h.

References CGProfile.

Referenced by llvm::MCELFStreamer::emitCGProfileEntry(), llvm::MCWinCOFFStreamer::emitCGProfileEntry(), and llvm::WinCOFFWriter::writeObject().

◆ getEmitAddrsigSection()

bool llvm::MCObjectWriter::getEmitAddrsigSection ( )

inline

Definition at line 109 of file MCObjectWriter.h.

References EmitAddrsigSection.

Referenced by llvm::WinCOFFWriter::writeObject().

◆ getFileNames()

MutableArrayRef< std::pair< std::string, size_t > > llvm::MCObjectWriter::getFileNames ( )

inline

Definition at line 96 of file MCObjectWriter.h.

References FileNames.

◆ getSubsectionsViaSymbols()

bool llvm::MCObjectWriter::getSubsectionsViaSymbols ( ) const

inline

Definition at line 119 of file MCObjectWriter.h.

References SubsectionsViaSymbols.

◆ isSymbolRefDifferenceFullyResolved()

bool MCObjectWriter::isSymbolRefDifferenceFullyResolved	(	const MCAssembler &	Asm,
		const MCSymbolRefExpr *	A,
		const MCSymbolRefExpr *	B,
		bool	InSet
	)		const

Check whether the difference (A - B) between two symbol references is fully resolved.

Clients are not required to answer precisely and may conservatively return false, even when a difference is fully resolved.

Definition at line 30 of file MCObjectWriter.cpp.

References A, assert(), B, llvm::MCSymbol::getFragment(), isSymbolRefDifferenceFullyResolvedImpl(), llvm::MCSymbol::isUndefined(), and llvm::MCSymbolRefExpr::VK_None.

◆ isSymbolRefDifferenceFullyResolvedImpl()

bool MCObjectWriter::isSymbolRefDifferenceFullyResolvedImpl	(	const MCAssembler &	Asm,
		const MCSymbol &	SymA,
		const MCFragment &	FB,
		bool	InSet,
		bool	IsPCRel
	)		const

virtual

Reimplemented in llvm::ELFObjectWriter, llvm::MachObjectWriter, and llvm::WinCOFFObjectWriter.

Definition at line 45 of file MCObjectWriter.cpp.

References llvm::MCFragment::getParent(), and llvm::MCSymbol::getSection().

Referenced by isSymbolRefDifferenceFullyResolved().

◆ operator=()

MCObjectWriter & llvm::MCObjectWriter::operator= ( const MCObjectWriter & )

delete

◆ recordRelocation()

virtual void llvm::MCObjectWriter::recordRelocation	(	MCAssembler &	Asm,
		const MCFragment *	Fragment,
		const MCFixup &	Fixup,
		MCValue	Target,
		uint64_t &	FixedValue
	)

pure virtual

Record a relocation entry.

This routine is called by the assembler after layout and relaxation, and post layout binding. The implementation is responsible for storing information about the relocation so that it can be emitted during writeObject().

Implemented in llvm::DXContainerObjectWriter, llvm::ELFObjectWriter, llvm::MachObjectWriter, and llvm::WinCOFFObjectWriter.