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/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/StringExtras.h"
14 #include "llvm/ADT/Twine.h"
15 #include "llvm/MC/MCAsmBackend.h"
16 #include "llvm/MC/MCAsmInfo.h"
17 #include "llvm/MC/MCCodeEmitter.h"
18 #include "llvm/MC/MCContext.h"
19 #include "llvm/MC/MCExpr.h"
20 #include "llvm/MC/MCFixupKindInfo.h"
21 #include "llvm/MC/MCInst.h"
22 #include "llvm/MC/MCInstPrinter.h"
23 #include "llvm/MC/MCObjectFileInfo.h"
24 #include "llvm/MC/MCRegisterInfo.h"
25 #include "llvm/MC/MCSectionCOFF.h"
26 #include "llvm/MC/MCSectionMachO.h"
27 #include "llvm/MC/MCSymbolELF.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/Format.h"
31 #include "llvm/Support/FormattedStream.h"
32 #include "llvm/Support/MathExtras.h"
33 #include "llvm/Support/Path.h"
39 class MCAsmStreamer final : public MCStreamer {
40 std::unique_ptr<formatted_raw_ostream> OSOwner;
41 formatted_raw_ostream &OS;
43 std::unique_ptr<MCInstPrinter> InstPrinter;
44 std::unique_ptr<MCCodeEmitter> Emitter;
45 std::unique_ptr<MCAsmBackend> AsmBackend;
47 SmallString<128> CommentToEmit;
48 raw_svector_ostream CommentStream;
50 unsigned IsVerboseAsm : 1;
51 unsigned ShowInst : 1;
52 unsigned UseDwarfDirectory : 1;
54 void EmitRegisterName(int64_t Register);
55 void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) override;
56 void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) override;
59 MCAsmStreamer(MCContext &Context, std::unique_ptr<formatted_raw_ostream> os,
60 bool isVerboseAsm, bool useDwarfDirectory,
61 MCInstPrinter *printer, MCCodeEmitter *emitter,
62 MCAsmBackend *asmbackend, bool showInst)
63 : MCStreamer(Context), OSOwner(std::move(os)), OS(*OSOwner),
64 MAI(Context.getAsmInfo()), InstPrinter(printer), Emitter(emitter),
65 AsmBackend(asmbackend), CommentStream(CommentToEmit),
66 IsVerboseAsm(isVerboseAsm), ShowInst(showInst),
67 UseDwarfDirectory(useDwarfDirectory) {
70 InstPrinter->setCommentStream(CommentStream);
73 inline void EmitEOL() {
74 // If we don't have any comments, just emit a \n.
82 void EmitSyntaxDirective() override;
84 void EmitCommentsAndEOL();
86 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
88 bool isVerboseAsm() const override { return IsVerboseAsm; }
90 /// hasRawTextSupport - We support EmitRawText.
91 bool hasRawTextSupport() const override { return true; }
93 /// AddComment - Add a comment that can be emitted to the generated .s
94 /// file if applicable as a QoI issue to make the output of the compiler
95 /// more readable. This only affects the MCAsmStreamer, and only when
96 /// verbose assembly output is enabled.
97 void AddComment(const Twine &T) override;
99 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
100 void AddEncodingComment(const MCInst &Inst, const MCSubtargetInfo &);
102 /// GetCommentOS - Return a raw_ostream that comments can be written to.
103 /// Unlike AddComment, you are required to terminate comments with \n if you
105 raw_ostream &GetCommentOS() override {
107 return nulls(); // Discard comments unless in verbose asm mode.
108 return CommentStream;
111 void emitRawComment(const Twine &T, bool TabPrefix = true) override;
113 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
114 void AddBlankLine() override {
118 /// @name MCStreamer Interface
121 void ChangeSection(MCSection *Section, const MCExpr *Subsection) override;
123 void EmitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) override;
124 void EmitLabel(MCSymbol *Symbol) override;
126 void EmitAssemblerFlag(MCAssemblerFlag Flag) override;
127 void EmitLinkerOptions(ArrayRef<std::string> Options) override;
128 void EmitDataRegion(MCDataRegionType Kind) override;
129 void EmitVersionMin(MCVersionMinType Kind, unsigned Major, unsigned Minor,
130 unsigned Update) override;
131 void EmitThumbFunc(MCSymbol *Func) override;
133 void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
134 void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
135 bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
137 void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) override;
138 void BeginCOFFSymbolDef(const MCSymbol *Symbol) override;
139 void EmitCOFFSymbolStorageClass(int StorageClass) override;
140 void EmitCOFFSymbolType(int Type) override;
141 void EndCOFFSymbolDef() override;
142 void EmitCOFFSafeSEH(MCSymbol const *Symbol) override;
143 void EmitCOFFSectionIndex(MCSymbol const *Symbol) override;
144 void EmitCOFFSecRel32(MCSymbol const *Symbol) override;
145 void emitELFSize(MCSymbolELF *Symbol, const MCExpr *Value) override;
146 void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
147 unsigned ByteAlignment) override;
149 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
151 /// @param Symbol - The common symbol to emit.
152 /// @param Size - The size of the common symbol.
153 /// @param ByteAlignment - The alignment of the common symbol in bytes.
154 void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
155 unsigned ByteAlignment) override;
157 void EmitZerofill(MCSection *Section, MCSymbol *Symbol = nullptr,
158 uint64_t Size = 0, unsigned ByteAlignment = 0) override;
160 void EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol, uint64_t Size,
161 unsigned ByteAlignment = 0) override;
163 void EmitBytes(StringRef Data) override;
165 void EmitValueImpl(const MCExpr *Value, unsigned Size,
166 const SMLoc &Loc = SMLoc()) override;
167 void EmitIntValue(uint64_t Value, unsigned Size) override;
169 void EmitULEB128Value(const MCExpr *Value) override;
171 void EmitSLEB128Value(const MCExpr *Value) override;
173 void EmitGPRel64Value(const MCExpr *Value) override;
175 void EmitGPRel32Value(const MCExpr *Value) override;
178 void EmitFill(uint64_t NumBytes, uint8_t FillValue) override;
180 void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
181 unsigned ValueSize = 1,
182 unsigned MaxBytesToEmit = 0) override;
184 void EmitCodeAlignment(unsigned ByteAlignment,
185 unsigned MaxBytesToEmit = 0) override;
187 bool EmitValueToOffset(const MCExpr *Offset,
188 unsigned char Value = 0) override;
190 void EmitFileDirective(StringRef Filename) override;
191 unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
193 unsigned CUID = 0) override;
194 void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
195 unsigned Column, unsigned Flags,
196 unsigned Isa, unsigned Discriminator,
197 StringRef FileName) override;
198 MCSymbol *getDwarfLineTableSymbol(unsigned CUID) override;
200 void EmitIdent(StringRef IdentString) override;
201 void EmitCFISections(bool EH, bool Debug) override;
202 void EmitCFIDefCfa(int64_t Register, int64_t Offset) override;
203 void EmitCFIDefCfaOffset(int64_t Offset) override;
204 void EmitCFIDefCfaRegister(int64_t Register) override;
205 void EmitCFIOffset(int64_t Register, int64_t Offset) override;
206 void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
207 void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
208 void EmitCFIRememberState() override;
209 void EmitCFIRestoreState() override;
210 void EmitCFISameValue(int64_t Register) override;
211 void EmitCFIRelOffset(int64_t Register, int64_t Offset) override;
212 void EmitCFIAdjustCfaOffset(int64_t Adjustment) override;
213 void EmitCFISignalFrame() override;
214 void EmitCFIUndefined(int64_t Register) override;
215 void EmitCFIRegister(int64_t Register1, int64_t Register2) override;
216 void EmitCFIWindowSave() override;
218 void EmitWinCFIStartProc(const MCSymbol *Symbol) override;
219 void EmitWinCFIEndProc() override;
220 void EmitWinCFIStartChained() override;
221 void EmitWinCFIEndChained() override;
222 void EmitWinCFIPushReg(unsigned Register) override;
223 void EmitWinCFISetFrame(unsigned Register, unsigned Offset) override;
224 void EmitWinCFIAllocStack(unsigned Size) override;
225 void EmitWinCFISaveReg(unsigned Register, unsigned Offset) override;
226 void EmitWinCFISaveXMM(unsigned Register, unsigned Offset) override;
227 void EmitWinCFIPushFrame(bool Code) override;
228 void EmitWinCFIEndProlog() override;
230 void EmitWinEHHandler(const MCSymbol *Sym, bool Unwind, bool Except) override;
231 void EmitWinEHHandlerData() override;
233 void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
235 void EmitBundleAlignMode(unsigned AlignPow2) override;
236 void EmitBundleLock(bool AlignToEnd) override;
237 void EmitBundleUnlock() override;
239 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
240 /// the specified string in the output .s file. This capability is
241 /// indicated by the hasRawTextSupport() predicate.
242 void EmitRawTextImpl(StringRef String) override;
244 void FinishImpl() override;
247 } // end anonymous namespace.
249 /// AddComment - Add a comment that can be emitted to the generated .s
250 /// file if applicable as a QoI issue to make the output of the compiler
251 /// more readable. This only affects the MCAsmStreamer, and only when
252 /// verbose assembly output is enabled.
253 void MCAsmStreamer::AddComment(const Twine &T) {
254 if (!IsVerboseAsm) return;
256 T.toVector(CommentToEmit);
257 // Each comment goes on its own line.
258 CommentToEmit.push_back('\n');
261 void MCAsmStreamer::EmitCommentsAndEOL() {
262 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
267 StringRef Comments = CommentToEmit;
269 assert(Comments.back() == '\n' &&
270 "Comment array not newline terminated");
272 // Emit a line of comments.
273 OS.PadToColumn(MAI->getCommentColumn());
274 size_t Position = Comments.find('\n');
275 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
277 Comments = Comments.substr(Position+1);
278 } while (!Comments.empty());
280 CommentToEmit.clear();
283 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
284 assert(Bytes && "Invalid size!");
285 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
288 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
291 OS << MAI->getCommentString() << T;
295 void MCAsmStreamer::ChangeSection(MCSection *Section,
296 const MCExpr *Subsection) {
297 assert(Section && "Cannot switch to a null section!");
298 Section->PrintSwitchToSection(*MAI, OS, Subsection);
301 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
302 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
303 MCStreamer::EmitLabel(Symbol);
305 Symbol->print(OS, MAI);
306 OS << MAI->getLabelSuffix();
311 void MCAsmStreamer::EmitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) {
312 StringRef str = MCLOHIdToName(Kind);
315 int NbArgs = MCLOHIdToNbArgs(Kind);
316 assert(NbArgs != -1 && ((size_t)NbArgs) == Args.size() && "Malformed LOH!");
317 assert(str != "" && "Invalid LOH name");
320 OS << "\t" << MCLOHDirectiveName() << " " << str << "\t";
322 for (MCLOHArgs::const_iterator It = Args.begin(), EndIt = Args.end();
327 (*It)->print(OS, MAI);
332 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
334 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
335 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
336 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
337 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
338 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
343 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
344 assert(!Options.empty() && "At least one option is required!");
345 OS << "\t.linker_option \"" << Options[0] << '"';
346 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
347 ie = Options.end(); it != ie; ++it) {
348 OS << ", " << '"' << *it << '"';
353 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
354 if (!MAI->doesSupportDataRegionDirectives())
357 case MCDR_DataRegion: OS << "\t.data_region"; break;
358 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
359 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
360 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
361 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
366 void MCAsmStreamer::EmitVersionMin(MCVersionMinType Kind, unsigned Major,
367 unsigned Minor, unsigned Update) {
369 case MCVM_IOSVersionMin: OS << "\t.ios_version_min"; break;
370 case MCVM_OSXVersionMin: OS << "\t.macosx_version_min"; break;
372 OS << " " << Major << ", " << Minor;
374 OS << ", " << Update;
378 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
379 // This needs to emit to a temporary string to get properly quoted
380 // MCSymbols when they have spaces in them.
381 OS << "\t.thumb_func";
382 // Only Mach-O hasSubsectionsViaSymbols()
383 if (MAI->hasSubsectionsViaSymbols()) {
385 Func->print(OS, MAI);
390 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
391 Symbol->print(OS, MAI);
393 Value->print(OS, MAI);
397 MCStreamer::EmitAssignment(Symbol, Value);
400 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
402 Alias->print(OS, MAI);
404 Symbol->print(OS, MAI);
408 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
409 MCSymbolAttr Attribute) {
411 case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
412 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
413 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
414 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
415 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
416 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
417 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
418 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
419 if (!MAI->hasDotTypeDotSizeDirective())
420 return false; // Symbol attribute not supported
422 Symbol->print(OS, MAI);
423 OS << ',' << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
425 default: return false;
426 case MCSA_ELF_TypeFunction: OS << "function"; break;
427 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
428 case MCSA_ELF_TypeObject: OS << "object"; break;
429 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
430 case MCSA_ELF_TypeCommon: OS << "common"; break;
431 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
432 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
436 case MCSA_Global: // .globl/.global
437 OS << MAI->getGlobalDirective();
439 case MCSA_Hidden: OS << "\t.hidden\t"; break;
440 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
441 case MCSA_Internal: OS << "\t.internal\t"; break;
442 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
443 case MCSA_Local: OS << "\t.local\t"; break;
444 case MCSA_NoDeadStrip:
445 if (!MAI->hasNoDeadStrip())
447 OS << "\t.no_dead_strip\t";
449 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
450 case MCSA_PrivateExtern:
451 OS << "\t.private_extern\t";
453 case MCSA_Protected: OS << "\t.protected\t"; break;
454 case MCSA_Reference: OS << "\t.reference\t"; break;
455 case MCSA_Weak: OS << MAI->getWeakDirective(); break;
456 case MCSA_WeakDefinition:
457 OS << "\t.weak_definition\t";
460 case MCSA_WeakReference: OS << MAI->getWeakRefDirective(); break;
461 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
464 Symbol->print(OS, MAI);
470 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
471 OS << ".desc" << ' ';
472 Symbol->print(OS, MAI);
473 OS << ',' << DescValue;
477 void MCAsmStreamer::EmitSyntaxDirective() {
478 if (MAI->getAssemblerDialect() == 1)
479 OS << "\t.intel_syntax noprefix\n";
480 // FIXME: Currently emit unprefix'ed registers.
481 // The intel_syntax directive has one optional argument
482 // with may have a value of prefix or noprefix.
485 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
487 Symbol->print(OS, MAI);
492 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
493 OS << "\t.scl\t" << StorageClass << ';';
497 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
498 OS << "\t.type\t" << Type << ';';
502 void MCAsmStreamer::EndCOFFSymbolDef() {
507 void MCAsmStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
508 OS << "\t.safeseh\t";
509 Symbol->print(OS, MAI);
513 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
515 Symbol->print(OS, MAI);
519 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
520 OS << "\t.secrel32\t";
521 Symbol->print(OS, MAI);
525 void MCAsmStreamer::emitELFSize(MCSymbolELF *Symbol, const MCExpr *Value) {
526 assert(MAI->hasDotTypeDotSizeDirective());
528 Symbol->print(OS, MAI);
530 Value->print(OS, MAI);
534 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
535 unsigned ByteAlignment) {
536 // Common symbols do not belong to any actual section.
537 AssignSection(Symbol, nullptr);
540 Symbol->print(OS, MAI);
543 if (ByteAlignment != 0) {
544 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
545 OS << ',' << ByteAlignment;
547 OS << ',' << Log2_32(ByteAlignment);
552 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
554 /// @param Symbol - The common symbol to emit.
555 /// @param Size - The size of the common symbol.
556 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
557 unsigned ByteAlign) {
558 // Common symbols do not belong to any actual section.
559 AssignSection(Symbol, nullptr);
562 Symbol->print(OS, MAI);
566 switch (MAI->getLCOMMDirectiveAlignmentType()) {
567 case LCOMM::NoAlignment:
568 llvm_unreachable("alignment not supported on .lcomm!");
569 case LCOMM::ByteAlignment:
570 OS << ',' << ByteAlign;
572 case LCOMM::Log2Alignment:
573 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
574 OS << ',' << Log2_32(ByteAlign);
581 void MCAsmStreamer::EmitZerofill(MCSection *Section, MCSymbol *Symbol,
582 uint64_t Size, unsigned ByteAlignment) {
584 AssignSection(Symbol, Section);
586 // Note: a .zerofill directive does not switch sections.
589 // This is a mach-o specific directive.
590 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
591 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
595 Symbol->print(OS, MAI);
597 if (ByteAlignment != 0)
598 OS << ',' << Log2_32(ByteAlignment);
603 // .tbss sym, size, align
604 // This depends that the symbol has already been mangled from the original,
606 void MCAsmStreamer::EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
607 uint64_t Size, unsigned ByteAlignment) {
608 AssignSection(Symbol, Section);
610 assert(Symbol && "Symbol shouldn't be NULL!");
611 // Instead of using the Section we'll just use the shortcut.
612 // This is a mach-o specific directive and section.
614 Symbol->print(OS, MAI);
617 // Output align if we have it. We default to 1 so don't bother printing
619 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
624 static inline char toOctal(int X) { return (X&7)+'0'; }
626 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
629 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
630 unsigned char C = Data[i];
631 if (C == '"' || C == '\\') {
632 OS << '\\' << (char)C;
636 if (isprint((unsigned char)C)) {
642 case '\b': OS << "\\b"; break;
643 case '\f': OS << "\\f"; break;
644 case '\n': OS << "\\n"; break;
645 case '\r': OS << "\\r"; break;
646 case '\t': OS << "\\t"; break;
649 OS << toOctal(C >> 6);
650 OS << toOctal(C >> 3);
651 OS << toOctal(C >> 0);
660 void MCAsmStreamer::EmitBytes(StringRef Data) {
661 assert(getCurrentSection().first &&
662 "Cannot emit contents before setting section!");
663 if (Data.empty()) return;
665 if (Data.size() == 1) {
666 OS << MAI->getData8bitsDirective();
667 OS << (unsigned)(unsigned char)Data[0];
672 // If the data ends with 0 and the target supports .asciz, use it, otherwise
674 if (MAI->getAscizDirective() && Data.back() == 0) {
675 OS << MAI->getAscizDirective();
676 Data = Data.substr(0, Data.size()-1);
678 OS << MAI->getAsciiDirective();
681 PrintQuotedString(Data, OS);
685 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
686 EmitValue(MCConstantExpr::create(Value, getContext()), Size);
689 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
691 assert(Size <= 8 && "Invalid size");
692 assert(getCurrentSection().first &&
693 "Cannot emit contents before setting section!");
694 const char *Directive = nullptr;
697 case 1: Directive = MAI->getData8bitsDirective(); break;
698 case 2: Directive = MAI->getData16bitsDirective(); break;
699 case 4: Directive = MAI->getData32bitsDirective(); break;
700 case 8: Directive = MAI->getData64bitsDirective(); break;
705 if (!Value->evaluateAsAbsolute(IntValue))
706 report_fatal_error("Don't know how to emit this value.");
708 // We couldn't handle the requested integer size so we fallback by breaking
709 // the request down into several, smaller, integers. Since sizes greater
710 // than eight are invalid and size equivalent to eight should have been
711 // handled earlier, we use four bytes as our largest piece of granularity.
712 bool IsLittleEndian = MAI->isLittleEndian();
713 for (unsigned Emitted = 0; Emitted != Size;) {
714 unsigned Remaining = Size - Emitted;
715 // The size of our partial emission must be a power of two less than
717 unsigned EmissionSize = PowerOf2Floor(Remaining);
718 if (EmissionSize > 4)
720 // Calculate the byte offset of our partial emission taking into account
721 // the endianness of the target.
722 unsigned ByteOffset =
723 IsLittleEndian ? Emitted : (Remaining - EmissionSize);
724 uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
725 // We truncate our partial emission to fit within the bounds of the
726 // emission domain. This produces nicer output and silences potential
727 // truncation warnings when round tripping through another assembler.
728 uint64_t Shift = 64 - EmissionSize * 8;
729 assert(Shift < static_cast<uint64_t>(
730 std::numeric_limits<unsigned long long>::digits) &&
731 "undefined behavior");
732 ValueToEmit &= ~0ULL >> Shift;
733 EmitIntValue(ValueToEmit, EmissionSize);
734 Emitted += EmissionSize;
739 assert(Directive && "Invalid size for machine code value!");
741 Value->print(OS, MAI);
745 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
747 if (Value->evaluateAsAbsolute(IntValue)) {
748 EmitULEB128IntValue(IntValue);
752 Value->print(OS, MAI);
756 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
758 if (Value->evaluateAsAbsolute(IntValue)) {
759 EmitSLEB128IntValue(IntValue);
763 Value->print(OS, MAI);
767 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
768 assert(MAI->getGPRel64Directive() != nullptr);
769 OS << MAI->getGPRel64Directive();
770 Value->print(OS, MAI);
774 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
775 assert(MAI->getGPRel32Directive() != nullptr);
776 OS << MAI->getGPRel32Directive();
777 Value->print(OS, MAI);
782 /// EmitFill - Emit NumBytes bytes worth of the value specified by
783 /// FillValue. This implements directives such as '.space'.
784 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
785 if (NumBytes == 0) return;
787 if (const char *ZeroDirective = MAI->getZeroDirective()) {
788 OS << ZeroDirective << NumBytes;
790 OS << ',' << (int)FillValue;
795 // Emit a byte at a time.
796 MCStreamer::EmitFill(NumBytes, FillValue);
799 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
801 unsigned MaxBytesToEmit) {
802 // Some assemblers don't support non-power of two alignments, so we always
803 // emit alignments as a power of two if possible.
804 if (isPowerOf2_32(ByteAlignment)) {
807 llvm_unreachable("Invalid size for machine code value!");
818 llvm_unreachable("Unsupported alignment size!");
821 if (MAI->getAlignmentIsInBytes())
824 OS << Log2_32(ByteAlignment);
826 if (Value || MaxBytesToEmit) {
828 OS.write_hex(truncateToSize(Value, ValueSize));
831 OS << ", " << MaxBytesToEmit;
837 // Non-power of two alignment. This is not widely supported by assemblers.
838 // FIXME: Parameterize this based on MAI.
840 default: llvm_unreachable("Invalid size for machine code value!");
841 case 1: OS << ".balign"; break;
842 case 2: OS << ".balignw"; break;
843 case 4: OS << ".balignl"; break;
844 case 8: llvm_unreachable("Unsupported alignment size!");
847 OS << ' ' << ByteAlignment;
848 OS << ", " << truncateToSize(Value, ValueSize);
850 OS << ", " << MaxBytesToEmit;
854 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
855 unsigned MaxBytesToEmit) {
856 // Emit with a text fill value.
857 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
861 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
862 unsigned char Value) {
863 // FIXME: Verify that Offset is associated with the current section.
865 Offset->print(OS, MAI);
866 OS << ", " << (unsigned)Value;
872 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
873 assert(MAI->hasSingleParameterDotFile());
875 PrintQuotedString(Filename, OS);
879 unsigned MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo,
885 MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
886 unsigned NumFiles = Table.getMCDwarfFiles().size();
887 FileNo = Table.getFile(Directory, Filename, FileNo);
890 if (NumFiles == Table.getMCDwarfFiles().size())
893 SmallString<128> FullPathName;
895 if (!UseDwarfDirectory && !Directory.empty()) {
896 if (sys::path::is_absolute(Filename))
899 FullPathName = Directory;
900 sys::path::append(FullPathName, Filename);
902 Filename = FullPathName;
906 OS << "\t.file\t" << FileNo << ' ';
907 if (!Directory.empty()) {
908 PrintQuotedString(Directory, OS);
911 PrintQuotedString(Filename, OS);
917 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
918 unsigned Column, unsigned Flags,
920 unsigned Discriminator,
921 StringRef FileName) {
922 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
923 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
924 OS << " basic_block";
925 if (Flags & DWARF2_FLAG_PROLOGUE_END)
926 OS << " prologue_end";
927 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
928 OS << " epilogue_begin";
930 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
931 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
934 if (Flags & DWARF2_FLAG_IS_STMT)
941 OS << " isa " << Isa;
943 OS << " discriminator " << Discriminator;
946 OS.PadToColumn(MAI->getCommentColumn());
947 OS << MAI->getCommentString() << ' ' << FileName << ':'
948 << Line << ':' << Column;
951 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
952 Isa, Discriminator, FileName);
955 MCSymbol *MCAsmStreamer::getDwarfLineTableSymbol(unsigned CUID) {
956 // Always use the zeroth line table, since asm syntax only supports one line
958 return MCStreamer::getDwarfLineTableSymbol(0);
961 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
962 assert(MAI->hasIdentDirective() && ".ident directive not supported");
964 PrintQuotedString(IdentString, OS);
968 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
969 MCStreamer::EmitCFISections(EH, Debug);
970 OS << "\t.cfi_sections ";
974 OS << ", .debug_frame";
976 OS << ".debug_frame";
982 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
983 OS << "\t.cfi_startproc";
989 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
990 MCStreamer::EmitCFIEndProcImpl(Frame);
991 OS << "\t.cfi_endproc";
995 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
996 if (!MAI->useDwarfRegNumForCFI()) {
997 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
998 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
999 InstPrinter->printRegName(OS, LLVMRegister);
1005 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
1006 MCStreamer::EmitCFIDefCfa(Register, Offset);
1007 OS << "\t.cfi_def_cfa ";
1008 EmitRegisterName(Register);
1009 OS << ", " << Offset;
1013 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
1014 MCStreamer::EmitCFIDefCfaOffset(Offset);
1015 OS << "\t.cfi_def_cfa_offset " << Offset;
1019 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
1020 MCStreamer::EmitCFIDefCfaRegister(Register);
1021 OS << "\t.cfi_def_cfa_register ";
1022 EmitRegisterName(Register);
1026 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1027 this->MCStreamer::EmitCFIOffset(Register, Offset);
1028 OS << "\t.cfi_offset ";
1029 EmitRegisterName(Register);
1030 OS << ", " << Offset;
1034 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1035 unsigned Encoding) {
1036 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1037 OS << "\t.cfi_personality " << Encoding << ", ";
1038 Sym->print(OS, MAI);
1042 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1043 MCStreamer::EmitCFILsda(Sym, Encoding);
1044 OS << "\t.cfi_lsda " << Encoding << ", ";
1045 Sym->print(OS, MAI);
1049 void MCAsmStreamer::EmitCFIRememberState() {
1050 MCStreamer::EmitCFIRememberState();
1051 OS << "\t.cfi_remember_state";
1055 void MCAsmStreamer::EmitCFIRestoreState() {
1056 MCStreamer::EmitCFIRestoreState();
1057 OS << "\t.cfi_restore_state";
1061 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1062 MCStreamer::EmitCFISameValue(Register);
1063 OS << "\t.cfi_same_value ";
1064 EmitRegisterName(Register);
1068 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1069 MCStreamer::EmitCFIRelOffset(Register, Offset);
1070 OS << "\t.cfi_rel_offset ";
1071 EmitRegisterName(Register);
1072 OS << ", " << Offset;
1076 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1077 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1078 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1082 void MCAsmStreamer::EmitCFISignalFrame() {
1083 MCStreamer::EmitCFISignalFrame();
1084 OS << "\t.cfi_signal_frame";
1088 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1089 MCStreamer::EmitCFIUndefined(Register);
1090 OS << "\t.cfi_undefined " << Register;
1094 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1095 MCStreamer::EmitCFIRegister(Register1, Register2);
1096 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1100 void MCAsmStreamer::EmitCFIWindowSave() {
1101 MCStreamer::EmitCFIWindowSave();
1102 OS << "\t.cfi_window_save";
1106 void MCAsmStreamer::EmitWinCFIStartProc(const MCSymbol *Symbol) {
1107 MCStreamer::EmitWinCFIStartProc(Symbol);
1110 Symbol->print(OS, MAI);
1114 void MCAsmStreamer::EmitWinCFIEndProc() {
1115 MCStreamer::EmitWinCFIEndProc();
1117 OS << "\t.seh_endproc";
1121 void MCAsmStreamer::EmitWinCFIStartChained() {
1122 MCStreamer::EmitWinCFIStartChained();
1124 OS << "\t.seh_startchained";
1128 void MCAsmStreamer::EmitWinCFIEndChained() {
1129 MCStreamer::EmitWinCFIEndChained();
1131 OS << "\t.seh_endchained";
1135 void MCAsmStreamer::EmitWinEHHandler(const MCSymbol *Sym, bool Unwind,
1137 MCStreamer::EmitWinEHHandler(Sym, Unwind, Except);
1139 OS << "\t.seh_handler ";
1140 Sym->print(OS, MAI);
1148 void MCAsmStreamer::EmitWinEHHandlerData() {
1149 MCStreamer::EmitWinEHHandlerData();
1151 // Switch sections. Don't call SwitchSection directly, because that will
1152 // cause the section switch to be visible in the emitted assembly.
1153 // We only do this so the section switch that terminates the handler
1154 // data block is visible.
1155 WinEH::FrameInfo *CurFrame = getCurrentWinFrameInfo();
1157 WinEH::UnwindEmitter::getXDataSection(CurFrame->Function, getContext());
1158 SwitchSectionNoChange(XData);
1160 OS << "\t.seh_handlerdata";
1164 void MCAsmStreamer::EmitWinCFIPushReg(unsigned Register) {
1165 MCStreamer::EmitWinCFIPushReg(Register);
1167 OS << "\t.seh_pushreg " << Register;
1171 void MCAsmStreamer::EmitWinCFISetFrame(unsigned Register, unsigned Offset) {
1172 MCStreamer::EmitWinCFISetFrame(Register, Offset);
1174 OS << "\t.seh_setframe " << Register << ", " << Offset;
1178 void MCAsmStreamer::EmitWinCFIAllocStack(unsigned Size) {
1179 MCStreamer::EmitWinCFIAllocStack(Size);
1181 OS << "\t.seh_stackalloc " << Size;
1185 void MCAsmStreamer::EmitWinCFISaveReg(unsigned Register, unsigned Offset) {
1186 MCStreamer::EmitWinCFISaveReg(Register, Offset);
1188 OS << "\t.seh_savereg " << Register << ", " << Offset;
1192 void MCAsmStreamer::EmitWinCFISaveXMM(unsigned Register, unsigned Offset) {
1193 MCStreamer::EmitWinCFISaveXMM(Register, Offset);
1195 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1199 void MCAsmStreamer::EmitWinCFIPushFrame(bool Code) {
1200 MCStreamer::EmitWinCFIPushFrame(Code);
1202 OS << "\t.seh_pushframe";
1208 void MCAsmStreamer::EmitWinCFIEndProlog(void) {
1209 MCStreamer::EmitWinCFIEndProlog();
1211 OS << "\t.seh_endprologue";
1215 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1216 const MCSubtargetInfo &STI) {
1217 raw_ostream &OS = GetCommentOS();
1218 SmallString<256> Code;
1219 SmallVector<MCFixup, 4> Fixups;
1220 raw_svector_ostream VecOS(Code);
1221 Emitter->encodeInstruction(Inst, VecOS, Fixups, STI);
1223 // If we are showing fixups, create symbolic markers in the encoded
1224 // representation. We do this by making a per-bit map to the fixup item index,
1225 // then trying to display it as nicely as possible.
1226 SmallVector<uint8_t, 64> FixupMap;
1227 FixupMap.resize(Code.size() * 8);
1228 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1231 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1232 MCFixup &F = Fixups[i];
1233 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1234 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1235 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1236 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1237 FixupMap[Index] = 1 + i;
1241 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1242 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1243 OS << "encoding: [";
1244 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1248 // See if all bits are the same map entry.
1249 uint8_t MapEntry = FixupMap[i * 8 + 0];
1250 for (unsigned j = 1; j != 8; ++j) {
1251 if (FixupMap[i * 8 + j] == MapEntry)
1254 MapEntry = uint8_t(~0U);
1258 if (MapEntry != uint8_t(~0U)) {
1259 if (MapEntry == 0) {
1260 OS << format("0x%02x", uint8_t(Code[i]));
1263 // FIXME: Some of the 8 bits require fix up.
1264 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1265 << char('A' + MapEntry - 1) << '\'';
1267 OS << char('A' + MapEntry - 1);
1270 // Otherwise, write out in binary.
1272 for (unsigned j = 8; j--;) {
1273 unsigned Bit = (Code[i] >> j) & 1;
1276 if (MAI->isLittleEndian())
1277 FixupBit = i * 8 + j;
1279 FixupBit = i * 8 + (7-j);
1281 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1282 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1283 OS << char('A' + MapEntry - 1);
1291 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1292 MCFixup &F = Fixups[i];
1293 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1294 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1295 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1299 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1300 assert(getCurrentSection().first &&
1301 "Cannot emit contents before setting section!");
1303 // Show the encoding in a comment if we have a code emitter.
1305 AddEncodingComment(Inst, STI);
1307 // Show the MCInst if enabled.
1309 Inst.dump_pretty(GetCommentOS(), InstPrinter.get(), "\n ");
1310 GetCommentOS() << "\n";
1313 if(getTargetStreamer())
1314 getTargetStreamer()->prettyPrintAsm(*InstPrinter, OS, Inst, STI);
1316 InstPrinter->printInst(&Inst, OS, "", STI);
1321 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1322 OS << "\t.bundle_align_mode " << AlignPow2;
1326 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1327 OS << "\t.bundle_lock";
1329 OS << " align_to_end";
1333 void MCAsmStreamer::EmitBundleUnlock() {
1334 OS << "\t.bundle_unlock";
1338 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1339 /// the specified string in the output .s file. This capability is
1340 /// indicated by the hasRawTextSupport() predicate.
1341 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1342 if (!String.empty() && String.back() == '\n')
1343 String = String.substr(0, String.size()-1);
1348 void MCAsmStreamer::FinishImpl() {
1349 // If we are generating dwarf for assembly source files dump out the sections.
1350 if (getContext().getGenDwarfForAssembly())
1351 MCGenDwarfInfo::Emit(this);
1353 // Emit the label for the line table, if requested - since the rest of the
1354 // line table will be defined by .loc/.file directives, and not emitted
1355 // directly, the label is the only work required here.
1356 auto &Tables = getContext().getMCDwarfLineTables();
1357 if (!Tables.empty()) {
1358 assert(Tables.size() == 1 && "asm output only supports one line table");
1359 if (auto *Label = Tables.begin()->second.getLabel()) {
1360 SwitchSection(getContext().getObjectFileInfo()->getDwarfLineSection());
1366 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1367 std::unique_ptr<formatted_raw_ostream> OS,
1368 bool isVerboseAsm, bool useDwarfDirectory,
1369 MCInstPrinter *IP, MCCodeEmitter *CE,
1370 MCAsmBackend *MAB, bool ShowInst) {
1371 return new MCAsmStreamer(Context, std::move(OS), isVerboseAsm,
1372 useDwarfDirectory, IP, CE, MAB, ShowInst);