LLVM  6.0.0svn
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
llvm::MCObjectWriter Class Referenceabstract

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:
Inheritance graph
[legend]
Collaboration diagram for llvm::MCObjectWriter:
Collaboration graph
[legend]

Public Member Functions

 MCObjectWriter (const MCObjectWriter &)=delete
 
MCObjectWriteroperator= (const MCObjectWriter &)=delete
 
virtual ~MCObjectWriter ()
 
virtual void reset ()
 lifetime management More...
 
bool isLittleEndian () const
 
raw_pwrite_streamgetStream ()
 
void setStream (raw_pwrite_stream &NewOS)
 
High-Level API
virtual void executePostLayoutBinding (MCAssembler &Asm, const MCAsmLayout &Layout)=0
 Perform any late binding of symbols (for example, to assign symbol indices for use when generating relocations). More...
 
virtual void recordRelocation (MCAssembler &Asm, const MCAsmLayout &Layout, const MCFragment *Fragment, const MCFixup &Fixup, MCValue Target, uint64_t &FixedValue)=0
 Record a relocation entry. More...
 
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. More...
 
virtual bool isSymbolRefDifferenceFullyResolvedImpl (const MCAssembler &Asm, const MCSymbol &A, const MCSymbol &B, bool InSet) const
 
virtual bool isSymbolRefDifferenceFullyResolvedImpl (const MCAssembler &Asm, const MCSymbol &SymA, const MCFragment &FB, bool InSet, bool IsPCRel) const
 
virtual void writeObject (MCAssembler &Asm, const MCAsmLayout &Layout)=0
 Write the object file. More...
 
Binary Output
void write8 (uint8_t Value)
 
void writeLE16 (uint16_t Value)
 
void writeLE32 (uint32_t Value)
 
void writeLE64 (uint64_t Value)
 
void writeBE16 (uint16_t Value)
 
void writeBE32 (uint32_t Value)
 
void writeBE64 (uint64_t Value)
 
void write16 (uint16_t Value)
 
void write32 (uint32_t Value)
 
void write64 (uint64_t Value)
 
void WriteZeros (unsigned N)
 
void writeBytes (const SmallVectorImpl< char > &ByteVec, unsigned ZeroFillSize=0)
 
void writeBytes (StringRef Str, unsigned ZeroFillSize=0)
 

Protected Member Functions

 MCObjectWriter (raw_pwrite_stream &OS, bool IsLittleEndian)
 
unsigned getInitialOffset ()
 

Protected Attributes

unsigned IsLittleEndian: 1
 

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

The object writer also contains a number of helper methods for writing binary data to the output stream.

Definition at line 42 of file MCObjectWriter.h.

Constructor & Destructor Documentation

◆ MCObjectWriter() [1/2]

llvm::MCObjectWriter::MCObjectWriter ( raw_pwrite_stream OS,
bool  IsLittleEndian 
)
inlineprotected

Definition at line 49 of file MCObjectWriter.h.

Referenced by getInitialOffset().

◆ MCObjectWriter() [2/2]

llvm::MCObjectWriter::MCObjectWriter ( const MCObjectWriter )
delete

◆ ~MCObjectWriter()

MCObjectWriter::~MCObjectWriter ( )
virtualdefault

Referenced by getInitialOffset().

Member Function Documentation

◆ executePostLayoutBinding()

virtual void llvm::MCObjectWriter::executePostLayoutBinding ( MCAssembler Asm,
const MCAsmLayout Layout 
)
pure virtual

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.

Implemented in llvm::MachObjectWriter.

Referenced by llvm::MCAssembler::layout(), and setStream().

◆ getInitialOffset()

unsigned llvm::MCObjectWriter::getInitialOffset ( )
inlineprotected

◆ getStream()

raw_pwrite_stream& llvm::MCObjectWriter::getStream ( )
inline

◆ isLittleEndian()

bool llvm::MCObjectWriter::isLittleEndian ( ) const
inline

Definition at line 64 of file MCObjectWriter.h.

References IsLittleEndian.

◆ 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 20 of file MCObjectWriter.cpp.

References llvm::MCSymbol::getFragment(), llvm::MCSymbolRefExpr::getKind(), llvm::MCSymbolRefExpr::getSymbol(), isSymbolRefDifferenceFullyResolvedImpl(), llvm::MCSymbol::isUndefined(), and llvm::MCSymbolRefExpr::VK_None.

Referenced by setStream().

◆ isSymbolRefDifferenceFullyResolvedImpl() [1/2]

bool MCObjectWriter::isSymbolRefDifferenceFullyResolvedImpl ( const MCAssembler Asm,
const MCSymbol A,
const MCSymbol B,
bool  InSet 
) const
virtual

◆ isSymbolRefDifferenceFullyResolvedImpl() [2/2]

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

Reimplemented in llvm::MachObjectWriter.

Definition at line 46 of file MCObjectWriter.cpp.

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

◆ operator=()

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

Referenced by getInitialOffset().

◆ recordRelocation()

virtual void llvm::MCObjectWriter::recordRelocation ( MCAssembler Asm,
const MCAsmLayout Layout,
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::MachObjectWriter.

Referenced by setStream(), and llvm::MCAssembler::writeSectionData().

◆ reset()

virtual void llvm::MCObjectWriter::reset ( )
inlinevirtual

lifetime management

Reimplemented in llvm::MachObjectWriter.

Definition at line 62 of file MCObjectWriter.h.

Referenced by llvm::MachObjectWriter::reset(), and llvm::MCAssembler::reset().

◆ setStream()

void llvm::MCObjectWriter::setStream ( raw_pwrite_stream NewOS)
inline

◆ write16()

void llvm::MCObjectWriter::write16 ( uint16_t  Value)
inline

◆ write32()

void llvm::MCObjectWriter::write32 ( uint32_t  Value)
inline

◆ write64()

void llvm::MCObjectWriter::write64 ( uint64_t  Value)
inline

◆ write8()

void llvm::MCObjectWriter::write8 ( uint8_t  Value)
inline

◆ writeBE16()

void llvm::MCObjectWriter::writeBE16 ( uint16_t  Value)
inline

Definition at line 137 of file MCObjectWriter.h.

References llvm::support::endian::Writer< endian >::write().

Referenced by write16().

◆ writeBE32()

void llvm::MCObjectWriter::writeBE32 ( uint32_t  Value)
inline

Definition at line 141 of file MCObjectWriter.h.

References llvm::support::endian::Writer< endian >::write().

Referenced by write32().

◆ writeBE64()

void llvm::MCObjectWriter::writeBE64 ( uint64_t  Value)
inline

Definition at line 145 of file MCObjectWriter.h.

References llvm::support::endian::Writer< endian >::write().

Referenced by write64().

◆ writeBytes() [1/2]

void llvm::MCObjectWriter::writeBytes ( const SmallVectorImpl< char > &  ByteVec,
unsigned  ZeroFillSize = 0 
)
inline

◆ writeBytes() [2/2]

void llvm::MCObjectWriter::writeBytes ( StringRef  Str,
unsigned  ZeroFillSize = 0 
)
inline

Definition at line 184 of file MCObjectWriter.h.

References assert(), llvm::StringRef::size(), and WriteZeros().

◆ writeLE16()

void llvm::MCObjectWriter::writeLE16 ( uint16_t  Value)
inline

Definition at line 125 of file MCObjectWriter.h.

References llvm::support::endian::Writer< endian >::write().

Referenced by write16().

◆ writeLE32()

void llvm::MCObjectWriter::writeLE32 ( uint32_t  Value)
inline

Definition at line 129 of file MCObjectWriter.h.

References llvm::support::endian::Writer< endian >::write().

Referenced by write32().

◆ writeLE64()

void llvm::MCObjectWriter::writeLE64 ( uint64_t  Value)
inline

Definition at line 133 of file MCObjectWriter.h.

References llvm::support::endian::Writer< endian >::write().

Referenced by write64().

◆ writeObject()

virtual void llvm::MCObjectWriter::writeObject ( MCAssembler Asm,
const MCAsmLayout Layout 
)
pure virtual

Write the object file.

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

Implemented in llvm::MachObjectWriter.

Referenced by llvm::MCAssembler::Finish(), and setStream().

◆ WriteZeros()

void llvm::MCObjectWriter::WriteZeros ( unsigned  N)
inline

Member Data Documentation

◆ IsLittleEndian

unsigned llvm::MCObjectWriter::IsLittleEndian
protected

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