7556ba52b7a15e33e0701331a12afc30c97cb760
[oota-llvm.git] / lib / MC / MCAsmStreamer.cpp
1 //===- lib/MC/MCAsmStreamer.cpp - Text Assembly 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/MCAsmInfo.h"
12 #include "llvm/MC/MCCodeEmitter.h"
13 #include "llvm/MC/MCContext.h"
14 #include "llvm/MC/MCExpr.h"
15 #include "llvm/MC/MCFixupKindInfo.h"
16 #include "llvm/MC/MCInst.h"
17 #include "llvm/MC/MCInstPrinter.h"
18 #include "llvm/MC/MCSectionMachO.h"
19 #include "llvm/MC/MCSymbol.h"
20 #include "llvm/ADT/OwningPtr.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/MathExtras.h"
25 #include "llvm/Support/Format.h"
26 #include "llvm/Support/FormattedStream.h"
27 #include "llvm/Target/TargetAsmBackend.h"
28 #include "llvm/Target/TargetAsmInfo.h"
29 #include "llvm/Target/TargetLoweringObjectFile.h"
30 #include <cctype>
31 using namespace llvm;
32
33 namespace {
34
35 class MCAsmStreamer : public MCStreamer {
36   formatted_raw_ostream &OS;
37   const MCAsmInfo &MAI;
38   OwningPtr<MCInstPrinter> InstPrinter;
39   OwningPtr<MCCodeEmitter> Emitter;
40   OwningPtr<TargetAsmBackend> AsmBackend;
41
42   SmallString<128> CommentToEmit;
43   raw_svector_ostream CommentStream;
44
45   unsigned IsVerboseAsm : 1;
46   unsigned ShowInst : 1;
47   unsigned UseLoc : 1;
48
49   bool needsSet(const MCExpr *Value);
50
51 public:
52   MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
53                 bool isVerboseAsm,
54                 bool useLoc,
55                 MCInstPrinter *printer, MCCodeEmitter *emitter,
56                 TargetAsmBackend *asmbackend,
57                 bool showInst)
58     : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
59       InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
60       CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
61       ShowInst(showInst), UseLoc(useLoc) {
62     if (InstPrinter && IsVerboseAsm)
63       InstPrinter->setCommentStream(CommentStream);
64   }
65   ~MCAsmStreamer() {}
66
67   inline void EmitEOL() {
68     // If we don't have any comments, just emit a \n.
69     if (!IsVerboseAsm) {
70       OS << '\n';
71       return;
72     }
73     EmitCommentsAndEOL();
74   }
75   void EmitCommentsAndEOL();
76
77   /// isVerboseAsm - Return true if this streamer supports verbose assembly at
78   /// all.
79   virtual bool isVerboseAsm() const { return IsVerboseAsm; }
80
81   /// hasRawTextSupport - We support EmitRawText.
82   virtual bool hasRawTextSupport() const { return true; }
83
84   /// AddComment - Add a comment that can be emitted to the generated .s
85   /// file if applicable as a QoI issue to make the output of the compiler
86   /// more readable.  This only affects the MCAsmStreamer, and only when
87   /// verbose assembly output is enabled.
88   virtual void AddComment(const Twine &T);
89
90   /// AddEncodingComment - Add a comment showing the encoding of an instruction.
91   virtual void AddEncodingComment(const MCInst &Inst);
92
93   /// GetCommentOS - Return a raw_ostream that comments can be written to.
94   /// Unlike AddComment, you are required to terminate comments with \n if you
95   /// use this method.
96   virtual raw_ostream &GetCommentOS() {
97     if (!IsVerboseAsm)
98       return nulls();  // Discard comments unless in verbose asm mode.
99     return CommentStream;
100   }
101
102   /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
103   virtual void AddBlankLine() {
104     EmitEOL();
105   }
106
107   /// @name MCStreamer Interface
108   /// @{
109
110   virtual void ChangeSection(const MCSection *Section);
111
112   virtual void InitSections() {
113     // FIXME, this is MachO specific, but the testsuite
114     // expects this.
115     SwitchSection(getContext().getMachOSection("__TEXT", "__text",
116                          MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
117                          0, SectionKind::getText()));
118   }
119
120   virtual void EmitLabel(MCSymbol *Symbol);
121
122   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
123   virtual void EmitThumbFunc(MCSymbol *Func);
124
125   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
126   virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
127   virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
128                                         const MCSymbol *LastLabel,
129                                         const MCSymbol *Label);
130
131   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
132
133   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
134   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
135   virtual void EmitCOFFSymbolStorageClass(int StorageClass);
136   virtual void EmitCOFFSymbolType(int Type);
137   virtual void EndCOFFSymbolDef();
138   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
139   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
140                                 unsigned ByteAlignment);
141
142   /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
143   ///
144   /// @param Symbol - The common symbol to emit.
145   /// @param Size - The size of the common symbol.
146   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
147
148   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
149                             unsigned Size = 0, unsigned ByteAlignment = 0);
150
151   virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
152                                uint64_t Size, unsigned ByteAlignment = 0);
153
154   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
155
156   virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
157                              bool isPCRel, unsigned AddrSpace);
158   virtual void EmitIntValue(uint64_t Value, unsigned Size,
159                             unsigned AddrSpace = 0);
160
161   virtual void EmitULEB128Value(const MCExpr *Value);
162
163   virtual void EmitSLEB128Value(const MCExpr *Value);
164
165   virtual void EmitGPRel32Value(const MCExpr *Value);
166
167
168   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
169                         unsigned AddrSpace);
170
171   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
172                                     unsigned ValueSize = 1,
173                                     unsigned MaxBytesToEmit = 0);
174
175   virtual void EmitCodeAlignment(unsigned ByteAlignment,
176                                  unsigned MaxBytesToEmit = 0);
177
178   virtual void EmitValueToOffset(const MCExpr *Offset,
179                                  unsigned char Value = 0);
180
181   virtual void EmitFileDirective(StringRef Filename);
182   virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
183   virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
184                                      unsigned Column, unsigned Flags,
185                                      unsigned Isa, unsigned Discriminator,
186                                      StringRef FileName);
187
188   virtual void EmitCFIStartProc();
189   virtual void EmitCFIEndProc();
190   virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
191   virtual void EmitCFIDefCfaOffset(int64_t Offset);
192   virtual void EmitCFIDefCfaRegister(int64_t Register);
193   virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
194   virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
195   virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
196   virtual void EmitCFIRememberState();
197   virtual void EmitCFIRestoreState();
198   virtual void EmitCFISameValue(int64_t Register);
199   virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
200   virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
201
202   virtual void EmitFnStart();
203   virtual void EmitFnEnd();
204   virtual void EmitCantUnwind();
205   virtual void EmitPersonality(const MCSymbol *Personality);
206   virtual void EmitHandlerData();
207   virtual void EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0);
208   virtual void EmitPad(int64_t Offset);
209   virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool);
210
211
212   virtual void EmitInstruction(const MCInst &Inst);
213
214   /// EmitRawText - If this file is backed by an assembly streamer, this dumps
215   /// the specified string in the output .s file.  This capability is
216   /// indicated by the hasRawTextSupport() predicate.
217   virtual void EmitRawText(StringRef String);
218
219   virtual void Finish();
220
221   /// @}
222 };
223
224 } // end anonymous namespace.
225
226 /// AddComment - Add a comment that can be emitted to the generated .s
227 /// file if applicable as a QoI issue to make the output of the compiler
228 /// more readable.  This only affects the MCAsmStreamer, and only when
229 /// verbose assembly output is enabled.
230 void MCAsmStreamer::AddComment(const Twine &T) {
231   if (!IsVerboseAsm) return;
232
233   // Make sure that CommentStream is flushed.
234   CommentStream.flush();
235
236   T.toVector(CommentToEmit);
237   // Each comment goes on its own line.
238   CommentToEmit.push_back('\n');
239
240   // Tell the comment stream that the vector changed underneath it.
241   CommentStream.resync();
242 }
243
244 void MCAsmStreamer::EmitCommentsAndEOL() {
245   if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
246     OS << '\n';
247     return;
248   }
249
250   CommentStream.flush();
251   StringRef Comments = CommentToEmit.str();
252
253   assert(Comments.back() == '\n' &&
254          "Comment array not newline terminated");
255   do {
256     // Emit a line of comments.
257     OS.PadToColumn(MAI.getCommentColumn());
258     size_t Position = Comments.find('\n');
259     OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
260
261     Comments = Comments.substr(Position+1);
262   } while (!Comments.empty());
263
264   CommentToEmit.clear();
265   // Tell the comment stream that the vector changed underneath it.
266   CommentStream.resync();
267 }
268
269 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
270   assert(Bytes && "Invalid size!");
271   return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
272 }
273
274 void MCAsmStreamer::ChangeSection(const MCSection *Section) {
275   assert(Section && "Cannot switch to a null section!");
276   Section->PrintSwitchToSection(MAI, OS);
277 }
278
279 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
280   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
281   MCStreamer::EmitLabel(Symbol);
282
283   OS << *Symbol << MAI.getLabelSuffix();
284   EmitEOL();
285 }
286
287 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
288   switch (Flag) {
289   default: assert(0 && "Invalid flag!");
290   case MCAF_SyntaxUnified:         OS << "\t.syntax unified"; break;
291   case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
292   case MCAF_Code16:                OS << "\t.code\t16"; break;
293   case MCAF_Code32:                OS << "\t.code\t32"; break;
294   }
295   EmitEOL();
296 }
297
298 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
299   // This needs to emit to a temporary string to get properly quoted
300   // MCSymbols when they have spaces in them.
301   OS << "\t.thumb_func";
302   if (Func)
303     OS << '\t' << *Func;
304   EmitEOL();
305 }
306
307 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
308   OS << *Symbol << " = " << *Value;
309   EmitEOL();
310
311   // FIXME: Lift context changes into super class.
312   Symbol->setVariableValue(Value);
313 }
314
315 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
316   OS << ".weakref " << *Alias << ", " << *Symbol;
317   EmitEOL();
318 }
319
320 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
321                                              const MCSymbol *LastLabel,
322                                              const MCSymbol *Label) {
323   EmitDwarfSetLineAddr(LineDelta, Label,
324                        getContext().getTargetAsmInfo().getPointerSize());
325 }
326
327 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
328                                         MCSymbolAttr Attribute) {
329   switch (Attribute) {
330   case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
331   case MCSA_ELF_TypeFunction:    /// .type _foo, STT_FUNC  # aka @function
332   case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
333   case MCSA_ELF_TypeObject:      /// .type _foo, STT_OBJECT  # aka @object
334   case MCSA_ELF_TypeTLS:         /// .type _foo, STT_TLS     # aka @tls_object
335   case MCSA_ELF_TypeCommon:      /// .type _foo, STT_COMMON  # aka @common
336   case MCSA_ELF_TypeNoType:      /// .type _foo, STT_NOTYPE  # aka @notype
337   case MCSA_ELF_TypeGnuUniqueObject:  /// .type _foo, @gnu_unique_object
338     assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
339     OS << "\t.type\t" << *Symbol << ','
340        << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
341     switch (Attribute) {
342     default: assert(0 && "Unknown ELF .type");
343     case MCSA_ELF_TypeFunction:    OS << "function"; break;
344     case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
345     case MCSA_ELF_TypeObject:      OS << "object"; break;
346     case MCSA_ELF_TypeTLS:         OS << "tls_object"; break;
347     case MCSA_ELF_TypeCommon:      OS << "common"; break;
348     case MCSA_ELF_TypeNoType:      OS << "no_type"; break;
349     case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
350     }
351     EmitEOL();
352     return;
353   case MCSA_Global: // .globl/.global
354     OS << MAI.getGlobalDirective();
355     break;
356   case MCSA_Hidden:         OS << "\t.hidden\t";          break;
357   case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
358   case MCSA_Internal:       OS << "\t.internal\t";        break;
359   case MCSA_LazyReference:  OS << "\t.lazy_reference\t";  break;
360   case MCSA_Local:          OS << "\t.local\t";           break;
361   case MCSA_NoDeadStrip:    OS << "\t.no_dead_strip\t";   break;
362   case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
363   case MCSA_PrivateExtern:  OS << "\t.private_extern\t";  break;
364   case MCSA_Protected:      OS << "\t.protected\t";       break;
365   case MCSA_Reference:      OS << "\t.reference\t";       break;
366   case MCSA_Weak:           OS << "\t.weak\t";            break;
367   case MCSA_WeakDefinition: OS << "\t.weak_definition\t"; break;
368       // .weak_reference
369   case MCSA_WeakReference:  OS << MAI.getWeakRefDirective(); break;
370   case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
371   }
372
373   OS << *Symbol;
374   EmitEOL();
375 }
376
377 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
378   OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
379   EmitEOL();
380 }
381
382 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
383   OS << "\t.def\t " << *Symbol << ';';
384   EmitEOL();
385 }
386
387 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
388   OS << "\t.scl\t" << StorageClass << ';';
389   EmitEOL();
390 }
391
392 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
393   OS << "\t.type\t" << Type << ';';
394   EmitEOL();
395 }
396
397 void MCAsmStreamer::EndCOFFSymbolDef() {
398   OS << "\t.endef";
399   EmitEOL();
400 }
401
402 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
403   assert(MAI.hasDotTypeDotSizeDirective());
404   OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
405 }
406
407 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
408                                      unsigned ByteAlignment) {
409   OS << "\t.comm\t" << *Symbol << ',' << Size;
410   if (ByteAlignment != 0) {
411     if (MAI.getCOMMDirectiveAlignmentIsInBytes())
412       OS << ',' << ByteAlignment;
413     else
414       OS << ',' << Log2_32(ByteAlignment);
415   }
416   EmitEOL();
417 }
418
419 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
420 ///
421 /// @param Symbol - The common symbol to emit.
422 /// @param Size - The size of the common symbol.
423 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
424   assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
425   OS << "\t.lcomm\t" << *Symbol << ',' << Size;
426   EmitEOL();
427 }
428
429 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
430                                  unsigned Size, unsigned ByteAlignment) {
431   // Note: a .zerofill directive does not switch sections.
432   OS << ".zerofill ";
433
434   // This is a mach-o specific directive.
435   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
436   OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
437
438   if (Symbol != NULL) {
439     OS << ',' << *Symbol << ',' << Size;
440     if (ByteAlignment != 0)
441       OS << ',' << Log2_32(ByteAlignment);
442   }
443   EmitEOL();
444 }
445
446 // .tbss sym, size, align
447 // This depends that the symbol has already been mangled from the original,
448 // e.g. _a.
449 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
450                                    uint64_t Size, unsigned ByteAlignment) {
451   assert(Symbol != NULL && "Symbol shouldn't be NULL!");
452   // Instead of using the Section we'll just use the shortcut.
453   // This is a mach-o specific directive and section.
454   OS << ".tbss " << *Symbol << ", " << Size;
455
456   // Output align if we have it.  We default to 1 so don't bother printing
457   // that.
458   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
459
460   EmitEOL();
461 }
462
463 static inline char toOctal(int X) { return (X&7)+'0'; }
464
465 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
466   OS << '"';
467
468   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
469     unsigned char C = Data[i];
470     if (C == '"' || C == '\\') {
471       OS << '\\' << (char)C;
472       continue;
473     }
474
475     if (isprint((unsigned char)C)) {
476       OS << (char)C;
477       continue;
478     }
479
480     switch (C) {
481       case '\b': OS << "\\b"; break;
482       case '\f': OS << "\\f"; break;
483       case '\n': OS << "\\n"; break;
484       case '\r': OS << "\\r"; break;
485       case '\t': OS << "\\t"; break;
486       default:
487         OS << '\\';
488         OS << toOctal(C >> 6);
489         OS << toOctal(C >> 3);
490         OS << toOctal(C >> 0);
491         break;
492     }
493   }
494
495   OS << '"';
496 }
497
498
499 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
500   assert(getCurrentSection() && "Cannot emit contents before setting section!");
501   if (Data.empty()) return;
502
503   if (Data.size() == 1) {
504     OS << MAI.getData8bitsDirective(AddrSpace);
505     OS << (unsigned)(unsigned char)Data[0];
506     EmitEOL();
507     return;
508   }
509
510   // If the data ends with 0 and the target supports .asciz, use it, otherwise
511   // use .ascii
512   if (MAI.getAscizDirective() && Data.back() == 0) {
513     OS << MAI.getAscizDirective();
514     Data = Data.substr(0, Data.size()-1);
515   } else {
516     OS << MAI.getAsciiDirective();
517   }
518
519   OS << ' ';
520   PrintQuotedString(Data, OS);
521   EmitEOL();
522 }
523
524 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
525                                  unsigned AddrSpace) {
526   EmitValue(MCConstantExpr::Create(Value, getContext()), Size, AddrSpace);
527 }
528
529 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
530                                   bool isPCRel, unsigned AddrSpace) {
531   assert(getCurrentSection() && "Cannot emit contents before setting section!");
532   assert(!isPCRel && "Cannot emit pc relative relocations!");
533   const char *Directive = 0;
534   switch (Size) {
535   default: break;
536   case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
537   case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
538   case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
539   case 8:
540     Directive = MAI.getData64bitsDirective(AddrSpace);
541     // If the target doesn't support 64-bit data, emit as two 32-bit halves.
542     if (Directive) break;
543     int64_t IntValue;
544     if (!Value->EvaluateAsAbsolute(IntValue))
545       report_fatal_error("Don't know how to emit this value.");
546     if (getContext().getTargetAsmInfo().isLittleEndian()) {
547       EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
548       EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
549     } else {
550       EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
551       EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
552     }
553     return;
554   }
555
556   assert(Directive && "Invalid size for machine code value!");
557   OS << Directive << *Value;
558   EmitEOL();
559 }
560
561 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
562   int64_t IntValue;
563   if (Value->EvaluateAsAbsolute(IntValue)) {
564     EmitULEB128IntValue(IntValue);
565     return;
566   }
567   assert(MAI.hasLEB128() && "Cannot print a .uleb");
568   OS << ".uleb128 " << *Value;
569   EmitEOL();
570 }
571
572 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
573   int64_t IntValue;
574   if (Value->EvaluateAsAbsolute(IntValue)) {
575     EmitSLEB128IntValue(IntValue);
576     return;
577   }
578   assert(MAI.hasLEB128() && "Cannot print a .sleb");
579   OS << ".sleb128 " << *Value;
580   EmitEOL();
581 }
582
583 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
584   assert(MAI.getGPRel32Directive() != 0);
585   OS << MAI.getGPRel32Directive() << *Value;
586   EmitEOL();
587 }
588
589
590 /// EmitFill - Emit NumBytes bytes worth of the value specified by
591 /// FillValue.  This implements directives such as '.space'.
592 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
593                              unsigned AddrSpace) {
594   if (NumBytes == 0) return;
595
596   if (AddrSpace == 0)
597     if (const char *ZeroDirective = MAI.getZeroDirective()) {
598       OS << ZeroDirective << NumBytes;
599       if (FillValue != 0)
600         OS << ',' << (int)FillValue;
601       EmitEOL();
602       return;
603     }
604
605   // Emit a byte at a time.
606   MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
607 }
608
609 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
610                                          unsigned ValueSize,
611                                          unsigned MaxBytesToEmit) {
612   // Some assemblers don't support non-power of two alignments, so we always
613   // emit alignments as a power of two if possible.
614   if (isPowerOf2_32(ByteAlignment)) {
615     switch (ValueSize) {
616     default: llvm_unreachable("Invalid size for machine code value!");
617     case 1: OS << MAI.getAlignDirective(); break;
618     // FIXME: use MAI for this!
619     case 2: OS << ".p2alignw "; break;
620     case 4: OS << ".p2alignl "; break;
621     case 8: llvm_unreachable("Unsupported alignment size!");
622     }
623
624     if (MAI.getAlignmentIsInBytes())
625       OS << ByteAlignment;
626     else
627       OS << Log2_32(ByteAlignment);
628
629     if (Value || MaxBytesToEmit) {
630       OS << ", 0x";
631       OS.write_hex(truncateToSize(Value, ValueSize));
632
633       if (MaxBytesToEmit)
634         OS << ", " << MaxBytesToEmit;
635     }
636     EmitEOL();
637     return;
638   }
639
640   // Non-power of two alignment.  This is not widely supported by assemblers.
641   // FIXME: Parameterize this based on MAI.
642   switch (ValueSize) {
643   default: llvm_unreachable("Invalid size for machine code value!");
644   case 1: OS << ".balign";  break;
645   case 2: OS << ".balignw"; break;
646   case 4: OS << ".balignl"; break;
647   case 8: llvm_unreachable("Unsupported alignment size!");
648   }
649
650   OS << ' ' << ByteAlignment;
651   OS << ", " << truncateToSize(Value, ValueSize);
652   if (MaxBytesToEmit)
653     OS << ", " << MaxBytesToEmit;
654   EmitEOL();
655 }
656
657 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
658                                       unsigned MaxBytesToEmit) {
659   // Emit with a text fill value.
660   EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
661                        1, MaxBytesToEmit);
662 }
663
664 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
665                                       unsigned char Value) {
666   // FIXME: Verify that Offset is associated with the current section.
667   OS << ".org " << *Offset << ", " << (unsigned) Value;
668   EmitEOL();
669 }
670
671
672 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
673   assert(MAI.hasSingleParameterDotFile());
674   OS << "\t.file\t";
675   PrintQuotedString(Filename, OS);
676   EmitEOL();
677 }
678
679 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
680   if (UseLoc) {
681     OS << "\t.file\t" << FileNo << ' ';
682     PrintQuotedString(Filename, OS);
683     EmitEOL();
684   }
685   return this->MCStreamer::EmitDwarfFileDirective(FileNo, Filename);
686 }
687
688 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
689                                           unsigned Column, unsigned Flags,
690                                           unsigned Isa,
691                                           unsigned Discriminator,
692                                           StringRef FileName) {
693   this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
694                                           Isa, Discriminator, FileName);
695   if (!UseLoc)
696     return;
697
698   OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
699   if (Flags & DWARF2_FLAG_BASIC_BLOCK)
700     OS << " basic_block";
701   if (Flags & DWARF2_FLAG_PROLOGUE_END)
702     OS << " prologue_end";
703   if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
704     OS << " epilogue_begin";
705
706   unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
707   if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
708     OS << " is_stmt ";
709
710     if (Flags & DWARF2_FLAG_IS_STMT)
711       OS << "1";
712     else
713       OS << "0";
714   }
715
716   if (Isa)
717     OS << "isa " << Isa;
718   if (Discriminator)
719     OS << "discriminator " << Discriminator;
720
721   if (IsVerboseAsm) {
722     OS.PadToColumn(MAI.getCommentColumn());
723     OS << MAI.getCommentString() << ' ' << FileName << ':' 
724        << Line << ':' << Column;
725   }
726   EmitEOL();
727 }
728
729 void MCAsmStreamer::EmitCFIStartProc() {
730   MCStreamer::EmitCFIStartProc();
731
732   OS << "\t.cfi_startproc";
733   EmitEOL();
734 }
735
736 void MCAsmStreamer::EmitCFIEndProc() {
737   MCStreamer::EmitCFIEndProc();
738
739   OS << "\t.cfi_endproc";
740   EmitEOL();
741 }
742
743 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
744   MCStreamer::EmitCFIDefCfa(Register, Offset);
745
746   OS << ".cfi_def_cfa " << Register << ", " << Offset;
747   EmitEOL();
748 }
749
750 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
751   MCStreamer::EmitCFIDefCfaOffset(Offset);
752
753   OS << "\t.cfi_def_cfa_offset " << Offset;
754   EmitEOL();
755 }
756
757 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
758   MCStreamer::EmitCFIDefCfaRegister(Register);
759
760   OS << "\t.cfi_def_cfa_register " << Register;
761   EmitEOL();
762 }
763
764 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
765   this->MCStreamer::EmitCFIOffset(Register, Offset);
766
767   OS << "\t.cfi_offset " << Register << ", " << Offset;
768   EmitEOL();
769 }
770
771 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
772                                        unsigned Encoding) {
773   MCStreamer::EmitCFIPersonality(Sym, Encoding);
774
775   OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
776   EmitEOL();
777 }
778
779 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
780   MCStreamer::EmitCFILsda(Sym, Encoding);
781
782   OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
783   EmitEOL();
784 }
785
786 void MCAsmStreamer::EmitCFIRememberState() {
787   MCStreamer::EmitCFIRememberState();
788
789   OS << "\t.cfi_remember_state";
790   EmitEOL();
791 }
792
793 void MCAsmStreamer::EmitCFIRestoreState() {
794   MCStreamer::EmitCFIRestoreState();
795
796   OS << "\t.cfi_restore_state";
797   EmitEOL();
798 }
799
800 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
801   MCStreamer::EmitCFISameValue(Register);
802
803   OS << "\t.cfi_same_value " << Register;
804   EmitEOL();
805 }
806
807 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
808   MCStreamer::EmitCFIRelOffset(Register, Offset);
809
810   OS << "\t.cfi_rel_offset " << Register << ", " << Offset;
811   EmitEOL();
812 }
813
814 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
815   MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
816
817   OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
818   EmitEOL();
819 }
820
821 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
822   raw_ostream &OS = GetCommentOS();
823   SmallString<256> Code;
824   SmallVector<MCFixup, 4> Fixups;
825   raw_svector_ostream VecOS(Code);
826   Emitter->EncodeInstruction(Inst, VecOS, Fixups);
827   VecOS.flush();
828
829   // If we are showing fixups, create symbolic markers in the encoded
830   // representation. We do this by making a per-bit map to the fixup item index,
831   // then trying to display it as nicely as possible.
832   SmallVector<uint8_t, 64> FixupMap;
833   FixupMap.resize(Code.size() * 8);
834   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
835     FixupMap[i] = 0;
836
837   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
838     MCFixup &F = Fixups[i];
839     const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
840     for (unsigned j = 0; j != Info.TargetSize; ++j) {
841       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
842       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
843       FixupMap[Index] = 1 + i;
844     }
845   }
846
847   // FIXME: Node the fixup comments for Thumb2 are completely bogus since the
848   // high order halfword of a 32-bit Thumb2 instruction is emitted first.
849   OS << "encoding: [";
850   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
851     if (i)
852       OS << ',';
853
854     // See if all bits are the same map entry.
855     uint8_t MapEntry = FixupMap[i * 8 + 0];
856     for (unsigned j = 1; j != 8; ++j) {
857       if (FixupMap[i * 8 + j] == MapEntry)
858         continue;
859
860       MapEntry = uint8_t(~0U);
861       break;
862     }
863
864     if (MapEntry != uint8_t(~0U)) {
865       if (MapEntry == 0) {
866         OS << format("0x%02x", uint8_t(Code[i]));
867       } else {
868         if (Code[i]) {
869           // FIXME: Some of the 8 bits require fix up.
870           OS << format("0x%02x", uint8_t(Code[i])) << '\''
871              << char('A' + MapEntry - 1) << '\'';
872         } else
873           OS << char('A' + MapEntry - 1);
874       }
875     } else {
876       // Otherwise, write out in binary.
877       OS << "0b";
878       for (unsigned j = 8; j--;) {
879         unsigned Bit = (Code[i] >> j) & 1;
880
881         unsigned FixupBit;
882         if (getContext().getTargetAsmInfo().isLittleEndian())
883           FixupBit = i * 8 + j;
884         else
885           FixupBit = i * 8 + (7-j);
886
887         if (uint8_t MapEntry = FixupMap[FixupBit]) {
888           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
889           OS << char('A' + MapEntry - 1);
890         } else
891           OS << Bit;
892       }
893     }
894   }
895   OS << "]\n";
896
897   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
898     MCFixup &F = Fixups[i];
899     const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
900     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
901        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
902   }
903 }
904
905 void MCAsmStreamer::EmitFnStart() {
906   OS << "\t.fnstart";
907   EmitEOL();
908 }
909
910 void MCAsmStreamer::EmitFnEnd() {
911   OS << "\t.fnend";
912   EmitEOL();
913 }
914
915 void MCAsmStreamer::EmitCantUnwind() {
916   OS << "\t.cantunwind";
917   EmitEOL();
918 }
919
920 void MCAsmStreamer::EmitHandlerData() {
921   OS << "\t.handlerdata";
922   EmitEOL();
923 }
924
925 void MCAsmStreamer::EmitPersonality(const MCSymbol *Personality) {
926   OS << "\t.personality " << Personality->getName();
927   EmitEOL();
928 }
929
930 void MCAsmStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
931   OS << "\t.setfp\t" << InstPrinter->getRegName(FpReg)
932      << ", "        << InstPrinter->getRegName(SpReg);
933   if (Offset)
934     OS << ", #" << Offset;
935   EmitEOL();
936 }
937
938 void MCAsmStreamer::EmitPad(int64_t Offset) {
939   OS << "\t.pad\t#" << Offset;
940   EmitEOL();
941 }
942
943 void MCAsmStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
944                                 bool isVector) {
945   assert(RegList.size() && "RegList should not be empty");
946   if (isVector)
947     OS << "\t.vsave\t{";
948   else
949     OS << "\t.save\t{";
950
951   OS << InstPrinter->getRegName(RegList[0]);
952
953   for (unsigned i = 1, e = RegList.size(); i != e; ++i)
954     OS << ", " << InstPrinter->getRegName(RegList[i]);
955
956   OS << "}";
957   EmitEOL();
958 }
959
960 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
961   assert(getCurrentSection() && "Cannot emit contents before setting section!");
962
963   // Show the encoding in a comment if we have a code emitter.
964   if (Emitter)
965     AddEncodingComment(Inst);
966
967   // Show the MCInst if enabled.
968   if (ShowInst) {
969     Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
970     GetCommentOS() << "\n";
971   }
972
973   // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
974   if (InstPrinter)
975     InstPrinter->printInst(&Inst, OS);
976   else
977     Inst.print(OS, &MAI);
978   EmitEOL();
979 }
980
981 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
982 /// the specified string in the output .s file.  This capability is
983 /// indicated by the hasRawTextSupport() predicate.
984 void MCAsmStreamer::EmitRawText(StringRef String) {
985   if (!String.empty() && String.back() == '\n')
986     String = String.substr(0, String.size()-1);
987   OS << String;
988   EmitEOL();
989 }
990
991 void MCAsmStreamer::Finish() {
992   // Dump out the dwarf file & directory tables and line tables.
993   if (getContext().hasDwarfFiles() && !UseLoc)
994     MCDwarfFileTable::Emit(this);
995 }
996
997 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
998                                     formatted_raw_ostream &OS,
999                                     bool isVerboseAsm, bool useLoc,
1000                                     MCInstPrinter *IP, MCCodeEmitter *CE,
1001                                     TargetAsmBackend *TAB, bool ShowInst) {
1002   return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc,
1003                            IP, CE, TAB, ShowInst);
1004 }