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