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 bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
201 StringRef Filename, unsigned CUID = 0) override;
202 void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
203 unsigned Column, unsigned Flags,
204 unsigned Isa, unsigned Discriminator,
205 StringRef FileName) override;
207 void EmitIdent(StringRef IdentString) override;
208 void EmitCFISections(bool EH, bool Debug) override;
209 void EmitCFIDefCfa(int64_t Register, int64_t Offset) override;
210 void EmitCFIDefCfaOffset(int64_t Offset) override;
211 void EmitCFIDefCfaRegister(int64_t Register) override;
212 void EmitCFIOffset(int64_t Register, int64_t Offset) override;
213 void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
214 void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
215 void EmitCFIRememberState() override;
216 void EmitCFIRestoreState() override;
217 void EmitCFISameValue(int64_t Register) override;
218 void EmitCFIRelOffset(int64_t Register, int64_t Offset) override;
219 void EmitCFIAdjustCfaOffset(int64_t Adjustment) override;
220 void EmitCFISignalFrame() override;
221 void EmitCFIUndefined(int64_t Register) override;
222 void EmitCFIRegister(int64_t Register1, int64_t Register2) override;
223 void EmitCFIWindowSave() override;
225 void EmitWin64EHStartProc(const MCSymbol *Symbol) override;
226 void EmitWin64EHEndProc() override;
227 void EmitWin64EHStartChained() override;
228 void EmitWin64EHEndChained() override;
229 void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
230 bool Except) override;
231 void EmitWin64EHHandlerData() override;
232 void EmitWin64EHPushReg(unsigned Register) override;
233 void EmitWin64EHSetFrame(unsigned Register, unsigned Offset) override;
234 void EmitWin64EHAllocStack(unsigned Size) override;
235 void EmitWin64EHSaveReg(unsigned Register, unsigned Offset) override;
236 void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) override;
237 void EmitWin64EHPushFrame(bool Code) override;
238 void EmitWin64EHEndProlog() override;
240 void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
242 void EmitBundleAlignMode(unsigned AlignPow2) override;
243 void EmitBundleLock(bool AlignToEnd) override;
244 void EmitBundleUnlock() override;
246 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
247 /// the specified string in the output .s file. This capability is
248 /// indicated by the hasRawTextSupport() predicate.
249 void EmitRawTextImpl(StringRef String) override;
251 void FinishImpl() override;
254 } // end anonymous namespace.
256 /// AddComment - Add a comment that can be emitted to the generated .s
257 /// file if applicable as a QoI issue to make the output of the compiler
258 /// more readable. This only affects the MCAsmStreamer, and only when
259 /// verbose assembly output is enabled.
260 void MCAsmStreamer::AddComment(const Twine &T) {
261 if (!IsVerboseAsm) return;
263 // Make sure that CommentStream is flushed.
264 CommentStream.flush();
266 T.toVector(CommentToEmit);
267 // Each comment goes on its own line.
268 CommentToEmit.push_back('\n');
270 // Tell the comment stream that the vector changed underneath it.
271 CommentStream.resync();
274 void MCAsmStreamer::EmitCommentsAndEOL() {
275 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
280 CommentStream.flush();
281 StringRef Comments = CommentToEmit.str();
283 assert(Comments.back() == '\n' &&
284 "Comment array not newline terminated");
286 // Emit a line of comments.
287 OS.PadToColumn(MAI->getCommentColumn());
288 size_t Position = Comments.find('\n');
289 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
291 Comments = Comments.substr(Position+1);
292 } while (!Comments.empty());
294 CommentToEmit.clear();
295 // Tell the comment stream that the vector changed underneath it.
296 CommentStream.resync();
299 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
300 assert(Bytes && "Invalid size!");
301 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
304 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
307 OS << MAI->getCommentString() << T;
311 void MCAsmStreamer::ChangeSection(const MCSection *Section,
312 const MCExpr *Subsection) {
313 assert(Section && "Cannot switch to a null section!");
314 Section->PrintSwitchToSection(*MAI, OS, Subsection);
317 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
318 MCSymbol *EHSymbol) {
322 unsigned Flags = FlagMap.lookup(Symbol);
324 if (Flags & EHGlobal)
325 EmitSymbolAttribute(EHSymbol, MCSA_Global);
326 if (Flags & EHWeakDefinition)
327 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
328 if (Flags & EHPrivateExtern)
329 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
332 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
333 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
334 MCStreamer::EmitLabel(Symbol);
336 OS << *Symbol << MAI->getLabelSuffix();
340 void MCAsmStreamer::EmitDebugLabel(MCSymbol *Symbol) {
341 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
342 MCStreamer::EmitDebugLabel(Symbol);
344 OS << *Symbol << MAI->getDebugLabelSuffix();
348 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
350 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
351 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
352 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
353 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
354 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
359 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
360 assert(!Options.empty() && "At least one option is required!");
361 OS << "\t.linker_option \"" << Options[0] << '"';
362 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
363 ie = Options.end(); it != ie; ++it) {
364 OS << ", " << '"' << *it << '"';
369 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
370 if (!MAI->doesSupportDataRegionDirectives())
373 case MCDR_DataRegion: OS << "\t.data_region"; break;
374 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
375 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
376 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
377 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
382 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
383 // This needs to emit to a temporary string to get properly quoted
384 // MCSymbols when they have spaces in them.
385 OS << "\t.thumb_func";
386 // Only Mach-O hasSubsectionsViaSymbols()
387 if (MAI->hasSubsectionsViaSymbols())
392 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
393 OS << *Symbol << " = " << *Value;
396 // FIXME: Lift context changes into super class.
397 Symbol->setVariableValue(Value);
400 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
401 OS << ".weakref " << *Alias << ", " << *Symbol;
405 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
406 const MCSymbol *LastLabel,
407 const MCSymbol *Label,
408 unsigned PointerSize) {
409 EmitDwarfSetLineAddr(LineDelta, Label, PointerSize);
412 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
413 const MCSymbol *Label) {
414 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
415 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
416 AddrDelta = ForceExpAbs(AddrDelta);
417 EmitValue(AddrDelta, 4);
421 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
422 MCSymbolAttr Attribute) {
424 case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
425 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
426 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
427 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
428 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
429 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
430 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
431 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
432 if (!MAI->hasDotTypeDotSizeDirective())
433 return false; // Symbol attribute not supported
434 OS << "\t.type\t" << *Symbol << ','
435 << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
437 default: return false;
438 case MCSA_ELF_TypeFunction: OS << "function"; break;
439 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
440 case MCSA_ELF_TypeObject: OS << "object"; break;
441 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
442 case MCSA_ELF_TypeCommon: OS << "common"; break;
443 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
444 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
448 case MCSA_Global: // .globl/.global
449 OS << MAI->getGlobalDirective();
450 FlagMap[Symbol] |= EHGlobal;
452 case MCSA_Hidden: OS << "\t.hidden\t"; break;
453 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
454 case MCSA_Internal: OS << "\t.internal\t"; break;
455 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
456 case MCSA_Local: OS << "\t.local\t"; break;
457 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
458 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
459 case MCSA_PrivateExtern:
460 OS << "\t.private_extern\t";
461 FlagMap[Symbol] |= EHPrivateExtern;
463 case MCSA_Protected: OS << "\t.protected\t"; break;
464 case MCSA_Reference: OS << "\t.reference\t"; break;
465 case MCSA_Weak: OS << "\t.weak\t"; break;
466 case MCSA_WeakDefinition:
467 OS << "\t.weak_definition\t";
468 FlagMap[Symbol] |= EHWeakDefinition;
471 case MCSA_WeakReference: OS << MAI->getWeakRefDirective(); break;
472 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
481 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
482 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
486 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
487 OS << "\t.def\t " << *Symbol << ';';
491 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
492 OS << "\t.scl\t" << StorageClass << ';';
496 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
497 OS << "\t.type\t" << Type << ';';
501 void MCAsmStreamer::EndCOFFSymbolDef() {
506 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
507 OS << "\t.secidx\t" << *Symbol;
511 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
512 OS << "\t.secrel32\t" << *Symbol;
516 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
517 assert(MAI->hasDotTypeDotSizeDirective());
518 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
521 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
522 unsigned ByteAlignment) {
523 // Common symbols do not belong to any actual section.
524 AssignSection(Symbol, NULL);
526 OS << "\t.comm\t" << *Symbol << ',' << Size;
527 if (ByteAlignment != 0) {
528 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
529 OS << ',' << ByteAlignment;
531 OS << ',' << Log2_32(ByteAlignment);
536 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
538 /// @param Symbol - The common symbol to emit.
539 /// @param Size - The size of the common symbol.
540 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
541 unsigned ByteAlign) {
542 // Common symbols do not belong to any actual section.
543 AssignSection(Symbol, NULL);
545 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
547 switch (MAI->getLCOMMDirectiveAlignmentType()) {
548 case LCOMM::NoAlignment:
549 llvm_unreachable("alignment not supported on .lcomm!");
550 case LCOMM::ByteAlignment:
551 OS << ',' << ByteAlign;
553 case LCOMM::Log2Alignment:
554 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
555 OS << ',' << Log2_32(ByteAlign);
562 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
563 uint64_t Size, unsigned ByteAlignment) {
565 AssignSection(Symbol, Section);
567 // Note: a .zerofill directive does not switch sections.
570 // This is a mach-o specific directive.
571 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
572 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
574 if (Symbol != NULL) {
575 OS << ',' << *Symbol << ',' << Size;
576 if (ByteAlignment != 0)
577 OS << ',' << Log2_32(ByteAlignment);
582 // .tbss sym, size, align
583 // This depends that the symbol has already been mangled from the original,
585 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
586 uint64_t Size, unsigned ByteAlignment) {
587 AssignSection(Symbol, Section);
589 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
590 // Instead of using the Section we'll just use the shortcut.
591 // This is a mach-o specific directive and section.
592 OS << ".tbss " << *Symbol << ", " << Size;
594 // Output align if we have it. We default to 1 so don't bother printing
596 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
601 static inline char toOctal(int X) { return (X&7)+'0'; }
603 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
606 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
607 unsigned char C = Data[i];
608 if (C == '"' || C == '\\') {
609 OS << '\\' << (char)C;
613 if (isprint((unsigned char)C)) {
619 case '\b': OS << "\\b"; break;
620 case '\f': OS << "\\f"; break;
621 case '\n': OS << "\\n"; break;
622 case '\r': OS << "\\r"; break;
623 case '\t': OS << "\\t"; break;
626 OS << toOctal(C >> 6);
627 OS << toOctal(C >> 3);
628 OS << toOctal(C >> 0);
637 void MCAsmStreamer::EmitBytes(StringRef Data) {
638 assert(getCurrentSection().first &&
639 "Cannot emit contents before setting section!");
640 if (Data.empty()) return;
642 if (Data.size() == 1) {
643 OS << MAI->getData8bitsDirective();
644 OS << (unsigned)(unsigned char)Data[0];
649 // If the data ends with 0 and the target supports .asciz, use it, otherwise
651 if (MAI->getAscizDirective() && Data.back() == 0) {
652 OS << MAI->getAscizDirective();
653 Data = Data.substr(0, Data.size()-1);
655 OS << MAI->getAsciiDirective();
658 PrintQuotedString(Data, OS);
662 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
663 EmitValue(MCConstantExpr::Create(Value, getContext()), Size);
666 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size) {
667 assert(Size <= 8 && "Invalid size");
668 assert(getCurrentSection().first &&
669 "Cannot emit contents before setting section!");
670 const char *Directive = 0;
673 case 1: Directive = MAI->getData8bitsDirective(); break;
674 case 2: Directive = MAI->getData16bitsDirective(); break;
675 case 4: Directive = MAI->getData32bitsDirective(); break;
676 case 8: Directive = MAI->getData64bitsDirective(); break;
681 if (!Value->EvaluateAsAbsolute(IntValue))
682 report_fatal_error("Don't know how to emit this value.");
684 // We couldn't handle the requested integer size so we fallback by breaking
685 // the request down into several, smaller, integers. Since sizes greater
686 // than eight are invalid and size equivalent to eight should have been
687 // handled earlier, we use four bytes as our largest piece of granularity.
688 bool IsLittleEndian = MAI->isLittleEndian();
689 for (unsigned Emitted = 0; Emitted != Size;) {
690 unsigned Remaining = Size - Emitted;
691 // The size of our partial emission must be a power of two less than
693 unsigned EmissionSize = PowerOf2Floor(Remaining);
694 if (EmissionSize > 4)
696 // Calculate the byte offset of our partial emission taking into account
697 // the endianness of the target.
698 unsigned ByteOffset =
699 IsLittleEndian ? Emitted : (Remaining - EmissionSize);
700 uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
701 // We truncate our partial emission to fit within the bounds of the
702 // emission domain. This produces nicer output and silences potential
703 // truncation warnings when round tripping through another assembler.
704 ValueToEmit &= ~0ULL >> (64 - EmissionSize * 8);
705 EmitIntValue(ValueToEmit, EmissionSize);
706 Emitted += EmissionSize;
711 assert(Directive && "Invalid size for machine code value!");
712 OS << Directive << *Value;
716 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
718 if (Value->EvaluateAsAbsolute(IntValue)) {
719 EmitULEB128IntValue(IntValue);
722 assert(MAI->hasLEB128() && "Cannot print a .uleb");
723 OS << ".uleb128 " << *Value;
727 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
729 if (Value->EvaluateAsAbsolute(IntValue)) {
730 EmitSLEB128IntValue(IntValue);
733 assert(MAI->hasLEB128() && "Cannot print a .sleb");
734 OS << ".sleb128 " << *Value;
738 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
739 assert(MAI->getGPRel64Directive() != 0);
740 OS << MAI->getGPRel64Directive() << *Value;
744 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
745 assert(MAI->getGPRel32Directive() != 0);
746 OS << MAI->getGPRel32Directive() << *Value;
751 /// EmitFill - Emit NumBytes bytes worth of the value specified by
752 /// FillValue. This implements directives such as '.space'.
753 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
754 if (NumBytes == 0) return;
756 if (const char *ZeroDirective = MAI->getZeroDirective()) {
757 OS << ZeroDirective << NumBytes;
759 OS << ',' << (int)FillValue;
764 // Emit a byte at a time.
765 MCStreamer::EmitFill(NumBytes, FillValue);
768 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
770 unsigned MaxBytesToEmit) {
771 // Some assemblers don't support non-power of two alignments, so we always
772 // emit alignments as a power of two if possible.
773 if (isPowerOf2_32(ByteAlignment)) {
776 llvm_unreachable("Invalid size for machine code value!");
787 llvm_unreachable("Unsupported alignment size!");
790 if (MAI->getAlignmentIsInBytes())
793 OS << Log2_32(ByteAlignment);
795 if (Value || MaxBytesToEmit) {
797 OS.write_hex(truncateToSize(Value, ValueSize));
800 OS << ", " << MaxBytesToEmit;
806 // Non-power of two alignment. This is not widely supported by assemblers.
807 // FIXME: Parameterize this based on MAI.
809 default: llvm_unreachable("Invalid size for machine code value!");
810 case 1: OS << ".balign"; break;
811 case 2: OS << ".balignw"; break;
812 case 4: OS << ".balignl"; break;
813 case 8: llvm_unreachable("Unsupported alignment size!");
816 OS << ' ' << ByteAlignment;
817 OS << ", " << truncateToSize(Value, ValueSize);
819 OS << ", " << MaxBytesToEmit;
823 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
824 unsigned MaxBytesToEmit) {
825 // Emit with a text fill value.
826 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
830 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
831 unsigned char Value) {
832 // FIXME: Verify that Offset is associated with the current section.
833 OS << ".org " << *Offset << ", " << (unsigned) Value;
839 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
840 assert(MAI->hasSingleParameterDotFile());
842 PrintQuotedString(Filename, OS);
846 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
847 StringRef Filename, unsigned CUID) {
848 if (!UseDwarfDirectory && !Directory.empty()) {
849 if (sys::path::is_absolute(Filename))
850 return EmitDwarfFileDirective(FileNo, "", Filename, CUID);
852 SmallString<128> FullPathName = Directory;
853 sys::path::append(FullPathName, Filename);
854 return EmitDwarfFileDirective(FileNo, "", FullPathName, CUID);
857 OS << "\t.file\t" << FileNo << ' ';
858 if (!Directory.empty()) {
859 PrintQuotedString(Directory, OS);
862 PrintQuotedString(Filename, OS);
864 // All .file will belong to a single CUID.
867 return this->MCStreamer::EmitDwarfFileDirective(FileNo, Directory, Filename,
871 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
872 unsigned Column, unsigned Flags,
874 unsigned Discriminator,
875 StringRef FileName) {
876 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
877 Isa, Discriminator, FileName);
878 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
879 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
880 OS << " basic_block";
881 if (Flags & DWARF2_FLAG_PROLOGUE_END)
882 OS << " prologue_end";
883 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
884 OS << " epilogue_begin";
886 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
887 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
890 if (Flags & DWARF2_FLAG_IS_STMT)
897 OS << " isa " << Isa;
899 OS << " discriminator " << Discriminator;
902 OS.PadToColumn(MAI->getCommentColumn());
903 OS << MAI->getCommentString() << ' ' << FileName << ':'
904 << Line << ':' << Column;
909 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
910 assert(MAI->hasIdentDirective() && ".ident directive not supported");
912 PrintQuotedString(IdentString, OS);
916 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
917 MCStreamer::EmitCFISections(EH, Debug);
922 OS << "\t.cfi_sections ";
926 OS << ", .debug_frame";
928 OS << ".debug_frame";
934 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
936 RecordProcStart(Frame);
940 OS << "\t.cfi_startproc";
946 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
948 RecordProcEnd(Frame);
952 // Put a dummy non-null value in Frame.End to mark that this frame has been
954 Frame.End = (MCSymbol *) 1;
956 OS << "\t.cfi_endproc";
960 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
961 if (InstPrinter && !MAI->useDwarfRegNumForCFI()) {
962 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
963 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
964 InstPrinter->printRegName(OS, LLVMRegister);
970 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
971 MCStreamer::EmitCFIDefCfa(Register, Offset);
976 OS << "\t.cfi_def_cfa ";
977 EmitRegisterName(Register);
978 OS << ", " << Offset;
982 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
983 MCStreamer::EmitCFIDefCfaOffset(Offset);
988 OS << "\t.cfi_def_cfa_offset " << Offset;
992 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
993 MCStreamer::EmitCFIDefCfaRegister(Register);
998 OS << "\t.cfi_def_cfa_register ";
999 EmitRegisterName(Register);
1003 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1004 this->MCStreamer::EmitCFIOffset(Register, Offset);
1009 OS << "\t.cfi_offset ";
1010 EmitRegisterName(Register);
1011 OS << ", " << Offset;
1015 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1016 unsigned Encoding) {
1017 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1022 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
1026 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1027 MCStreamer::EmitCFILsda(Sym, Encoding);
1032 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
1036 void MCAsmStreamer::EmitCFIRememberState() {
1037 MCStreamer::EmitCFIRememberState();
1042 OS << "\t.cfi_remember_state";
1046 void MCAsmStreamer::EmitCFIRestoreState() {
1047 MCStreamer::EmitCFIRestoreState();
1052 OS << "\t.cfi_restore_state";
1056 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1057 MCStreamer::EmitCFISameValue(Register);
1062 OS << "\t.cfi_same_value ";
1063 EmitRegisterName(Register);
1067 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1068 MCStreamer::EmitCFIRelOffset(Register, Offset);
1073 OS << "\t.cfi_rel_offset ";
1074 EmitRegisterName(Register);
1075 OS << ", " << Offset;
1079 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1080 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1085 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1089 void MCAsmStreamer::EmitCFISignalFrame() {
1090 MCStreamer::EmitCFISignalFrame();
1095 OS << "\t.cfi_signal_frame";
1099 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1100 MCStreamer::EmitCFIUndefined(Register);
1105 OS << "\t.cfi_undefined " << Register;
1109 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1110 MCStreamer::EmitCFIRegister(Register1, Register2);
1115 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1119 void MCAsmStreamer::EmitCFIWindowSave() {
1120 MCStreamer::EmitCFIWindowSave();
1125 OS << "\t.cfi_window_save";
1129 void MCAsmStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
1130 MCStreamer::EmitWin64EHStartProc(Symbol);
1132 OS << ".seh_proc " << *Symbol;
1136 void MCAsmStreamer::EmitWin64EHEndProc() {
1137 MCStreamer::EmitWin64EHEndProc();
1139 OS << "\t.seh_endproc";
1143 void MCAsmStreamer::EmitWin64EHStartChained() {
1144 MCStreamer::EmitWin64EHStartChained();
1146 OS << "\t.seh_startchained";
1150 void MCAsmStreamer::EmitWin64EHEndChained() {
1151 MCStreamer::EmitWin64EHEndChained();
1153 OS << "\t.seh_endchained";
1157 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
1159 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
1161 OS << "\t.seh_handler " << *Sym;
1169 static const MCSection *getWin64EHTableSection(StringRef suffix,
1170 MCContext &context) {
1171 // FIXME: This doesn't belong in MCObjectFileInfo. However,
1172 /// this duplicate code in MCWin64EH.cpp.
1174 return context.getObjectFileInfo()->getXDataSection();
1175 return context.getCOFFSection((".xdata"+suffix).str(),
1176 COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
1177 COFF::IMAGE_SCN_MEM_READ |
1178 COFF::IMAGE_SCN_MEM_WRITE,
1179 SectionKind::getDataRel());
1182 void MCAsmStreamer::EmitWin64EHHandlerData() {
1183 MCStreamer::EmitWin64EHHandlerData();
1185 // Switch sections. Don't call SwitchSection directly, because that will
1186 // cause the section switch to be visible in the emitted assembly.
1187 // We only do this so the section switch that terminates the handler
1188 // data block is visible.
1189 MCWin64EHUnwindInfo *CurFrame = getCurrentW64UnwindInfo();
1190 StringRef suffix=MCWin64EHUnwindEmitter::GetSectionSuffix(CurFrame->Function);
1191 const MCSection *xdataSect = getWin64EHTableSection(suffix, getContext());
1193 SwitchSectionNoChange(xdataSect);
1195 OS << "\t.seh_handlerdata";
1199 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
1200 MCStreamer::EmitWin64EHPushReg(Register);
1202 OS << "\t.seh_pushreg " << Register;
1206 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
1207 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
1209 OS << "\t.seh_setframe " << Register << ", " << Offset;
1213 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
1214 MCStreamer::EmitWin64EHAllocStack(Size);
1216 OS << "\t.seh_stackalloc " << Size;
1220 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1221 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1223 OS << "\t.seh_savereg " << Register << ", " << Offset;
1227 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1228 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1230 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1234 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1235 MCStreamer::EmitWin64EHPushFrame(Code);
1237 OS << "\t.seh_pushframe";
1243 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1244 MCStreamer::EmitWin64EHEndProlog();
1246 OS << "\t.seh_endprologue";
1250 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1251 const MCSubtargetInfo &STI) {
1252 raw_ostream &OS = GetCommentOS();
1253 SmallString<256> Code;
1254 SmallVector<MCFixup, 4> Fixups;
1255 raw_svector_ostream VecOS(Code);
1256 Emitter->EncodeInstruction(Inst, VecOS, Fixups, STI);
1259 // If we are showing fixups, create symbolic markers in the encoded
1260 // representation. We do this by making a per-bit map to the fixup item index,
1261 // then trying to display it as nicely as possible.
1262 SmallVector<uint8_t, 64> FixupMap;
1263 FixupMap.resize(Code.size() * 8);
1264 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1267 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1268 MCFixup &F = Fixups[i];
1269 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1270 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1271 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1272 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1273 FixupMap[Index] = 1 + i;
1277 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1278 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1279 OS << "encoding: [";
1280 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1284 // See if all bits are the same map entry.
1285 uint8_t MapEntry = FixupMap[i * 8 + 0];
1286 for (unsigned j = 1; j != 8; ++j) {
1287 if (FixupMap[i * 8 + j] == MapEntry)
1290 MapEntry = uint8_t(~0U);
1294 if (MapEntry != uint8_t(~0U)) {
1295 if (MapEntry == 0) {
1296 OS << format("0x%02x", uint8_t(Code[i]));
1299 // FIXME: Some of the 8 bits require fix up.
1300 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1301 << char('A' + MapEntry - 1) << '\'';
1303 OS << char('A' + MapEntry - 1);
1306 // Otherwise, write out in binary.
1308 for (unsigned j = 8; j--;) {
1309 unsigned Bit = (Code[i] >> j) & 1;
1312 if (MAI->isLittleEndian())
1313 FixupBit = i * 8 + j;
1315 FixupBit = i * 8 + (7-j);
1317 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1318 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1319 OS << char('A' + MapEntry - 1);
1327 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1328 MCFixup &F = Fixups[i];
1329 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1330 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1331 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1335 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1336 assert(getCurrentSection().first &&
1337 "Cannot emit contents before setting section!");
1339 // Show the encoding in a comment if we have a code emitter.
1341 AddEncodingComment(Inst, STI);
1343 // Show the MCInst if enabled.
1345 Inst.dump_pretty(GetCommentOS(), MAI, InstPrinter.get(), "\n ");
1346 GetCommentOS() << "\n";
1349 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1351 InstPrinter->printInst(&Inst, OS, "");
1353 Inst.print(OS, MAI);
1357 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1358 OS << "\t.bundle_align_mode " << AlignPow2;
1362 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1363 OS << "\t.bundle_lock";
1365 OS << " align_to_end";
1369 void MCAsmStreamer::EmitBundleUnlock() {
1370 OS << "\t.bundle_unlock";
1374 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1375 /// the specified string in the output .s file. This capability is
1376 /// indicated by the hasRawTextSupport() predicate.
1377 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1378 if (!String.empty() && String.back() == '\n')
1379 String = String.substr(0, String.size()-1);
1384 void MCAsmStreamer::FinishImpl() {
1385 // If we are generating dwarf for assembly source files dump out the sections.
1386 if (getContext().getGenDwarfForAssembly())
1387 MCGenDwarfInfo::Emit(this, NULL);
1390 EmitFrames(AsmBackend.get(), false);
1393 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1394 formatted_raw_ostream &OS,
1395 bool isVerboseAsm, bool useCFI,
1396 bool useDwarfDirectory, MCInstPrinter *IP,
1397 MCCodeEmitter *CE, MCAsmBackend *MAB,
1399 return new MCAsmStreamer(Context, OS, isVerboseAsm, useCFI, useDwarfDirectory,
1400 IP, CE, MAB, ShowInst);