2010-03-19 09:28:59 +00:00
|
|
|
//===-- llvm/MC/MCObjectWriter.h - Object File Writer Interface -*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_MC_MCOBJECTWRITER_H
|
|
|
|
#define LLVM_MC_MCOBJECTWRITER_H
|
|
|
|
|
2010-11-13 07:33:40 +00:00
|
|
|
#include "llvm/ADT/Triple.h"
|
2010-03-19 09:28:59 +00:00
|
|
|
#include "llvm/Support/raw_ostream.h"
|
2010-11-29 18:16:10 +00:00
|
|
|
#include "llvm/Support/DataTypes.h"
|
2010-03-19 09:28:59 +00:00
|
|
|
#include <cassert>
|
|
|
|
|
|
|
|
namespace llvm {
|
2010-03-24 03:43:40 +00:00
|
|
|
class MCAsmLayout;
|
2010-03-19 09:28:59 +00:00
|
|
|
class MCAssembler;
|
2010-05-26 15:18:56 +00:00
|
|
|
class MCFixup;
|
2010-03-22 20:35:50 +00:00
|
|
|
class MCFragment;
|
2010-12-18 05:37:28 +00:00
|
|
|
class MCSymbol;
|
2010-12-24 21:22:02 +00:00
|
|
|
class MCSymbolData;
|
2010-12-17 04:54:54 +00:00
|
|
|
class MCSymbolRefExpr;
|
2010-03-19 09:28:59 +00:00
|
|
|
class MCValue;
|
|
|
|
class raw_ostream;
|
|
|
|
|
|
|
|
/// MCObjectWriter - 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.
|
|
|
|
class MCObjectWriter {
|
|
|
|
MCObjectWriter(const MCObjectWriter &); // DO NOT IMPLEMENT
|
|
|
|
void operator=(const MCObjectWriter &); // DO NOT IMPLEMENT
|
|
|
|
|
|
|
|
protected:
|
|
|
|
raw_ostream &OS;
|
|
|
|
|
|
|
|
unsigned IsLittleEndian : 1;
|
|
|
|
|
|
|
|
protected: // Can only create subclasses.
|
|
|
|
MCObjectWriter(raw_ostream &_OS, bool _IsLittleEndian)
|
|
|
|
: OS(_OS), IsLittleEndian(_IsLittleEndian) {}
|
|
|
|
|
|
|
|
public:
|
|
|
|
virtual ~MCObjectWriter();
|
|
|
|
|
2010-04-19 15:39:27 +00:00
|
|
|
bool isLittleEndian() const { return IsLittleEndian; }
|
2010-03-19 09:28:59 +00:00
|
|
|
|
|
|
|
raw_ostream &getStream() { return OS; }
|
|
|
|
|
|
|
|
/// @name High-Level API
|
|
|
|
/// @{
|
|
|
|
|
|
|
|
/// 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.
|
2010-12-07 00:27:36 +00:00
|
|
|
virtual void ExecutePostLayoutBinding(MCAssembler &Asm,
|
|
|
|
const MCAsmLayout &Layout) = 0;
|
2010-03-19 09:28:59 +00:00
|
|
|
|
|
|
|
/// 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().
|
|
|
|
virtual void RecordRelocation(const MCAssembler &Asm,
|
2010-03-24 03:43:40 +00:00
|
|
|
const MCAsmLayout &Layout,
|
2010-03-22 20:35:50 +00:00
|
|
|
const MCFragment *Fragment,
|
2010-05-26 15:18:56 +00:00
|
|
|
const MCFixup &Fixup, MCValue Target,
|
2010-03-19 09:28:59 +00:00
|
|
|
uint64_t &FixedValue) = 0;
|
|
|
|
|
2010-12-17 04:54:54 +00:00
|
|
|
/// \brief 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.
|
2010-12-24 21:22:02 +00:00
|
|
|
bool
|
2010-12-17 04:54:54 +00:00
|
|
|
IsSymbolRefDifferenceFullyResolved(const MCAssembler &Asm,
|
|
|
|
const MCSymbolRefExpr *A,
|
2010-12-18 06:27:54 +00:00
|
|
|
const MCSymbolRefExpr *B,
|
|
|
|
bool InSet) const;
|
2010-12-17 04:54:54 +00:00
|
|
|
|
2010-12-24 21:22:02 +00:00
|
|
|
virtual bool
|
|
|
|
IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
|
|
|
|
const MCSymbolData &DataA,
|
|
|
|
const MCFragment &FB,
|
|
|
|
bool InSet,
|
|
|
|
bool IsPCRel) const = 0;
|
|
|
|
|
2010-09-30 02:22:20 +00:00
|
|
|
|
2010-03-19 09:28:59 +00:00
|
|
|
/// Write the object file.
|
|
|
|
///
|
|
|
|
/// This routine is called by the assembler after layout and relaxation is
|
2010-05-14 01:02:48 +00:00
|
|
|
/// complete, fixups have been evaluated and applied, and relocations
|
2010-03-19 09:28:59 +00:00
|
|
|
/// generated.
|
2010-10-05 15:11:03 +00:00
|
|
|
virtual void WriteObject(MCAssembler &Asm,
|
2010-03-24 03:43:40 +00:00
|
|
|
const MCAsmLayout &Layout) = 0;
|
2010-03-19 09:28:59 +00:00
|
|
|
|
|
|
|
/// @}
|
|
|
|
/// @name Binary Output
|
|
|
|
/// @{
|
|
|
|
|
|
|
|
void Write8(uint8_t Value) {
|
|
|
|
OS << char(Value);
|
|
|
|
}
|
|
|
|
|
|
|
|
void WriteLE16(uint16_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
Write8(uint8_t(Value >> 0));
|
|
|
|
Write8(uint8_t(Value >> 8));
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteLE32(uint32_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
WriteLE16(uint16_t(Value >> 0));
|
|
|
|
WriteLE16(uint16_t(Value >> 16));
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteLE64(uint64_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
WriteLE32(uint32_t(Value >> 0));
|
|
|
|
WriteLE32(uint32_t(Value >> 32));
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteBE16(uint16_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
Write8(uint8_t(Value >> 8));
|
|
|
|
Write8(uint8_t(Value >> 0));
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteBE32(uint32_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
WriteBE16(uint16_t(Value >> 16));
|
|
|
|
WriteBE16(uint16_t(Value >> 0));
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteBE64(uint64_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
WriteBE32(uint32_t(Value >> 32));
|
|
|
|
WriteBE32(uint32_t(Value >> 0));
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void Write16(uint16_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
if (IsLittleEndian)
|
|
|
|
WriteLE16(Value);
|
|
|
|
else
|
|
|
|
WriteBE16(Value);
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void Write32(uint32_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
if (IsLittleEndian)
|
|
|
|
WriteLE32(Value);
|
|
|
|
else
|
|
|
|
WriteBE32(Value);
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void Write64(uint64_t Value) {
|
2010-08-17 15:50:23 +00:00
|
|
|
if (IsLittleEndian)
|
|
|
|
WriteLE64(Value);
|
|
|
|
else
|
|
|
|
WriteBE64(Value);
|
2010-03-19 09:28:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteZeros(unsigned N) {
|
|
|
|
const char Zeros[16] = { 0 };
|
|
|
|
|
|
|
|
for (unsigned i = 0, e = N / 16; i != e; ++i)
|
|
|
|
OS << StringRef(Zeros, 16);
|
|
|
|
|
|
|
|
OS << StringRef(Zeros, N % 16);
|
|
|
|
}
|
|
|
|
|
|
|
|
void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
|
2010-05-21 18:23:56 +00:00
|
|
|
assert((ZeroFillSize == 0 || Str.size () <= ZeroFillSize) &&
|
|
|
|
"data size greater than fill size, unexpected large write will occur");
|
2010-03-19 09:28:59 +00:00
|
|
|
OS << Str;
|
|
|
|
if (ZeroFillSize)
|
|
|
|
WriteZeros(ZeroFillSize - Str.size());
|
|
|
|
}
|
|
|
|
|
|
|
|
/// @}
|
2010-09-30 17:16:09 +00:00
|
|
|
|
|
|
|
/// Utility function to encode a SLEB128 value.
|
|
|
|
static void EncodeSLEB128(int64_t Value, raw_ostream &OS);
|
|
|
|
/// Utility function to encode a ULEB128 value.
|
|
|
|
static void EncodeULEB128(uint64_t Value, raw_ostream &OS);
|
2010-03-19 09:28:59 +00:00
|
|
|
};
|
|
|
|
|
2010-08-21 05:58:13 +00:00
|
|
|
MCObjectWriter *createWinCOFFObjectWriter(raw_ostream &OS, bool is64Bit);
|
2010-07-11 22:07:02 +00:00
|
|
|
|
2010-03-19 09:28:59 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
|
|
|
#endif
|