Renamed MCInstFragment to MCRelaxableFragment and added some comments.
[oota-llvm.git] / lib / MC / MCPureStreamer.cpp
1 //===- lib/MC/MCPureStreamer.cpp - MC "Pure" Object Output ----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "llvm/MC/MCStreamer.h"
11 #include "llvm/MC/MCAssembler.h"
12 #include "llvm/MC/MCCodeEmitter.h"
13 #include "llvm/MC/MCContext.h"
14 #include "llvm/MC/MCExpr.h"
15 #include "llvm/MC/MCObjectStreamer.h"
16 // FIXME: Remove this.
17 #include "llvm/MC/MCSectionMachO.h"
18 #include "llvm/MC/MCSymbol.h"
19 #include "llvm/Support/ErrorHandling.h"
20
21 using namespace llvm;
22
23 namespace {
24
25 class MCPureStreamer : public MCObjectStreamer {
26 private:
27   virtual void EmitInstToFragment(const MCInst &Inst);
28   virtual void EmitInstToData(const MCInst &Inst);
29
30 public:
31   MCPureStreamer(MCContext &Context, MCAsmBackend &TAB,
32                  raw_ostream &OS, MCCodeEmitter *Emitter)
33     : MCObjectStreamer(Context, TAB, OS, Emitter) {}
34
35   /// @name MCStreamer Interface
36   /// @{
37
38   virtual void InitSections();
39   virtual void EmitLabel(MCSymbol *Symbol);
40   virtual void EmitDebugLabel(MCSymbol *Symbol);
41   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
42                             uint64_t Size = 0, unsigned ByteAlignment = 0);
43   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
44   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
45                                     unsigned ValueSize = 1,
46                                     unsigned MaxBytesToEmit = 0);
47   virtual void EmitCodeAlignment(unsigned ByteAlignment,
48                                  unsigned MaxBytesToEmit = 0);
49   virtual bool EmitValueToOffset(const MCExpr *Offset,
50                                  unsigned char Value = 0);
51   virtual void FinishImpl();
52
53
54   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) {
55     report_fatal_error("unsupported directive in pure streamer");
56   }
57   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) {
58     report_fatal_error("unsupported directive in pure streamer");
59   }
60   virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
61                               uint64_t Size, unsigned ByteAlignment = 0) {
62     report_fatal_error("unsupported directive in pure streamer");
63   }
64   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
65     report_fatal_error("unsupported directive in pure streamer");
66   }
67   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
68                                 unsigned ByteAlignment) {
69     report_fatal_error("unsupported directive in pure streamer");
70   }
71   virtual void EmitThumbFunc(MCSymbol *Func) {
72     report_fatal_error("unsupported directive in pure streamer");
73   }
74   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) {
75     report_fatal_error("unsupported directive in pure streamer");
76   }
77   virtual void EmitCOFFSymbolStorageClass(int StorageClass) {
78     report_fatal_error("unsupported directive in pure streamer");
79   }
80   virtual void EmitCOFFSymbolType(int Type) {
81     report_fatal_error("unsupported directive in pure streamer");
82   }
83   virtual void EndCOFFSymbolDef() {
84     report_fatal_error("unsupported directive in pure streamer");
85   }
86   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
87     report_fatal_error("unsupported directive in pure streamer");
88   }
89   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
90                                      unsigned ByteAlignment) {
91     report_fatal_error("unsupported directive in pure streamer");
92   }
93   virtual void EmitFileDirective(StringRef Filename) {
94     report_fatal_error("unsupported directive in pure streamer");
95   }
96   virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
97                                       StringRef Filename) {
98     report_fatal_error("unsupported directive in pure streamer");
99   }
100
101   /// @}
102 };
103
104 } // end anonymous namespace.
105
106 void MCPureStreamer::InitSections() {
107   // FIMXE: To what!?
108   SwitchSection(getContext().getMachOSection("__TEXT", "__text",
109                                     MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
110                                     0, SectionKind::getText()));
111
112 }
113
114 void MCPureStreamer::EmitLabel(MCSymbol *Symbol) {
115   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
116   assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
117   assert(getCurrentSection() && "Cannot emit before setting section!");
118
119   Symbol->setSection(*getCurrentSection());
120
121   MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
122
123   // We have to create a new fragment if this is an atom defining symbol,
124   // fragments cannot span atoms.
125   if (getAssembler().isSymbolLinkerVisible(SD.getSymbol()))
126     new MCDataFragment(getCurrentSectionData());
127
128   // FIXME: This is wasteful, we don't necessarily need to create a data
129   // fragment. Instead, we should mark the symbol as pointing into the data
130   // fragment if it exists, otherwise we should just queue the label and set its
131   // fragment pointer when we emit the next fragment.
132   MCDataFragment *F = getOrCreateDataFragment();
133   assert(!SD.getFragment() && "Unexpected fragment on symbol data!");
134   SD.setFragment(F);
135   SD.setOffset(F->getContents().size());
136 }
137
138
139 void MCPureStreamer::EmitDebugLabel(MCSymbol *Symbol) {
140   EmitLabel(Symbol);
141 }
142
143 void MCPureStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
144                                   uint64_t Size, unsigned ByteAlignment) {
145   report_fatal_error("not yet implemented in pure streamer");
146 }
147
148 void MCPureStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
149   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
150   // MCObjectStreamer.
151   getOrCreateDataFragment()->getContents().append(Data.begin(), Data.end());
152 }
153
154 void MCPureStreamer::EmitValueToAlignment(unsigned ByteAlignment,
155                                           int64_t Value, unsigned ValueSize,
156                                           unsigned MaxBytesToEmit) {
157   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
158   // MCObjectStreamer.
159   if (MaxBytesToEmit == 0)
160     MaxBytesToEmit = ByteAlignment;
161   new MCAlignFragment(ByteAlignment, Value, ValueSize, MaxBytesToEmit,
162                       getCurrentSectionData());
163
164   // Update the maximum alignment on the current section if necessary.
165   if (ByteAlignment > getCurrentSectionData()->getAlignment())
166     getCurrentSectionData()->setAlignment(ByteAlignment);
167 }
168
169 void MCPureStreamer::EmitCodeAlignment(unsigned ByteAlignment,
170                                        unsigned MaxBytesToEmit) {
171   // TODO: This is exactly the same as WinCOFFStreamer. Consider merging into
172   // MCObjectStreamer.
173   if (MaxBytesToEmit == 0)
174     MaxBytesToEmit = ByteAlignment;
175   MCAlignFragment *F = new MCAlignFragment(ByteAlignment, 0, 1, MaxBytesToEmit,
176                                            getCurrentSectionData());
177   F->setEmitNops(true);
178
179   // Update the maximum alignment on the current section if necessary.
180   if (ByteAlignment > getCurrentSectionData()->getAlignment())
181     getCurrentSectionData()->setAlignment(ByteAlignment);
182 }
183
184 bool MCPureStreamer::EmitValueToOffset(const MCExpr *Offset,
185                                        unsigned char Value) {
186   new MCOrgFragment(*Offset, Value, getCurrentSectionData());
187   return false;
188 }
189
190 void MCPureStreamer::EmitInstToFragment(const MCInst &Inst) {
191   MCRelaxableFragment *IF =
192     new MCRelaxableFragment(Inst, getCurrentSectionData());
193
194   // Add the fixups and data.
195   //
196   // FIXME: Revisit this design decision when relaxation is done, we may be
197   // able to get away with not storing any extra data in the MCInst.
198   SmallVector<MCFixup, 4> Fixups;
199   SmallString<256> Code;
200   raw_svector_ostream VecOS(Code);
201   getAssembler().getEmitter().EncodeInstruction(Inst, VecOS, Fixups);
202   VecOS.flush();
203
204   IF->getContents() = Code;
205   IF->getFixups() = Fixups;
206 }
207
208 void MCPureStreamer::EmitInstToData(const MCInst &Inst) {
209   MCDataFragment *DF = getOrCreateDataFragment();
210
211   SmallVector<MCFixup, 4> Fixups;
212   SmallString<256> Code;
213   raw_svector_ostream VecOS(Code);
214   getAssembler().getEmitter().EncodeInstruction(Inst, VecOS, Fixups);
215   VecOS.flush();
216
217   // Add the fixups and data.
218   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
219     Fixups[i].setOffset(Fixups[i].getOffset() + DF->getContents().size());
220     DF->getFixups().push_back(Fixups[i]);
221   }
222   DF->getContents().append(Code.begin(), Code.end());
223 }
224
225 void MCPureStreamer::FinishImpl() {
226   // FIXME: Handle DWARF tables?
227
228   this->MCObjectStreamer::FinishImpl();
229 }
230
231 MCStreamer *llvm::createPureStreamer(MCContext &Context, MCAsmBackend &MAB,
232                                      raw_ostream &OS, MCCodeEmitter *CE) {
233   return new MCPureStreamer(Context, MAB, OS, CE);
234 }