MCStreamer.cpp revision 91d9a1c0f7c598d51c50f80bc9e8dfc1494f78c1 
1//===- lib/MC/MCStreamer.cpp - Streaming Machine Code 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/MCAsmInfo.h"
11#include "llvm/MC/MCContext.h"
12#include "llvm/MC/MCStreamer.h"
13#include "llvm/MC/MCExpr.h"
14#include "llvm/MC/MCObjectWriter.h"
15#include "llvm/MC/MCSymbol.h"
16#include "llvm/Support/ErrorHandling.h"
17#include "llvm/Support/raw_ostream.h"
18#include "llvm/ADT/SmallString.h"
19#include "llvm/ADT/Twine.h"
20#include <cstdlib>
21using namespace llvm;
22
23MCStreamer::MCStreamer(MCContext &Ctx) : Context(Ctx), EmitEHFrame(true),
24                                         EmitDebugFrame(false) {
25  const MCSection *section = NULL;
26  SectionStack.push_back(std::make_pair(section, section));
27}
28
29MCStreamer::~MCStreamer() {
30}
31
32const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
33                                          const MCSymbol *A,
34                                          const MCSymbol *B) {
35  MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
36  const MCExpr *ARef =
37    MCSymbolRefExpr::Create(A, Variant, Context);
38  const MCExpr *BRef =
39    MCSymbolRefExpr::Create(B, Variant, Context);
40  const MCExpr *AddrDelta =
41    MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
42  return AddrDelta;
43}
44
45const MCExpr *MCStreamer::ForceExpAbs(MCStreamer *Streamer,
46                                      MCContext &Context, const MCExpr* Expr) {
47 if (Context.getAsmInfo().hasAggressiveSymbolFolding())
48   return Expr;
49
50 MCSymbol *ABS = Context.CreateTempSymbol();
51 Streamer->EmitAssignment(ABS, Expr);
52 return MCSymbolRefExpr::Create(ABS, Context);
53}
54
55raw_ostream &MCStreamer::GetCommentOS() {
56  // By default, discard comments.
57  return nulls();
58}
59
60void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
61                                      const MCSymbol *Label, int PointerSize) {
62  // emit the sequence to set the address
63  EmitIntValue(dwarf::DW_LNS_extended_op, 1);
64  EmitULEB128IntValue(PointerSize + 1);
65  EmitIntValue(dwarf::DW_LNE_set_address, 1);
66  EmitSymbolValue(Label, PointerSize);
67
68  // emit the sequence for the LineDelta (from 1) and a zero address delta.
69  MCDwarfLineAddr::Emit(this, LineDelta, 0);
70}
71
72/// EmitIntValue - Special case of EmitValue that avoids the client having to
73/// pass in a MCExpr for constant integers.
74void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
75                              unsigned AddrSpace) {
76  assert(Size <= 8 && "Invalid size");
77  assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
78         "Invalid size");
79  char buf[8];
80  // FIXME: Endianness assumption.
81  for (unsigned i = 0; i != Size; ++i)
82    buf[i] = uint8_t(Value >> (i * 8));
83  EmitBytes(StringRef(buf, Size), AddrSpace);
84}
85
86/// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
87/// client having to pass in a MCExpr for constant integers.
88void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
89  SmallString<32> Tmp;
90  raw_svector_ostream OSE(Tmp);
91  MCObjectWriter::EncodeULEB128(Value, OSE);
92  EmitBytes(OSE.str(), AddrSpace);
93}
94
95/// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
96/// client having to pass in a MCExpr for constant integers.
97void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
98  SmallString<32> Tmp;
99  raw_svector_ostream OSE(Tmp);
100  MCObjectWriter::EncodeSLEB128(Value, OSE);
101  EmitBytes(OSE.str(), AddrSpace);
102}
103
104void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
105                              unsigned AddrSpace) {
106  if (getContext().getAsmInfo().hasAggressiveSymbolFolding()) {
107    EmitValue(Value, Size, AddrSpace);
108    return;
109  }
110  MCSymbol *ABS = getContext().CreateTempSymbol();
111  EmitAssignment(ABS, Value);
112  EmitSymbolValue(ABS, Size, AddrSpace);
113}
114
115
116void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
117                           unsigned AddrSpace) {
118  EmitValueImpl(Value, Size, AddrSpace);
119}
120
121void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
122                                  unsigned AddrSpace) {
123  EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
124                AddrSpace);
125}
126
127void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
128  report_fatal_error("unsupported directive in streamer");
129}
130
131/// EmitFill - Emit NumBytes bytes worth of the value specified by
132/// FillValue.  This implements directives such as '.space'.
133void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
134                          unsigned AddrSpace) {
135  const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
136  for (uint64_t i = 0, e = NumBytes; i != e; ++i)
137    EmitValue(E, 1, AddrSpace);
138}
139
140bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
141                                        StringRef Filename) {
142  return getContext().GetDwarfFile(Filename, FileNo) == 0;
143}
144
145void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
146                                       unsigned Column, unsigned Flags,
147                                       unsigned Isa,
148                                       unsigned Discriminator,
149                                       StringRef FileName) {
150  getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
151                                  Discriminator);
152}
153
154MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
155  if (FrameInfos.empty())
156    return NULL;
157  return &FrameInfos.back();
158}
159
160void MCStreamer::EnsureValidFrame() {
161  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
162  if (!CurFrame || CurFrame->End)
163    report_fatal_error("No open frame");
164}
165
166void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
167                                     MCSymbol *EHSymbol) {
168}
169
170void MCStreamer::EmitLabel(MCSymbol *Symbol) {
171  assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
172  assert(getCurrentSection() && "Cannot emit before setting section!");
173  Symbol->setSection(*getCurrentSection());
174
175  StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
176  if (!Symbol->getName().startswith(Prefix))
177    LastNonPrivate = Symbol;
178}
179
180void MCStreamer::EmitCFISections(bool EH, bool Debug) {
181  assert(EH || Debug);
182  EmitEHFrame = EH;
183  EmitDebugFrame = Debug;
184}
185
186void MCStreamer::EmitCFIStartProc() {
187  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
188  if (CurFrame && !CurFrame->End)
189    report_fatal_error("Starting a frame before finishing the previous one!");
190  MCDwarfFrameInfo Frame;
191  Frame.Begin = getContext().CreateTempSymbol();
192  Frame.Function = LastNonPrivate;
193  EmitLabel(Frame.Begin);
194  FrameInfos.push_back(Frame);
195}
196
197void MCStreamer::EmitCFIEndProc() {
198  EnsureValidFrame();
199  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
200  CurFrame->End = getContext().CreateTempSymbol();
201  EmitLabel(CurFrame->End);
202}
203
204void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
205  EnsureValidFrame();
206  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
207  MCSymbol *Label = getContext().CreateTempSymbol();
208  EmitLabel(Label);
209  MachineLocation Dest(MachineLocation::VirtualFP);
210  MachineLocation Source(Register, -Offset);
211  MCCFIInstruction Instruction(Label, Dest, Source);
212  CurFrame->Instructions.push_back(Instruction);
213}
214
215void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
216  EnsureValidFrame();
217  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
218  MCSymbol *Label = getContext().CreateTempSymbol();
219  EmitLabel(Label);
220  MachineLocation Dest(MachineLocation::VirtualFP);
221  MachineLocation Source(MachineLocation::VirtualFP, -Offset);
222  MCCFIInstruction Instruction(Label, Dest, Source);
223  CurFrame->Instructions.push_back(Instruction);
224}
225
226void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
227  EnsureValidFrame();
228  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
229  MCSymbol *Label = getContext().CreateTempSymbol();
230  EmitLabel(Label);
231  MachineLocation Dest(MachineLocation::VirtualFP);
232  MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
233  MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
234  CurFrame->Instructions.push_back(Instruction);
235}
236
237void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
238  EnsureValidFrame();
239  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
240  MCSymbol *Label = getContext().CreateTempSymbol();
241  EmitLabel(Label);
242  MachineLocation Dest(Register);
243  MachineLocation Source(MachineLocation::VirtualFP);
244  MCCFIInstruction Instruction(Label, Dest, Source);
245  CurFrame->Instructions.push_back(Instruction);
246}
247
248void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
249  EnsureValidFrame();
250  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
251  MCSymbol *Label = getContext().CreateTempSymbol();
252  EmitLabel(Label);
253  MachineLocation Dest(Register, Offset);
254  MachineLocation Source(Register, Offset);
255  MCCFIInstruction Instruction(Label, Dest, Source);
256  CurFrame->Instructions.push_back(Instruction);
257}
258
259void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
260  EnsureValidFrame();
261  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
262  MCSymbol *Label = getContext().CreateTempSymbol();
263  EmitLabel(Label);
264  MachineLocation Dest(Register, Offset);
265  MachineLocation Source(Register, Offset);
266  MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
267  CurFrame->Instructions.push_back(Instruction);
268}
269
270void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
271                                    unsigned Encoding) {
272  EnsureValidFrame();
273  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
274  CurFrame->Personality = Sym;
275  CurFrame->PersonalityEncoding = Encoding;
276}
277
278void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
279  EnsureValidFrame();
280  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
281  CurFrame->Lsda = Sym;
282  CurFrame->LsdaEncoding = Encoding;
283}
284
285void MCStreamer::EmitCFIRememberState() {
286  EnsureValidFrame();
287  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
288  MCSymbol *Label = getContext().CreateTempSymbol();
289  EmitLabel(Label);
290  MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
291  CurFrame->Instructions.push_back(Instruction);
292}
293
294void MCStreamer::EmitCFIRestoreState() {
295  // FIXME: Error if there is no matching cfi_remember_state.
296  EnsureValidFrame();
297  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
298  MCSymbol *Label = getContext().CreateTempSymbol();
299  EmitLabel(Label);
300  MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
301  CurFrame->Instructions.push_back(Instruction);
302}
303
304void MCStreamer::EmitCFISameValue(int64_t Register) {
305  EnsureValidFrame();
306  MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
307  MCSymbol *Label = getContext().CreateTempSymbol();
308  EmitLabel(Label);
309  MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
310  CurFrame->Instructions.push_back(Instruction);
311}
312
313void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
314  W64UnwindInfos.push_back(*Frame);
315  CurrentW64UnwindInfo = &W64UnwindInfos.back();
316}
317
318void MCStreamer::EnsureValidW64UnwindInfo() {
319  MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
320  if (!CurFrame || CurFrame->End)
321    report_fatal_error("No open Win64 EH frame function!");
322}
323
324void MCStreamer::EmitWin64EHStartProc(MCSymbol *Symbol, MCSymbol *EHandler) {
325  MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
326  if (CurFrame && !CurFrame->End)
327    report_fatal_error("Starting a function before ending the previous one!");
328  MCWin64EHUnwindInfo Frame;
329  Frame.Begin = getContext().CreateTempSymbol();
330  Frame.Function = Symbol;
331  Frame.ExceptionHandler = EHandler;
332  EmitLabel(Frame.Begin);
333  setCurrentW64UnwindInfo(&Frame);
334}
335
336void MCStreamer::EmitWin64EHEndProc() {
337  EnsureValidW64UnwindInfo();
338  MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
339  if (CurFrame->ChainedParent)
340    report_fatal_error("Not all chained regions terminated!");
341  CurFrame->End = getContext().CreateTempSymbol();
342  EmitLabel(CurFrame->End);
343}
344
345void MCStreamer::EmitWin64EHStartChained()
346{
347  EnsureValidW64UnwindInfo();
348  MCWin64EHUnwindInfo Frame;
349  MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
350  Frame.Begin = getContext().CreateTempSymbol();
351  Frame.Function = CurFrame->Function;
352  Frame.ChainedParent = CurFrame;
353  EmitLabel(Frame.Begin);
354  setCurrentW64UnwindInfo(&Frame);
355}
356
357void MCStreamer::EmitWin64EHEndChained()
358{
359  EnsureValidW64UnwindInfo();
360  MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
361  if (!CurFrame->ChainedParent)
362    report_fatal_error("End of a chained region outside a chained region!");
363  CurFrame->End = getContext().CreateTempSymbol();
364  EmitLabel(CurFrame->End);
365  CurrentW64UnwindInfo = CurFrame->ChainedParent;
366}
367
368void MCStreamer::EmitWin64EHUnwindOnly()
369{
370  errs() << "Not implemented yet\n";
371  abort();
372}
373
374void MCStreamer::EmitWin64EHLsda(const MCSymbol *Sym, int64_t Size)
375{
376  errs() << "Not implemented yet\n";
377  abort();
378}
379
380void MCStreamer::EmitWin64EHPushReg(int64_t Register)
381{
382  errs() << "Not implemented yet\n";
383  abort();
384}
385
386void MCStreamer::EmitWin64EHSetFrame(int64_t Register, int64_t Offset)
387{
388  errs() << "Not implemented yet\n";
389  abort();
390}
391
392void MCStreamer::EmitWin64EHAllocStack(int64_t Size)
393{
394  errs() << "Not implemented yet\n";
395  abort();
396}
397
398void MCStreamer::EmitWin64EHSaveReg(int64_t Register, int64_t Offset)
399{
400  errs() << "Not implemented yet\n";
401  abort();
402}
403
404void MCStreamer::EmitWin64EHPushFrame(bool Code)
405{
406  errs() << "Not implemented yet\n";
407  abort();
408}
409
410void MCStreamer::EmitWin64EHEndProlog()
411{
412  errs() << "Not implemented yet\n";
413  abort();
414}
415
416void MCStreamer::EmitFnStart() {
417  errs() << "Not implemented yet\n";
418  abort();
419}
420
421void MCStreamer::EmitFnEnd() {
422  errs() << "Not implemented yet\n";
423  abort();
424}
425
426void MCStreamer::EmitCantUnwind() {
427  errs() << "Not implemented yet\n";
428  abort();
429}
430
431void MCStreamer::EmitHandlerData() {
432  errs() << "Not implemented yet\n";
433  abort();
434}
435
436void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
437  errs() << "Not implemented yet\n";
438  abort();
439}
440
441void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
442  errs() << "Not implemented yet\n";
443  abort();
444}
445
446void MCStreamer::EmitPad(int64_t Offset) {
447  errs() << "Not implemented yet\n";
448  abort();
449}
450
451void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
452  errs() << "Not implemented yet\n";
453  abort();
454}
455
456/// EmitRawText - If this file is backed by an assembly streamer, this dumps
457/// the specified string in the output .s file.  This capability is
458/// indicated by the hasRawTextSupport() predicate.
459void MCStreamer::EmitRawText(StringRef String) {
460  errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
461  " something must not be fully mc'ized\n";
462  abort();
463}
464
465void MCStreamer::EmitRawText(const Twine &T) {
466  SmallString<128> Str;
467  T.toVector(Str);
468  EmitRawText(Str.str());
469}
470
471void MCStreamer::EmitFrames(bool usingCFI) {
472  if (!getNumFrameInfos())
473    return;
474
475  if (EmitEHFrame)
476    MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
477
478  if (EmitDebugFrame)
479    MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
480}
481