#include "llvm/MC/MCMachObjectWriter.h"

Inheritance diagram for llvm::MachObjectWriter:

Public Member Functions
	MachObjectWriter (std::unique_ptr< MCMachObjectTargetWriter > MOTW, raw_pwrite_stream &OS, bool IsLittleEndian)

const MCSymbol &	findAliasedSymbol (const MCSymbol &Sym) const

void	writeHeader (MachO::HeaderFileType Type, unsigned NumLoadCommands, unsigned LoadCommandsSize, bool SubsectionsViaSymbols)

void	writeSegmentLoadCommand (StringRef Name, unsigned NumSections, uint64_t VMAddr, uint64_t VMSize, uint64_t SectionDataStartOffset, uint64_t SectionDataSize, uint32_t MaxProt, uint32_t InitProt)
	Write a segment load command.

void	writeSection (const MCAsmLayout &Layout, const MCSection &Sec, uint64_t VMAddr, uint64_t FileOffset, unsigned Flags, uint64_t RelocationsStart, unsigned NumRelocations)

void	writeSymtabLoadCommand (uint32_t SymbolOffset, uint32_t NumSymbols, uint32_t StringTableOffset, uint32_t StringTableSize)

void	writeDysymtabLoadCommand (uint32_t FirstLocalSymbol, uint32_t NumLocalSymbols, uint32_t FirstExternalSymbol, uint32_t NumExternalSymbols, uint32_t FirstUndefinedSymbol, uint32_t NumUndefinedSymbols, uint32_t IndirectSymbolOffset, uint32_t NumIndirectSymbols)

void	writeNlist (MachSymbolData &MSD, const MCAsmLayout &Layout)

void	writeLinkeditLoadCommand (uint32_t Type, uint32_t DataOffset, uint32_t DataSize)

void	writeLinkerOptionsLoadCommand (const std::vector< std::string > &Options)

void	addRelocation (const MCSymbol RelSymbol, const MCSection Sec, MachO::any_relocation_info &MRE)

void	recordRelocation (MCAssembler &Asm, const MCAsmLayout &Layout, const MCFragment *Fragment, const MCFixup &Fixup, MCValue Target, uint64_t &FixedValue) override
	Record a relocation entry.

void	bindIndirectSymbols (MCAssembler &Asm)

void	computeSymbolTable (MCAssembler &Asm, std::vector< MachSymbolData > &LocalSymbolData, std::vector< MachSymbolData > &ExternalSymbolData, std::vector< MachSymbolData > &UndefinedSymbolData)
	Compute the symbol table data.

void	computeSectionAddresses (const MCAssembler &Asm, const MCAsmLayout &Layout)

void	executePostLayoutBinding (MCAssembler &Asm, const MCAsmLayout &Layout) override
	Perform any late binding of symbols (for example, to assign symbol indices for use when generating relocations).

bool	isSymbolRefDifferenceFullyResolvedImpl (const MCAssembler &Asm, const MCSymbol &A, const MCSymbol &B, bool InSet) const override

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

void	populateAddrSigSection (MCAssembler &Asm)

uint64_t	writeObject (MCAssembler &Asm, const MCAsmLayout &Layout) override
	Write the object file and returns the number of bytes written.

Lifetime management Methods
void	reset () override
	lifetime management

Utility Methods
bool	isFixupKindPCRel (const MCAssembler &Asm, unsigned Kind)

SectionAddrMap &	getSectionAddressMap ()

uint64_t	getSectionAddress (const MCSection *Sec) const

uint64_t	getSymbolAddress (const MCSymbol &S, const MCAsmLayout &Layout) const

uint64_t	getFragmentAddress (const MCFragment *Fragment, const MCAsmLayout &Layout) const

uint64_t	getPaddingSize (const MCSection *SD, const MCAsmLayout &Layout) const

bool	doesSymbolRequireExternRelocation (const MCSymbol &S)

Target Writer Proxy Accessors
bool	is64Bit () const

bool	isX86_64 () const

Public Member Functions inherited from llvm::MCObjectWriter
	MCObjectWriter (const MCObjectWriter &)=delete

MCObjectWriter &	operator= (const MCObjectWriter &)=delete

virtual	~MCObjectWriter ()

virtual void	reset ()
	lifetime management

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 void	markGnuAbi ()
	ELF only. Mark that we have seen GNU ABI usage (e.g. SHF_GNU_RETAIN).

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 ()

virtual void	addExceptionEntry (const MCSymbol Symbol, const MCSymbol Trap, unsigned LanguageCode, unsigned ReasonCode, unsigned FunctionSize, bool hasDebug)

Public Attributes
support::endian::Writer	W

Additional Inherited Members
Protected Member Functions inherited from llvm::MCObjectWriter
	MCObjectWriter ()=default

Protected Attributes inherited from llvm::MCObjectWriter
std::vector< const MCSymbol * >	AddrsigSyms

bool	EmitAddrsigSection = false

Detailed Description

Definition at line 84 of file MCMachObjectWriter.h.

Constructor & Destructor Documentation

◆ MachObjectWriter()

llvm::MachObjectWriter::MachObjectWriter	(	std::unique_ptr< MCMachObjectTargetWriter >	MOTW,
		raw_pwrite_stream &	OS,
		bool	IsLittleEndian
	)

inline

Definition at line 129 of file MCMachObjectWriter.h.

Member Function Documentation

◆ addRelocation()

void llvm::MachObjectWriter::addRelocation	(	const MCSymbol *	RelSymbol,
		const MCSection *	Sec,
		MachO::any_relocation_info &	MRE
	)

inline

Definition at line 232 of file MCMachObjectWriter.h.

References P.

Referenced by populateAddrSigSection().

◆ bindIndirectSymbols()

void MachObjectWriter::bindIndirectSymbols ( MCAssembler & Asm )

Definition at line 478 of file MachObjectWriter.cpp.

References llvm::make_range(), llvm::report_fatal_error(), llvm::MachO::S_LAZY_SYMBOL_POINTERS, llvm::MachO::S_NON_LAZY_SYMBOL_POINTERS, llvm::MachO::S_SYMBOL_STUBS, and llvm::MachO::S_THREAD_LOCAL_VARIABLE_POINTERS.

Referenced by executePostLayoutBinding().

◆ computeSectionAddresses()

void MachObjectWriter::computeSectionAddresses	(	const MCAssembler &	Asm,
		const MCAsmLayout &	Layout
	)

strictly be necessary.

Definition at line 641 of file MachObjectWriter.cpp.

References llvm::alignTo(), getPaddingSize(), llvm::MCAsmLayout::getSectionAddressSize(), and llvm::MCAsmLayout::getSectionOrder().

Referenced by executePostLayoutBinding().

◆ computeSymbolTable()

void MachObjectWriter::computeSymbolTable	(	MCAssembler &	Asm,
		std::vector< MachSymbolData > &	LocalSymbolData,
		std::vector< MachSymbolData > &	ExternalSymbolData,
		std::vector< MachSymbolData > &	UndefinedSymbolData
	)

Compute the symbol table data.

computeSymbolTable - Compute the symbol table data

Definition at line 540 of file MachObjectWriter.cpp.

References llvm::StringTableBuilder::add(), assert(), llvm::support::endian::Writer::Endian, llvm::StringTableBuilder::finalize(), llvm::StringTableBuilder::getOffset(), llvm::support::little, llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::lookup(), llvm::sort(), and W.

Referenced by writeObject().

◆ doesSymbolRequireExternRelocation()

bool MachObjectWriter::doesSymbolRequireExternRelocation ( const MCSymbol & S )

Definition at line 57 of file MachObjectWriter.cpp.

References llvm::MCSymbol::isUndefined().

◆ executePostLayoutBinding()

void MachObjectWriter::executePostLayoutBinding	(	MCAssembler &	Asm,
		const MCAsmLayout &	Layout
	)

overridevirtual

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.

Implements llvm::MCObjectWriter.

Definition at line 656 of file MachObjectWriter.cpp.

References bindIndirectSymbols(), and computeSectionAddresses().

◆ findAliasedSymbol()

const MCSymbol & MachObjectWriter::findAliasedSymbol ( const MCSymbol & Sym ) const

Definition at line 327 of file MachObjectWriter.cpp.

References llvm::MCSymbol::getVariableValue(), llvm::MCSymbol::isVariable(), llvm::Ref, and Sym.

Referenced by isSymbolRefDifferenceFullyResolvedImpl(), and writeNlist().

◆ getFragmentAddress()

uint64_t MachObjectWriter::getFragmentAddress	(	const MCFragment *	Fragment,
		const MCAsmLayout &	Layout
	)		const

Definition at line 83 of file MachObjectWriter.cpp.

References llvm::MCAsmLayout::getFragmentOffset(), llvm::MCFragment::getParent(), and getSectionAddress().

◆ getPaddingSize()

uint64_t MachObjectWriter::getPaddingSize	(	const MCSection *	SD,
		const MCAsmLayout &	Layout
	)		const

Definition at line 122 of file MachObjectWriter.cpp.

References llvm::MCSection::getAlign(), llvm::MCSection::getLayoutOrder(), getSectionAddress(), llvm::MCAsmLayout::getSectionAddressSize(), llvm::MCAsmLayout::getSectionOrder(), llvm::MCSection::isVirtualSection(), and llvm::offsetToAlignment().

Referenced by computeSectionAddresses(), and writeObject().

◆ getSectionAddress()

uint64_t llvm::MachObjectWriter::getSectionAddress ( const MCSection * Sec ) const

inline

Definition at line 154 of file MCMachObjectWriter.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::lookup().

Referenced by getFragmentAddress(), getPaddingSize(), getSymbolAddress(), and writeObject().

◆ getSectionAddressMap()

SectionAddrMap & llvm::MachObjectWriter::getSectionAddressMap ( )

inline

Definition at line 152 of file MCMachObjectWriter.h.

◆ getSymbolAddress()

uint64_t MachObjectWriter::getSymbolAddress	(	const MCSymbol &	S,
		const MCAsmLayout &	Layout
	)		const

Definition at line 89 of file MachObjectWriter.cpp.

References llvm::Address, llvm::CallingConv::C, llvm::MCExpr::evaluateAsRelocatable(), llvm::MCSymbol::getFragment(), llvm::MCSymbol::getName(), llvm::Target::getName(), llvm::MCFragment::getParent(), getSectionAddress(), getSymbolAddress(), llvm::MCAsmLayout::getSymbolOffset(), llvm::MCSymbol::getVariableValue(), llvm::MCSymbol::isVariable(), and llvm::report_fatal_error().

Referenced by getSymbolAddress(), writeNlist(), and writeObject().

◆ is64Bit()

bool llvm::MachObjectWriter::is64Bit ( ) const

inline

Definition at line 171 of file MCMachObjectWriter.h.

Referenced by populateAddrSigSection(), writeHeader(), writeLinkerOptionsLoadCommand(), writeNlist(), writeObject(), writeSection(), and writeSegmentLoadCommand().

◆ isFixupKindPCRel()

bool MachObjectWriter::isFixupKindPCRel	(	const MCAssembler &	Asm,
		unsigned	Kind
	)

Definition at line 76 of file MachObjectWriter.cpp.

References llvm::MCFixupKindInfo::FKF_IsPCRel, and llvm::MCFixupKindInfo::Flags.

◆ isSymbolRefDifferenceFullyResolvedImpl() [1/2]

bool MachObjectWriter::isSymbolRefDifferenceFullyResolvedImpl	(	const MCAssembler &	Asm,
		const MCSymbol &	A,
		const MCSymbol &	B,
		bool	InSet
	)		const

overridevirtual

Reimplemented from llvm::MCObjectWriter.

Definition at line 664 of file MachObjectWriter.cpp.

References A, B, and llvm::MCObjectWriter::isSymbolRefDifferenceFullyResolvedImpl().

◆ isSymbolRefDifferenceFullyResolvedImpl() [2/2]

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

overridevirtual

Reimplemented from llvm::MCObjectWriter.

Definition at line 676 of file MachObjectWriter.cpp.

References findAliasedSymbol(), llvm::MCFragment::getAtom(), llvm::MCSymbol::getFragment(), llvm::MCFragment::getParent(), llvm::MCSymbol::getSection(), llvm::MCSymbol::isInSection(), llvm::MCSymbol::isTemporary(), and isX86_64().

◆ isX86_64()

bool llvm::MachObjectWriter::isX86_64 ( ) const

inline

Definition at line 172 of file MCMachObjectWriter.h.

References llvm::MachO::CPU_TYPE_X86_64.

Referenced by isSymbolRefDifferenceFullyResolvedImpl().

◆ populateAddrSigSection()

void MachObjectWriter::populateAddrSigSection ( MCAssembler & Asm )

Definition at line 753 of file MachObjectWriter.cpp.

References addRelocation(), llvm::MachO::GENERIC_RELOC_VANILLA, llvm::MCObjectWriter::getAddrsigSyms(), is64Bit(), llvm::MachO::any_relocation_info::r_word0, and llvm::MachO::any_relocation_info::r_word1.

Referenced by writeObject().

◆ recordRelocation()

void MachObjectWriter::recordRelocation	(	MCAssembler &	Asm,
		const MCAsmLayout &	Layout,
		const MCFragment *	Fragment,
		const MCFixup &	Fixup,
		MCValue	Target,
		uint64_t &	FixedValue
	)

overridevirtual

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().

Implements llvm::MCObjectWriter.

Definition at line 463 of file MachObjectWriter.cpp.

References Fixup, and isFixupTargetValid().

◆ reset()

void MachObjectWriter::reset ( )

overridevirtual

lifetime management

Reimplemented from llvm::MCObjectWriter.

Definition at line 47 of file MachObjectWriter.cpp.

References llvm::StringTableBuilder::clear(), and llvm::MCObjectWriter::reset().

◆ writeDysymtabLoadCommand()

void MachObjectWriter::writeDysymtabLoadCommand	(	uint32_t	FirstLocalSymbol,
		uint32_t	NumLocalSymbols,
		uint32_t	FirstExternalSymbol,
		uint32_t	NumExternalSymbols,
		uint32_t	FirstUndefinedSymbol,
		uint32_t	NumUndefinedSymbols,
		uint32_t	IndirectSymbolOffset,
		uint32_t	NumIndirectSymbols
	)

Definition at line 279 of file MachObjectWriter.cpp.

References assert(), llvm::support::endian::Writer::OS, llvm::raw_ostream::tell(), W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

◆ writeHeader()

void MachObjectWriter::writeHeader	(	MachO::HeaderFileType	Type,
		unsigned	NumLoadCommands,
		unsigned	LoadCommandsSize,
		bool	SubsectionsViaSymbols
	)

Definition at line 135 of file MachObjectWriter.cpp.

References assert(), Flags, is64Bit(), llvm::MachO::MH_MAGIC, llvm::MachO::MH_MAGIC_64, llvm::MachO::MH_SUBSECTIONS_VIA_SYMBOLS, llvm::support::endian::Writer::OS, llvm::raw_ostream::tell(), W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

◆ writeLinkeditLoadCommand()

void MachObjectWriter::writeLinkeditLoadCommand	(	uint32_t	Type,
		uint32_t	DataOffset,
		uint32_t	DataSize
	)

Definition at line 408 of file MachObjectWriter.cpp.

References assert(), llvm::support::endian::Writer::OS, llvm::raw_ostream::tell(), W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

◆ writeLinkerOptionsLoadCommand()

void MachObjectWriter::writeLinkerOptionsLoadCommand ( const std::vector< std::string > & Options )

Definition at line 431 of file MachObjectWriter.cpp.

References assert(), ComputeLinkerOptionsLoadCommandSize(), is64Bit(), llvm::offsetToAlignment(), Options, llvm::support::endian::Writer::OS, Size, llvm::raw_ostream::tell(), W, llvm::support::endian::Writer::write(), and llvm::raw_ostream::write_zeros().

Referenced by writeObject().

◆ writeNlist()

void MachObjectWriter::writeNlist	(	MachSymbolData &	MSD,
		const MCAsmLayout &	Layout
	)

Definition at line 339 of file MachObjectWriter.cpp.

References llvm::Address, llvm::Data, findAliasedSymbol(), getSymbolAddress(), is64Bit(), llvm::MachO::N_ABS, llvm::MachO::N_EXT, llvm::MachO::N_INDR, llvm::MachO::N_PEXT, llvm::MachO::N_SECT, llvm::MachO::N_UNDF, llvm::support::endian::Writer::OS, W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

◆ writeObject()

uint64_t MachObjectWriter::writeObject	(	MCAssembler &	Asm,
		const MCAsmLayout &	Layout
	)

overridevirtual

Write the object file and returns the number of bytes written.

This routine is called by the assembler after layout and relaxation is complete, fixups have been evaluated and applied, and relocations generated.

Implements llvm::MCObjectWriter.

Definition at line 767 of file MachObjectWriter.cpp.

References llvm::Address, llvm::alignTo(), assert(), llvm::SmallVectorImpl< T >::clear(), ComputeLinkerOptionsLoadCommandSize(), computeSymbolTable(), llvm::MCAssembler::CGProfileEntry::Count, llvm::Data, llvm::dbgs(), End, llvm::support::endian::Writer::Endian, Flags, llvm::MCAssembler::CGProfileEntry::From, llvm::MCAsmLayout::getAssembler(), llvm::MCEncodedFragmentWithContents< ContentsSize >::getContents(), llvm::MCAssembler::getDarwinTargetVariantVersionInfo(), llvm::MCSection::getFragmentList(), llvm::MCSymbol::getIndex(), getLCFromMCVM(), llvm::SectionKind::getMetadata(), getPaddingSize(), getSectionAddress(), llvm::MCAsmLayout::getSectionAddressSize(), llvm::MCAsmLayout::getSectionFileSize(), llvm::StringTableBuilder::getSize(), llvm::MCSymbolRefExpr::getSymbol(), getSymbolAddress(), llvm::MCAssembler::getVersionInfo(), llvm::MachO::INDIRECT_SYMBOL_ABS, llvm::MachO::INDIRECT_SYMBOL_LOCAL, is64Bit(), LLVM_DEBUG, llvm::MachO::MH_OBJECT, llvm::offsetToAlignment(), llvm::support::endian::Writer::OS, OS, populateAddrSigSection(), llvm::report_fatal_error(), llvm::reverse(), llvm::MachO::S_ATTR_SOME_INSTRUCTIONS, llvm::MachO::S_NON_LAZY_SYMBOL_POINTERS, Size, llvm::raw_ostream::tell(), llvm::MCAssembler::CGProfileEntry::To, llvm::MachO::VM_PROT_EXECUTE, llvm::MachO::VM_PROT_READ, llvm::MachO::VM_PROT_WRITE, W, llvm::support::endian::Writer::write(), llvm::StringTableBuilder::write(), llvm::support::endian::write(), llvm::raw_ostream::write_zeros(), writeDysymtabLoadCommand(), writeHeader(), writeLinkeditLoadCommand(), writeLinkerOptionsLoadCommand(), writeNlist(), writeSection(), writeSegmentLoadCommand(), and writeSymtabLoadCommand().

◆ writeSection()

void MachObjectWriter::writeSection	(	const MCAsmLayout &	Layout,
		const MCSection &	Sec,
		uint64_t	VMAddr,
		uint64_t	FileOffset,
		unsigned	Flags,
		uint64_t	RelocationsStart,
		unsigned	NumRelocations
	)

Definition at line 216 of file MachObjectWriter.cpp.

References assert(), Flags, llvm::MCAsmLayout::getSectionAddressSize(), llvm::MCAsmLayout::getSectionFileSize(), is64Bit(), llvm::Log2(), llvm::support::endian::Writer::OS, llvm::raw_ostream::tell(), W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

◆ writeSegmentLoadCommand()

void MachObjectWriter::writeSegmentLoadCommand	(	StringRef	Name,
		unsigned	NumSections,
		uint64_t	VMAddr,
		uint64_t	VMSize,
		uint64_t	SectionDataStartOffset,
		uint64_t	SectionDataSize,
		uint32_t	MaxProt,
		uint32_t	InitProt
	)

Write a segment load command.

writeSegmentLoadCommand - Write a segment load command.

Parameters

NumSections	The number of sections in this segment.
SectionDataSize	The total size of the sections.

Definition at line 176 of file MachObjectWriter.cpp.

References assert(), is64Bit(), Name, llvm::support::endian::Writer::OS, llvm::raw_ostream::tell(), W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

◆ writeSymtabLoadCommand()

void MachObjectWriter::writeSymtabLoadCommand	(	uint32_t	SymbolOffset,
		uint32_t	NumSymbols,
		uint32_t	StringTableOffset,
		uint32_t	StringTableSize
	)

Definition at line 260 of file MachObjectWriter.cpp.

References assert(), llvm::support::endian::Writer::OS, llvm::raw_ostream::tell(), W, and llvm::support::endian::Writer::write().

Referenced by writeObject().

Member Data Documentation

◆ W

support::endian::Writer llvm::MachObjectWriter::W

Definition at line 136 of file MCMachObjectWriter.h.

Referenced by computeSymbolTable(), llvm::MCLOHDirective::emit(), writeDysymtabLoadCommand(), writeHeader(), writeLinkeditLoadCommand(), writeLinkerOptionsLoadCommand(), writeNlist(), writeObject(), writeSection(), writeSegmentLoadCommand(), and writeSymtabLoadCommand().

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

include/llvm/MC/MCMachObjectWriter.h
lib/MC/MachObjectWriter.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MachObjectWriter()

Member Function Documentation

◆ addRelocation()

◆ bindIndirectSymbols()

◆ computeSectionAddresses()

◆ computeSymbolTable()

◆ doesSymbolRequireExternRelocation()

◆ executePostLayoutBinding()

◆ findAliasedSymbol()

◆ getFragmentAddress()

◆ getPaddingSize()

◆ getSectionAddress()

◆ getSectionAddressMap()

◆ getSymbolAddress()

◆ is64Bit()

◆ isFixupKindPCRel()

◆ isSymbolRefDifferenceFullyResolvedImpl() [1/2]

◆ isSymbolRefDifferenceFullyResolvedImpl() [2/2]

◆ isX86_64()

◆ populateAddrSigSection()

◆ recordRelocation()

◆ reset()

◆ writeDysymtabLoadCommand()

◆ writeHeader()

◆ writeLinkeditLoadCommand()

◆ writeLinkerOptionsLoadCommand()

◆ writeNlist()

◆ writeObject()

◆ writeSection()

◆ writeSegmentLoadCommand()

◆ writeSymtabLoadCommand()

Member Data Documentation

◆ W