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 DenseMap<const MCSymbol*, MCSymbolData*> SymbolMap;
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 EmitVersionMin(MCVersionMinType Kind, unsigned Major, unsigned Minor,
137 unsigned Update) override;
138 void EmitThumbFunc(MCSymbol *Func) override;
140 void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
141 void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
142 void EmitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel,
143 const MCSymbol *Label,
144 unsigned PointerSize) override;
145 void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
146 const MCSymbol *Label) override;
148 bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
150 void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) override;
151 void BeginCOFFSymbolDef(const MCSymbol *Symbol) override;
152 void EmitCOFFSymbolStorageClass(int StorageClass) override;
153 void EmitCOFFSymbolType(int Type) override;
154 void EndCOFFSymbolDef() override;
155 void EmitCOFFSectionIndex(MCSymbol const *Symbol) override;
156 void EmitCOFFSecRel32(MCSymbol const *Symbol) override;
157 void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) override;
158 void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
159 unsigned ByteAlignment) override;
161 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
163 /// @param Symbol - The common symbol to emit.
164 /// @param Size - The size of the common symbol.
165 /// @param ByteAlignment - The alignment of the common symbol in bytes.
166 void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
167 unsigned ByteAlignment) override;
169 void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
170 uint64_t Size = 0, unsigned ByteAlignment = 0) override;
172 void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
173 uint64_t Size, unsigned ByteAlignment = 0) override;
175 void EmitBytes(StringRef Data) override;
177 void EmitValueImpl(const MCExpr *Value, unsigned Size) override;
178 void EmitIntValue(uint64_t Value, unsigned Size) override;
180 void EmitULEB128Value(const MCExpr *Value) override;
182 void EmitSLEB128Value(const MCExpr *Value) override;
184 void EmitGPRel64Value(const MCExpr *Value) override;
186 void EmitGPRel32Value(const MCExpr *Value) override;
189 void EmitFill(uint64_t NumBytes, uint8_t FillValue) override;
191 void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
192 unsigned ValueSize = 1,
193 unsigned MaxBytesToEmit = 0) override;
195 void EmitCodeAlignment(unsigned ByteAlignment,
196 unsigned MaxBytesToEmit = 0) override;
198 bool EmitValueToOffset(const MCExpr *Offset,
199 unsigned char Value = 0) override;
201 void EmitFileDirective(StringRef Filename) override;
202 unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
204 unsigned CUID = 0) override;
205 void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
206 unsigned Column, unsigned Flags,
207 unsigned Isa, unsigned Discriminator,
208 StringRef FileName) override;
210 void EmitIdent(StringRef IdentString) override;
211 void EmitCFISections(bool EH, bool Debug) override;
212 void EmitCFIDefCfa(int64_t Register, int64_t Offset) override;
213 void EmitCFIDefCfaOffset(int64_t Offset) override;
214 void EmitCFIDefCfaRegister(int64_t Register) override;
215 void EmitCFIOffset(int64_t Register, int64_t Offset) override;
216 void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
217 void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
218 void EmitCFIRememberState() override;
219 void EmitCFIRestoreState() override;
220 void EmitCFISameValue(int64_t Register) override;
221 void EmitCFIRelOffset(int64_t Register, int64_t Offset) override;
222 void EmitCFIAdjustCfaOffset(int64_t Adjustment) override;
223 void EmitCFISignalFrame() override;
224 void EmitCFIUndefined(int64_t Register) override;
225 void EmitCFIRegister(int64_t Register1, int64_t Register2) override;
226 void EmitCFIWindowSave() override;
228 void EmitWin64EHStartProc(const MCSymbol *Symbol) override;
229 void EmitWin64EHEndProc() override;
230 void EmitWin64EHStartChained() override;
231 void EmitWin64EHEndChained() override;
232 void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
233 bool Except) override;
234 void EmitWin64EHHandlerData() override;
235 void EmitWin64EHPushReg(unsigned Register) override;
236 void EmitWin64EHSetFrame(unsigned Register, unsigned Offset) override;
237 void EmitWin64EHAllocStack(unsigned Size) override;
238 void EmitWin64EHSaveReg(unsigned Register, unsigned Offset) override;
239 void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) override;
240 void EmitWin64EHPushFrame(bool Code) override;
241 void EmitWin64EHEndProlog() override;
243 void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
245 void EmitBundleAlignMode(unsigned AlignPow2) override;
246 void EmitBundleLock(bool AlignToEnd) override;
247 void EmitBundleUnlock() override;
249 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
250 /// the specified string in the output .s file. This capability is
251 /// indicated by the hasRawTextSupport() predicate.
252 void EmitRawTextImpl(StringRef String) override;
254 void FinishImpl() override;
256 virtual MCSymbolData &getOrCreateSymbolData(const MCSymbol *Symbol) override;
259 } // end anonymous namespace.
261 /// AddComment - Add a comment that can be emitted to the generated .s
262 /// file if applicable as a QoI issue to make the output of the compiler
263 /// more readable. This only affects the MCAsmStreamer, and only when
264 /// verbose assembly output is enabled.
265 void MCAsmStreamer::AddComment(const Twine &T) {
266 if (!IsVerboseAsm) return;
268 // Make sure that CommentStream is flushed.
269 CommentStream.flush();
271 T.toVector(CommentToEmit);
272 // Each comment goes on its own line.
273 CommentToEmit.push_back('\n');
275 // Tell the comment stream that the vector changed underneath it.
276 CommentStream.resync();
279 void MCAsmStreamer::EmitCommentsAndEOL() {
280 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
285 CommentStream.flush();
286 StringRef Comments = CommentToEmit.str();
288 assert(Comments.back() == '\n' &&
289 "Comment array not newline terminated");
291 // Emit a line of comments.
292 OS.PadToColumn(MAI->getCommentColumn());
293 size_t Position = Comments.find('\n');
294 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
296 Comments = Comments.substr(Position+1);
297 } while (!Comments.empty());
299 CommentToEmit.clear();
300 // Tell the comment stream that the vector changed underneath it.
301 CommentStream.resync();
304 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
305 assert(Bytes && "Invalid size!");
306 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
309 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
312 OS << MAI->getCommentString() << T;
316 void MCAsmStreamer::ChangeSection(const MCSection *Section,
317 const MCExpr *Subsection) {
318 assert(Section && "Cannot switch to a null section!");
319 Section->PrintSwitchToSection(*MAI, OS, Subsection);
322 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
323 MCSymbol *EHSymbol) {
327 unsigned Flags = FlagMap.lookup(Symbol);
329 if (Flags & EHGlobal)
330 EmitSymbolAttribute(EHSymbol, MCSA_Global);
331 if (Flags & EHWeakDefinition)
332 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
333 if (Flags & EHPrivateExtern)
334 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
337 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
338 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
339 MCStreamer::EmitLabel(Symbol);
341 OS << *Symbol << MAI->getLabelSuffix();
345 void MCAsmStreamer::EmitDebugLabel(MCSymbol *Symbol) {
346 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
347 MCStreamer::EmitDebugLabel(Symbol);
349 OS << *Symbol << MAI->getDebugLabelSuffix();
353 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
355 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
356 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
357 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
358 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
359 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
364 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
365 assert(!Options.empty() && "At least one option is required!");
366 OS << "\t.linker_option \"" << Options[0] << '"';
367 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
368 ie = Options.end(); it != ie; ++it) {
369 OS << ", " << '"' << *it << '"';
374 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
375 if (!MAI->doesSupportDataRegionDirectives())
378 case MCDR_DataRegion: OS << "\t.data_region"; break;
379 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
380 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
381 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
382 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
387 void MCAsmStreamer::EmitVersionMin(MCVersionMinType Kind, unsigned Major,
388 unsigned Minor, unsigned Update) {
390 case MCVM_IOSVersionMin: OS << "\t.ios_version_min"; break;
391 case MCVM_OSXVersionMin: OS << "\t.macosx_version_min"; break;
393 OS << " " << Major << ", " << Minor;
395 OS << ", " << Update;
399 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
400 // This needs to emit to a temporary string to get properly quoted
401 // MCSymbols when they have spaces in them.
402 OS << "\t.thumb_func";
403 // Only Mach-O hasSubsectionsViaSymbols()
404 if (MAI->hasSubsectionsViaSymbols())
409 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
410 OS << *Symbol << " = " << *Value;
413 MCStreamer::EmitAssignment(Symbol, Value);
416 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
417 OS << ".weakref " << *Alias << ", " << *Symbol;
421 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
422 const MCSymbol *LastLabel,
423 const MCSymbol *Label,
424 unsigned PointerSize) {
425 EmitDwarfSetLineAddr(LineDelta, Label, PointerSize);
428 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
429 const MCSymbol *Label) {
430 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
431 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
432 AddrDelta = ForceExpAbs(AddrDelta);
433 EmitValue(AddrDelta, 4);
437 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
438 MCSymbolAttr Attribute) {
440 case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
441 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
442 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
443 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
444 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
445 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
446 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
447 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
448 if (!MAI->hasDotTypeDotSizeDirective())
449 return false; // Symbol attribute not supported
450 OS << "\t.type\t" << *Symbol << ','
451 << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
453 default: return false;
454 case MCSA_ELF_TypeFunction: OS << "function"; break;
455 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
456 case MCSA_ELF_TypeObject: OS << "object"; break;
457 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
458 case MCSA_ELF_TypeCommon: OS << "common"; break;
459 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
460 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
464 case MCSA_Global: // .globl/.global
465 OS << MAI->getGlobalDirective();
466 FlagMap[Symbol] |= EHGlobal;
468 case MCSA_Hidden: OS << "\t.hidden\t"; break;
469 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
470 case MCSA_Internal: OS << "\t.internal\t"; break;
471 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
472 case MCSA_Local: OS << "\t.local\t"; break;
473 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
474 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
475 case MCSA_PrivateExtern:
476 OS << "\t.private_extern\t";
477 FlagMap[Symbol] |= EHPrivateExtern;
479 case MCSA_Protected: OS << "\t.protected\t"; break;
480 case MCSA_Reference: OS << "\t.reference\t"; break;
481 case MCSA_Weak: OS << "\t.weak\t"; break;
482 case MCSA_WeakDefinition:
483 OS << "\t.weak_definition\t";
484 FlagMap[Symbol] |= EHWeakDefinition;
487 case MCSA_WeakReference: OS << MAI->getWeakRefDirective(); break;
488 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
497 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
498 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
502 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
503 OS << "\t.def\t " << *Symbol << ';';
507 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
508 OS << "\t.scl\t" << StorageClass << ';';
512 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
513 OS << "\t.type\t" << Type << ';';
517 void MCAsmStreamer::EndCOFFSymbolDef() {
522 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
523 OS << "\t.secidx\t" << *Symbol;
527 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
528 OS << "\t.secrel32\t" << *Symbol;
532 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
533 assert(MAI->hasDotTypeDotSizeDirective());
534 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
537 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
538 unsigned ByteAlignment) {
539 // Common symbols do not belong to any actual section.
540 AssignSection(Symbol, NULL);
542 OS << "\t.comm\t" << *Symbol << ',' << Size;
543 if (ByteAlignment != 0) {
544 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
545 OS << ',' << ByteAlignment;
547 OS << ',' << Log2_32(ByteAlignment);
552 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
554 /// @param Symbol - The common symbol to emit.
555 /// @param Size - The size of the common symbol.
556 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
557 unsigned ByteAlign) {
558 // Common symbols do not belong to any actual section.
559 AssignSection(Symbol, NULL);
561 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
563 switch (MAI->getLCOMMDirectiveAlignmentType()) {
564 case LCOMM::NoAlignment:
565 llvm_unreachable("alignment not supported on .lcomm!");
566 case LCOMM::ByteAlignment:
567 OS << ',' << ByteAlign;
569 case LCOMM::Log2Alignment:
570 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
571 OS << ',' << Log2_32(ByteAlign);
578 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
579 uint64_t Size, unsigned ByteAlignment) {
581 AssignSection(Symbol, Section);
583 // Note: a .zerofill directive does not switch sections.
586 // This is a mach-o specific directive.
587 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
588 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
590 if (Symbol != NULL) {
591 OS << ',' << *Symbol << ',' << Size;
592 if (ByteAlignment != 0)
593 OS << ',' << Log2_32(ByteAlignment);
598 // .tbss sym, size, align
599 // This depends that the symbol has already been mangled from the original,
601 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
602 uint64_t Size, unsigned ByteAlignment) {
603 AssignSection(Symbol, Section);
605 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
606 // Instead of using the Section we'll just use the shortcut.
607 // This is a mach-o specific directive and section.
608 OS << ".tbss " << *Symbol << ", " << Size;
610 // Output align if we have it. We default to 1 so don't bother printing
612 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
617 static inline char toOctal(int X) { return (X&7)+'0'; }
619 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
622 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
623 unsigned char C = Data[i];
624 if (C == '"' || C == '\\') {
625 OS << '\\' << (char)C;
629 if (isprint((unsigned char)C)) {
635 case '\b': OS << "\\b"; break;
636 case '\f': OS << "\\f"; break;
637 case '\n': OS << "\\n"; break;
638 case '\r': OS << "\\r"; break;
639 case '\t': OS << "\\t"; break;
642 OS << toOctal(C >> 6);
643 OS << toOctal(C >> 3);
644 OS << toOctal(C >> 0);
653 void MCAsmStreamer::EmitBytes(StringRef Data) {
654 assert(getCurrentSection().first &&
655 "Cannot emit contents before setting section!");
656 if (Data.empty()) return;
658 if (Data.size() == 1) {
659 OS << MAI->getData8bitsDirective();
660 OS << (unsigned)(unsigned char)Data[0];
665 // If the data ends with 0 and the target supports .asciz, use it, otherwise
667 if (MAI->getAscizDirective() && Data.back() == 0) {
668 OS << MAI->getAscizDirective();
669 Data = Data.substr(0, Data.size()-1);
671 OS << MAI->getAsciiDirective();
674 PrintQuotedString(Data, OS);
678 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
679 EmitValue(MCConstantExpr::Create(Value, getContext()), Size);
682 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size) {
683 assert(Size <= 8 && "Invalid size");
684 assert(getCurrentSection().first &&
685 "Cannot emit contents before setting section!");
686 const char *Directive = 0;
689 case 1: Directive = MAI->getData8bitsDirective(); break;
690 case 2: Directive = MAI->getData16bitsDirective(); break;
691 case 4: Directive = MAI->getData32bitsDirective(); break;
692 case 8: Directive = MAI->getData64bitsDirective(); break;
697 if (!Value->EvaluateAsAbsolute(IntValue))
698 report_fatal_error("Don't know how to emit this value.");
700 // We couldn't handle the requested integer size so we fallback by breaking
701 // the request down into several, smaller, integers. Since sizes greater
702 // than eight are invalid and size equivalent to eight should have been
703 // handled earlier, we use four bytes as our largest piece of granularity.
704 bool IsLittleEndian = MAI->isLittleEndian();
705 for (unsigned Emitted = 0; Emitted != Size;) {
706 unsigned Remaining = Size - Emitted;
707 // The size of our partial emission must be a power of two less than
709 unsigned EmissionSize = PowerOf2Floor(Remaining);
710 if (EmissionSize > 4)
712 // Calculate the byte offset of our partial emission taking into account
713 // the endianness of the target.
714 unsigned ByteOffset =
715 IsLittleEndian ? Emitted : (Remaining - EmissionSize);
716 uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
717 // We truncate our partial emission to fit within the bounds of the
718 // emission domain. This produces nicer output and silences potential
719 // truncation warnings when round tripping through another assembler.
720 ValueToEmit &= ~0ULL >> (64 - EmissionSize * 8);
721 EmitIntValue(ValueToEmit, EmissionSize);
722 Emitted += EmissionSize;
727 assert(Directive && "Invalid size for machine code value!");
728 OS << Directive << *Value;
732 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
734 if (Value->EvaluateAsAbsolute(IntValue)) {
735 EmitULEB128IntValue(IntValue);
738 assert(MAI->hasLEB128() && "Cannot print a .uleb");
739 OS << ".uleb128 " << *Value;
743 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
745 if (Value->EvaluateAsAbsolute(IntValue)) {
746 EmitSLEB128IntValue(IntValue);
749 assert(MAI->hasLEB128() && "Cannot print a .sleb");
750 OS << ".sleb128 " << *Value;
754 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
755 assert(MAI->getGPRel64Directive() != 0);
756 OS << MAI->getGPRel64Directive() << *Value;
760 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
761 assert(MAI->getGPRel32Directive() != 0);
762 OS << MAI->getGPRel32Directive() << *Value;
767 /// EmitFill - Emit NumBytes bytes worth of the value specified by
768 /// FillValue. This implements directives such as '.space'.
769 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
770 if (NumBytes == 0) return;
772 if (const char *ZeroDirective = MAI->getZeroDirective()) {
773 OS << ZeroDirective << NumBytes;
775 OS << ',' << (int)FillValue;
780 // Emit a byte at a time.
781 MCStreamer::EmitFill(NumBytes, FillValue);
784 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
786 unsigned MaxBytesToEmit) {
787 // Some assemblers don't support non-power of two alignments, so we always
788 // emit alignments as a power of two if possible.
789 if (isPowerOf2_32(ByteAlignment)) {
792 llvm_unreachable("Invalid size for machine code value!");
803 llvm_unreachable("Unsupported alignment size!");
806 if (MAI->getAlignmentIsInBytes())
809 OS << Log2_32(ByteAlignment);
811 if (Value || MaxBytesToEmit) {
813 OS.write_hex(truncateToSize(Value, ValueSize));
816 OS << ", " << MaxBytesToEmit;
822 // Non-power of two alignment. This is not widely supported by assemblers.
823 // FIXME: Parameterize this based on MAI.
825 default: llvm_unreachable("Invalid size for machine code value!");
826 case 1: OS << ".balign"; break;
827 case 2: OS << ".balignw"; break;
828 case 4: OS << ".balignl"; break;
829 case 8: llvm_unreachable("Unsupported alignment size!");
832 OS << ' ' << ByteAlignment;
833 OS << ", " << truncateToSize(Value, ValueSize);
835 OS << ", " << MaxBytesToEmit;
839 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
840 unsigned MaxBytesToEmit) {
841 // Emit with a text fill value.
842 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
846 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
847 unsigned char Value) {
848 // FIXME: Verify that Offset is associated with the current section.
849 OS << ".org " << *Offset << ", " << (unsigned) Value;
855 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
856 assert(MAI->hasSingleParameterDotFile());
858 PrintQuotedString(Filename, OS);
862 unsigned MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo,
868 MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
869 unsigned NumFiles = Table.getMCDwarfFiles().size();
870 FileNo = Table.getFile(Directory, Filename, FileNo);
873 if (NumFiles == Table.getMCDwarfFiles().size())
876 SmallString<128> FullPathName;
878 if (!UseDwarfDirectory && !Directory.empty()) {
879 if (sys::path::is_absolute(Filename))
882 FullPathName = Directory;
883 sys::path::append(FullPathName, Filename);
885 Filename = FullPathName;
889 OS << "\t.file\t" << FileNo << ' ';
890 if (!Directory.empty()) {
891 PrintQuotedString(Directory, OS);
894 PrintQuotedString(Filename, OS);
900 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
901 unsigned Column, unsigned Flags,
903 unsigned Discriminator,
904 StringRef FileName) {
905 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
906 Isa, Discriminator, FileName);
907 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
908 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
909 OS << " basic_block";
910 if (Flags & DWARF2_FLAG_PROLOGUE_END)
911 OS << " prologue_end";
912 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
913 OS << " epilogue_begin";
915 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
916 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
919 if (Flags & DWARF2_FLAG_IS_STMT)
926 OS << " isa " << Isa;
928 OS << " discriminator " << Discriminator;
931 OS.PadToColumn(MAI->getCommentColumn());
932 OS << MAI->getCommentString() << ' ' << FileName << ':'
933 << Line << ':' << Column;
938 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
939 assert(MAI->hasIdentDirective() && ".ident directive not supported");
941 PrintQuotedString(IdentString, OS);
945 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
946 MCStreamer::EmitCFISections(EH, Debug);
951 OS << "\t.cfi_sections ";
955 OS << ", .debug_frame";
957 OS << ".debug_frame";
963 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
965 RecordProcStart(Frame);
969 OS << "\t.cfi_startproc";
975 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
977 RecordProcEnd(Frame);
981 // Put a dummy non-null value in Frame.End to mark that this frame has been
983 Frame.End = (MCSymbol *) 1;
985 OS << "\t.cfi_endproc";
989 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
990 if (InstPrinter && !MAI->useDwarfRegNumForCFI()) {
991 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
992 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
993 InstPrinter->printRegName(OS, LLVMRegister);
999 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
1000 MCStreamer::EmitCFIDefCfa(Register, Offset);
1005 OS << "\t.cfi_def_cfa ";
1006 EmitRegisterName(Register);
1007 OS << ", " << Offset;
1011 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
1012 MCStreamer::EmitCFIDefCfaOffset(Offset);
1017 OS << "\t.cfi_def_cfa_offset " << Offset;
1021 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
1022 MCStreamer::EmitCFIDefCfaRegister(Register);
1027 OS << "\t.cfi_def_cfa_register ";
1028 EmitRegisterName(Register);
1032 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1033 this->MCStreamer::EmitCFIOffset(Register, Offset);
1038 OS << "\t.cfi_offset ";
1039 EmitRegisterName(Register);
1040 OS << ", " << Offset;
1044 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1045 unsigned Encoding) {
1046 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1051 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
1055 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1056 MCStreamer::EmitCFILsda(Sym, Encoding);
1061 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
1065 void MCAsmStreamer::EmitCFIRememberState() {
1066 MCStreamer::EmitCFIRememberState();
1071 OS << "\t.cfi_remember_state";
1075 void MCAsmStreamer::EmitCFIRestoreState() {
1076 MCStreamer::EmitCFIRestoreState();
1081 OS << "\t.cfi_restore_state";
1085 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1086 MCStreamer::EmitCFISameValue(Register);
1091 OS << "\t.cfi_same_value ";
1092 EmitRegisterName(Register);
1096 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1097 MCStreamer::EmitCFIRelOffset(Register, Offset);
1102 OS << "\t.cfi_rel_offset ";
1103 EmitRegisterName(Register);
1104 OS << ", " << Offset;
1108 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1109 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1114 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1118 void MCAsmStreamer::EmitCFISignalFrame() {
1119 MCStreamer::EmitCFISignalFrame();
1124 OS << "\t.cfi_signal_frame";
1128 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1129 MCStreamer::EmitCFIUndefined(Register);
1134 OS << "\t.cfi_undefined " << Register;
1138 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1139 MCStreamer::EmitCFIRegister(Register1, Register2);
1144 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1148 void MCAsmStreamer::EmitCFIWindowSave() {
1149 MCStreamer::EmitCFIWindowSave();
1154 OS << "\t.cfi_window_save";
1158 void MCAsmStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
1159 MCStreamer::EmitWin64EHStartProc(Symbol);
1161 OS << ".seh_proc " << *Symbol;
1165 void MCAsmStreamer::EmitWin64EHEndProc() {
1166 MCStreamer::EmitWin64EHEndProc();
1168 OS << "\t.seh_endproc";
1172 void MCAsmStreamer::EmitWin64EHStartChained() {
1173 MCStreamer::EmitWin64EHStartChained();
1175 OS << "\t.seh_startchained";
1179 void MCAsmStreamer::EmitWin64EHEndChained() {
1180 MCStreamer::EmitWin64EHEndChained();
1182 OS << "\t.seh_endchained";
1186 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
1188 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
1190 OS << "\t.seh_handler " << *Sym;
1198 static const MCSection *getWin64EHTableSection(StringRef suffix,
1199 MCContext &context) {
1200 // FIXME: This doesn't belong in MCObjectFileInfo. However,
1201 /// this duplicate code in MCWin64EH.cpp.
1203 return context.getObjectFileInfo()->getXDataSection();
1204 return context.getCOFFSection((".xdata"+suffix).str(),
1205 COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
1206 COFF::IMAGE_SCN_MEM_READ |
1207 COFF::IMAGE_SCN_MEM_WRITE,
1208 SectionKind::getDataRel());
1211 void MCAsmStreamer::EmitWin64EHHandlerData() {
1212 MCStreamer::EmitWin64EHHandlerData();
1214 // Switch sections. Don't call SwitchSection directly, because that will
1215 // cause the section switch to be visible in the emitted assembly.
1216 // We only do this so the section switch that terminates the handler
1217 // data block is visible.
1218 MCWin64EHUnwindInfo *CurFrame = getCurrentW64UnwindInfo();
1219 StringRef suffix=MCWin64EHUnwindEmitter::GetSectionSuffix(CurFrame->Function);
1220 const MCSection *xdataSect = getWin64EHTableSection(suffix, getContext());
1222 SwitchSectionNoChange(xdataSect);
1224 OS << "\t.seh_handlerdata";
1228 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
1229 MCStreamer::EmitWin64EHPushReg(Register);
1231 OS << "\t.seh_pushreg " << Register;
1235 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
1236 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
1238 OS << "\t.seh_setframe " << Register << ", " << Offset;
1242 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
1243 MCStreamer::EmitWin64EHAllocStack(Size);
1245 OS << "\t.seh_stackalloc " << Size;
1249 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1250 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1252 OS << "\t.seh_savereg " << Register << ", " << Offset;
1256 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1257 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1259 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1263 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1264 MCStreamer::EmitWin64EHPushFrame(Code);
1266 OS << "\t.seh_pushframe";
1272 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1273 MCStreamer::EmitWin64EHEndProlog();
1275 OS << "\t.seh_endprologue";
1279 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1280 const MCSubtargetInfo &STI) {
1281 raw_ostream &OS = GetCommentOS();
1282 SmallString<256> Code;
1283 SmallVector<MCFixup, 4> Fixups;
1284 raw_svector_ostream VecOS(Code);
1285 Emitter->EncodeInstruction(Inst, VecOS, Fixups, STI);
1288 // If we are showing fixups, create symbolic markers in the encoded
1289 // representation. We do this by making a per-bit map to the fixup item index,
1290 // then trying to display it as nicely as possible.
1291 SmallVector<uint8_t, 64> FixupMap;
1292 FixupMap.resize(Code.size() * 8);
1293 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1296 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1297 MCFixup &F = Fixups[i];
1298 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1299 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1300 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1301 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1302 FixupMap[Index] = 1 + i;
1306 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1307 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1308 OS << "encoding: [";
1309 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1313 // See if all bits are the same map entry.
1314 uint8_t MapEntry = FixupMap[i * 8 + 0];
1315 for (unsigned j = 1; j != 8; ++j) {
1316 if (FixupMap[i * 8 + j] == MapEntry)
1319 MapEntry = uint8_t(~0U);
1323 if (MapEntry != uint8_t(~0U)) {
1324 if (MapEntry == 0) {
1325 OS << format("0x%02x", uint8_t(Code[i]));
1328 // FIXME: Some of the 8 bits require fix up.
1329 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1330 << char('A' + MapEntry - 1) << '\'';
1332 OS << char('A' + MapEntry - 1);
1335 // Otherwise, write out in binary.
1337 for (unsigned j = 8; j--;) {
1338 unsigned Bit = (Code[i] >> j) & 1;
1341 if (MAI->isLittleEndian())
1342 FixupBit = i * 8 + j;
1344 FixupBit = i * 8 + (7-j);
1346 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1347 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1348 OS << char('A' + MapEntry - 1);
1356 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1357 MCFixup &F = Fixups[i];
1358 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1359 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1360 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1364 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1365 assert(getCurrentSection().first &&
1366 "Cannot emit contents before setting section!");
1368 // Show the encoding in a comment if we have a code emitter.
1370 AddEncodingComment(Inst, STI);
1372 // Show the MCInst if enabled.
1374 Inst.dump_pretty(GetCommentOS(), MAI, InstPrinter.get(), "\n ");
1375 GetCommentOS() << "\n";
1378 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1380 InstPrinter->printInst(&Inst, OS, "");
1382 Inst.print(OS, MAI);
1386 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1387 OS << "\t.bundle_align_mode " << AlignPow2;
1391 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1392 OS << "\t.bundle_lock";
1394 OS << " align_to_end";
1398 void MCAsmStreamer::EmitBundleUnlock() {
1399 OS << "\t.bundle_unlock";
1403 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1404 /// the specified string in the output .s file. This capability is
1405 /// indicated by the hasRawTextSupport() predicate.
1406 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1407 if (!String.empty() && String.back() == '\n')
1408 String = String.substr(0, String.size()-1);
1413 void MCAsmStreamer::FinishImpl() {
1414 // If we are generating dwarf for assembly source files dump out the sections.
1415 if (getContext().getGenDwarfForAssembly())
1416 MCGenDwarfInfo::Emit(this, NULL);
1419 EmitFrames(AsmBackend.get(), false);
1422 MCSymbolData &MCAsmStreamer::getOrCreateSymbolData(const MCSymbol *Symbol) {
1423 MCSymbolData *&Entry = SymbolMap[Symbol];
1426 Entry = new MCSymbolData(*Symbol, 0, 0, 0);
1431 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1432 formatted_raw_ostream &OS,
1433 bool isVerboseAsm, bool useCFI,
1434 bool useDwarfDirectory, MCInstPrinter *IP,
1435 MCCodeEmitter *CE, MCAsmBackend *MAB,
1437 return new MCAsmStreamer(Context, OS, isVerboseAsm, useCFI, useDwarfDirectory,
1438 IP, CE, MAB, ShowInst);