1 //===-- llvm/MC/MCObjectWriter.h - Object File Writer Interface -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_MC_MCOBJECTWRITER_H
11 #define LLVM_MC_MCOBJECTWRITER_H
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/Support/Compiler.h"
15 #include "llvm/Support/DataTypes.h"
16 #include "llvm/Support/EndianStream.h"
17 #include "llvm/Support/raw_ostream.h"
25 class MCSymbolRefExpr;
28 /// Defines the object file and target independent interfaces used by the
29 /// assembler backend to write native file format object files.
31 /// The object writer contains a few callbacks used by the assembler to allow
32 /// the object writer to modify the assembler data structures at appropriate
33 /// points. Once assembly is complete, the object writer is given the
34 /// MCAssembler instance, which contains all the symbol and section data which
35 /// should be emitted as part of writeObject().
37 /// The object writer also contains a number of helper methods for writing
38 /// binary data to the output stream.
39 class MCObjectWriter {
40 MCObjectWriter(const MCObjectWriter &) = delete;
41 void operator=(const MCObjectWriter &) = delete;
43 raw_pwrite_stream *OS;
46 unsigned IsLittleEndian : 1;
48 protected: // Can only create subclasses.
49 MCObjectWriter(raw_pwrite_stream &OS, bool IsLittleEndian)
50 : OS(&OS), IsLittleEndian(IsLittleEndian) {}
53 virtual ~MCObjectWriter();
55 /// lifetime management
56 virtual void reset() {}
58 bool isLittleEndian() const { return IsLittleEndian; }
60 raw_pwrite_stream &getStream() { return *OS; }
61 void setStream(raw_pwrite_stream &NewOS) { OS = &NewOS; }
63 /// \name High-Level API
66 /// Perform any late binding of symbols (for example, to assign symbol
67 /// indices for use when generating relocations).
69 /// This routine is called by the assembler after layout and relaxation is
71 virtual void executePostLayoutBinding(MCAssembler &Asm,
72 const MCAsmLayout &Layout) = 0;
74 /// Record a relocation entry.
76 /// This routine is called by the assembler after layout and relaxation, and
77 /// post layout binding. The implementation is responsible for storing
78 /// information about the relocation so that it can be emitted during
80 virtual void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
81 const MCFragment *Fragment,
82 const MCFixup &Fixup, MCValue Target,
83 bool &IsPCRel, uint64_t &FixedValue) = 0;
85 /// Check whether the difference (A - B) between two symbol references is
88 /// Clients are not required to answer precisely and may conservatively return
89 /// false, even when a difference is fully resolved.
90 bool isSymbolRefDifferenceFullyResolved(const MCAssembler &Asm,
91 const MCSymbolRefExpr *A,
92 const MCSymbolRefExpr *B,
95 virtual bool isSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
100 virtual bool isSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
101 const MCSymbol &SymA,
102 const MCFragment &FB,
106 /// True if this symbol (which is a variable) is weak. This is not
107 /// just STB_WEAK, but more generally whether or not we can evaluate
109 virtual bool isWeak(const MCSymbol &Sym) const;
111 /// Write the object file.
113 /// This routine is called by the assembler after layout and relaxation is
114 /// complete, fixups have been evaluated and applied, and relocations
116 virtual void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) = 0;
119 /// \name Binary Output
122 void write8(uint8_t Value) { *OS << char(Value); }
124 void writeLE16(uint16_t Value) {
125 support::endian::Writer<support::little>(*OS).write(Value);
128 void writeLE32(uint32_t Value) {
129 support::endian::Writer<support::little>(*OS).write(Value);
132 void writeLE64(uint64_t Value) {
133 support::endian::Writer<support::little>(*OS).write(Value);
136 void writeBE16(uint16_t Value) {
137 support::endian::Writer<support::big>(*OS).write(Value);
140 void writeBE32(uint32_t Value) {
141 support::endian::Writer<support::big>(*OS).write(Value);
144 void writeBE64(uint64_t Value) {
145 support::endian::Writer<support::big>(*OS).write(Value);
148 void write16(uint16_t Value) {
155 void write32(uint32_t Value) {
162 void write64(uint64_t Value) {
169 void WriteZeros(unsigned N) {
170 const char Zeros[16] = {0};
172 for (unsigned i = 0, e = N / 16; i != e; ++i)
173 *OS << StringRef(Zeros, 16);
175 *OS << StringRef(Zeros, N % 16);
178 void writeBytes(const SmallVectorImpl<char> &ByteVec,
179 unsigned ZeroFillSize = 0) {
180 writeBytes(StringRef(ByteVec.data(), ByteVec.size()), ZeroFillSize);
183 void writeBytes(StringRef Str, unsigned ZeroFillSize = 0) {
184 // TODO: this version may need to go away once all fragment contents are
185 // converted to SmallVector<char, N>
187 (ZeroFillSize == 0 || Str.size() <= ZeroFillSize) &&
188 "data size greater than fill size, unexpected large write will occur");
191 WriteZeros(ZeroFillSize - Str.size());
197 } // End llvm namespace