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/MC/StringTableBuilder.h"
18 #include "llvm/Support/DataTypes.h"
19 #include "llvm/Support/MachO.h"
25 class MachObjectWriter;
27 class MCMachObjectTargetWriter {
28 const unsigned Is64Bit : 1;
29 const uint32_t CPUType;
30 const uint32_t CPUSubtype;
31 // FIXME: Remove this, we should just always use it once we no longer care
32 // about Darwin 'as' compatibility.
33 const unsigned UseAggressiveSymbolFolding : 1;
34 unsigned LocalDifference_RIT;
37 MCMachObjectTargetWriter(bool Is64Bit_, uint32_t CPUType_,
39 bool UseAggressiveSymbolFolding_ = false);
41 void setLocalDifferenceRelocationType(unsigned Type) {
42 LocalDifference_RIT = Type;
46 virtual ~MCMachObjectTargetWriter();
48 /// \name Lifetime Management
51 virtual void reset() {};
58 bool is64Bit() const { return Is64Bit; }
59 bool useAggressiveSymbolFolding() const { return UseAggressiveSymbolFolding; }
60 uint32_t getCPUType() const { return CPUType; }
61 uint32_t getCPUSubtype() const { return CPUSubtype; }
62 unsigned getLocalDifferenceRelocationType() const {
63 return LocalDifference_RIT;
71 virtual void RecordRelocation(MachObjectWriter *Writer, MCAssembler &Asm,
72 const MCAsmLayout &Layout,
73 const MCFragment *Fragment,
74 const MCFixup &Fixup, MCValue Target,
75 uint64_t &FixedValue) = 0;
80 class MachObjectWriter : public MCObjectWriter {
81 /// MachSymbolData - Helper struct for containing some precomputed information
83 struct MachSymbolData {
84 const MCSymbol *Symbol;
88 // Support lexicographic sorting.
89 bool operator<(const MachSymbolData &RHS) const;
92 /// The target specific Mach-O writer instance.
93 std::unique_ptr<MCMachObjectTargetWriter> TargetObjectWriter;
95 /// \name Relocation Data
100 MachO::any_relocation_info MRE;
101 RelAndSymbol(const MCSymbol *Sym, const MachO::any_relocation_info &MRE)
102 : Sym(Sym), MRE(MRE) {}
105 llvm::DenseMap<const MCSectionData *, std::vector<RelAndSymbol>> Relocations;
106 llvm::DenseMap<const MCSectionData*, unsigned> IndirectSymBase;
109 /// \name Symbol Table Data
112 StringTableBuilder StringTable;
113 std::vector<MachSymbolData> LocalSymbolData;
114 std::vector<MachSymbolData> ExternalSymbolData;
115 std::vector<MachSymbolData> UndefinedSymbolData;
119 MachSymbolData *findSymbolData(const MCSymbol &Sym);
122 MachObjectWriter(MCMachObjectTargetWriter *MOTW, raw_pwrite_stream &OS,
124 : MCObjectWriter(OS, IsLittleEndian), TargetObjectWriter(MOTW) {}
126 const MCSymbol &findAliasedSymbol(const MCSymbol &Sym) const;
128 /// \name Lifetime management Methods
131 void reset() override;
135 /// \name Utility Methods
138 bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind);
140 SectionAddrMap SectionAddress;
142 SectionAddrMap &getSectionAddressMap() { return SectionAddress; }
144 uint64_t getSectionAddress(const MCSectionData* SD) const {
145 return SectionAddress.lookup(SD);
147 uint64_t getSymbolAddress(const MCSymbol &S, const MCAsmLayout &Layout) const;
149 uint64_t getFragmentAddress(const MCFragment *Fragment,
150 const MCAsmLayout &Layout) const;
152 uint64_t getPaddingSize(const MCSectionData *SD,
153 const MCAsmLayout &Layout) const;
155 bool doesSymbolRequireExternRelocation(const MCSymbol &S);
159 /// \name Target Writer Proxy Accessors
162 bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
163 bool isX86_64() const {
164 uint32_t CPUType = TargetObjectWriter->getCPUType();
165 return CPUType == MachO::CPU_TYPE_X86_64;
170 void WriteHeader(unsigned NumLoadCommands, unsigned LoadCommandsSize,
171 bool SubsectionsViaSymbols);
173 /// WriteSegmentLoadCommand - Write a segment load command.
175 /// \param NumSections The number of sections in this segment.
176 /// \param SectionDataSize The total size of the sections.
177 void WriteSegmentLoadCommand(unsigned NumSections,
179 uint64_t SectionDataStartOffset,
180 uint64_t SectionDataSize);
182 void WriteSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
183 const MCSectionData &SD, uint64_t FileOffset,
184 uint64_t RelocationsStart, unsigned NumRelocations);
186 void WriteSymtabLoadCommand(uint32_t SymbolOffset, uint32_t NumSymbols,
187 uint32_t StringTableOffset,
188 uint32_t StringTableSize);
190 void WriteDysymtabLoadCommand(uint32_t FirstLocalSymbol,
191 uint32_t NumLocalSymbols,
192 uint32_t FirstExternalSymbol,
193 uint32_t NumExternalSymbols,
194 uint32_t FirstUndefinedSymbol,
195 uint32_t NumUndefinedSymbols,
196 uint32_t IndirectSymbolOffset,
197 uint32_t NumIndirectSymbols);
199 void WriteNlist(MachSymbolData &MSD, const MCAsmLayout &Layout);
201 void WriteLinkeditLoadCommand(uint32_t Type, uint32_t DataOffset,
204 void WriteLinkerOptionsLoadCommand(const std::vector<std::string> &Options);
206 // FIXME: We really need to improve the relocation validation. Basically, we
207 // want to implement a separate computation which evaluates the relocation
208 // entry as the linker would, and verifies that the resultant fixup value is
209 // exactly what the encoder wanted. This will catch several classes of
212 // - Relocation entry bugs, the two algorithms are unlikely to have the same
215 // - Relaxation issues, where we forget to relax something.
217 // - Input errors, where something cannot be correctly encoded. 'as' allows
218 // these through in many cases.
220 // Add a relocation to be output in the object file. At the time this is
221 // called, the symbol indexes are not know, so if the relocation refers
222 // to a symbol it should be passed as \p RelSymbol so that it can be updated
223 // afterwards. If the relocation doesn't refer to a symbol, nullptr should be
225 void addRelocation(const MCSymbol *RelSymbol, const MCSectionData *SD,
226 MachO::any_relocation_info &MRE) {
227 RelAndSymbol P(RelSymbol, MRE);
228 Relocations[SD].push_back(P);
231 void RecordScatteredRelocation(const MCAssembler &Asm,
232 const MCAsmLayout &Layout,
233 const MCFragment *Fragment,
234 const MCFixup &Fixup, MCValue Target,
236 uint64_t &FixedValue);
238 void RecordTLVPRelocation(const MCAssembler &Asm,
239 const MCAsmLayout &Layout,
240 const MCFragment *Fragment,
241 const MCFixup &Fixup, MCValue Target,
242 uint64_t &FixedValue);
244 void RecordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
245 const MCFragment *Fragment, const MCFixup &Fixup,
246 MCValue Target, bool &IsPCRel,
247 uint64_t &FixedValue) override;
249 void BindIndirectSymbols(MCAssembler &Asm);
251 /// ComputeSymbolTable - Compute the symbol table data
253 void ComputeSymbolTable(MCAssembler &Asm,
254 std::vector<MachSymbolData> &LocalSymbolData,
255 std::vector<MachSymbolData> &ExternalSymbolData,
256 std::vector<MachSymbolData> &UndefinedSymbolData);
258 void computeSectionAddresses(const MCAssembler &Asm,
259 const MCAsmLayout &Layout);
261 void ExecutePostLayoutBinding(MCAssembler &Asm,
262 const MCAsmLayout &Layout) override;
264 bool IsSymbolRefDifferenceFullyResolvedImpl(const MCAssembler &Asm,
265 const MCSymbol &SymA,
266 const MCFragment &FB, bool InSet,
267 bool IsPCRel) const override;
269 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
273 /// \brief Construct a new Mach-O writer instance.
275 /// This routine takes ownership of the target writer subclass.
277 /// \param MOTW - The target specific Mach-O writer subclass.
278 /// \param OS - The stream to write to.
279 /// \returns The constructed object writer.
280 MCObjectWriter *createMachObjectWriter(MCMachObjectTargetWriter *MOTW,
281 raw_pwrite_stream &OS,
282 bool IsLittleEndian);
284 } // End llvm namespace