1 //===- lib/MC/MCMachOStreamer.cpp - Mach-O Object Output ------------===//
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 #include "llvm/MC/MCStreamer.h"
12 #include "llvm/MC/MCAssembler.h"
13 #include "llvm/MC/MCContext.h"
14 #include "llvm/MC/MCCodeEmitter.h"
15 #include "llvm/MC/MCExpr.h"
16 #include "llvm/MC/MCInst.h"
17 #include "llvm/MC/MCObjectStreamer.h"
18 #include "llvm/MC/MCSection.h"
19 #include "llvm/MC/MCSymbol.h"
20 #include "llvm/MC/MCMachOSymbolFlags.h"
21 #include "llvm/MC/MCSectionMachO.h"
22 #include "llvm/MC/MCDwarf.h"
23 #include "llvm/Support/Dwarf.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/Target/TargetAsmBackend.h"
27 #include "llvm/Target/TargetAsmInfo.h"
33 class MCMachOStreamer : public MCObjectStreamer {
35 virtual void EmitInstToData(const MCInst &Inst);
38 MCMachOStreamer(MCContext &Context, TargetAsmBackend &TAB,
39 raw_ostream &OS, MCCodeEmitter *Emitter)
40 : MCObjectStreamer(Context, TAB, OS, Emitter) {}
42 /// @name MCStreamer Interface
45 virtual void InitSections();
46 virtual void EmitLabel(MCSymbol *Symbol);
47 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
48 virtual void EmitThumbFunc(MCSymbol *Func);
49 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
50 virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
51 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
52 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
53 unsigned ByteAlignment);
54 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) {
55 assert(0 && "macho doesn't support this directive");
57 virtual void EmitCOFFSymbolStorageClass(int StorageClass) {
58 assert(0 && "macho doesn't support this directive");
60 virtual void EmitCOFFSymbolType(int Type) {
61 assert(0 && "macho doesn't support this directive");
63 virtual void EndCOFFSymbolDef() {
64 assert(0 && "macho doesn't support this directive");
66 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
67 assert(0 && "macho doesn't support this directive");
69 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
70 assert(0 && "macho doesn't support this directive");
72 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
73 unsigned Size = 0, unsigned ByteAlignment = 0);
74 virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
75 uint64_t Size, unsigned ByteAlignment = 0);
76 virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
77 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
78 unsigned ValueSize = 1,
79 unsigned MaxBytesToEmit = 0);
80 virtual void EmitCodeAlignment(unsigned ByteAlignment,
81 unsigned MaxBytesToEmit = 0);
83 virtual void EmitFileDirective(StringRef Filename) {
84 // FIXME: Just ignore the .file; it isn't important enough to fail the
87 //report_fatal_error("unsupported directive: '.file'");
90 virtual void Finish();
95 } // end anonymous namespace.
97 void MCMachOStreamer::InitSections() {
98 SwitchSection(getContext().getMachOSection("__TEXT", "__text",
99 MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
100 0, SectionKind::getText()));
104 void MCMachOStreamer::EmitLabel(MCSymbol *Symbol) {
105 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
107 // isSymbolLinkerVisible uses the section.
108 Symbol->setSection(*CurSection);
109 // We have to create a new fragment if this is an atom defining symbol,
110 // fragments cannot span atoms.
111 if (getAssembler().isSymbolLinkerVisible(*Symbol))
112 new MCDataFragment(getCurrentSectionData());
114 MCObjectStreamer::EmitLabel(Symbol);
116 MCSymbolData &SD = getAssembler().getSymbolData(*Symbol);
117 // This causes the reference type flag to be cleared. Darwin 'as' was "trying"
118 // to clear the weak reference and weak definition bits too, but the
119 // implementation was buggy. For now we just try to match 'as', for
122 // FIXME: Cleanup this code, these bits should be emitted based on semantic
123 // properties, not on the order of definition, etc.
124 SD.setFlags(SD.getFlags() & ~SF_ReferenceTypeMask);
127 void MCMachOStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
128 // Let the target do whatever target specific stuff it needs to do.
129 getAssembler().getBackend().HandleAssemblerFlag(Flag);
130 // Do any generic stuff we need to do.
132 case MCAF_SyntaxUnified: return; // no-op here.
133 case MCAF_Code16: return; // no-op here.
134 case MCAF_Code32: return; // no-op here.
135 case MCAF_SubsectionsViaSymbols:
136 getAssembler().setSubsectionsViaSymbols(true);
139 llvm_unreachable("invalid assembler flag!");
143 void MCMachOStreamer::EmitThumbFunc(MCSymbol *Func) {
144 // FIXME: Flag the function ISA as thumb with DW_AT_APPLE_isa.
146 // Remember that the function is a thumb function. Fixup and relocation
147 // values will need adjusted.
148 getAssembler().setIsThumbFunc(Func);
151 void MCMachOStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
152 // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
154 // FIXME: Lift context changes into super class.
155 getAssembler().getOrCreateSymbolData(*Symbol);
156 Symbol->setVariableValue(AddValueSymbols(Value));
159 void MCMachOStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
160 MCSymbolAttr Attribute) {
161 // Indirect symbols are handled differently, to match how 'as' handles
162 // them. This makes writing matching .o files easier.
163 if (Attribute == MCSA_IndirectSymbol) {
164 // Note that we intentionally cannot use the symbol data here; this is
165 // important for matching the string table that 'as' generates.
166 IndirectSymbolData ISD;
168 ISD.SectionData = getCurrentSectionData();
169 getAssembler().getIndirectSymbols().push_back(ISD);
173 // Adding a symbol attribute always introduces the symbol, note that an
174 // important side effect of calling getOrCreateSymbolData here is to register
175 // the symbol with the assembler.
176 MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
178 // The implementation of symbol attributes is designed to match 'as', but it
179 // leaves much to desired. It doesn't really make sense to arbitrarily add and
180 // remove flags, but 'as' allows this (in particular, see .desc).
182 // In the future it might be worth trying to make these operations more well
186 case MCSA_ELF_TypeFunction:
187 case MCSA_ELF_TypeIndFunction:
188 case MCSA_ELF_TypeObject:
189 case MCSA_ELF_TypeTLS:
190 case MCSA_ELF_TypeCommon:
191 case MCSA_ELF_TypeNoType:
192 case MCSA_ELF_TypeGnuUniqueObject:
193 case MCSA_IndirectSymbol:
199 assert(0 && "Invalid symbol attribute for Mach-O!");
203 SD.setExternal(true);
204 // This effectively clears the undefined lazy bit, in Darwin 'as', although
205 // it isn't very consistent because it implements this as part of symbol
208 // FIXME: Cleanup this code, these bits should be emitted based on semantic
209 // properties, not on the order of definition, etc.
210 SD.setFlags(SD.getFlags() & ~SF_ReferenceTypeUndefinedLazy);
213 case MCSA_LazyReference:
214 // FIXME: This requires -dynamic.
215 SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
216 if (Symbol->isUndefined())
217 SD.setFlags(SD.getFlags() | SF_ReferenceTypeUndefinedLazy);
220 // Since .reference sets the no dead strip bit, it is equivalent to
221 // .no_dead_strip in practice.
223 case MCSA_NoDeadStrip:
224 SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
227 case MCSA_SymbolResolver:
228 SD.setFlags(SD.getFlags() | SF_SymbolResolver);
231 case MCSA_PrivateExtern:
232 SD.setExternal(true);
233 SD.setPrivateExtern(true);
236 case MCSA_WeakReference:
237 // FIXME: This requires -dynamic.
238 if (Symbol->isUndefined())
239 SD.setFlags(SD.getFlags() | SF_WeakReference);
242 case MCSA_WeakDefinition:
243 // FIXME: 'as' enforces that this is defined and global. The manual claims
244 // it has to be in a coalesced section, but this isn't enforced.
245 SD.setFlags(SD.getFlags() | SF_WeakDefinition);
248 case MCSA_WeakDefAutoPrivate:
249 SD.setFlags(SD.getFlags() | SF_WeakDefinition | SF_WeakReference);
254 void MCMachOStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
255 // Encode the 'desc' value into the lowest implementation defined bits.
256 assert(DescValue == (DescValue & SF_DescFlagsMask) &&
257 "Invalid .desc value!");
258 getAssembler().getOrCreateSymbolData(*Symbol).setFlags(
259 DescValue & SF_DescFlagsMask);
262 void MCMachOStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
263 unsigned ByteAlignment) {
264 // FIXME: Darwin 'as' does appear to allow redef of a .comm by itself.
265 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
267 MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
268 SD.setExternal(true);
269 SD.setCommon(Size, ByteAlignment);
272 void MCMachOStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
273 unsigned Size, unsigned ByteAlignment) {
274 MCSectionData &SectData = getAssembler().getOrCreateSectionData(*Section);
276 // The symbol may not be present, which only creates the section.
280 // FIXME: Assert that this section has the zerofill type.
282 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
284 MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
286 // Emit an align fragment if necessary.
287 if (ByteAlignment != 1)
288 new MCAlignFragment(ByteAlignment, 0, 0, ByteAlignment, &SectData);
290 MCFragment *F = new MCFillFragment(0, 0, Size, &SectData);
293 Symbol->setSection(*Section);
295 // Update the maximum alignment on the zero fill section if necessary.
296 if (ByteAlignment > SectData.getAlignment())
297 SectData.setAlignment(ByteAlignment);
300 // This should always be called with the thread local bss section. Like the
301 // .zerofill directive this doesn't actually switch sections on us.
302 void MCMachOStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
303 uint64_t Size, unsigned ByteAlignment) {
304 EmitZerofill(Section, Symbol, Size, ByteAlignment);
308 void MCMachOStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
309 // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
311 getOrCreateDataFragment()->getContents().append(Data.begin(), Data.end());
314 void MCMachOStreamer::EmitValueToAlignment(unsigned ByteAlignment,
315 int64_t Value, unsigned ValueSize,
316 unsigned MaxBytesToEmit) {
317 // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
319 if (MaxBytesToEmit == 0)
320 MaxBytesToEmit = ByteAlignment;
321 new MCAlignFragment(ByteAlignment, Value, ValueSize, MaxBytesToEmit,
322 getCurrentSectionData());
324 // Update the maximum alignment on the current section if necessary.
325 if (ByteAlignment > getCurrentSectionData()->getAlignment())
326 getCurrentSectionData()->setAlignment(ByteAlignment);
329 void MCMachOStreamer::EmitCodeAlignment(unsigned ByteAlignment,
330 unsigned MaxBytesToEmit) {
331 // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
333 if (MaxBytesToEmit == 0)
334 MaxBytesToEmit = ByteAlignment;
335 MCAlignFragment *F = new MCAlignFragment(ByteAlignment, 0, 1, MaxBytesToEmit,
336 getCurrentSectionData());
337 F->setEmitNops(true);
339 // Update the maximum alignment on the current section if necessary.
340 if (ByteAlignment > getCurrentSectionData()->getAlignment())
341 getCurrentSectionData()->setAlignment(ByteAlignment);
344 void MCMachOStreamer::EmitInstToData(const MCInst &Inst) {
345 MCDataFragment *DF = getOrCreateDataFragment();
347 SmallVector<MCFixup, 4> Fixups;
348 SmallString<256> Code;
349 raw_svector_ostream VecOS(Code);
350 getAssembler().getEmitter().EncodeInstruction(Inst, VecOS, Fixups);
353 // Add the fixups and data.
354 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
355 Fixups[i].setOffset(Fixups[i].getOffset() + DF->getContents().size());
356 DF->addFixup(Fixups[i]);
358 DF->getContents().append(Code.begin(), Code.end());
361 void MCMachOStreamer::Finish() {
362 // We have to set the fragment atom associations so we can relax properly for
365 // First, scan the symbol table to build a lookup table from fragments to
367 DenseMap<const MCFragment*, MCSymbolData*> DefiningSymbolMap;
368 for (MCAssembler::symbol_iterator it = getAssembler().symbol_begin(),
369 ie = getAssembler().symbol_end(); it != ie; ++it) {
370 if (getAssembler().isSymbolLinkerVisible(it->getSymbol()) &&
372 // An atom defining symbol should never be internal to a fragment.
373 assert(it->getOffset() == 0 && "Invalid offset in atom defining symbol!");
374 DefiningSymbolMap[it->getFragment()] = it;
378 // Set the fragment atom associations by tracking the last seen atom defining
380 for (MCAssembler::iterator it = getAssembler().begin(),
381 ie = getAssembler().end(); it != ie; ++it) {
382 MCSymbolData *CurrentAtom = 0;
383 for (MCSectionData::iterator it2 = it->begin(),
384 ie2 = it->end(); it2 != ie2; ++it2) {
385 if (MCSymbolData *SD = DefiningSymbolMap.lookup(it2))
387 it2->setAtom(CurrentAtom);
391 this->MCObjectStreamer::Finish();
394 MCStreamer *llvm::createMachOStreamer(MCContext &Context, TargetAsmBackend &TAB,
395 raw_ostream &OS, MCCodeEmitter *CE,
397 MCMachOStreamer *S = new MCMachOStreamer(Context, TAB, OS, CE);
399 S->getAssembler().setRelaxAll(true);