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/OwningPtr.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/MCSymbol.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 : public MCStreamer {
41 formatted_raw_ostream &OS;
44 OwningPtr<MCInstPrinter> InstPrinter;
45 OwningPtr<MCCodeEmitter> Emitter;
46 OwningPtr<MCAsmBackend> AsmBackend;
48 SmallString<128> CommentToEmit;
49 raw_svector_ostream CommentStream;
51 unsigned IsVerboseAsm : 1;
52 unsigned ShowInst : 1;
55 unsigned UseDwarfDirectory : 1;
57 enum EHSymbolFlags { EHGlobal = 1,
58 EHWeakDefinition = 1 << 1,
59 EHPrivateExtern = 1 << 2 };
60 DenseMap<const MCSymbol*, unsigned> FlagMap;
62 bool needsSet(const MCExpr *Value);
64 void EmitRegisterName(int64_t Register);
65 virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
66 virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame);
69 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
70 bool isVerboseAsm, bool useLoc, bool useCFI,
71 bool useDwarfDirectory, MCInstPrinter *printer,
72 MCCodeEmitter *emitter, MCAsmBackend *asmbackend, bool showInst)
73 : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
74 InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
75 CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
76 ShowInst(showInst), UseLoc(useLoc), UseCFI(useCFI),
77 UseDwarfDirectory(useDwarfDirectory) {
78 if (InstPrinter && IsVerboseAsm)
79 InstPrinter->setCommentStream(CommentStream);
83 inline void EmitEOL() {
84 // If we don't have any comments, just emit a \n.
91 void EmitCommentsAndEOL();
93 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
95 virtual bool isVerboseAsm() const { return IsVerboseAsm; }
97 /// hasRawTextSupport - We support EmitRawText.
98 virtual bool hasRawTextSupport() const { return true; }
100 /// AddComment - Add a comment that can be emitted to the generated .s
101 /// file if applicable as a QoI issue to make the output of the compiler
102 /// more readable. This only affects the MCAsmStreamer, and only when
103 /// verbose assembly output is enabled.
104 virtual void AddComment(const Twine &T);
106 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
107 virtual void AddEncodingComment(const MCInst &Inst, const MCSubtargetInfo &);
109 /// GetCommentOS - Return a raw_ostream that comments can be written to.
110 /// Unlike AddComment, you are required to terminate comments with \n if you
112 virtual raw_ostream &GetCommentOS() {
114 return nulls(); // Discard comments unless in verbose asm mode.
115 return CommentStream;
118 void emitRawComment(const Twine &T, bool TabPrefix = true) LLVM_OVERRIDE;
120 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
121 virtual void AddBlankLine() {
125 /// @name MCStreamer Interface
128 virtual void ChangeSection(const MCSection *Section,
129 const MCExpr *Subsection);
131 virtual void InitSections(bool Force) {
133 SwitchSection(getContext().getObjectFileInfo()->getTextSection());
136 virtual void EmitLabel(MCSymbol *Symbol);
137 virtual void EmitDebugLabel(MCSymbol *Symbol);
139 virtual void EmitEHSymAttributes(const MCSymbol *Symbol,
141 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
142 virtual void EmitLinkerOptions(ArrayRef<std::string> Options);
143 virtual void EmitDataRegion(MCDataRegionType Kind);
144 virtual void EmitThumbFunc(MCSymbol *Func);
146 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
147 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
148 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
149 const MCSymbol *LastLabel,
150 const MCSymbol *Label,
151 unsigned PointerSize);
152 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
153 const MCSymbol *Label);
155 virtual bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
157 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
158 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
159 virtual void EmitCOFFSymbolStorageClass(int StorageClass);
160 virtual void EmitCOFFSymbolType(int Type);
161 virtual void EndCOFFSymbolDef();
162 virtual void EmitCOFFSectionIndex(MCSymbol const *Symbol);
163 virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
164 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
165 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
166 unsigned ByteAlignment);
168 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
170 /// @param Symbol - The common symbol to emit.
171 /// @param Size - The size of the common symbol.
172 /// @param ByteAlignment - The alignment of the common symbol in bytes.
173 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
174 unsigned ByteAlignment);
176 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
177 uint64_t Size = 0, unsigned ByteAlignment = 0);
179 virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
180 uint64_t Size, unsigned ByteAlignment = 0);
182 virtual void EmitBytes(StringRef Data);
184 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size);
185 virtual void EmitIntValue(uint64_t Value, unsigned Size);
187 virtual void EmitULEB128Value(const MCExpr *Value);
189 virtual void EmitSLEB128Value(const MCExpr *Value);
191 virtual void EmitGPRel64Value(const MCExpr *Value);
193 virtual void EmitGPRel32Value(const MCExpr *Value);
196 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
198 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
199 unsigned ValueSize = 1,
200 unsigned MaxBytesToEmit = 0);
202 virtual void EmitCodeAlignment(unsigned ByteAlignment,
203 unsigned MaxBytesToEmit = 0);
205 virtual bool EmitValueToOffset(const MCExpr *Offset,
206 unsigned char Value = 0);
208 virtual void EmitFileDirective(StringRef Filename);
209 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
210 StringRef Filename, unsigned CUID = 0);
211 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
212 unsigned Column, unsigned Flags,
213 unsigned Isa, unsigned Discriminator,
216 virtual void EmitIdent(StringRef IdentString);
217 virtual void EmitCFISections(bool EH, bool Debug);
218 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
219 virtual void EmitCFIDefCfaOffset(int64_t Offset);
220 virtual void EmitCFIDefCfaRegister(int64_t Register);
221 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
222 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
223 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
224 virtual void EmitCFIRememberState();
225 virtual void EmitCFIRestoreState();
226 virtual void EmitCFISameValue(int64_t Register);
227 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
228 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
229 virtual void EmitCFISignalFrame();
230 virtual void EmitCFIUndefined(int64_t Register);
231 virtual void EmitCFIRegister(int64_t Register1, int64_t Register2);
232 virtual void EmitCFIWindowSave();
234 virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
235 virtual void EmitWin64EHEndProc();
236 virtual void EmitWin64EHStartChained();
237 virtual void EmitWin64EHEndChained();
238 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
240 virtual void EmitWin64EHHandlerData();
241 virtual void EmitWin64EHPushReg(unsigned Register);
242 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
243 virtual void EmitWin64EHAllocStack(unsigned Size);
244 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
245 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
246 virtual void EmitWin64EHPushFrame(bool Code);
247 virtual void EmitWin64EHEndProlog();
249 virtual void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI);
251 virtual void EmitBundleAlignMode(unsigned AlignPow2);
252 virtual void EmitBundleLock(bool AlignToEnd);
253 virtual void EmitBundleUnlock();
255 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
256 /// the specified string in the output .s file. This capability is
257 /// indicated by the hasRawTextSupport() predicate.
258 virtual void EmitRawTextImpl(StringRef String);
260 virtual void FinishImpl();
263 } // end anonymous namespace.
265 /// AddComment - Add a comment that can be emitted to the generated .s
266 /// file if applicable as a QoI issue to make the output of the compiler
267 /// more readable. This only affects the MCAsmStreamer, and only when
268 /// verbose assembly output is enabled.
269 void MCAsmStreamer::AddComment(const Twine &T) {
270 if (!IsVerboseAsm) return;
272 // Make sure that CommentStream is flushed.
273 CommentStream.flush();
275 T.toVector(CommentToEmit);
276 // Each comment goes on its own line.
277 CommentToEmit.push_back('\n');
279 // Tell the comment stream that the vector changed underneath it.
280 CommentStream.resync();
283 void MCAsmStreamer::EmitCommentsAndEOL() {
284 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
289 CommentStream.flush();
290 StringRef Comments = CommentToEmit.str();
292 assert(Comments.back() == '\n' &&
293 "Comment array not newline terminated");
295 // Emit a line of comments.
296 OS.PadToColumn(MAI->getCommentColumn());
297 size_t Position = Comments.find('\n');
298 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
300 Comments = Comments.substr(Position+1);
301 } while (!Comments.empty());
303 CommentToEmit.clear();
304 // Tell the comment stream that the vector changed underneath it.
305 CommentStream.resync();
308 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
309 assert(Bytes && "Invalid size!");
310 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
313 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
316 OS << MAI->getCommentString() << T;
320 void MCAsmStreamer::ChangeSection(const MCSection *Section,
321 const MCExpr *Subsection) {
322 assert(Section && "Cannot switch to a null section!");
323 Section->PrintSwitchToSection(*MAI, OS, Subsection);
326 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
327 MCSymbol *EHSymbol) {
331 unsigned Flags = FlagMap.lookup(Symbol);
333 if (Flags & EHGlobal)
334 EmitSymbolAttribute(EHSymbol, MCSA_Global);
335 if (Flags & EHWeakDefinition)
336 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
337 if (Flags & EHPrivateExtern)
338 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
341 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
342 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
343 MCStreamer::EmitLabel(Symbol);
345 OS << *Symbol << MAI->getLabelSuffix();
349 void MCAsmStreamer::EmitDebugLabel(MCSymbol *Symbol) {
350 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
351 MCStreamer::EmitDebugLabel(Symbol);
353 OS << *Symbol << MAI->getDebugLabelSuffix();
357 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
359 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
360 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
361 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
362 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
363 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
368 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
369 assert(!Options.empty() && "At least one option is required!");
370 OS << "\t.linker_option \"" << Options[0] << '"';
371 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
372 ie = Options.end(); it != ie; ++it) {
373 OS << ", " << '"' << *it << '"';
378 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
379 if (!MAI->doesSupportDataRegionDirectives())
382 case MCDR_DataRegion: OS << "\t.data_region"; break;
383 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
384 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
385 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
386 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
391 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
392 // This needs to emit to a temporary string to get properly quoted
393 // MCSymbols when they have spaces in them.
394 OS << "\t.thumb_func";
395 // Only Mach-O hasSubsectionsViaSymbols()
396 if (MAI->hasSubsectionsViaSymbols())
401 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
402 OS << *Symbol << " = " << *Value;
405 // FIXME: Lift context changes into super class.
406 Symbol->setVariableValue(Value);
409 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
410 OS << ".weakref " << *Alias << ", " << *Symbol;
414 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
415 const MCSymbol *LastLabel,
416 const MCSymbol *Label,
417 unsigned PointerSize) {
418 EmitDwarfSetLineAddr(LineDelta, Label, PointerSize);
421 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
422 const MCSymbol *Label) {
423 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
424 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
425 AddrDelta = ForceExpAbs(AddrDelta);
426 EmitValue(AddrDelta, 4);
430 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
431 MCSymbolAttr Attribute) {
433 case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
434 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
435 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
436 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
437 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
438 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
439 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
440 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
441 if (!MAI->hasDotTypeDotSizeDirective())
442 return false; // Symbol attribute not supported
443 OS << "\t.type\t" << *Symbol << ','
444 << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
446 default: return false;
447 case MCSA_ELF_TypeFunction: OS << "function"; break;
448 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
449 case MCSA_ELF_TypeObject: OS << "object"; break;
450 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
451 case MCSA_ELF_TypeCommon: OS << "common"; break;
452 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
453 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
457 case MCSA_Global: // .globl/.global
458 OS << MAI->getGlobalDirective();
459 FlagMap[Symbol] |= EHGlobal;
461 case MCSA_Hidden: OS << "\t.hidden\t"; break;
462 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
463 case MCSA_Internal: OS << "\t.internal\t"; break;
464 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
465 case MCSA_Local: OS << "\t.local\t"; break;
466 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
467 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
468 case MCSA_PrivateExtern:
469 OS << "\t.private_extern\t";
470 FlagMap[Symbol] |= EHPrivateExtern;
472 case MCSA_Protected: OS << "\t.protected\t"; break;
473 case MCSA_Reference: OS << "\t.reference\t"; break;
474 case MCSA_Weak: OS << "\t.weak\t"; break;
475 case MCSA_WeakDefinition:
476 OS << "\t.weak_definition\t";
477 FlagMap[Symbol] |= EHWeakDefinition;
480 case MCSA_WeakReference: OS << MAI->getWeakRefDirective(); break;
481 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
490 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
491 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
495 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
496 OS << "\t.def\t " << *Symbol << ';';
500 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
501 OS << "\t.scl\t" << StorageClass << ';';
505 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
506 OS << "\t.type\t" << Type << ';';
510 void MCAsmStreamer::EndCOFFSymbolDef() {
515 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
516 OS << "\t.secidx\t" << *Symbol;
520 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
521 OS << "\t.secrel32\t" << *Symbol;
525 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
526 assert(MAI->hasDotTypeDotSizeDirective());
527 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
530 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
531 unsigned ByteAlignment) {
532 // Common symbols do not belong to any actual section.
533 AssignSection(Symbol, NULL);
535 OS << "\t.comm\t" << *Symbol << ',' << Size;
536 if (ByteAlignment != 0) {
537 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
538 OS << ',' << ByteAlignment;
540 OS << ',' << Log2_32(ByteAlignment);
545 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
547 /// @param Symbol - The common symbol to emit.
548 /// @param Size - The size of the common symbol.
549 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
550 unsigned ByteAlign) {
551 // Common symbols do not belong to any actual section.
552 AssignSection(Symbol, NULL);
554 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
556 switch (MAI->getLCOMMDirectiveAlignmentType()) {
557 case LCOMM::NoAlignment:
558 llvm_unreachable("alignment not supported on .lcomm!");
559 case LCOMM::ByteAlignment:
560 OS << ',' << ByteAlign;
562 case LCOMM::Log2Alignment:
563 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
564 OS << ',' << Log2_32(ByteAlign);
571 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
572 uint64_t Size, unsigned ByteAlignment) {
574 AssignSection(Symbol, Section);
576 // Note: a .zerofill directive does not switch sections.
579 // This is a mach-o specific directive.
580 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
581 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
583 if (Symbol != NULL) {
584 OS << ',' << *Symbol << ',' << Size;
585 if (ByteAlignment != 0)
586 OS << ',' << Log2_32(ByteAlignment);
591 // .tbss sym, size, align
592 // This depends that the symbol has already been mangled from the original,
594 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
595 uint64_t Size, unsigned ByteAlignment) {
596 AssignSection(Symbol, Section);
598 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
599 // Instead of using the Section we'll just use the shortcut.
600 // This is a mach-o specific directive and section.
601 OS << ".tbss " << *Symbol << ", " << Size;
603 // Output align if we have it. We default to 1 so don't bother printing
605 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
610 static inline char toOctal(int X) { return (X&7)+'0'; }
612 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
615 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
616 unsigned char C = Data[i];
617 if (C == '"' || C == '\\') {
618 OS << '\\' << (char)C;
622 if (isprint((unsigned char)C)) {
628 case '\b': OS << "\\b"; break;
629 case '\f': OS << "\\f"; break;
630 case '\n': OS << "\\n"; break;
631 case '\r': OS << "\\r"; break;
632 case '\t': OS << "\\t"; break;
635 OS << toOctal(C >> 6);
636 OS << toOctal(C >> 3);
637 OS << toOctal(C >> 0);
646 void MCAsmStreamer::EmitBytes(StringRef Data) {
647 assert(getCurrentSection().first &&
648 "Cannot emit contents before setting section!");
649 if (Data.empty()) return;
651 if (Data.size() == 1) {
652 OS << MAI->getData8bitsDirective();
653 OS << (unsigned)(unsigned char)Data[0];
658 // If the data ends with 0 and the target supports .asciz, use it, otherwise
660 if (MAI->getAscizDirective() && Data.back() == 0) {
661 OS << MAI->getAscizDirective();
662 Data = Data.substr(0, Data.size()-1);
664 OS << MAI->getAsciiDirective();
667 PrintQuotedString(Data, OS);
671 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
672 EmitValue(MCConstantExpr::Create(Value, getContext()), Size);
675 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size) {
676 assert(Size <= 8 && "Invalid size");
677 assert(getCurrentSection().first &&
678 "Cannot emit contents before setting section!");
679 const char *Directive = 0;
682 case 1: Directive = MAI->getData8bitsDirective(); break;
683 case 2: Directive = MAI->getData16bitsDirective(); break;
684 case 4: Directive = MAI->getData32bitsDirective(); break;
685 case 8: Directive = MAI->getData64bitsDirective(); break;
690 if (!Value->EvaluateAsAbsolute(IntValue))
691 report_fatal_error("Don't know how to emit this value.");
693 // We couldn't handle the requested integer size so we fallback by breaking
694 // the request down into several, smaller, integers. Since sizes greater
695 // than eight are invalid and size equivalent to eight should have been
696 // handled earlier, we use four bytes as our largest piece of granularity.
697 bool IsLittleEndian = MAI->isLittleEndian();
698 for (unsigned Emitted = 0; Emitted != Size;) {
699 unsigned Remaining = Size - Emitted;
700 // The size of our partial emission must be a power of two less than
702 unsigned EmissionSize = PowerOf2Floor(Remaining);
703 if (EmissionSize > 4)
705 // Calculate the byte offset of our partial emission taking into account
706 // the endianness of the target.
707 unsigned ByteOffset =
708 IsLittleEndian ? Emitted : (Remaining - EmissionSize);
709 uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
710 // We truncate our partial emission to fit within the bounds of the
711 // emission domain. This produces nicer output and silences potential
712 // truncation warnings when round tripping through another assembler.
713 ValueToEmit &= ~0ULL >> (64 - EmissionSize * 8);
714 EmitIntValue(ValueToEmit, EmissionSize);
715 Emitted += EmissionSize;
720 assert(Directive && "Invalid size for machine code value!");
721 OS << Directive << *Value;
725 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
727 if (Value->EvaluateAsAbsolute(IntValue)) {
728 EmitULEB128IntValue(IntValue);
731 assert(MAI->hasLEB128() && "Cannot print a .uleb");
732 OS << ".uleb128 " << *Value;
736 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
738 if (Value->EvaluateAsAbsolute(IntValue)) {
739 EmitSLEB128IntValue(IntValue);
742 assert(MAI->hasLEB128() && "Cannot print a .sleb");
743 OS << ".sleb128 " << *Value;
747 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
748 assert(MAI->getGPRel64Directive() != 0);
749 OS << MAI->getGPRel64Directive() << *Value;
753 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
754 assert(MAI->getGPRel32Directive() != 0);
755 OS << MAI->getGPRel32Directive() << *Value;
760 /// EmitFill - Emit NumBytes bytes worth of the value specified by
761 /// FillValue. This implements directives such as '.space'.
762 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
763 if (NumBytes == 0) return;
765 if (const char *ZeroDirective = MAI->getZeroDirective()) {
766 OS << ZeroDirective << NumBytes;
768 OS << ',' << (int)FillValue;
773 // Emit a byte at a time.
774 MCStreamer::EmitFill(NumBytes, FillValue);
777 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
779 unsigned MaxBytesToEmit) {
780 // Some assemblers don't support non-power of two alignments, so we always
781 // emit alignments as a power of two if possible.
782 if (isPowerOf2_32(ByteAlignment)) {
784 default: llvm_unreachable("Invalid size for machine code value!");
785 case 1: OS << MAI->getAlignDirective(); break;
786 // FIXME: use MAI for this!
787 case 2: OS << ".p2alignw "; break;
788 case 4: OS << ".p2alignl "; break;
789 case 8: llvm_unreachable("Unsupported alignment size!");
792 if (MAI->getAlignmentIsInBytes())
795 OS << Log2_32(ByteAlignment);
797 if (Value || MaxBytesToEmit) {
799 OS.write_hex(truncateToSize(Value, ValueSize));
802 OS << ", " << MaxBytesToEmit;
808 // Non-power of two alignment. This is not widely supported by assemblers.
809 // FIXME: Parameterize this based on MAI.
811 default: llvm_unreachable("Invalid size for machine code value!");
812 case 1: OS << ".balign"; break;
813 case 2: OS << ".balignw"; break;
814 case 4: OS << ".balignl"; break;
815 case 8: llvm_unreachable("Unsupported alignment size!");
818 OS << ' ' << ByteAlignment;
819 OS << ", " << truncateToSize(Value, ValueSize);
821 OS << ", " << MaxBytesToEmit;
825 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
826 unsigned MaxBytesToEmit) {
827 // Emit with a text fill value.
828 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
832 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
833 unsigned char Value) {
834 // FIXME: Verify that Offset is associated with the current section.
835 OS << ".org " << *Offset << ", " << (unsigned) Value;
841 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
842 assert(MAI->hasSingleParameterDotFile());
844 PrintQuotedString(Filename, OS);
848 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
849 StringRef Filename, unsigned CUID) {
850 if (!UseDwarfDirectory && !Directory.empty()) {
851 if (sys::path::is_absolute(Filename))
852 return EmitDwarfFileDirective(FileNo, "", Filename, CUID);
854 SmallString<128> FullPathName = Directory;
855 sys::path::append(FullPathName, Filename);
856 return EmitDwarfFileDirective(FileNo, "", FullPathName, CUID);
860 OS << "\t.file\t" << FileNo << ' ';
861 if (!Directory.empty()) {
862 PrintQuotedString(Directory, OS);
865 PrintQuotedString(Filename, OS);
867 // All .file will belong to a single CUID.
870 return this->MCStreamer::EmitDwarfFileDirective(FileNo, Directory, Filename,
874 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
875 unsigned Column, unsigned Flags,
877 unsigned Discriminator,
878 StringRef FileName) {
879 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
880 Isa, Discriminator, FileName);
884 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
885 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
886 OS << " basic_block";
887 if (Flags & DWARF2_FLAG_PROLOGUE_END)
888 OS << " prologue_end";
889 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
890 OS << " epilogue_begin";
892 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
893 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
896 if (Flags & DWARF2_FLAG_IS_STMT)
905 OS << "discriminator " << Discriminator;
908 OS.PadToColumn(MAI->getCommentColumn());
909 OS << MAI->getCommentString() << ' ' << FileName << ':'
910 << Line << ':' << Column;
915 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
916 assert(MAI->hasIdentDirective() && ".ident directive not supported");
918 PrintQuotedString(IdentString, OS);
922 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
923 MCStreamer::EmitCFISections(EH, Debug);
928 OS << "\t.cfi_sections ";
932 OS << ", .debug_frame";
934 OS << ".debug_frame";
940 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
942 RecordProcStart(Frame);
946 OS << "\t.cfi_startproc";
952 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
954 RecordProcEnd(Frame);
958 // Put a dummy non-null value in Frame.End to mark that this frame has been
960 Frame.End = (MCSymbol *) 1;
962 OS << "\t.cfi_endproc";
966 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
967 if (InstPrinter && !MAI->useDwarfRegNumForCFI()) {
968 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
969 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
970 InstPrinter->printRegName(OS, LLVMRegister);
976 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
977 MCStreamer::EmitCFIDefCfa(Register, Offset);
982 OS << "\t.cfi_def_cfa ";
983 EmitRegisterName(Register);
984 OS << ", " << Offset;
988 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
989 MCStreamer::EmitCFIDefCfaOffset(Offset);
994 OS << "\t.cfi_def_cfa_offset " << Offset;
998 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
999 MCStreamer::EmitCFIDefCfaRegister(Register);
1004 OS << "\t.cfi_def_cfa_register ";
1005 EmitRegisterName(Register);
1009 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1010 this->MCStreamer::EmitCFIOffset(Register, Offset);
1015 OS << "\t.cfi_offset ";
1016 EmitRegisterName(Register);
1017 OS << ", " << Offset;
1021 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1022 unsigned Encoding) {
1023 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1028 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
1032 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1033 MCStreamer::EmitCFILsda(Sym, Encoding);
1038 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
1042 void MCAsmStreamer::EmitCFIRememberState() {
1043 MCStreamer::EmitCFIRememberState();
1048 OS << "\t.cfi_remember_state";
1052 void MCAsmStreamer::EmitCFIRestoreState() {
1053 MCStreamer::EmitCFIRestoreState();
1058 OS << "\t.cfi_restore_state";
1062 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1063 MCStreamer::EmitCFISameValue(Register);
1068 OS << "\t.cfi_same_value ";
1069 EmitRegisterName(Register);
1073 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1074 MCStreamer::EmitCFIRelOffset(Register, Offset);
1079 OS << "\t.cfi_rel_offset ";
1080 EmitRegisterName(Register);
1081 OS << ", " << Offset;
1085 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1086 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1091 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1095 void MCAsmStreamer::EmitCFISignalFrame() {
1096 MCStreamer::EmitCFISignalFrame();
1101 OS << "\t.cfi_signal_frame";
1105 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1106 MCStreamer::EmitCFIUndefined(Register);
1111 OS << "\t.cfi_undefined " << Register;
1115 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1116 MCStreamer::EmitCFIRegister(Register1, Register2);
1121 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1125 void MCAsmStreamer::EmitCFIWindowSave() {
1126 MCStreamer::EmitCFIWindowSave();
1131 OS << "\t.cfi_window_save";
1135 void MCAsmStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
1136 MCStreamer::EmitWin64EHStartProc(Symbol);
1138 OS << ".seh_proc " << *Symbol;
1142 void MCAsmStreamer::EmitWin64EHEndProc() {
1143 MCStreamer::EmitWin64EHEndProc();
1145 OS << "\t.seh_endproc";
1149 void MCAsmStreamer::EmitWin64EHStartChained() {
1150 MCStreamer::EmitWin64EHStartChained();
1152 OS << "\t.seh_startchained";
1156 void MCAsmStreamer::EmitWin64EHEndChained() {
1157 MCStreamer::EmitWin64EHEndChained();
1159 OS << "\t.seh_endchained";
1163 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
1165 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
1167 OS << "\t.seh_handler " << *Sym;
1175 static const MCSection *getWin64EHTableSection(StringRef suffix,
1176 MCContext &context) {
1177 // FIXME: This doesn't belong in MCObjectFileInfo. However,
1178 /// this duplicate code in MCWin64EH.cpp.
1180 return context.getObjectFileInfo()->getXDataSection();
1181 return context.getCOFFSection((".xdata"+suffix).str(),
1182 COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
1183 COFF::IMAGE_SCN_MEM_READ |
1184 COFF::IMAGE_SCN_MEM_WRITE,
1185 SectionKind::getDataRel());
1188 void MCAsmStreamer::EmitWin64EHHandlerData() {
1189 MCStreamer::EmitWin64EHHandlerData();
1191 // Switch sections. Don't call SwitchSection directly, because that will
1192 // cause the section switch to be visible in the emitted assembly.
1193 // We only do this so the section switch that terminates the handler
1194 // data block is visible.
1195 MCWin64EHUnwindInfo *CurFrame = getCurrentW64UnwindInfo();
1196 StringRef suffix=MCWin64EHUnwindEmitter::GetSectionSuffix(CurFrame->Function);
1197 const MCSection *xdataSect = getWin64EHTableSection(suffix, getContext());
1199 SwitchSectionNoChange(xdataSect);
1201 OS << "\t.seh_handlerdata";
1205 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
1206 MCStreamer::EmitWin64EHPushReg(Register);
1208 OS << "\t.seh_pushreg " << Register;
1212 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
1213 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
1215 OS << "\t.seh_setframe " << Register << ", " << Offset;
1219 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
1220 MCStreamer::EmitWin64EHAllocStack(Size);
1222 OS << "\t.seh_stackalloc " << Size;
1226 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1227 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1229 OS << "\t.seh_savereg " << Register << ", " << Offset;
1233 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1234 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1236 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1240 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1241 MCStreamer::EmitWin64EHPushFrame(Code);
1243 OS << "\t.seh_pushframe";
1249 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1250 MCStreamer::EmitWin64EHEndProlog();
1252 OS << "\t.seh_endprologue";
1256 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1257 const MCSubtargetInfo &STI) {
1258 raw_ostream &OS = GetCommentOS();
1259 SmallString<256> Code;
1260 SmallVector<MCFixup, 4> Fixups;
1261 raw_svector_ostream VecOS(Code);
1262 Emitter->EncodeInstruction(Inst, VecOS, Fixups, STI);
1265 // If we are showing fixups, create symbolic markers in the encoded
1266 // representation. We do this by making a per-bit map to the fixup item index,
1267 // then trying to display it as nicely as possible.
1268 SmallVector<uint8_t, 64> FixupMap;
1269 FixupMap.resize(Code.size() * 8);
1270 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1273 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1274 MCFixup &F = Fixups[i];
1275 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1276 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1277 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1278 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1279 FixupMap[Index] = 1 + i;
1283 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1284 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1285 OS << "encoding: [";
1286 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1290 // See if all bits are the same map entry.
1291 uint8_t MapEntry = FixupMap[i * 8 + 0];
1292 for (unsigned j = 1; j != 8; ++j) {
1293 if (FixupMap[i * 8 + j] == MapEntry)
1296 MapEntry = uint8_t(~0U);
1300 if (MapEntry != uint8_t(~0U)) {
1301 if (MapEntry == 0) {
1302 OS << format("0x%02x", uint8_t(Code[i]));
1305 // FIXME: Some of the 8 bits require fix up.
1306 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1307 << char('A' + MapEntry - 1) << '\'';
1309 OS << char('A' + MapEntry - 1);
1312 // Otherwise, write out in binary.
1314 for (unsigned j = 8; j--;) {
1315 unsigned Bit = (Code[i] >> j) & 1;
1318 if (MAI->isLittleEndian())
1319 FixupBit = i * 8 + j;
1321 FixupBit = i * 8 + (7-j);
1323 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1324 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1325 OS << char('A' + MapEntry - 1);
1333 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1334 MCFixup &F = Fixups[i];
1335 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1336 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1337 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1341 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1342 assert(getCurrentSection().first &&
1343 "Cannot emit contents before setting section!");
1345 // Show the encoding in a comment if we have a code emitter.
1347 AddEncodingComment(Inst, STI);
1349 // Show the MCInst if enabled.
1351 Inst.dump_pretty(GetCommentOS(), MAI, InstPrinter.get(), "\n ");
1352 GetCommentOS() << "\n";
1355 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1357 InstPrinter->printInst(&Inst, OS, "");
1359 Inst.print(OS, MAI);
1363 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1364 OS << "\t.bundle_align_mode " << AlignPow2;
1368 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1369 OS << "\t.bundle_lock";
1371 OS << " align_to_end";
1375 void MCAsmStreamer::EmitBundleUnlock() {
1376 OS << "\t.bundle_unlock";
1380 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1381 /// the specified string in the output .s file. This capability is
1382 /// indicated by the hasRawTextSupport() predicate.
1383 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1384 if (!String.empty() && String.back() == '\n')
1385 String = String.substr(0, String.size()-1);
1390 void MCAsmStreamer::FinishImpl() {
1391 // FIXME: This header is duplicated with MCObjectStreamer
1392 // Dump out the dwarf file & directory tables and line tables.
1393 const MCSymbol *LineSectionSymbol = NULL;
1394 if (getContext().hasDwarfFiles() && !UseLoc)
1395 LineSectionSymbol = MCDwarfFileTable::Emit(this);
1397 // If we are generating dwarf for assembly source files dump out the sections.
1398 if (getContext().getGenDwarfForAssembly())
1399 MCGenDwarfInfo::Emit(this, LineSectionSymbol);
1402 EmitFrames(AsmBackend.get(), false);
1405 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1406 formatted_raw_ostream &OS,
1407 bool isVerboseAsm, bool useLoc, bool useCFI,
1408 bool useDwarfDirectory, MCInstPrinter *IP,
1409 MCCodeEmitter *CE, MCAsmBackend *MAB,
1411 return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc,
1412 useCFI, useDwarfDirectory, IP, CE, MAB, ShowInst);