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);
212 virtual void EmitWin64EHEndProc();
213 virtual void EmitWin64EHStartChained();
214 virtual void EmitWin64EHEndChained();
215 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
217 virtual void EmitWin64EHHandlerData();
218 virtual void EmitWin64EHPushReg(unsigned Register);
219 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
220 virtual void EmitWin64EHAllocStack(unsigned Size);
221 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
222 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
223 virtual void EmitWin64EHPushFrame(bool Code);
224 virtual void EmitWin64EHEndProlog();
226 virtual void EmitFnStart();
227 virtual void EmitFnEnd();
228 virtual void EmitCantUnwind();
229 virtual void EmitPersonality(const MCSymbol *Personality);
230 virtual void EmitHandlerData();
231 virtual void EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0);
232 virtual void EmitPad(int64_t Offset);
233 virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool);
236 virtual void EmitInstruction(const MCInst &Inst);
238 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
239 /// the specified string in the output .s file. This capability is
240 /// indicated by the hasRawTextSupport() predicate.
241 virtual void EmitRawText(StringRef String);
243 virtual void Finish();
248 } // end anonymous namespace.
250 /// AddComment - Add a comment that can be emitted to the generated .s
251 /// file if applicable as a QoI issue to make the output of the compiler
252 /// more readable. This only affects the MCAsmStreamer, and only when
253 /// verbose assembly output is enabled.
254 void MCAsmStreamer::AddComment(const Twine &T) {
255 if (!IsVerboseAsm) return;
257 // Make sure that CommentStream is flushed.
258 CommentStream.flush();
260 T.toVector(CommentToEmit);
261 // Each comment goes on its own line.
262 CommentToEmit.push_back('\n');
264 // Tell the comment stream that the vector changed underneath it.
265 CommentStream.resync();
268 void MCAsmStreamer::EmitCommentsAndEOL() {
269 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
274 CommentStream.flush();
275 StringRef Comments = CommentToEmit.str();
277 assert(Comments.back() == '\n' &&
278 "Comment array not newline terminated");
280 // Emit a line of comments.
281 OS.PadToColumn(MAI.getCommentColumn());
282 size_t Position = Comments.find('\n');
283 OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
285 Comments = Comments.substr(Position+1);
286 } while (!Comments.empty());
288 CommentToEmit.clear();
289 // Tell the comment stream that the vector changed underneath it.
290 CommentStream.resync();
293 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
294 assert(Bytes && "Invalid size!");
295 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
298 void MCAsmStreamer::ChangeSection(const MCSection *Section) {
299 assert(Section && "Cannot switch to a null section!");
300 Section->PrintSwitchToSection(MAI, OS);
303 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
304 MCSymbol *EHSymbol) {
308 unsigned Flags = FlagMap.lookup(Symbol);
310 if (Flags & EHGlobal)
311 EmitSymbolAttribute(EHSymbol, MCSA_Global);
312 if (Flags & EHWeakDefinition)
313 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
314 if (Flags & EHPrivateExtern)
315 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
318 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
319 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
320 MCStreamer::EmitLabel(Symbol);
322 OS << *Symbol << MAI.getLabelSuffix();
326 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
328 default: assert(0 && "Invalid flag!");
329 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
330 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
331 case MCAF_Code16: OS << "\t.code\t16"; break;
332 case MCAF_Code32: OS << "\t.code\t32"; break;
337 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
338 // This needs to emit to a temporary string to get properly quoted
339 // MCSymbols when they have spaces in them.
340 OS << "\t.thumb_func";
341 // Only Mach-O hasSubsectionsViaSymbols()
342 if (MAI.hasSubsectionsViaSymbols())
347 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
348 OS << *Symbol << " = " << *Value;
351 // FIXME: Lift context changes into super class.
352 Symbol->setVariableValue(Value);
355 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
356 OS << ".weakref " << *Alias << ", " << *Symbol;
360 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
361 const MCSymbol *LastLabel,
362 const MCSymbol *Label) {
363 EmitDwarfSetLineAddr(LineDelta, Label,
364 getContext().getTargetAsmInfo().getPointerSize());
367 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
368 const MCSymbol *Label) {
369 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
370 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
371 AddrDelta = ForceExpAbs(AddrDelta);
372 EmitValue(AddrDelta, 4);
376 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
377 MCSymbolAttr Attribute) {
379 case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
380 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
381 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
382 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
383 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
384 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
385 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
386 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
387 assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
388 OS << "\t.type\t" << *Symbol << ','
389 << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
391 default: assert(0 && "Unknown ELF .type");
392 case MCSA_ELF_TypeFunction: OS << "function"; break;
393 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
394 case MCSA_ELF_TypeObject: OS << "object"; break;
395 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
396 case MCSA_ELF_TypeCommon: OS << "common"; break;
397 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
398 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
402 case MCSA_Global: // .globl/.global
403 OS << MAI.getGlobalDirective();
404 FlagMap[Symbol] |= EHGlobal;
406 case MCSA_Hidden: OS << "\t.hidden\t"; break;
407 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
408 case MCSA_Internal: OS << "\t.internal\t"; break;
409 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
410 case MCSA_Local: OS << "\t.local\t"; break;
411 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
412 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
413 case MCSA_PrivateExtern:
414 OS << "\t.private_extern\t";
415 FlagMap[Symbol] |= EHPrivateExtern;
417 case MCSA_Protected: OS << "\t.protected\t"; break;
418 case MCSA_Reference: OS << "\t.reference\t"; break;
419 case MCSA_Weak: OS << "\t.weak\t"; break;
420 case MCSA_WeakDefinition:
421 OS << "\t.weak_definition\t";
422 FlagMap[Symbol] |= EHWeakDefinition;
425 case MCSA_WeakReference: OS << MAI.getWeakRefDirective(); break;
426 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
433 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
434 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
438 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
439 OS << "\t.def\t " << *Symbol << ';';
443 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
444 OS << "\t.scl\t" << StorageClass << ';';
448 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
449 OS << "\t.type\t" << Type << ';';
453 void MCAsmStreamer::EndCOFFSymbolDef() {
458 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
459 assert(MAI.hasDotTypeDotSizeDirective());
460 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
463 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
464 unsigned ByteAlignment) {
465 OS << "\t.comm\t" << *Symbol << ',' << Size;
466 if (ByteAlignment != 0) {
467 if (MAI.getCOMMDirectiveAlignmentIsInBytes())
468 OS << ',' << ByteAlignment;
470 OS << ',' << Log2_32(ByteAlignment);
475 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
477 /// @param Symbol - The common symbol to emit.
478 /// @param Size - The size of the common symbol.
479 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
480 assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
481 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
485 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
486 unsigned Size, unsigned ByteAlignment) {
487 // Note: a .zerofill directive does not switch sections.
490 // This is a mach-o specific directive.
491 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
492 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
494 if (Symbol != NULL) {
495 OS << ',' << *Symbol << ',' << Size;
496 if (ByteAlignment != 0)
497 OS << ',' << Log2_32(ByteAlignment);
502 // .tbss sym, size, align
503 // This depends that the symbol has already been mangled from the original,
505 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
506 uint64_t Size, unsigned ByteAlignment) {
507 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
508 // Instead of using the Section we'll just use the shortcut.
509 // This is a mach-o specific directive and section.
510 OS << ".tbss " << *Symbol << ", " << Size;
512 // Output align if we have it. We default to 1 so don't bother printing
514 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
519 static inline char toOctal(int X) { return (X&7)+'0'; }
521 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
524 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
525 unsigned char C = Data[i];
526 if (C == '"' || C == '\\') {
527 OS << '\\' << (char)C;
531 if (isprint((unsigned char)C)) {
537 case '\b': OS << "\\b"; break;
538 case '\f': OS << "\\f"; break;
539 case '\n': OS << "\\n"; break;
540 case '\r': OS << "\\r"; break;
541 case '\t': OS << "\\t"; break;
544 OS << toOctal(C >> 6);
545 OS << toOctal(C >> 3);
546 OS << toOctal(C >> 0);
555 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
556 assert(getCurrentSection() && "Cannot emit contents before setting section!");
557 if (Data.empty()) return;
559 if (Data.size() == 1) {
560 OS << MAI.getData8bitsDirective(AddrSpace);
561 OS << (unsigned)(unsigned char)Data[0];
566 // If the data ends with 0 and the target supports .asciz, use it, otherwise
568 if (MAI.getAscizDirective() && Data.back() == 0) {
569 OS << MAI.getAscizDirective();
570 Data = Data.substr(0, Data.size()-1);
572 OS << MAI.getAsciiDirective();
576 PrintQuotedString(Data, OS);
580 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
581 unsigned AddrSpace) {
582 EmitValue(MCConstantExpr::Create(Value, getContext()), Size, AddrSpace);
585 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
586 unsigned AddrSpace) {
587 assert(getCurrentSection() && "Cannot emit contents before setting section!");
588 const char *Directive = 0;
591 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
592 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
593 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
595 Directive = MAI.getData64bitsDirective(AddrSpace);
596 // If the target doesn't support 64-bit data, emit as two 32-bit halves.
597 if (Directive) break;
599 if (!Value->EvaluateAsAbsolute(IntValue))
600 report_fatal_error("Don't know how to emit this value.");
601 if (getContext().getTargetAsmInfo().isLittleEndian()) {
602 EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
603 EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
605 EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
606 EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
611 assert(Directive && "Invalid size for machine code value!");
612 OS << Directive << *Value;
616 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
618 if (Value->EvaluateAsAbsolute(IntValue)) {
619 EmitULEB128IntValue(IntValue);
622 assert(MAI.hasLEB128() && "Cannot print a .uleb");
623 OS << ".uleb128 " << *Value;
627 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
629 if (Value->EvaluateAsAbsolute(IntValue)) {
630 EmitSLEB128IntValue(IntValue);
633 assert(MAI.hasLEB128() && "Cannot print a .sleb");
634 OS << ".sleb128 " << *Value;
638 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
639 assert(MAI.getGPRel32Directive() != 0);
640 OS << MAI.getGPRel32Directive() << *Value;
645 /// EmitFill - Emit NumBytes bytes worth of the value specified by
646 /// FillValue. This implements directives such as '.space'.
647 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
648 unsigned AddrSpace) {
649 if (NumBytes == 0) return;
652 if (const char *ZeroDirective = MAI.getZeroDirective()) {
653 OS << ZeroDirective << NumBytes;
655 OS << ',' << (int)FillValue;
660 // Emit a byte at a time.
661 MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
664 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
666 unsigned MaxBytesToEmit) {
667 // Some assemblers don't support non-power of two alignments, so we always
668 // emit alignments as a power of two if possible.
669 if (isPowerOf2_32(ByteAlignment)) {
671 default: llvm_unreachable("Invalid size for machine code value!");
672 case 1: OS << MAI.getAlignDirective(); break;
673 // FIXME: use MAI for this!
674 case 2: OS << ".p2alignw "; break;
675 case 4: OS << ".p2alignl "; break;
676 case 8: llvm_unreachable("Unsupported alignment size!");
679 if (MAI.getAlignmentIsInBytes())
682 OS << Log2_32(ByteAlignment);
684 if (Value || MaxBytesToEmit) {
686 OS.write_hex(truncateToSize(Value, ValueSize));
689 OS << ", " << MaxBytesToEmit;
695 // Non-power of two alignment. This is not widely supported by assemblers.
696 // FIXME: Parameterize this based on MAI.
698 default: llvm_unreachable("Invalid size for machine code value!");
699 case 1: OS << ".balign"; break;
700 case 2: OS << ".balignw"; break;
701 case 4: OS << ".balignl"; break;
702 case 8: llvm_unreachable("Unsupported alignment size!");
705 OS << ' ' << ByteAlignment;
706 OS << ", " << truncateToSize(Value, ValueSize);
708 OS << ", " << MaxBytesToEmit;
712 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
713 unsigned MaxBytesToEmit) {
714 // Emit with a text fill value.
715 EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
719 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
720 unsigned char Value) {
721 // FIXME: Verify that Offset is associated with the current section.
722 OS << ".org " << *Offset << ", " << (unsigned) Value;
727 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
728 assert(MAI.hasSingleParameterDotFile());
730 PrintQuotedString(Filename, OS);
734 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
736 OS << "\t.file\t" << FileNo << ' ';
737 PrintQuotedString(Filename, OS);
740 return this->MCStreamer::EmitDwarfFileDirective(FileNo, Filename);
743 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
744 unsigned Column, unsigned Flags,
746 unsigned Discriminator,
747 StringRef FileName) {
748 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
749 Isa, Discriminator, FileName);
753 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
754 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
755 OS << " basic_block";
756 if (Flags & DWARF2_FLAG_PROLOGUE_END)
757 OS << " prologue_end";
758 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
759 OS << " epilogue_begin";
761 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
762 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
765 if (Flags & DWARF2_FLAG_IS_STMT)
774 OS << "discriminator " << Discriminator;
777 OS.PadToColumn(MAI.getCommentColumn());
778 OS << MAI.getCommentString() << ' ' << FileName << ':'
779 << Line << ':' << Column;
784 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
785 MCStreamer::EmitCFISections(EH, Debug);
790 OS << "\t.cfi_sections ";
794 OS << ", .debug_frame";
796 OS << ".debug_frame";
802 void MCAsmStreamer::EmitCFIStartProc() {
803 MCStreamer::EmitCFIStartProc();
808 OS << "\t.cfi_startproc";
812 void MCAsmStreamer::EmitCFIEndProc() {
813 MCStreamer::EmitCFIEndProc();
818 OS << "\t.cfi_endproc";
822 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
823 MCStreamer::EmitCFIDefCfa(Register, Offset);
828 OS << ".cfi_def_cfa " << Register << ", " << Offset;
832 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
833 MCStreamer::EmitCFIDefCfaOffset(Offset);
838 OS << "\t.cfi_def_cfa_offset " << Offset;
842 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
843 MCStreamer::EmitCFIDefCfaRegister(Register);
848 OS << "\t.cfi_def_cfa_register " << Register;
852 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
853 this->MCStreamer::EmitCFIOffset(Register, Offset);
858 OS << "\t.cfi_offset " << Register << ", " << Offset;
862 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
864 MCStreamer::EmitCFIPersonality(Sym, Encoding);
869 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
873 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
874 MCStreamer::EmitCFILsda(Sym, Encoding);
879 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
883 void MCAsmStreamer::EmitCFIRememberState() {
884 MCStreamer::EmitCFIRememberState();
889 OS << "\t.cfi_remember_state";
893 void MCAsmStreamer::EmitCFIRestoreState() {
894 MCStreamer::EmitCFIRestoreState();
899 OS << "\t.cfi_restore_state";
903 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
904 MCStreamer::EmitCFISameValue(Register);
909 OS << "\t.cfi_same_value " << Register;
913 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
914 MCStreamer::EmitCFIRelOffset(Register, Offset);
919 OS << "\t.cfi_rel_offset " << Register << ", " << Offset;
923 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
924 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
929 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
933 void MCAsmStreamer::EmitWin64EHStartProc(MCSymbol *Symbol) {
934 MCStreamer::EmitWin64EHStartProc(Symbol);
936 OS << ".seh_proc " << *Symbol;
940 void MCAsmStreamer::EmitWin64EHEndProc() {
941 MCStreamer::EmitWin64EHEndProc();
943 OS << "\t.seh_endproc";
947 void MCAsmStreamer::EmitWin64EHStartChained() {
948 MCStreamer::EmitWin64EHStartChained();
950 OS << "\t.seh_startchained";
954 void MCAsmStreamer::EmitWin64EHEndChained() {
955 MCStreamer::EmitWin64EHEndChained();
957 OS << "\t.seh_endchained";
961 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
963 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
965 OS << "\t.seh_handler " << *Sym;
973 void MCAsmStreamer::EmitWin64EHHandlerData() {
974 MCStreamer::EmitWin64EHHandlerData();
976 OS << "\t.seh_handlerdata";
980 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
981 MCStreamer::EmitWin64EHPushReg(Register);
983 OS << "\t.seh_pushreg " << Register;
987 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
988 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
990 OS << "\t.seh_setframe " << Register << ", " << Offset;
994 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
995 MCStreamer::EmitWin64EHAllocStack(Size);
997 OS << "\t.seh_stackalloc " << Size;
1001 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1002 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1004 OS << "\t.seh_savereg " << Register << ", " << Offset;
1008 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1009 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1011 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1015 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1016 MCStreamer::EmitWin64EHPushFrame(Code);
1018 OS << "\t.seh_pushframe";
1024 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1025 MCStreamer::EmitWin64EHEndProlog();
1027 OS << "\t.seh_endprologue";
1031 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
1032 raw_ostream &OS = GetCommentOS();
1033 SmallString<256> Code;
1034 SmallVector<MCFixup, 4> Fixups;
1035 raw_svector_ostream VecOS(Code);
1036 Emitter->EncodeInstruction(Inst, VecOS, Fixups);
1039 // If we are showing fixups, create symbolic markers in the encoded
1040 // representation. We do this by making a per-bit map to the fixup item index,
1041 // then trying to display it as nicely as possible.
1042 SmallVector<uint8_t, 64> FixupMap;
1043 FixupMap.resize(Code.size() * 8);
1044 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1047 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1048 MCFixup &F = Fixups[i];
1049 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1050 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1051 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1052 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1053 FixupMap[Index] = 1 + i;
1057 // FIXME: Node the fixup comments for Thumb2 are completely bogus since the
1058 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1059 OS << "encoding: [";
1060 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1064 // See if all bits are the same map entry.
1065 uint8_t MapEntry = FixupMap[i * 8 + 0];
1066 for (unsigned j = 1; j != 8; ++j) {
1067 if (FixupMap[i * 8 + j] == MapEntry)
1070 MapEntry = uint8_t(~0U);
1074 if (MapEntry != uint8_t(~0U)) {
1075 if (MapEntry == 0) {
1076 OS << format("0x%02x", uint8_t(Code[i]));
1079 // FIXME: Some of the 8 bits require fix up.
1080 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1081 << char('A' + MapEntry - 1) << '\'';
1083 OS << char('A' + MapEntry - 1);
1086 // Otherwise, write out in binary.
1088 for (unsigned j = 8; j--;) {
1089 unsigned Bit = (Code[i] >> j) & 1;
1092 if (getContext().getTargetAsmInfo().isLittleEndian())
1093 FixupBit = i * 8 + j;
1095 FixupBit = i * 8 + (7-j);
1097 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1098 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1099 OS << char('A' + MapEntry - 1);
1107 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1108 MCFixup &F = Fixups[i];
1109 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1110 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1111 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1115 void MCAsmStreamer::EmitFnStart() {
1120 void MCAsmStreamer::EmitFnEnd() {
1125 void MCAsmStreamer::EmitCantUnwind() {
1126 OS << "\t.cantunwind";
1130 void MCAsmStreamer::EmitHandlerData() {
1131 OS << "\t.handlerdata";
1135 void MCAsmStreamer::EmitPersonality(const MCSymbol *Personality) {
1136 OS << "\t.personality " << Personality->getName();
1140 void MCAsmStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
1141 OS << "\t.setfp\t" << InstPrinter->getRegName(FpReg)
1142 << ", " << InstPrinter->getRegName(SpReg);
1144 OS << ", #" << Offset;
1148 void MCAsmStreamer::EmitPad(int64_t Offset) {
1149 OS << "\t.pad\t#" << Offset;
1153 void MCAsmStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
1155 assert(RegList.size() && "RegList should not be empty");
1157 OS << "\t.vsave\t{";
1161 OS << InstPrinter->getRegName(RegList[0]);
1163 for (unsigned i = 1, e = RegList.size(); i != e; ++i)
1164 OS << ", " << InstPrinter->getRegName(RegList[i]);
1170 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
1171 assert(getCurrentSection() && "Cannot emit contents before setting section!");
1173 // Show the encoding in a comment if we have a code emitter.
1175 AddEncodingComment(Inst);
1177 // Show the MCInst if enabled.
1179 Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
1180 GetCommentOS() << "\n";
1183 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1185 InstPrinter->printInst(&Inst, OS);
1187 Inst.print(OS, &MAI);
1191 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1192 /// the specified string in the output .s file. This capability is
1193 /// indicated by the hasRawTextSupport() predicate.
1194 void MCAsmStreamer::EmitRawText(StringRef String) {
1195 if (!String.empty() && String.back() == '\n')
1196 String = String.substr(0, String.size()-1);
1201 void MCAsmStreamer::Finish() {
1202 // Dump out the dwarf file & directory tables and line tables.
1203 if (getContext().hasDwarfFiles() && !UseLoc)
1204 MCDwarfFileTable::Emit(this);
1210 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1211 formatted_raw_ostream &OS,
1212 bool isVerboseAsm, bool useLoc,
1214 MCInstPrinter *IP, MCCodeEmitter *CE,
1215 TargetAsmBackend *TAB, bool ShowInst) {
1216 return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc, useCFI,
1217 IP, CE, TAB, ShowInst);