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/MCSection.h"
18 #include "llvm/MC/MCSymbol.h"
19 #include "llvm/MC/MCValue.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/raw_ostream.h"
26 class MCMachOStreamer : public MCStreamer {
27 /// SymbolFlags - We store the value for the 'desc' symbol field in the lowest
28 /// 16 bits of the implementation defined flags.
29 enum SymbolFlags { // See <mach-o/nlist.h>.
30 SF_DescFlagsMask = 0xFFFF,
32 // Reference type flags.
33 SF_ReferenceTypeMask = 0x0007,
34 SF_ReferenceTypeUndefinedNonLazy = 0x0000,
35 SF_ReferenceTypeUndefinedLazy = 0x0001,
36 SF_ReferenceTypeDefined = 0x0002,
37 SF_ReferenceTypePrivateDefined = 0x0003,
38 SF_ReferenceTypePrivateUndefinedNonLazy = 0x0004,
39 SF_ReferenceTypePrivateUndefinedLazy = 0x0005,
41 // Other 'desc' flags.
42 SF_NoDeadStrip = 0x0020,
43 SF_WeakReference = 0x0040,
44 SF_WeakDefinition = 0x0080
48 MCAssembler Assembler;
50 MCCodeEmitter *Emitter;
52 MCSectionData *CurSectionData;
54 DenseMap<const MCSection*, MCSectionData*> SectionMap;
56 DenseMap<const MCSymbol*, MCSymbolData*> SymbolMap;
59 MCFragment *getCurrentFragment() const {
60 assert(CurSectionData && "No current section!");
62 if (!CurSectionData->empty())
63 return &CurSectionData->getFragmentList().back();
68 MCSectionData &getSectionData(const MCSection &Section) {
69 MCSectionData *&Entry = SectionMap[&Section];
72 Entry = new MCSectionData(Section, &Assembler);
77 MCSymbolData &getSymbolData(const MCSymbol &Symbol) {
78 MCSymbolData *&Entry = SymbolMap[&Symbol];
81 Entry = new MCSymbolData(Symbol, 0, 0, &Assembler);
87 MCMachOStreamer(MCContext &Context, raw_ostream &_OS, MCCodeEmitter *_Emitter)
88 : MCStreamer(Context), Assembler(Context, _OS), Emitter(_Emitter),
92 const MCExpr *AddValueSymbols(const MCExpr *Value) {
93 switch (Value->getKind()) {
94 case MCExpr::Constant:
97 case MCExpr::Binary: {
98 const MCBinaryExpr *BE = cast<MCBinaryExpr>(Value);
99 AddValueSymbols(BE->getLHS());
100 AddValueSymbols(BE->getRHS());
104 case MCExpr::SymbolRef:
105 getSymbolData(cast<MCSymbolRefExpr>(Value)->getSymbol());
109 AddValueSymbols(cast<MCUnaryExpr>(Value)->getSubExpr());
116 /// @name MCStreamer Interface
119 virtual void SwitchSection(const MCSection *Section);
120 virtual void EmitLabel(MCSymbol *Symbol);
121 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
122 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
123 virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
124 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
125 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
126 unsigned ByteAlignment);
127 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
128 assert(0 && "macho doesn't support this directive");
130 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
131 unsigned Size = 0, unsigned ByteAlignment = 0);
132 virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
133 virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace);
134 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
135 unsigned ValueSize = 1,
136 unsigned MaxBytesToEmit = 0);
137 virtual void EmitValueToOffset(const MCExpr *Offset,
138 unsigned char Value = 0);
139 virtual void EmitInstruction(const MCInst &Inst);
140 virtual void Finish();
145 } // end anonymous namespace.
147 void MCMachOStreamer::SwitchSection(const MCSection *Section) {
148 assert(Section && "Cannot switch to a null section!");
150 // If already in this section, then this is a noop.
151 if (Section == CurSection) return;
153 CurSection = Section;
154 CurSectionData = &getSectionData(*Section);
157 void MCMachOStreamer::EmitLabel(MCSymbol *Symbol) {
158 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
160 // FIXME: We should also use offsets into Fill fragments.
161 MCDataFragment *F = dyn_cast_or_null<MCDataFragment>(getCurrentFragment());
163 F = new MCDataFragment(CurSectionData);
165 MCSymbolData &SD = getSymbolData(*Symbol);
166 assert(!SD.getFragment() && "Unexpected fragment on symbol data!");
168 SD.setOffset(F->getContents().size());
170 // This causes the reference type and weak reference flags to be cleared.
171 SD.setFlags(SD.getFlags() & ~(SF_WeakReference | SF_ReferenceTypeMask));
173 Symbol->setSection(*CurSection);
176 void MCMachOStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
178 case MCAF_SubsectionsViaSymbols:
179 Assembler.setSubsectionsViaSymbols(true);
183 assert(0 && "invalid assembler flag!");
186 void MCMachOStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
187 // Only absolute symbols can be redefined.
188 assert((Symbol->isUndefined() || Symbol->isAbsolute()) &&
189 "Cannot define a symbol twice!");
191 // FIXME: Lift context changes into super class.
192 // FIXME: Set associated section.
193 Symbol->setValue(Value);
196 void MCMachOStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
197 MCSymbolAttr Attribute) {
198 // Indirect symbols are handled differently, to match how 'as' handles
199 // them. This makes writing matching .o files easier.
200 if (Attribute == MCSA_IndirectSymbol) {
201 // Note that we intentionally cannot use the symbol data here; this is
202 // important for matching the string table that 'as' generates.
203 IndirectSymbolData ISD;
205 ISD.SectionData = CurSectionData;
206 Assembler.getIndirectSymbols().push_back(ISD);
210 // Adding a symbol attribute always introduces the symbol, note that an
211 // important side effect of calling getSymbolData here is to register the
212 // symbol with the assembler.
213 MCSymbolData &SD = getSymbolData(*Symbol);
215 // The implementation of symbol attributes is designed to match 'as', but it
216 // leaves much to desired. It doesn't really make sense to arbitrarily add and
217 // remove flags, but 'as' allows this (in particular, see .desc).
219 // In the future it might be worth trying to make these operations more well
223 case MCSA_IndirectSymbol:
229 assert(0 && "Invalid symbol attribute for Mach-O!");
233 SD.setExternal(true);
236 case MCSA_LazyReference:
237 // FIXME: This requires -dynamic.
238 SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
239 if (Symbol->isUndefined())
240 SD.setFlags(SD.getFlags() | SF_ReferenceTypeUndefinedLazy);
243 // Since .reference sets the no dead strip bit, it is equivalent to
244 // .no_dead_strip in practice.
246 case MCSA_NoDeadStrip:
247 SD.setFlags(SD.getFlags() | SF_NoDeadStrip);
250 case MCSA_PrivateExtern:
251 SD.setExternal(true);
252 SD.setPrivateExtern(true);
255 case MCSA_WeakReference:
256 // FIXME: This requires -dynamic.
257 if (Symbol->isUndefined())
258 SD.setFlags(SD.getFlags() | SF_WeakReference);
261 case MCSA_WeakDefinition:
262 // FIXME: 'as' enforces that this is defined and global. The manual claims
263 // it has to be in a coalesced section, but this isn't enforced.
264 SD.setFlags(SD.getFlags() | SF_WeakDefinition);
269 void MCMachOStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
270 // Encode the 'desc' value into the lowest implementation defined bits.
271 assert(DescValue == (DescValue & SF_DescFlagsMask) &&
272 "Invalid .desc value!");
273 getSymbolData(*Symbol).setFlags(DescValue & SF_DescFlagsMask);
276 void MCMachOStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
277 unsigned ByteAlignment) {
278 // FIXME: Darwin 'as' does appear to allow redef of a .comm by itself.
279 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
281 MCSymbolData &SD = getSymbolData(*Symbol);
282 SD.setExternal(true);
283 SD.setCommon(Size, ByteAlignment);
286 void MCMachOStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
287 unsigned Size, unsigned ByteAlignment) {
288 MCSectionData &SectData = getSectionData(*Section);
290 // The symbol may not be present, which only creates the section.
294 // FIXME: Assert that this section has the zerofill type.
296 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
298 MCSymbolData &SD = getSymbolData(*Symbol);
300 MCFragment *F = new MCZeroFillFragment(Size, ByteAlignment, &SectData);
303 Symbol->setSection(*Section);
305 // Update the maximum alignment on the zero fill section if necessary.
306 if (ByteAlignment > SectData.getAlignment())
307 SectData.setAlignment(ByteAlignment);
310 void MCMachOStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
311 MCDataFragment *DF = dyn_cast_or_null<MCDataFragment>(getCurrentFragment());
313 DF = new MCDataFragment(CurSectionData);
314 DF->getContents().append(Data.begin(), Data.end());
317 void MCMachOStreamer::EmitValue(const MCExpr *Value, unsigned Size,
318 unsigned AddrSpace) {
319 new MCFillFragment(*AddValueSymbols(Value), Size, 1, CurSectionData);
322 void MCMachOStreamer::EmitValueToAlignment(unsigned ByteAlignment,
323 int64_t Value, unsigned ValueSize,
324 unsigned MaxBytesToEmit) {
325 if (MaxBytesToEmit == 0)
326 MaxBytesToEmit = ByteAlignment;
327 new MCAlignFragment(ByteAlignment, Value, ValueSize, MaxBytesToEmit,
330 // Update the maximum alignment on the current section if necessary.
331 if (ByteAlignment > CurSectionData->getAlignment())
332 CurSectionData->setAlignment(ByteAlignment);
335 void MCMachOStreamer::EmitValueToOffset(const MCExpr *Offset,
336 unsigned char Value) {
337 new MCOrgFragment(*Offset, Value, CurSectionData);
340 void MCMachOStreamer::EmitInstruction(const MCInst &Inst) {
342 for (unsigned i = 0; i != Inst.getNumOperands(); ++i)
343 if (Inst.getOperand(i).isExpr())
344 AddValueSymbols(Inst.getOperand(i).getExpr());
347 llvm_unreachable("no code emitter available!");
349 // FIXME: Emitting an instruction should cause S_ATTR_SOME_INSTRUCTIONS to
350 // be set for the current section.
351 // FIXME: Relocations!
352 SmallString<256> Code;
353 raw_svector_ostream VecOS(Code);
354 Emitter->EncodeInstruction(Inst, VecOS);
355 EmitBytes(VecOS.str(), 0);
358 void MCMachOStreamer::Finish() {
362 MCStreamer *llvm::createMachOStreamer(MCContext &Context, raw_ostream &OS,
364 return new MCMachOStreamer(Context, OS, CE);