1 //===- lib/MC/MCAsmStreamer.cpp - Text Assembly Output --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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"
35 class MCAsmStreamer : public MCStreamer {
36 formatted_raw_ostream &OS;
38 OwningPtr<MCInstPrinter> InstPrinter;
39 OwningPtr<MCCodeEmitter> Emitter;
40 OwningPtr<TargetAsmBackend> AsmBackend;
42 SmallString<128> CommentToEmit;
43 raw_svector_ostream CommentStream;
45 unsigned IsVerboseAsm : 1;
46 unsigned ShowInst : 1;
50 enum EHSymbolFlags { EHGlobal = 1,
51 EHWeakDefinition = 1 << 1,
52 EHPrivateExtern = 1 << 2 };
53 DenseMap<const MCSymbol*, unsigned> FlagMap;
55 bool needsSet(const MCExpr *Value);
58 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
59 bool isVerboseAsm, bool useLoc, bool useCFI,
60 MCInstPrinter *printer, MCCodeEmitter *emitter,
61 TargetAsmBackend *asmbackend,
63 : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
64 InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
65 CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
66 ShowInst(showInst), UseLoc(useLoc), UseCFI(useCFI) {
67 if (InstPrinter && IsVerboseAsm)
68 InstPrinter->setCommentStream(CommentStream);
72 inline void EmitEOL() {
73 // If we don't have any comments, just emit a \n.
80 void EmitCommentsAndEOL();
82 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
84 virtual bool isVerboseAsm() const { return IsVerboseAsm; }
86 /// hasRawTextSupport - We support EmitRawText.
87 virtual bool hasRawTextSupport() const { return true; }
89 /// AddComment - Add a comment that can be emitted to the generated .s
90 /// file if applicable as a QoI issue to make the output of the compiler
91 /// more readable. This only affects the MCAsmStreamer, and only when
92 /// verbose assembly output is enabled.
93 virtual void AddComment(const Twine &T);
95 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
96 virtual void AddEncodingComment(const MCInst &Inst);
98 /// GetCommentOS - Return a raw_ostream that comments can be written to.
99 /// Unlike AddComment, you are required to terminate comments with \n if you
101 virtual raw_ostream &GetCommentOS() {
103 return nulls(); // Discard comments unless in verbose asm mode.
104 return CommentStream;
107 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
108 virtual void AddBlankLine() {
112 /// @name MCStreamer Interface
115 virtual void ChangeSection(const MCSection *Section);
117 virtual void InitSections() {
118 // FIXME, this is MachO specific, but the testsuite
120 SwitchSection(getContext().getMachOSection("__TEXT", "__text",
121 MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
122 0, SectionKind::getText()));
125 virtual void EmitLabel(MCSymbol *Symbol);
126 virtual void EmitEHSymAttributes(const MCSymbol *Symbol,
128 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
129 virtual void EmitThumbFunc(MCSymbol *Func);
131 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
132 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
133 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
134 const MCSymbol *LastLabel,
135 const MCSymbol *Label);
136 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
137 const MCSymbol *Label);
139 virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
141 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
142 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
143 virtual void EmitCOFFSymbolStorageClass(int StorageClass);
144 virtual void EmitCOFFSymbolType(int Type);
145 virtual void EndCOFFSymbolDef();
146 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
147 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
148 unsigned ByteAlignment);
150 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
152 /// @param Symbol - The common symbol to emit.
153 /// @param Size - The size of the common symbol.
154 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
156 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
157 unsigned Size = 0, unsigned ByteAlignment = 0);
159 virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
160 uint64_t Size, unsigned ByteAlignment = 0);
162 virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
164 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
166 virtual void EmitIntValue(uint64_t Value, unsigned Size,
167 unsigned AddrSpace = 0);
169 virtual void EmitULEB128Value(const MCExpr *Value);
171 virtual void EmitSLEB128Value(const MCExpr *Value);
173 virtual void EmitGPRel32Value(const MCExpr *Value);
176 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
179 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
180 unsigned ValueSize = 1,
181 unsigned MaxBytesToEmit = 0);
183 virtual void EmitCodeAlignment(unsigned ByteAlignment,
184 unsigned MaxBytesToEmit = 0);
186 virtual void EmitValueToOffset(const MCExpr *Offset,
187 unsigned char Value = 0);
189 virtual void EmitFileDirective(StringRef Filename);
190 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
191 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
192 unsigned Column, unsigned Flags,
193 unsigned Isa, unsigned Discriminator,
196 virtual void EmitCFISections(bool EH, bool Debug);
197 virtual void EmitCFIStartProc();
198 virtual void EmitCFIEndProc();
199 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
200 virtual void EmitCFIDefCfaOffset(int64_t Offset);
201 virtual void EmitCFIDefCfaRegister(int64_t Register);
202 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
203 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
204 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
205 virtual void EmitCFIRememberState();
206 virtual void EmitCFIRestoreState();
207 virtual void EmitCFISameValue(int64_t Register);
208 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
209 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
211 virtual void EmitWin64EHStartProc(MCSymbol *Symbol, MCSymbol *EHandler = 0);
212 virtual void EmitWin64EHEndProc();
213 virtual void EmitWin64EHPushReg(int64_t Register);
214 virtual void EmitWin64EHSetFrame(int64_t Register, int64_t Offset);
215 virtual void EmitWin64EHAllocStack(int64_t Size);
216 virtual void EmitWin64EHSaveReg(int64_t Register, int64_t Offset);
217 virtual void EmitWin64EHPushFrame(bool Code);
218 virtual void EmitWin64EHEndProlog();
220 virtual void EmitFnStart();
221 virtual void EmitFnEnd();
222 virtual void EmitCantUnwind();
223 virtual void EmitPersonality(const MCSymbol *Personality);
224 virtual void EmitHandlerData();
225 virtual void EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0);
226 virtual void EmitPad(int64_t Offset);
227 virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool);
230 virtual void EmitInstruction(const MCInst &Inst);
232 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
233 /// the specified string in the output .s file. This capability is
234 /// indicated by the hasRawTextSupport() predicate.
235 virtual void EmitRawText(StringRef String);
237 virtual void Finish();
242 } // end anonymous namespace.
244 /// AddComment - Add a comment that can be emitted to the generated .s
245 /// file if applicable as a QoI issue to make the output of the compiler
246 /// more readable. This only affects the MCAsmStreamer, and only when
247 /// verbose assembly output is enabled.
248 void MCAsmStreamer::AddComment(const Twine &T) {
249 if (!IsVerboseAsm) return;
251 // Make sure that CommentStream is flushed.
252 CommentStream.flush();
254 T.toVector(CommentToEmit);
255 // Each comment goes on its own line.
256 CommentToEmit.push_back('\n');
258 // Tell the comment stream that the vector changed underneath it.
259 CommentStream.resync();
262 void MCAsmStreamer::EmitCommentsAndEOL() {
263 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
268 CommentStream.flush();
269 StringRef Comments = CommentToEmit.str();
271 assert(Comments.back() == '\n' &&
272 "Comment array not newline terminated");
274 // Emit a line of comments.
275 OS.PadToColumn(MAI.getCommentColumn());
276 size_t Position = Comments.find('\n');
277 OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
279 Comments = Comments.substr(Position+1);
280 } while (!Comments.empty());
282 CommentToEmit.clear();
283 // Tell the comment stream that the vector changed underneath it.
284 CommentStream.resync();
287 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
288 assert(Bytes && "Invalid size!");
289 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
292 void MCAsmStreamer::ChangeSection(const MCSection *Section) {
293 assert(Section && "Cannot switch to a null section!");
294 Section->PrintSwitchToSection(MAI, OS);
297 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
298 MCSymbol *EHSymbol) {
302 unsigned Flags = FlagMap.lookup(Symbol);
304 if (Flags & EHGlobal)
305 EmitSymbolAttribute(EHSymbol, MCSA_Global);
306 if (Flags & EHWeakDefinition)
307 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
308 if (Flags & EHPrivateExtern)
309 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
312 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
313 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
314 MCStreamer::EmitLabel(Symbol);
316 OS << *Symbol << MAI.getLabelSuffix();
320 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
322 default: assert(0 && "Invalid flag!");
323 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
324 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
325 case MCAF_Code16: OS << "\t.code\t16"; break;
326 case MCAF_Code32: OS << "\t.code\t32"; break;
331 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
332 // This needs to emit to a temporary string to get properly quoted
333 // MCSymbols when they have spaces in them.
334 OS << "\t.thumb_func";
335 // Only Mach-O hasSubsectionsViaSymbols()
336 if (MAI.hasSubsectionsViaSymbols())
341 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
342 OS << *Symbol << " = " << *Value;
345 // FIXME: Lift context changes into super class.
346 Symbol->setVariableValue(Value);
349 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
350 OS << ".weakref " << *Alias << ", " << *Symbol;
354 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
355 const MCSymbol *LastLabel,
356 const MCSymbol *Label) {
357 EmitDwarfSetLineAddr(LineDelta, Label,
358 getContext().getTargetAsmInfo().getPointerSize());
361 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
362 const MCSymbol *Label) {
363 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
364 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
365 AddrDelta = ForceExpAbs(this, getContext(), AddrDelta);
366 EmitValue(AddrDelta, 4);
370 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
371 MCSymbolAttr Attribute) {
373 case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
374 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
375 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
376 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
377 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
378 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
379 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
380 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
381 assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
382 OS << "\t.type\t" << *Symbol << ','
383 << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
385 default: assert(0 && "Unknown ELF .type");
386 case MCSA_ELF_TypeFunction: OS << "function"; break;
387 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
388 case MCSA_ELF_TypeObject: OS << "object"; break;
389 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
390 case MCSA_ELF_TypeCommon: OS << "common"; break;
391 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
392 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
396 case MCSA_Global: // .globl/.global
397 OS << MAI.getGlobalDirective();
398 FlagMap[Symbol] |= EHGlobal;
400 case MCSA_Hidden: OS << "\t.hidden\t"; break;
401 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
402 case MCSA_Internal: OS << "\t.internal\t"; break;
403 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
404 case MCSA_Local: OS << "\t.local\t"; break;
405 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
406 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
407 case MCSA_PrivateExtern:
408 OS << "\t.private_extern\t";
409 FlagMap[Symbol] |= EHPrivateExtern;
411 case MCSA_Protected: OS << "\t.protected\t"; break;
412 case MCSA_Reference: OS << "\t.reference\t"; break;
413 case MCSA_Weak: OS << "\t.weak\t"; break;
414 case MCSA_WeakDefinition:
415 OS << "\t.weak_definition\t";
416 FlagMap[Symbol] |= EHWeakDefinition;
419 case MCSA_WeakReference: OS << MAI.getWeakRefDirective(); break;
420 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
427 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
428 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
432 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
433 OS << "\t.def\t " << *Symbol << ';';
437 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
438 OS << "\t.scl\t" << StorageClass << ';';
442 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
443 OS << "\t.type\t" << Type << ';';
447 void MCAsmStreamer::EndCOFFSymbolDef() {
452 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
453 assert(MAI.hasDotTypeDotSizeDirective());
454 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
457 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
458 unsigned ByteAlignment) {
459 OS << "\t.comm\t" << *Symbol << ',' << Size;
460 if (ByteAlignment != 0) {
461 if (MAI.getCOMMDirectiveAlignmentIsInBytes())
462 OS << ',' << ByteAlignment;
464 OS << ',' << Log2_32(ByteAlignment);
469 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
471 /// @param Symbol - The common symbol to emit.
472 /// @param Size - The size of the common symbol.
473 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
474 assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
475 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
479 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
480 unsigned Size, unsigned ByteAlignment) {
481 // Note: a .zerofill directive does not switch sections.
484 // This is a mach-o specific directive.
485 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
486 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
488 if (Symbol != NULL) {
489 OS << ',' << *Symbol << ',' << Size;
490 if (ByteAlignment != 0)
491 OS << ',' << Log2_32(ByteAlignment);
496 // .tbss sym, size, align
497 // This depends that the symbol has already been mangled from the original,
499 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
500 uint64_t Size, unsigned ByteAlignment) {
501 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
502 // Instead of using the Section we'll just use the shortcut.
503 // This is a mach-o specific directive and section.
504 OS << ".tbss " << *Symbol << ", " << Size;
506 // Output align if we have it. We default to 1 so don't bother printing
508 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
513 static inline char toOctal(int X) { return (X&7)+'0'; }
515 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
518 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
519 unsigned char C = Data[i];
520 if (C == '"' || C == '\\') {
521 OS << '\\' << (char)C;
525 if (isprint((unsigned char)C)) {
531 case '\b': OS << "\\b"; break;
532 case '\f': OS << "\\f"; break;
533 case '\n': OS << "\\n"; break;
534 case '\r': OS << "\\r"; break;
535 case '\t': OS << "\\t"; break;
538 OS << toOctal(C >> 6);
539 OS << toOctal(C >> 3);
540 OS << toOctal(C >> 0);
549 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
550 assert(getCurrentSection() && "Cannot emit contents before setting section!");
551 if (Data.empty()) return;
553 if (Data.size() == 1) {
554 OS << MAI.getData8bitsDirective(AddrSpace);
555 OS << (unsigned)(unsigned char)Data[0];
560 // If the data ends with 0 and the target supports .asciz, use it, otherwise
562 if (MAI.getAscizDirective() && Data.back() == 0) {
563 OS << MAI.getAscizDirective();
564 Data = Data.substr(0, Data.size()-1);
566 OS << MAI.getAsciiDirective();
570 PrintQuotedString(Data, OS);
574 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
575 unsigned AddrSpace) {
576 EmitValue(MCConstantExpr::Create(Value, getContext()), Size, AddrSpace);
579 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
580 unsigned AddrSpace) {
581 assert(getCurrentSection() && "Cannot emit contents before setting section!");
582 const char *Directive = 0;
585 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
586 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
587 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
589 Directive = MAI.getData64bitsDirective(AddrSpace);
590 // If the target doesn't support 64-bit data, emit as two 32-bit halves.
591 if (Directive) break;
593 if (!Value->EvaluateAsAbsolute(IntValue))
594 report_fatal_error("Don't know how to emit this value.");
595 if (getContext().getTargetAsmInfo().isLittleEndian()) {
596 EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
597 EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
599 EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
600 EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
605 assert(Directive && "Invalid size for machine code value!");
606 OS << Directive << *Value;
610 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
612 if (Value->EvaluateAsAbsolute(IntValue)) {
613 EmitULEB128IntValue(IntValue);
616 assert(MAI.hasLEB128() && "Cannot print a .uleb");
617 OS << ".uleb128 " << *Value;
621 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
623 if (Value->EvaluateAsAbsolute(IntValue)) {
624 EmitSLEB128IntValue(IntValue);
627 assert(MAI.hasLEB128() && "Cannot print a .sleb");
628 OS << ".sleb128 " << *Value;
632 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
633 assert(MAI.getGPRel32Directive() != 0);
634 OS << MAI.getGPRel32Directive() << *Value;
639 /// EmitFill - Emit NumBytes bytes worth of the value specified by
640 /// FillValue. This implements directives such as '.space'.
641 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
642 unsigned AddrSpace) {
643 if (NumBytes == 0) return;
646 if (const char *ZeroDirective = MAI.getZeroDirective()) {
647 OS << ZeroDirective << NumBytes;
649 OS << ',' << (int)FillValue;
654 // Emit a byte at a time.
655 MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
658 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
660 unsigned MaxBytesToEmit) {
661 // Some assemblers don't support non-power of two alignments, so we always
662 // emit alignments as a power of two if possible.
663 if (isPowerOf2_32(ByteAlignment)) {
665 default: llvm_unreachable("Invalid size for machine code value!");
666 case 1: OS << MAI.getAlignDirective(); break;
667 // FIXME: use MAI for this!
668 case 2: OS << ".p2alignw "; break;
669 case 4: OS << ".p2alignl "; break;
670 case 8: llvm_unreachable("Unsupported alignment size!");
673 if (MAI.getAlignmentIsInBytes())
676 OS << Log2_32(ByteAlignment);
678 if (Value || MaxBytesToEmit) {
680 OS.write_hex(truncateToSize(Value, ValueSize));
683 OS << ", " << MaxBytesToEmit;
689 // Non-power of two alignment. This is not widely supported by assemblers.
690 // FIXME: Parameterize this based on MAI.
692 default: llvm_unreachable("Invalid size for machine code value!");
693 case 1: OS << ".balign"; break;
694 case 2: OS << ".balignw"; break;
695 case 4: OS << ".balignl"; break;
696 case 8: llvm_unreachable("Unsupported alignment size!");
699 OS << ' ' << ByteAlignment;
700 OS << ", " << truncateToSize(Value, ValueSize);
702 OS << ", " << MaxBytesToEmit;
706 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
707 unsigned MaxBytesToEmit) {
708 // Emit with a text fill value.
709 EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
713 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
714 unsigned char Value) {
715 // FIXME: Verify that Offset is associated with the current section.
716 OS << ".org " << *Offset << ", " << (unsigned) Value;
721 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
722 assert(MAI.hasSingleParameterDotFile());
724 PrintQuotedString(Filename, OS);
728 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
730 OS << "\t.file\t" << FileNo << ' ';
731 PrintQuotedString(Filename, OS);
734 return this->MCStreamer::EmitDwarfFileDirective(FileNo, Filename);
737 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
738 unsigned Column, unsigned Flags,
740 unsigned Discriminator,
741 StringRef FileName) {
742 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
743 Isa, Discriminator, FileName);
747 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
748 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
749 OS << " basic_block";
750 if (Flags & DWARF2_FLAG_PROLOGUE_END)
751 OS << " prologue_end";
752 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
753 OS << " epilogue_begin";
755 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
756 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
759 if (Flags & DWARF2_FLAG_IS_STMT)
768 OS << "discriminator " << Discriminator;
771 OS.PadToColumn(MAI.getCommentColumn());
772 OS << MAI.getCommentString() << ' ' << FileName << ':'
773 << Line << ':' << Column;
778 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
779 MCStreamer::EmitCFISections(EH, Debug);
784 OS << "\t.cfi_sections ";
788 OS << ", .debug_frame";
790 OS << ".debug_frame";
796 void MCAsmStreamer::EmitCFIStartProc() {
797 MCStreamer::EmitCFIStartProc();
802 OS << "\t.cfi_startproc";
806 void MCAsmStreamer::EmitCFIEndProc() {
807 MCStreamer::EmitCFIEndProc();
812 OS << "\t.cfi_endproc";
816 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
817 MCStreamer::EmitCFIDefCfa(Register, Offset);
822 OS << ".cfi_def_cfa " << Register << ", " << Offset;
826 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
827 MCStreamer::EmitCFIDefCfaOffset(Offset);
832 OS << "\t.cfi_def_cfa_offset " << Offset;
836 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
837 MCStreamer::EmitCFIDefCfaRegister(Register);
842 OS << "\t.cfi_def_cfa_register " << Register;
846 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
847 this->MCStreamer::EmitCFIOffset(Register, Offset);
852 OS << "\t.cfi_offset " << Register << ", " << Offset;
856 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
858 MCStreamer::EmitCFIPersonality(Sym, Encoding);
863 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
867 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
868 MCStreamer::EmitCFILsda(Sym, Encoding);
873 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
877 void MCAsmStreamer::EmitCFIRememberState() {
878 MCStreamer::EmitCFIRememberState();
883 OS << "\t.cfi_remember_state";
887 void MCAsmStreamer::EmitCFIRestoreState() {
888 MCStreamer::EmitCFIRestoreState();
893 OS << "\t.cfi_restore_state";
897 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
898 MCStreamer::EmitCFISameValue(Register);
903 OS << "\t.cfi_same_value " << Register;
907 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
908 MCStreamer::EmitCFIRelOffset(Register, Offset);
913 OS << "\t.cfi_rel_offset " << Register << ", " << Offset;
917 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
918 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
923 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
927 void MCAsmStreamer::EmitWin64EHStartProc(MCSymbol *Symbol, MCSymbol *EHandler)
929 //MCStreamer::EmitWin64EHStartProc(Symbol, EHandler);
931 OS << ".w64_startproc " << *Symbol;
933 OS << ", " << *EHandler;
937 void MCAsmStreamer::EmitWin64EHEndProc()
939 //MCStreamer::EmitWin64EHEndProc();
941 OS << "\t.w64_endproc";
945 void MCAsmStreamer::EmitWin64EHPushReg(int64_t Register)
947 //MCStreamer::EmitWin64EHPushReg(Register);
949 OS << "\t.w64_pushreg " << Register;
953 void MCAsmStreamer::EmitWin64EHSetFrame(int64_t Register, int64_t Offset)
955 //MCStreamer::EmitWin64EHSetFrame(Register, Offset);
957 OS << "\t.w64_setframe " << Register << ", " << Offset;
961 void MCAsmStreamer::EmitWin64EHAllocStack(int64_t Size)
963 //MCStremaer::EmitWin64EHAllocStack(Size);
965 OS << "\t.w64_allocstack " << Size;
969 void MCAsmStreamer::EmitWin64EHSaveReg(int64_t Register, int64_t Offset)
971 //MCStreamer::EmitWin64EHSaveReg(Register, Offset)
973 OS << "\t.w64_savereg " << Register << ", " << Offset;
977 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code)
979 //MCStreamer::EmitWin64EHPushFrame(Code);
981 OS << "\t.w64_pushframe";
987 void MCAsmStreamer::EmitWin64EHEndProlog(void)
989 //MCStreamer::EmitWin64EHEndProlog();
991 OS << "\t.w64_endprolog";
995 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
996 raw_ostream &OS = GetCommentOS();
997 SmallString<256> Code;
998 SmallVector<MCFixup, 4> Fixups;
999 raw_svector_ostream VecOS(Code);
1000 Emitter->EncodeInstruction(Inst, VecOS, Fixups);
1003 // If we are showing fixups, create symbolic markers in the encoded
1004 // representation. We do this by making a per-bit map to the fixup item index,
1005 // then trying to display it as nicely as possible.
1006 SmallVector<uint8_t, 64> FixupMap;
1007 FixupMap.resize(Code.size() * 8);
1008 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1011 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1012 MCFixup &F = Fixups[i];
1013 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1014 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1015 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1016 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1017 FixupMap[Index] = 1 + i;
1021 // FIXME: Node the fixup comments for Thumb2 are completely bogus since the
1022 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1023 OS << "encoding: [";
1024 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1028 // See if all bits are the same map entry.
1029 uint8_t MapEntry = FixupMap[i * 8 + 0];
1030 for (unsigned j = 1; j != 8; ++j) {
1031 if (FixupMap[i * 8 + j] == MapEntry)
1034 MapEntry = uint8_t(~0U);
1038 if (MapEntry != uint8_t(~0U)) {
1039 if (MapEntry == 0) {
1040 OS << format("0x%02x", uint8_t(Code[i]));
1043 // FIXME: Some of the 8 bits require fix up.
1044 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1045 << char('A' + MapEntry - 1) << '\'';
1047 OS << char('A' + MapEntry - 1);
1050 // Otherwise, write out in binary.
1052 for (unsigned j = 8; j--;) {
1053 unsigned Bit = (Code[i] >> j) & 1;
1056 if (getContext().getTargetAsmInfo().isLittleEndian())
1057 FixupBit = i * 8 + j;
1059 FixupBit = i * 8 + (7-j);
1061 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1062 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1063 OS << char('A' + MapEntry - 1);
1071 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1072 MCFixup &F = Fixups[i];
1073 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1074 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1075 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1079 void MCAsmStreamer::EmitFnStart() {
1084 void MCAsmStreamer::EmitFnEnd() {
1089 void MCAsmStreamer::EmitCantUnwind() {
1090 OS << "\t.cantunwind";
1094 void MCAsmStreamer::EmitHandlerData() {
1095 OS << "\t.handlerdata";
1099 void MCAsmStreamer::EmitPersonality(const MCSymbol *Personality) {
1100 OS << "\t.personality " << Personality->getName();
1104 void MCAsmStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
1105 OS << "\t.setfp\t" << InstPrinter->getRegName(FpReg)
1106 << ", " << InstPrinter->getRegName(SpReg);
1108 OS << ", #" << Offset;
1112 void MCAsmStreamer::EmitPad(int64_t Offset) {
1113 OS << "\t.pad\t#" << Offset;
1117 void MCAsmStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
1119 assert(RegList.size() && "RegList should not be empty");
1121 OS << "\t.vsave\t{";
1125 OS << InstPrinter->getRegName(RegList[0]);
1127 for (unsigned i = 1, e = RegList.size(); i != e; ++i)
1128 OS << ", " << InstPrinter->getRegName(RegList[i]);
1134 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
1135 assert(getCurrentSection() && "Cannot emit contents before setting section!");
1137 // Show the encoding in a comment if we have a code emitter.
1139 AddEncodingComment(Inst);
1141 // Show the MCInst if enabled.
1143 Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
1144 GetCommentOS() << "\n";
1147 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1149 InstPrinter->printInst(&Inst, OS);
1151 Inst.print(OS, &MAI);
1155 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1156 /// the specified string in the output .s file. This capability is
1157 /// indicated by the hasRawTextSupport() predicate.
1158 void MCAsmStreamer::EmitRawText(StringRef String) {
1159 if (!String.empty() && String.back() == '\n')
1160 String = String.substr(0, String.size()-1);
1165 void MCAsmStreamer::Finish() {
1166 // Dump out the dwarf file & directory tables and line tables.
1167 if (getContext().hasDwarfFiles() && !UseLoc)
1168 MCDwarfFileTable::Emit(this);
1174 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1175 formatted_raw_ostream &OS,
1176 bool isVerboseAsm, bool useLoc,
1178 MCInstPrinter *IP, MCCodeEmitter *CE,
1179 TargetAsmBackend *TAB, bool ShowInst) {
1180 return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc, useCFI,
1181 IP, CE, TAB, ShowInst);