1 //===-- llvm/MC/MCMachObjectWriter.h - Mach Object Writer -------*- 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_MCMACHOBJECTWRITER_H
11 #define LLVM_MC_MCMACHOBJECTWRITER_H
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/MC/MCExpr.h"
16 #include "llvm/MC/MCObjectWriter.h"
17 #include "llvm/Support/DataTypes.h"
18 #include "llvm/Support/MachO.h"
24 class MachObjectWriter;
26 class MCMachObjectTargetWriter {
27 const unsigned Is64Bit : 1;
28 const uint32_t CPUType;
29 const uint32_t CPUSubtype;
30 // FIXME: Remove this, we should just always use it once we no longer care
31 // about Darwin 'as' compatibility.
32 const unsigned UseAggressiveSymbolFolding : 1;
33 unsigned LocalDifference_RIT;
36 MCMachObjectTargetWriter(bool Is64Bit_, uint32_t CPUType_,
38 bool UseAggressiveSymbolFolding_ = false);
40 void setLocalDifferenceRelocationType(unsigned Type) {
41 LocalDifference_RIT = Type;
45 virtual ~MCMachObjectTargetWriter();
47 /// @name Lifetime Management
50 virtual void reset() {};
57 bool is64Bit() const { return Is64Bit; }
58 bool useAggressiveSymbolFolding() const { return UseAggressiveSymbolFolding; }
59 uint32_t getCPUType() const { return CPUType; }
60 uint32_t getCPUSubtype() const { return CPUSubtype; }
61 unsigned getLocalDifferenceRelocationType() const {
62 return LocalDifference_RIT;
70 virtual void RecordRelocation(MachObjectWriter *Writer,
71 const MCAssembler &Asm,
72 const MCAsmLayout &Layout,
73 const MCFragment *Fragment,
76 uint64_t &FixedValue) = 0;
81 class MachObjectWriter : public MCObjectWriter {
82 /// MachSymbolData - Helper struct for containing some precomputed information
84 struct MachSymbolData {
85 MCSymbolData *SymbolData;
89 // Support lexicographic sorting.
90 bool operator<(const MachSymbolData &RHS) const;
93 /// The target specific Mach-O writer instance.
94 std::unique_ptr<MCMachObjectTargetWriter> TargetObjectWriter;
96 /// @name Relocation Data
99 llvm::DenseMap<const MCSectionData*,
100 std::vector<MachO::any_relocation_info> > Relocations;
101 llvm::DenseMap<const MCSectionData*, unsigned> IndirectSymBase;
104 /// @name Symbol Table Data
107 SmallString<256> StringTable;
108 std::vector<MachSymbolData> LocalSymbolData;
109 std::vector<MachSymbolData> ExternalSymbolData;
110 std::vector<MachSymbolData> UndefinedSymbolData;
115 MachObjectWriter(MCMachObjectTargetWriter *MOTW, raw_ostream &_OS,
116 bool _IsLittleEndian)
117 : MCObjectWriter(_OS, _IsLittleEndian), TargetObjectWriter(MOTW) {
120 /// @name Lifetime management Methods
123 void reset() override;
127 /// @name Utility Methods
130 bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind);
132 SectionAddrMap SectionAddress;
134 SectionAddrMap &getSectionAddressMap() { return SectionAddress; }
136 uint64_t getSectionAddress(const MCSectionData* SD) const {
137 return SectionAddress.lookup(SD);
139 uint64_t getSymbolAddress(const MCSymbolData* SD,
140 const MCAsmLayout &Layout) const;
142 uint64_t getFragmentAddress(const MCFragment *Fragment,
143 const MCAsmLayout &Layout) const;
145 uint64_t getPaddingSize(const MCSectionData *SD,
146 const MCAsmLayout &Layout) const;
148 bool doesSymbolRequireExternRelocation(const MCSymbolData *SD);
152 /// @name Target Writer Proxy Accessors
155 bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
159 void WriteHeader(unsigned NumLoadCommands, unsigned LoadCommandsSize,
160 bool SubsectionsViaSymbols);
162 /// WriteSegmentLoadCommand - Write a segment load command.
164 /// \param NumSections The number of sections in this segment.
165 /// \param SectionDataSize The total size of the sections.
166 void WriteSegmentLoadCommand(unsigned NumSections,
168 uint64_t SectionDataStartOffset,
169 uint64_t SectionDataSize);
171 void WriteSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
172 const MCSectionData &SD, uint64_t FileOffset,
173 uint64_t RelocationsStart, unsigned NumRelocations);
175 void WriteSymtabLoadCommand(uint32_t SymbolOffset, uint32_t NumSymbols,
176 uint32_t StringTableOffset,
177 uint32_t StringTableSize);
179 void WriteDysymtabLoadCommand(uint32_t FirstLocalSymbol,
180 uint32_t NumLocalSymbols,
181 uint32_t FirstExternalSymbol,
182 uint32_t NumExternalSymbols,
183 uint32_t FirstUndefinedSymbol,
184 uint32_t NumUndefinedSymbols,
185 uint32_t IndirectSymbolOffset,
186 uint32_t NumIndirectSymbols);
188 void WriteNlist(MachSymbolData &MSD, const MCAsmLayout &Layout);
190 void WriteLinkeditLoadCommand(uint32_t Type, uint32_t DataOffset,
193 void WriteLinkerOptionsLoadCommand(const std::vector<std::string> &Options);
195 // FIXME: We really need to improve the relocation validation. Basically, we
196 // want to implement a separate computation which evaluates the relocation
197 // entry as the linker would, and verifies that the resultant fixup value is
198 // exactly what the encoder wanted. This will catch several classes of
201 // - Relocation entry bugs, the two algorithms are unlikely to have the same
204 // - Relaxation issues, where we forget to relax something.
206 // - Input errors, where something cannot be correctly encoded. 'as' allows
207 // these through in many cases.
209 void addRelocation(const MCSectionData *SD,
210 MachO::any_relocation_info &MRE) {
211 Relocations[SD].push_back(MRE);
214 void RecordScatteredRelocation(const MCAssembler &Asm,
215 const MCAsmLayout &Layout,
216 const MCFragment *Fragment,
217 const MCFixup &Fixup, MCValue Target,
219 uint64_t &FixedValue);
221 void RecordTLVPRelocation(const MCAssembler &Asm,
222 const MCAsmLayout &Layout,
223 const MCFragment *Fragment,
224 const MCFixup &Fixup, MCValue Target,
225 uint64_t &FixedValue);
227 void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
228 const MCFragment *Fragment, const MCFixup &Fixup,
229 MCValue Target, uint64_t &FixedValue) override;
231 void BindIndirectSymbols(MCAssembler &Asm);
233 /// ComputeSymbolTable - Compute the symbol table data
235 /// \param StringTable [out] - The string table data.
236 void ComputeSymbolTable(MCAssembler &Asm, SmallString<256> &StringTable,
237 std::vector<MachSymbolData> &LocalSymbolData,
238 std::vector<MachSymbolData> &ExternalSymbolData,
239 std::vector<MachSymbolData> &UndefinedSymbolData);
241 void computeSectionAddresses(const MCAssembler &Asm,
242 const MCAsmLayout &Layout);
244 void markAbsoluteVariableSymbols(MCAssembler &Asm,
245 const MCAsmLayout &Layout);
246 void ExecutePostLayoutBinding(MCAssembler &Asm,
247 const MCAsmLayout &Layout) override;
249 bool IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
250 const MCSymbolData &DataA,
251 const MCFragment &FB,
253 bool IsPCRel) const override;
255 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
259 /// \brief Construct a new Mach-O writer instance.
261 /// This routine takes ownership of the target writer subclass.
263 /// \param MOTW - The target specific Mach-O writer subclass.
264 /// \param OS - The stream to write to.
265 /// \returns The constructed object writer.
266 MCObjectWriter *createMachObjectWriter(MCMachObjectTargetWriter *MOTW,
267 raw_ostream &OS, bool IsLittleEndian);
269 } // End llvm namespace