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