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/SmallString.h"
12 #include "llvm/ADT/StringExtras.h"
13 #include "llvm/ADT/Twine.h"
14 #include "llvm/MC/MCAsmBackend.h"
15 #include "llvm/MC/MCAsmInfo.h"
16 #include "llvm/MC/MCCodeEmitter.h"
17 #include "llvm/MC/MCContext.h"
18 #include "llvm/MC/MCExpr.h"
19 #include "llvm/MC/MCFixupKindInfo.h"
20 #include "llvm/MC/MCInst.h"
21 #include "llvm/MC/MCInstPrinter.h"
22 #include "llvm/MC/MCObjectFileInfo.h"
23 #include "llvm/MC/MCRegisterInfo.h"
24 #include "llvm/MC/MCSectionCOFF.h"
25 #include "llvm/MC/MCSectionMachO.h"
26 #include "llvm/MC/MCSymbol.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/Format.h"
30 #include "llvm/Support/FormattedStream.h"
31 #include "llvm/Support/MathExtras.h"
32 #include "llvm/Support/Path.h"
38 class MCAsmStreamer : public MCStreamer {
40 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;
53 unsigned UseDwarfDirectory : 1;
55 enum EHSymbolFlags { EHGlobal = 1,
56 EHWeakDefinition = 1 << 1,
57 EHPrivateExtern = 1 << 2 };
58 DenseMap<const MCSymbol*, unsigned> FlagMap;
60 bool needsSet(const MCExpr *Value);
62 void EmitRegisterName(int64_t Register);
63 void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) override;
64 void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) override;
67 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
68 bool isVerboseAsm, bool useCFI, bool useDwarfDirectory,
69 MCInstPrinter *printer, MCCodeEmitter *emitter,
70 MCAsmBackend *asmbackend, bool showInst)
71 : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
72 InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
73 CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
74 ShowInst(showInst), UseCFI(useCFI),
75 UseDwarfDirectory(useDwarfDirectory) {
76 if (InstPrinter && IsVerboseAsm)
77 InstPrinter->setCommentStream(CommentStream);
81 inline void EmitEOL() {
82 // If we don't have any comments, just emit a \n.
89 void EmitCommentsAndEOL();
91 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
93 bool isVerboseAsm() const override { return IsVerboseAsm; }
95 /// hasRawTextSupport - We support EmitRawText.
96 bool hasRawTextSupport() const override { return true; }
98 /// AddComment - Add a comment that can be emitted to the generated .s
99 /// file if applicable as a QoI issue to make the output of the compiler
100 /// more readable. This only affects the MCAsmStreamer, and only when
101 /// verbose assembly output is enabled.
102 void AddComment(const Twine &T) override;
104 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
105 void AddEncodingComment(const MCInst &Inst, const MCSubtargetInfo &);
107 /// GetCommentOS - Return a raw_ostream that comments can be written to.
108 /// Unlike AddComment, you are required to terminate comments with \n if you
110 raw_ostream &GetCommentOS() override {
112 return nulls(); // Discard comments unless in verbose asm mode.
113 return CommentStream;
116 void emitRawComment(const Twine &T, bool TabPrefix = true) override;
118 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
119 void AddBlankLine() override {
123 /// @name MCStreamer Interface
126 void ChangeSection(const MCSection *Section,
127 const MCExpr *Subsection) override;
129 void EmitLabel(MCSymbol *Symbol) override;
130 void EmitDebugLabel(MCSymbol *Symbol) override;
132 void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol) override;
133 void EmitAssemblerFlag(MCAssemblerFlag Flag) override;
134 void EmitLinkerOptions(ArrayRef<std::string> Options) override;
135 void EmitDataRegion(MCDataRegionType Kind) override;
136 void EmitThumbFunc(MCSymbol *Func) override;
138 void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
139 void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
140 void EmitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel,
141 const MCSymbol *Label,
142 unsigned PointerSize) override;
143 void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
144 const MCSymbol *Label) override;
146 bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
148 void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) override;
149 void BeginCOFFSymbolDef(const MCSymbol *Symbol) override;
150 void EmitCOFFSymbolStorageClass(int StorageClass) override;
151 void EmitCOFFSymbolType(int Type) override;
152 void EndCOFFSymbolDef() override;
153 void EmitCOFFSectionIndex(MCSymbol const *Symbol) override;
154 void EmitCOFFSecRel32(MCSymbol const *Symbol) override;
155 void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) override;
156 void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
157 unsigned ByteAlignment) override;
159 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
161 /// @param Symbol - The common symbol to emit.
162 /// @param Size - The size of the common symbol.
163 /// @param ByteAlignment - The alignment of the common symbol in bytes.
164 void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
165 unsigned ByteAlignment) override;
167 void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
168 uint64_t Size = 0, unsigned ByteAlignment = 0) override;
170 void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
171 uint64_t Size, unsigned ByteAlignment = 0) override;
173 void EmitBytes(StringRef Data) override;
175 void EmitValueImpl(const MCExpr *Value, unsigned Size) override;
176 void EmitIntValue(uint64_t Value, unsigned Size) override;
178 void EmitULEB128Value(const MCExpr *Value) override;
180 void EmitSLEB128Value(const MCExpr *Value) override;
182 void EmitGPRel64Value(const MCExpr *Value) override;
184 void EmitGPRel32Value(const MCExpr *Value) override;
187 void EmitFill(uint64_t NumBytes, uint8_t FillValue) override;
189 void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
190 unsigned ValueSize = 1,
191 unsigned MaxBytesToEmit = 0) override;
193 void EmitCodeAlignment(unsigned ByteAlignment,
194 unsigned MaxBytesToEmit = 0) override;
196 bool EmitValueToOffset(const MCExpr *Offset,
197 unsigned char Value = 0) override;
199 void EmitFileDirective(StringRef Filename) override;
200 unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
202 unsigned CUID = 0) override;
203 void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
204 unsigned Column, unsigned Flags,
205 unsigned Isa, unsigned Discriminator,
206 StringRef FileName) override;
208 void EmitIdent(StringRef IdentString) override;
209 void EmitCFISections(bool EH, bool Debug) override;
210 void EmitCFIDefCfa(int64_t Register, int64_t Offset) override;
211 void EmitCFIDefCfaOffset(int64_t Offset) override;
212 void EmitCFIDefCfaRegister(int64_t Register) override;
213 void EmitCFIOffset(int64_t Register, int64_t Offset) override;
214 void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
215 void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
216 void EmitCFIRememberState() override;
217 void EmitCFIRestoreState() override;
218 void EmitCFISameValue(int64_t Register) override;
219 void EmitCFIRelOffset(int64_t Register, int64_t Offset) override;
220 void EmitCFIAdjustCfaOffset(int64_t Adjustment) override;
221 void EmitCFISignalFrame() override;
222 void EmitCFIUndefined(int64_t Register) override;
223 void EmitCFIRegister(int64_t Register1, int64_t Register2) override;
224 void EmitCFIWindowSave() override;
226 void EmitWin64EHStartProc(const MCSymbol *Symbol) override;
227 void EmitWin64EHEndProc() override;
228 void EmitWin64EHStartChained() override;
229 void EmitWin64EHEndChained() override;
230 void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
231 bool Except) override;
232 void EmitWin64EHHandlerData() override;
233 void EmitWin64EHPushReg(unsigned Register) override;
234 void EmitWin64EHSetFrame(unsigned Register, unsigned Offset) override;
235 void EmitWin64EHAllocStack(unsigned Size) override;
236 void EmitWin64EHSaveReg(unsigned Register, unsigned Offset) override;
237 void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) override;
238 void EmitWin64EHPushFrame(bool Code) override;
239 void EmitWin64EHEndProlog() override;
241 void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
243 void EmitBundleAlignMode(unsigned AlignPow2) override;
244 void EmitBundleLock(bool AlignToEnd) override;
245 void EmitBundleUnlock() override;
247 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
248 /// the specified string in the output .s file. This capability is
249 /// indicated by the hasRawTextSupport() predicate.
250 void EmitRawTextImpl(StringRef String) override;
252 void FinishImpl() override;
255 } // end anonymous namespace.
257 /// AddComment - Add a comment that can be emitted to the generated .s
258 /// file if applicable as a QoI issue to make the output of the compiler
259 /// more readable. This only affects the MCAsmStreamer, and only when
260 /// verbose assembly output is enabled.
261 void MCAsmStreamer::AddComment(const Twine &T) {
262 if (!IsVerboseAsm) return;
264 // Make sure that CommentStream is flushed.
265 CommentStream.flush();
267 T.toVector(CommentToEmit);
268 // Each comment goes on its own line.
269 CommentToEmit.push_back('\n');
271 // Tell the comment stream that the vector changed underneath it.
272 CommentStream.resync();
275 void MCAsmStreamer::EmitCommentsAndEOL() {
276 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
281 CommentStream.flush();
282 StringRef Comments = CommentToEmit.str();
284 assert(Comments.back() == '\n' &&
285 "Comment array not newline terminated");
287 // Emit a line of comments.
288 OS.PadToColumn(MAI->getCommentColumn());
289 size_t Position = Comments.find('\n');
290 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
292 Comments = Comments.substr(Position+1);
293 } while (!Comments.empty());
295 CommentToEmit.clear();
296 // Tell the comment stream that the vector changed underneath it.
297 CommentStream.resync();
300 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
301 assert(Bytes && "Invalid size!");
302 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
305 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
308 OS << MAI->getCommentString() << T;
312 void MCAsmStreamer::ChangeSection(const MCSection *Section,
313 const MCExpr *Subsection) {
314 assert(Section && "Cannot switch to a null section!");
315 Section->PrintSwitchToSection(*MAI, OS, Subsection);
318 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
319 MCSymbol *EHSymbol) {
323 unsigned Flags = FlagMap.lookup(Symbol);
325 if (Flags & EHGlobal)
326 EmitSymbolAttribute(EHSymbol, MCSA_Global);
327 if (Flags & EHWeakDefinition)
328 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
329 if (Flags & EHPrivateExtern)
330 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
333 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
334 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
335 MCStreamer::EmitLabel(Symbol);
337 OS << *Symbol << MAI->getLabelSuffix();
341 void MCAsmStreamer::EmitDebugLabel(MCSymbol *Symbol) {
342 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
343 MCStreamer::EmitDebugLabel(Symbol);
345 OS << *Symbol << MAI->getDebugLabelSuffix();
349 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
351 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
352 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
353 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
354 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
355 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
360 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
361 assert(!Options.empty() && "At least one option is required!");
362 OS << "\t.linker_option \"" << Options[0] << '"';
363 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
364 ie = Options.end(); it != ie; ++it) {
365 OS << ", " << '"' << *it << '"';
370 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
371 if (!MAI->doesSupportDataRegionDirectives())
374 case MCDR_DataRegion: OS << "\t.data_region"; break;
375 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
376 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
377 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
378 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
383 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
384 // This needs to emit to a temporary string to get properly quoted
385 // MCSymbols when they have spaces in them.
386 OS << "\t.thumb_func";
387 // Only Mach-O hasSubsectionsViaSymbols()
388 if (MAI->hasSubsectionsViaSymbols())
393 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
394 OS << *Symbol << " = " << *Value;
397 // FIXME: Lift context changes into super class.
398 Symbol->setVariableValue(Value);
401 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
402 OS << ".weakref " << *Alias << ", " << *Symbol;
406 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
407 const MCSymbol *LastLabel,
408 const MCSymbol *Label,
409 unsigned PointerSize) {
410 EmitDwarfSetLineAddr(LineDelta, Label, PointerSize);
413 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
414 const MCSymbol *Label) {
415 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
416 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
417 AddrDelta = ForceExpAbs(AddrDelta);
418 EmitValue(AddrDelta, 4);
422 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
423 MCSymbolAttr Attribute) {
425 case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
426 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
427 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
428 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
429 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
430 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
431 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
432 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
433 if (!MAI->hasDotTypeDotSizeDirective())
434 return false; // Symbol attribute not supported
435 OS << "\t.type\t" << *Symbol << ','
436 << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
438 default: return false;
439 case MCSA_ELF_TypeFunction: OS << "function"; break;
440 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
441 case MCSA_ELF_TypeObject: OS << "object"; break;
442 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
443 case MCSA_ELF_TypeCommon: OS << "common"; break;
444 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
445 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
449 case MCSA_Global: // .globl/.global
450 OS << MAI->getGlobalDirective();
451 FlagMap[Symbol] |= EHGlobal;
453 case MCSA_Hidden: OS << "\t.hidden\t"; break;
454 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
455 case MCSA_Internal: OS << "\t.internal\t"; break;
456 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
457 case MCSA_Local: OS << "\t.local\t"; break;
458 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
459 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
460 case MCSA_PrivateExtern:
461 OS << "\t.private_extern\t";
462 FlagMap[Symbol] |= EHPrivateExtern;
464 case MCSA_Protected: OS << "\t.protected\t"; break;
465 case MCSA_Reference: OS << "\t.reference\t"; break;
466 case MCSA_Weak: OS << "\t.weak\t"; break;
467 case MCSA_WeakDefinition:
468 OS << "\t.weak_definition\t";
469 FlagMap[Symbol] |= EHWeakDefinition;
472 case MCSA_WeakReference: OS << MAI->getWeakRefDirective(); break;
473 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
482 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
483 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
487 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
488 OS << "\t.def\t " << *Symbol << ';';
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::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
508 OS << "\t.secidx\t" << *Symbol;
512 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
513 OS << "\t.secrel32\t" << *Symbol;
517 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
518 assert(MAI->hasDotTypeDotSizeDirective());
519 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
522 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
523 unsigned ByteAlignment) {
524 // Common symbols do not belong to any actual section.
525 AssignSection(Symbol, NULL);
527 OS << "\t.comm\t" << *Symbol << ',' << Size;
528 if (ByteAlignment != 0) {
529 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
530 OS << ',' << ByteAlignment;
532 OS << ',' << Log2_32(ByteAlignment);
537 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
539 /// @param Symbol - The common symbol to emit.
540 /// @param Size - The size of the common symbol.
541 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
542 unsigned ByteAlign) {
543 // Common symbols do not belong to any actual section.
544 AssignSection(Symbol, NULL);
546 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
548 switch (MAI->getLCOMMDirectiveAlignmentType()) {
549 case LCOMM::NoAlignment:
550 llvm_unreachable("alignment not supported on .lcomm!");
551 case LCOMM::ByteAlignment:
552 OS << ',' << ByteAlign;
554 case LCOMM::Log2Alignment:
555 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
556 OS << ',' << Log2_32(ByteAlign);
563 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
564 uint64_t Size, unsigned ByteAlignment) {
566 AssignSection(Symbol, Section);
568 // Note: a .zerofill directive does not switch sections.
571 // This is a mach-o specific directive.
572 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
573 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
575 if (Symbol != NULL) {
576 OS << ',' << *Symbol << ',' << Size;
577 if (ByteAlignment != 0)
578 OS << ',' << Log2_32(ByteAlignment);
583 // .tbss sym, size, align
584 // This depends that the symbol has already been mangled from the original,
586 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
587 uint64_t Size, unsigned ByteAlignment) {
588 AssignSection(Symbol, Section);
590 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
591 // Instead of using the Section we'll just use the shortcut.
592 // This is a mach-o specific directive and section.
593 OS << ".tbss " << *Symbol << ", " << Size;
595 // Output align if we have it. We default to 1 so don't bother printing
597 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
602 static inline char toOctal(int X) { return (X&7)+'0'; }
604 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
607 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
608 unsigned char C = Data[i];
609 if (C == '"' || C == '\\') {
610 OS << '\\' << (char)C;
614 if (isprint((unsigned char)C)) {
620 case '\b': OS << "\\b"; break;
621 case '\f': OS << "\\f"; break;
622 case '\n': OS << "\\n"; break;
623 case '\r': OS << "\\r"; break;
624 case '\t': OS << "\\t"; break;
627 OS << toOctal(C >> 6);
628 OS << toOctal(C >> 3);
629 OS << toOctal(C >> 0);
638 void MCAsmStreamer::EmitBytes(StringRef Data) {
639 assert(getCurrentSection().first &&
640 "Cannot emit contents before setting section!");
641 if (Data.empty()) return;
643 if (Data.size() == 1) {
644 OS << MAI->getData8bitsDirective();
645 OS << (unsigned)(unsigned char)Data[0];
650 // If the data ends with 0 and the target supports .asciz, use it, otherwise
652 if (MAI->getAscizDirective() && Data.back() == 0) {
653 OS << MAI->getAscizDirective();
654 Data = Data.substr(0, Data.size()-1);
656 OS << MAI->getAsciiDirective();
659 PrintQuotedString(Data, OS);
663 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
664 EmitValue(MCConstantExpr::Create(Value, getContext()), Size);
667 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size) {
668 assert(Size <= 8 && "Invalid size");
669 assert(getCurrentSection().first &&
670 "Cannot emit contents before setting section!");
671 const char *Directive = 0;
674 case 1: Directive = MAI->getData8bitsDirective(); break;
675 case 2: Directive = MAI->getData16bitsDirective(); break;
676 case 4: Directive = MAI->getData32bitsDirective(); break;
677 case 8: Directive = MAI->getData64bitsDirective(); break;
682 if (!Value->EvaluateAsAbsolute(IntValue))
683 report_fatal_error("Don't know how to emit this value.");
685 // We couldn't handle the requested integer size so we fallback by breaking
686 // the request down into several, smaller, integers. Since sizes greater
687 // than eight are invalid and size equivalent to eight should have been
688 // handled earlier, we use four bytes as our largest piece of granularity.
689 bool IsLittleEndian = MAI->isLittleEndian();
690 for (unsigned Emitted = 0; Emitted != Size;) {
691 unsigned Remaining = Size - Emitted;
692 // The size of our partial emission must be a power of two less than
694 unsigned EmissionSize = PowerOf2Floor(Remaining);
695 if (EmissionSize > 4)
697 // Calculate the byte offset of our partial emission taking into account
698 // the endianness of the target.
699 unsigned ByteOffset =
700 IsLittleEndian ? Emitted : (Remaining - EmissionSize);
701 uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
702 // We truncate our partial emission to fit within the bounds of the
703 // emission domain. This produces nicer output and silences potential
704 // truncation warnings when round tripping through another assembler.
705 ValueToEmit &= ~0ULL >> (64 - EmissionSize * 8);
706 EmitIntValue(ValueToEmit, EmissionSize);
707 Emitted += EmissionSize;
712 assert(Directive && "Invalid size for machine code value!");
713 OS << Directive << *Value;
717 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
719 if (Value->EvaluateAsAbsolute(IntValue)) {
720 EmitULEB128IntValue(IntValue);
723 assert(MAI->hasLEB128() && "Cannot print a .uleb");
724 OS << ".uleb128 " << *Value;
728 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
730 if (Value->EvaluateAsAbsolute(IntValue)) {
731 EmitSLEB128IntValue(IntValue);
734 assert(MAI->hasLEB128() && "Cannot print a .sleb");
735 OS << ".sleb128 " << *Value;
739 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
740 assert(MAI->getGPRel64Directive() != 0);
741 OS << MAI->getGPRel64Directive() << *Value;
745 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
746 assert(MAI->getGPRel32Directive() != 0);
747 OS << MAI->getGPRel32Directive() << *Value;
752 /// EmitFill - Emit NumBytes bytes worth of the value specified by
753 /// FillValue. This implements directives such as '.space'.
754 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
755 if (NumBytes == 0) return;
757 if (const char *ZeroDirective = MAI->getZeroDirective()) {
758 OS << ZeroDirective << NumBytes;
760 OS << ',' << (int)FillValue;
765 // Emit a byte at a time.
766 MCStreamer::EmitFill(NumBytes, FillValue);
769 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
771 unsigned MaxBytesToEmit) {
772 // Some assemblers don't support non-power of two alignments, so we always
773 // emit alignments as a power of two if possible.
774 if (isPowerOf2_32(ByteAlignment)) {
777 llvm_unreachable("Invalid size for machine code value!");
788 llvm_unreachable("Unsupported alignment size!");
791 if (MAI->getAlignmentIsInBytes())
794 OS << Log2_32(ByteAlignment);
796 if (Value || MaxBytesToEmit) {
798 OS.write_hex(truncateToSize(Value, ValueSize));
801 OS << ", " << MaxBytesToEmit;
807 // Non-power of two alignment. This is not widely supported by assemblers.
808 // FIXME: Parameterize this based on MAI.
810 default: llvm_unreachable("Invalid size for machine code value!");
811 case 1: OS << ".balign"; break;
812 case 2: OS << ".balignw"; break;
813 case 4: OS << ".balignl"; break;
814 case 8: llvm_unreachable("Unsupported alignment size!");
817 OS << ' ' << ByteAlignment;
818 OS << ", " << truncateToSize(Value, ValueSize);
820 OS << ", " << MaxBytesToEmit;
824 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
825 unsigned MaxBytesToEmit) {
826 // Emit with a text fill value.
827 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
831 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
832 unsigned char Value) {
833 // FIXME: Verify that Offset is associated with the current section.
834 OS << ".org " << *Offset << ", " << (unsigned) Value;
840 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
841 assert(MAI->hasSingleParameterDotFile());
843 PrintQuotedString(Filename, OS);
847 unsigned MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo,
853 MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
854 unsigned NumFiles = Table.getMCDwarfFiles().size();
855 FileNo = Table.getFile(Directory, Filename, FileNo);
858 if (NumFiles == Table.getMCDwarfFiles().size())
861 SmallString<128> FullPathName;
863 if (!UseDwarfDirectory && !Directory.empty()) {
864 if (sys::path::is_absolute(Filename))
867 FullPathName = Directory;
868 sys::path::append(FullPathName, Filename);
870 Filename = FullPathName;
874 OS << "\t.file\t" << FileNo << ' ';
875 if (!Directory.empty()) {
876 PrintQuotedString(Directory, OS);
879 PrintQuotedString(Filename, OS);
885 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
886 unsigned Column, unsigned Flags,
888 unsigned Discriminator,
889 StringRef FileName) {
890 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
891 Isa, Discriminator, FileName);
892 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
893 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
894 OS << " basic_block";
895 if (Flags & DWARF2_FLAG_PROLOGUE_END)
896 OS << " prologue_end";
897 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
898 OS << " epilogue_begin";
900 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
901 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
904 if (Flags & DWARF2_FLAG_IS_STMT)
911 OS << " isa " << Isa;
913 OS << " discriminator " << Discriminator;
916 OS.PadToColumn(MAI->getCommentColumn());
917 OS << MAI->getCommentString() << ' ' << FileName << ':'
918 << Line << ':' << Column;
923 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
924 assert(MAI->hasIdentDirective() && ".ident directive not supported");
926 PrintQuotedString(IdentString, OS);
930 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
931 MCStreamer::EmitCFISections(EH, Debug);
936 OS << "\t.cfi_sections ";
940 OS << ", .debug_frame";
942 OS << ".debug_frame";
948 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
950 RecordProcStart(Frame);
954 OS << "\t.cfi_startproc";
960 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
962 RecordProcEnd(Frame);
966 // Put a dummy non-null value in Frame.End to mark that this frame has been
968 Frame.End = (MCSymbol *) 1;
970 OS << "\t.cfi_endproc";
974 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
975 if (InstPrinter && !MAI->useDwarfRegNumForCFI()) {
976 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
977 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
978 InstPrinter->printRegName(OS, LLVMRegister);
984 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
985 MCStreamer::EmitCFIDefCfa(Register, Offset);
990 OS << "\t.cfi_def_cfa ";
991 EmitRegisterName(Register);
992 OS << ", " << Offset;
996 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
997 MCStreamer::EmitCFIDefCfaOffset(Offset);
1002 OS << "\t.cfi_def_cfa_offset " << Offset;
1006 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
1007 MCStreamer::EmitCFIDefCfaRegister(Register);
1012 OS << "\t.cfi_def_cfa_register ";
1013 EmitRegisterName(Register);
1017 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1018 this->MCStreamer::EmitCFIOffset(Register, Offset);
1023 OS << "\t.cfi_offset ";
1024 EmitRegisterName(Register);
1025 OS << ", " << Offset;
1029 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1030 unsigned Encoding) {
1031 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1036 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
1040 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1041 MCStreamer::EmitCFILsda(Sym, Encoding);
1046 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
1050 void MCAsmStreamer::EmitCFIRememberState() {
1051 MCStreamer::EmitCFIRememberState();
1056 OS << "\t.cfi_remember_state";
1060 void MCAsmStreamer::EmitCFIRestoreState() {
1061 MCStreamer::EmitCFIRestoreState();
1066 OS << "\t.cfi_restore_state";
1070 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1071 MCStreamer::EmitCFISameValue(Register);
1076 OS << "\t.cfi_same_value ";
1077 EmitRegisterName(Register);
1081 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1082 MCStreamer::EmitCFIRelOffset(Register, Offset);
1087 OS << "\t.cfi_rel_offset ";
1088 EmitRegisterName(Register);
1089 OS << ", " << Offset;
1093 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1094 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1099 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1103 void MCAsmStreamer::EmitCFISignalFrame() {
1104 MCStreamer::EmitCFISignalFrame();
1109 OS << "\t.cfi_signal_frame";
1113 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1114 MCStreamer::EmitCFIUndefined(Register);
1119 OS << "\t.cfi_undefined " << Register;
1123 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1124 MCStreamer::EmitCFIRegister(Register1, Register2);
1129 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1133 void MCAsmStreamer::EmitCFIWindowSave() {
1134 MCStreamer::EmitCFIWindowSave();
1139 OS << "\t.cfi_window_save";
1143 void MCAsmStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
1144 MCStreamer::EmitWin64EHStartProc(Symbol);
1146 OS << ".seh_proc " << *Symbol;
1150 void MCAsmStreamer::EmitWin64EHEndProc() {
1151 MCStreamer::EmitWin64EHEndProc();
1153 OS << "\t.seh_endproc";
1157 void MCAsmStreamer::EmitWin64EHStartChained() {
1158 MCStreamer::EmitWin64EHStartChained();
1160 OS << "\t.seh_startchained";
1164 void MCAsmStreamer::EmitWin64EHEndChained() {
1165 MCStreamer::EmitWin64EHEndChained();
1167 OS << "\t.seh_endchained";
1171 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
1173 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
1175 OS << "\t.seh_handler " << *Sym;
1183 static const MCSection *getWin64EHTableSection(StringRef suffix,
1184 MCContext &context) {
1185 // FIXME: This doesn't belong in MCObjectFileInfo. However,
1186 /// this duplicate code in MCWin64EH.cpp.
1188 return context.getObjectFileInfo()->getXDataSection();
1189 return context.getCOFFSection((".xdata"+suffix).str(),
1190 COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
1191 COFF::IMAGE_SCN_MEM_READ |
1192 COFF::IMAGE_SCN_MEM_WRITE,
1193 SectionKind::getDataRel());
1196 void MCAsmStreamer::EmitWin64EHHandlerData() {
1197 MCStreamer::EmitWin64EHHandlerData();
1199 // Switch sections. Don't call SwitchSection directly, because that will
1200 // cause the section switch to be visible in the emitted assembly.
1201 // We only do this so the section switch that terminates the handler
1202 // data block is visible.
1203 MCWin64EHUnwindInfo *CurFrame = getCurrentW64UnwindInfo();
1204 StringRef suffix=MCWin64EHUnwindEmitter::GetSectionSuffix(CurFrame->Function);
1205 const MCSection *xdataSect = getWin64EHTableSection(suffix, getContext());
1207 SwitchSectionNoChange(xdataSect);
1209 OS << "\t.seh_handlerdata";
1213 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
1214 MCStreamer::EmitWin64EHPushReg(Register);
1216 OS << "\t.seh_pushreg " << Register;
1220 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
1221 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
1223 OS << "\t.seh_setframe " << Register << ", " << Offset;
1227 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
1228 MCStreamer::EmitWin64EHAllocStack(Size);
1230 OS << "\t.seh_stackalloc " << Size;
1234 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1235 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1237 OS << "\t.seh_savereg " << Register << ", " << Offset;
1241 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1242 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1244 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1248 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1249 MCStreamer::EmitWin64EHPushFrame(Code);
1251 OS << "\t.seh_pushframe";
1257 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1258 MCStreamer::EmitWin64EHEndProlog();
1260 OS << "\t.seh_endprologue";
1264 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1265 const MCSubtargetInfo &STI) {
1266 raw_ostream &OS = GetCommentOS();
1267 SmallString<256> Code;
1268 SmallVector<MCFixup, 4> Fixups;
1269 raw_svector_ostream VecOS(Code);
1270 Emitter->EncodeInstruction(Inst, VecOS, Fixups, STI);
1273 // If we are showing fixups, create symbolic markers in the encoded
1274 // representation. We do this by making a per-bit map to the fixup item index,
1275 // then trying to display it as nicely as possible.
1276 SmallVector<uint8_t, 64> FixupMap;
1277 FixupMap.resize(Code.size() * 8);
1278 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1281 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1282 MCFixup &F = Fixups[i];
1283 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1284 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1285 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1286 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1287 FixupMap[Index] = 1 + i;
1291 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1292 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1293 OS << "encoding: [";
1294 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1298 // See if all bits are the same map entry.
1299 uint8_t MapEntry = FixupMap[i * 8 + 0];
1300 for (unsigned j = 1; j != 8; ++j) {
1301 if (FixupMap[i * 8 + j] == MapEntry)
1304 MapEntry = uint8_t(~0U);
1308 if (MapEntry != uint8_t(~0U)) {
1309 if (MapEntry == 0) {
1310 OS << format("0x%02x", uint8_t(Code[i]));
1313 // FIXME: Some of the 8 bits require fix up.
1314 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1315 << char('A' + MapEntry - 1) << '\'';
1317 OS << char('A' + MapEntry - 1);
1320 // Otherwise, write out in binary.
1322 for (unsigned j = 8; j--;) {
1323 unsigned Bit = (Code[i] >> j) & 1;
1326 if (MAI->isLittleEndian())
1327 FixupBit = i * 8 + j;
1329 FixupBit = i * 8 + (7-j);
1331 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1332 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1333 OS << char('A' + MapEntry - 1);
1341 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1342 MCFixup &F = Fixups[i];
1343 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1344 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1345 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1349 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1350 assert(getCurrentSection().first &&
1351 "Cannot emit contents before setting section!");
1353 // Show the encoding in a comment if we have a code emitter.
1355 AddEncodingComment(Inst, STI);
1357 // Show the MCInst if enabled.
1359 Inst.dump_pretty(GetCommentOS(), MAI, InstPrinter.get(), "\n ");
1360 GetCommentOS() << "\n";
1363 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1365 InstPrinter->printInst(&Inst, OS, "");
1367 Inst.print(OS, MAI);
1371 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1372 OS << "\t.bundle_align_mode " << AlignPow2;
1376 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1377 OS << "\t.bundle_lock";
1379 OS << " align_to_end";
1383 void MCAsmStreamer::EmitBundleUnlock() {
1384 OS << "\t.bundle_unlock";
1388 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1389 /// the specified string in the output .s file. This capability is
1390 /// indicated by the hasRawTextSupport() predicate.
1391 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1392 if (!String.empty() && String.back() == '\n')
1393 String = String.substr(0, String.size()-1);
1398 void MCAsmStreamer::FinishImpl() {
1399 // If we are generating dwarf for assembly source files dump out the sections.
1400 if (getContext().getGenDwarfForAssembly())
1401 MCGenDwarfInfo::Emit(this, NULL);
1404 EmitFrames(AsmBackend.get(), false);
1407 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1408 formatted_raw_ostream &OS,
1409 bool isVerboseAsm, bool useCFI,
1410 bool useDwarfDirectory, MCInstPrinter *IP,
1411 MCCodeEmitter *CE, MCAsmBackend *MAB,
1413 return new MCAsmStreamer(Context, OS, isVerboseAsm, useCFI, useDwarfDirectory,
1414 IP, CE, MAB, ShowInst);