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 bool needsSet(const MCExpr *Value);
64 void EmitRegisterName(int64_t Register);
65 void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) override;
66 void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) override;
69 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
70 bool isVerboseAsm, bool useCFI, bool useDwarfDirectory,
71 MCInstPrinter *printer, MCCodeEmitter *emitter,
72 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), 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 bool isVerboseAsm() const override { return IsVerboseAsm; }
97 /// hasRawTextSupport - We support EmitRawText.
98 bool hasRawTextSupport() const override { 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 void AddComment(const Twine &T) override;
106 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
107 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 raw_ostream &GetCommentOS() override {
114 return nulls(); // Discard comments unless in verbose asm mode.
115 return CommentStream;
118 void emitRawComment(const Twine &T, bool TabPrefix = true) override;
120 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
121 void AddBlankLine() override {
125 /// @name MCStreamer Interface
128 void ChangeSection(const MCSection *Section,
129 const MCExpr *Subsection) override;
131 void EmitLabel(MCSymbol *Symbol) override;
132 void EmitDebugLabel(MCSymbol *Symbol) override;
134 void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol) override;
135 void EmitAssemblerFlag(MCAssemblerFlag Flag) override;
136 void EmitLinkerOptions(ArrayRef<std::string> Options) override;
137 void EmitDataRegion(MCDataRegionType Kind) override;
138 void EmitVersionMin(MCVersionMinType Kind, unsigned Major, unsigned Minor,
139 unsigned Update) override;
140 void EmitThumbFunc(MCSymbol *Func) override;
142 void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
143 void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
144 void EmitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel,
145 const MCSymbol *Label,
146 unsigned PointerSize) override;
147 void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
148 const MCSymbol *Label) override;
150 bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
152 void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) override;
153 void BeginCOFFSymbolDef(const MCSymbol *Symbol) override;
154 void EmitCOFFSymbolStorageClass(int StorageClass) override;
155 void EmitCOFFSymbolType(int Type) override;
156 void EndCOFFSymbolDef() override;
157 void EmitCOFFSectionIndex(MCSymbol const *Symbol) override;
158 void EmitCOFFSecRel32(MCSymbol const *Symbol) override;
159 void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) override;
160 void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
161 unsigned ByteAlignment) override;
163 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
165 /// @param Symbol - The common symbol to emit.
166 /// @param Size - The size of the common symbol.
167 /// @param ByteAlignment - The alignment of the common symbol in bytes.
168 void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
169 unsigned ByteAlignment) override;
171 void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
172 uint64_t Size = 0, unsigned ByteAlignment = 0) override;
174 void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
175 uint64_t Size, unsigned ByteAlignment = 0) override;
177 void EmitBytes(StringRef Data) override;
179 void EmitValueImpl(const MCExpr *Value, unsigned Size) override;
180 void EmitIntValue(uint64_t Value, unsigned Size) override;
182 void EmitULEB128Value(const MCExpr *Value) override;
184 void EmitSLEB128Value(const MCExpr *Value) override;
186 void EmitGPRel64Value(const MCExpr *Value) override;
188 void EmitGPRel32Value(const MCExpr *Value) override;
191 void EmitFill(uint64_t NumBytes, uint8_t FillValue) override;
193 void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
194 unsigned ValueSize = 1,
195 unsigned MaxBytesToEmit = 0) override;
197 void EmitCodeAlignment(unsigned ByteAlignment,
198 unsigned MaxBytesToEmit = 0) override;
200 bool EmitValueToOffset(const MCExpr *Offset,
201 unsigned char Value = 0) override;
203 void EmitFileDirective(StringRef Filename) override;
204 unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
206 unsigned CUID = 0) override;
207 void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
208 unsigned Column, unsigned Flags,
209 unsigned Isa, unsigned Discriminator,
210 StringRef FileName) override;
212 void EmitIdent(StringRef IdentString) override;
213 void EmitCFISections(bool EH, bool Debug) override;
214 void EmitCFIDefCfa(int64_t Register, int64_t Offset) override;
215 void EmitCFIDefCfaOffset(int64_t Offset) override;
216 void EmitCFIDefCfaRegister(int64_t Register) override;
217 void EmitCFIOffset(int64_t Register, int64_t Offset) override;
218 void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
219 void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
220 void EmitCFIRememberState() override;
221 void EmitCFIRestoreState() override;
222 void EmitCFISameValue(int64_t Register) override;
223 void EmitCFIRelOffset(int64_t Register, int64_t Offset) override;
224 void EmitCFIAdjustCfaOffset(int64_t Adjustment) override;
225 void EmitCFISignalFrame() override;
226 void EmitCFIUndefined(int64_t Register) override;
227 void EmitCFIRegister(int64_t Register1, int64_t Register2) override;
228 void EmitCFIWindowSave() override;
230 void EmitWin64EHStartProc(const MCSymbol *Symbol) override;
231 void EmitWin64EHEndProc() override;
232 void EmitWin64EHStartChained() override;
233 void EmitWin64EHEndChained() override;
234 void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
235 bool Except) override;
236 void EmitWin64EHHandlerData() override;
237 void EmitWin64EHPushReg(unsigned Register) override;
238 void EmitWin64EHSetFrame(unsigned Register, unsigned Offset) override;
239 void EmitWin64EHAllocStack(unsigned Size) override;
240 void EmitWin64EHSaveReg(unsigned Register, unsigned Offset) override;
241 void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) override;
242 void EmitWin64EHPushFrame(bool Code) override;
243 void EmitWin64EHEndProlog() override;
245 void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
247 void EmitBundleAlignMode(unsigned AlignPow2) override;
248 void EmitBundleLock(bool AlignToEnd) override;
249 void EmitBundleUnlock() override;
251 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
252 /// the specified string in the output .s file. This capability is
253 /// indicated by the hasRawTextSupport() predicate.
254 void EmitRawTextImpl(StringRef String) override;
256 void FinishImpl() override;
258 virtual MCSymbolData &getOrCreateSymbolData(const MCSymbol *Symbol) override;
261 } // end anonymous namespace.
263 /// AddComment - Add a comment that can be emitted to the generated .s
264 /// file if applicable as a QoI issue to make the output of the compiler
265 /// more readable. This only affects the MCAsmStreamer, and only when
266 /// verbose assembly output is enabled.
267 void MCAsmStreamer::AddComment(const Twine &T) {
268 if (!IsVerboseAsm) return;
270 // Make sure that CommentStream is flushed.
271 CommentStream.flush();
273 T.toVector(CommentToEmit);
274 // Each comment goes on its own line.
275 CommentToEmit.push_back('\n');
277 // Tell the comment stream that the vector changed underneath it.
278 CommentStream.resync();
281 void MCAsmStreamer::EmitCommentsAndEOL() {
282 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
287 CommentStream.flush();
288 StringRef Comments = CommentToEmit.str();
290 assert(Comments.back() == '\n' &&
291 "Comment array not newline terminated");
293 // Emit a line of comments.
294 OS.PadToColumn(MAI->getCommentColumn());
295 size_t Position = Comments.find('\n');
296 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
298 Comments = Comments.substr(Position+1);
299 } while (!Comments.empty());
301 CommentToEmit.clear();
302 // Tell the comment stream that the vector changed underneath it.
303 CommentStream.resync();
306 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
307 assert(Bytes && "Invalid size!");
308 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
311 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
314 OS << MAI->getCommentString() << T;
318 void MCAsmStreamer::ChangeSection(const MCSection *Section,
319 const MCExpr *Subsection) {
320 assert(Section && "Cannot switch to a null section!");
321 Section->PrintSwitchToSection(*MAI, OS, Subsection);
324 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
325 MCSymbol *EHSymbol) {
329 unsigned Flags = FlagMap.lookup(Symbol);
331 if (Flags & EHGlobal)
332 EmitSymbolAttribute(EHSymbol, MCSA_Global);
333 if (Flags & EHWeakDefinition)
334 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
335 if (Flags & EHPrivateExtern)
336 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
339 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
340 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
341 MCStreamer::EmitLabel(Symbol);
343 OS << *Symbol << MAI->getLabelSuffix();
347 void MCAsmStreamer::EmitDebugLabel(MCSymbol *Symbol) {
348 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
349 MCStreamer::EmitDebugLabel(Symbol);
351 OS << *Symbol << MAI->getDebugLabelSuffix();
355 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
357 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
358 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
359 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
360 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
361 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
366 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
367 assert(!Options.empty() && "At least one option is required!");
368 OS << "\t.linker_option \"" << Options[0] << '"';
369 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
370 ie = Options.end(); it != ie; ++it) {
371 OS << ", " << '"' << *it << '"';
376 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
377 if (!MAI->doesSupportDataRegionDirectives())
380 case MCDR_DataRegion: OS << "\t.data_region"; break;
381 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
382 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
383 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
384 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
389 void MCAsmStreamer::EmitVersionMin(MCVersionMinType Kind, unsigned Major,
390 unsigned Minor, unsigned Update) {
392 case MCVM_IOSVersionMin: OS << "\t.ios_version_min"; break;
393 case MCVM_OSXVersionMin: OS << "\t.macosx_version_min"; break;
395 OS << " " << Major << ", " << Minor;
397 OS << ", " << Update;
401 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
402 // This needs to emit to a temporary string to get properly quoted
403 // MCSymbols when they have spaces in them.
404 OS << "\t.thumb_func";
405 // Only Mach-O hasSubsectionsViaSymbols()
406 if (MAI->hasSubsectionsViaSymbols())
411 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
412 OS << *Symbol << " = " << *Value;
415 MCStreamer::EmitAssignment(Symbol, Value);
418 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
419 OS << ".weakref " << *Alias << ", " << *Symbol;
423 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
424 const MCSymbol *LastLabel,
425 const MCSymbol *Label,
426 unsigned PointerSize) {
427 EmitDwarfSetLineAddr(LineDelta, Label, PointerSize);
430 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
431 const MCSymbol *Label) {
432 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
433 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
434 AddrDelta = ForceExpAbs(AddrDelta);
435 EmitValue(AddrDelta, 4);
439 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
440 MCSymbolAttr Attribute) {
442 case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
443 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
444 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
445 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
446 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
447 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
448 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
449 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
450 if (!MAI->hasDotTypeDotSizeDirective())
451 return false; // Symbol attribute not supported
452 OS << "\t.type\t" << *Symbol << ','
453 << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
455 default: return false;
456 case MCSA_ELF_TypeFunction: OS << "function"; break;
457 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
458 case MCSA_ELF_TypeObject: OS << "object"; break;
459 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
460 case MCSA_ELF_TypeCommon: OS << "common"; break;
461 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
462 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
466 case MCSA_Global: // .globl/.global
467 OS << MAI->getGlobalDirective();
468 FlagMap[Symbol] |= EHGlobal;
470 case MCSA_Hidden: OS << "\t.hidden\t"; break;
471 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
472 case MCSA_Internal: OS << "\t.internal\t"; break;
473 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
474 case MCSA_Local: OS << "\t.local\t"; break;
475 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
476 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
477 case MCSA_PrivateExtern:
478 OS << "\t.private_extern\t";
479 FlagMap[Symbol] |= EHPrivateExtern;
481 case MCSA_Protected: OS << "\t.protected\t"; break;
482 case MCSA_Reference: OS << "\t.reference\t"; break;
483 case MCSA_Weak: OS << "\t.weak\t"; break;
484 case MCSA_WeakDefinition:
485 OS << "\t.weak_definition\t";
486 FlagMap[Symbol] |= EHWeakDefinition;
489 case MCSA_WeakReference: OS << MAI->getWeakRefDirective(); break;
490 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
499 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
500 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
504 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
505 OS << "\t.def\t " << *Symbol << ';';
509 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
510 OS << "\t.scl\t" << StorageClass << ';';
514 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
515 OS << "\t.type\t" << Type << ';';
519 void MCAsmStreamer::EndCOFFSymbolDef() {
524 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
525 OS << "\t.secidx\t" << *Symbol;
529 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
530 OS << "\t.secrel32\t" << *Symbol;
534 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
535 assert(MAI->hasDotTypeDotSizeDirective());
536 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
539 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
540 unsigned ByteAlignment) {
541 // Common symbols do not belong to any actual section.
542 AssignSection(Symbol, NULL);
544 OS << "\t.comm\t" << *Symbol << ',' << Size;
545 if (ByteAlignment != 0) {
546 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
547 OS << ',' << ByteAlignment;
549 OS << ',' << Log2_32(ByteAlignment);
554 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
556 /// @param Symbol - The common symbol to emit.
557 /// @param Size - The size of the common symbol.
558 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
559 unsigned ByteAlign) {
560 // Common symbols do not belong to any actual section.
561 AssignSection(Symbol, NULL);
563 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
565 switch (MAI->getLCOMMDirectiveAlignmentType()) {
566 case LCOMM::NoAlignment:
567 llvm_unreachable("alignment not supported on .lcomm!");
568 case LCOMM::ByteAlignment:
569 OS << ',' << ByteAlign;
571 case LCOMM::Log2Alignment:
572 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
573 OS << ',' << Log2_32(ByteAlign);
580 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
581 uint64_t Size, unsigned ByteAlignment) {
583 AssignSection(Symbol, Section);
585 // Note: a .zerofill directive does not switch sections.
588 // This is a mach-o specific directive.
589 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
590 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
592 if (Symbol != NULL) {
593 OS << ',' << *Symbol << ',' << Size;
594 if (ByteAlignment != 0)
595 OS << ',' << Log2_32(ByteAlignment);
600 // .tbss sym, size, align
601 // This depends that the symbol has already been mangled from the original,
603 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
604 uint64_t Size, unsigned ByteAlignment) {
605 AssignSection(Symbol, Section);
607 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
608 // Instead of using the Section we'll just use the shortcut.
609 // This is a mach-o specific directive and section.
610 OS << ".tbss " << *Symbol << ", " << Size;
612 // Output align if we have it. We default to 1 so don't bother printing
614 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
619 static inline char toOctal(int X) { return (X&7)+'0'; }
621 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
624 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
625 unsigned char C = Data[i];
626 if (C == '"' || C == '\\') {
627 OS << '\\' << (char)C;
631 if (isprint((unsigned char)C)) {
637 case '\b': OS << "\\b"; break;
638 case '\f': OS << "\\f"; break;
639 case '\n': OS << "\\n"; break;
640 case '\r': OS << "\\r"; break;
641 case '\t': OS << "\\t"; break;
644 OS << toOctal(C >> 6);
645 OS << toOctal(C >> 3);
646 OS << toOctal(C >> 0);
655 void MCAsmStreamer::EmitBytes(StringRef Data) {
656 assert(getCurrentSection().first &&
657 "Cannot emit contents before setting section!");
658 if (Data.empty()) return;
660 if (Data.size() == 1) {
661 OS << MAI->getData8bitsDirective();
662 OS << (unsigned)(unsigned char)Data[0];
667 // If the data ends with 0 and the target supports .asciz, use it, otherwise
669 if (MAI->getAscizDirective() && Data.back() == 0) {
670 OS << MAI->getAscizDirective();
671 Data = Data.substr(0, Data.size()-1);
673 OS << MAI->getAsciiDirective();
676 PrintQuotedString(Data, OS);
680 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
681 EmitValue(MCConstantExpr::Create(Value, getContext()), Size);
684 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size) {
685 assert(Size <= 8 && "Invalid size");
686 assert(getCurrentSection().first &&
687 "Cannot emit contents before setting section!");
688 const char *Directive = 0;
691 case 1: Directive = MAI->getData8bitsDirective(); break;
692 case 2: Directive = MAI->getData16bitsDirective(); break;
693 case 4: Directive = MAI->getData32bitsDirective(); break;
694 case 8: Directive = MAI->getData64bitsDirective(); break;
699 if (!Value->EvaluateAsAbsolute(IntValue))
700 report_fatal_error("Don't know how to emit this value.");
702 // We couldn't handle the requested integer size so we fallback by breaking
703 // the request down into several, smaller, integers. Since sizes greater
704 // than eight are invalid and size equivalent to eight should have been
705 // handled earlier, we use four bytes as our largest piece of granularity.
706 bool IsLittleEndian = MAI->isLittleEndian();
707 for (unsigned Emitted = 0; Emitted != Size;) {
708 unsigned Remaining = Size - Emitted;
709 // The size of our partial emission must be a power of two less than
711 unsigned EmissionSize = PowerOf2Floor(Remaining);
712 if (EmissionSize > 4)
714 // Calculate the byte offset of our partial emission taking into account
715 // the endianness of the target.
716 unsigned ByteOffset =
717 IsLittleEndian ? Emitted : (Remaining - EmissionSize);
718 uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
719 // We truncate our partial emission to fit within the bounds of the
720 // emission domain. This produces nicer output and silences potential
721 // truncation warnings when round tripping through another assembler.
722 ValueToEmit &= ~0ULL >> (64 - EmissionSize * 8);
723 EmitIntValue(ValueToEmit, EmissionSize);
724 Emitted += EmissionSize;
729 assert(Directive && "Invalid size for machine code value!");
730 OS << Directive << *Value;
734 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
736 if (Value->EvaluateAsAbsolute(IntValue)) {
737 EmitULEB128IntValue(IntValue);
740 assert(MAI->hasLEB128() && "Cannot print a .uleb");
741 OS << ".uleb128 " << *Value;
745 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
747 if (Value->EvaluateAsAbsolute(IntValue)) {
748 EmitSLEB128IntValue(IntValue);
751 assert(MAI->hasLEB128() && "Cannot print a .sleb");
752 OS << ".sleb128 " << *Value;
756 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
757 assert(MAI->getGPRel64Directive() != 0);
758 OS << MAI->getGPRel64Directive() << *Value;
762 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
763 assert(MAI->getGPRel32Directive() != 0);
764 OS << MAI->getGPRel32Directive() << *Value;
769 /// EmitFill - Emit NumBytes bytes worth of the value specified by
770 /// FillValue. This implements directives such as '.space'.
771 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
772 if (NumBytes == 0) return;
774 if (const char *ZeroDirective = MAI->getZeroDirective()) {
775 OS << ZeroDirective << NumBytes;
777 OS << ',' << (int)FillValue;
782 // Emit a byte at a time.
783 MCStreamer::EmitFill(NumBytes, FillValue);
786 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
788 unsigned MaxBytesToEmit) {
789 // Some assemblers don't support non-power of two alignments, so we always
790 // emit alignments as a power of two if possible.
791 if (isPowerOf2_32(ByteAlignment)) {
794 llvm_unreachable("Invalid size for machine code value!");
805 llvm_unreachable("Unsupported alignment size!");
808 if (MAI->getAlignmentIsInBytes())
811 OS << Log2_32(ByteAlignment);
813 if (Value || MaxBytesToEmit) {
815 OS.write_hex(truncateToSize(Value, ValueSize));
818 OS << ", " << MaxBytesToEmit;
824 // Non-power of two alignment. This is not widely supported by assemblers.
825 // FIXME: Parameterize this based on MAI.
827 default: llvm_unreachable("Invalid size for machine code value!");
828 case 1: OS << ".balign"; break;
829 case 2: OS << ".balignw"; break;
830 case 4: OS << ".balignl"; break;
831 case 8: llvm_unreachable("Unsupported alignment size!");
834 OS << ' ' << ByteAlignment;
835 OS << ", " << truncateToSize(Value, ValueSize);
837 OS << ", " << MaxBytesToEmit;
841 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
842 unsigned MaxBytesToEmit) {
843 // Emit with a text fill value.
844 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
848 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
849 unsigned char Value) {
850 // FIXME: Verify that Offset is associated with the current section.
851 OS << ".org " << *Offset << ", " << (unsigned) Value;
857 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
858 assert(MAI->hasSingleParameterDotFile());
860 PrintQuotedString(Filename, OS);
864 unsigned MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo,
870 MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
871 unsigned NumFiles = Table.getMCDwarfFiles().size();
872 FileNo = Table.getFile(Directory, Filename, FileNo);
875 if (NumFiles == Table.getMCDwarfFiles().size())
878 SmallString<128> FullPathName;
880 if (!UseDwarfDirectory && !Directory.empty()) {
881 if (sys::path::is_absolute(Filename))
884 FullPathName = Directory;
885 sys::path::append(FullPathName, Filename);
887 Filename = FullPathName;
891 OS << "\t.file\t" << FileNo << ' ';
892 if (!Directory.empty()) {
893 PrintQuotedString(Directory, OS);
896 PrintQuotedString(Filename, OS);
902 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
903 unsigned Column, unsigned Flags,
905 unsigned Discriminator,
906 StringRef FileName) {
907 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
908 Isa, Discriminator, FileName);
909 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
910 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
911 OS << " basic_block";
912 if (Flags & DWARF2_FLAG_PROLOGUE_END)
913 OS << " prologue_end";
914 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
915 OS << " epilogue_begin";
917 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
918 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
921 if (Flags & DWARF2_FLAG_IS_STMT)
928 OS << " isa " << Isa;
930 OS << " discriminator " << Discriminator;
933 OS.PadToColumn(MAI->getCommentColumn());
934 OS << MAI->getCommentString() << ' ' << FileName << ':'
935 << Line << ':' << Column;
940 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
941 assert(MAI->hasIdentDirective() && ".ident directive not supported");
943 PrintQuotedString(IdentString, OS);
947 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
948 MCStreamer::EmitCFISections(EH, Debug);
953 OS << "\t.cfi_sections ";
957 OS << ", .debug_frame";
959 OS << ".debug_frame";
965 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
967 RecordProcStart(Frame);
971 OS << "\t.cfi_startproc";
977 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
979 RecordProcEnd(Frame);
983 // Put a dummy non-null value in Frame.End to mark that this frame has been
985 Frame.End = (MCSymbol *) 1;
987 OS << "\t.cfi_endproc";
991 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
992 if (InstPrinter && !MAI->useDwarfRegNumForCFI()) {
993 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
994 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
995 InstPrinter->printRegName(OS, LLVMRegister);
1001 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
1002 MCStreamer::EmitCFIDefCfa(Register, Offset);
1007 OS << "\t.cfi_def_cfa ";
1008 EmitRegisterName(Register);
1009 OS << ", " << Offset;
1013 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
1014 MCStreamer::EmitCFIDefCfaOffset(Offset);
1019 OS << "\t.cfi_def_cfa_offset " << Offset;
1023 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
1024 MCStreamer::EmitCFIDefCfaRegister(Register);
1029 OS << "\t.cfi_def_cfa_register ";
1030 EmitRegisterName(Register);
1034 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1035 this->MCStreamer::EmitCFIOffset(Register, Offset);
1040 OS << "\t.cfi_offset ";
1041 EmitRegisterName(Register);
1042 OS << ", " << Offset;
1046 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1047 unsigned Encoding) {
1048 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1053 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
1057 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1058 MCStreamer::EmitCFILsda(Sym, Encoding);
1063 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
1067 void MCAsmStreamer::EmitCFIRememberState() {
1068 MCStreamer::EmitCFIRememberState();
1073 OS << "\t.cfi_remember_state";
1077 void MCAsmStreamer::EmitCFIRestoreState() {
1078 MCStreamer::EmitCFIRestoreState();
1083 OS << "\t.cfi_restore_state";
1087 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1088 MCStreamer::EmitCFISameValue(Register);
1093 OS << "\t.cfi_same_value ";
1094 EmitRegisterName(Register);
1098 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1099 MCStreamer::EmitCFIRelOffset(Register, Offset);
1104 OS << "\t.cfi_rel_offset ";
1105 EmitRegisterName(Register);
1106 OS << ", " << Offset;
1110 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1111 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1116 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1120 void MCAsmStreamer::EmitCFISignalFrame() {
1121 MCStreamer::EmitCFISignalFrame();
1126 OS << "\t.cfi_signal_frame";
1130 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1131 MCStreamer::EmitCFIUndefined(Register);
1136 OS << "\t.cfi_undefined " << Register;
1140 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1141 MCStreamer::EmitCFIRegister(Register1, Register2);
1146 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1150 void MCAsmStreamer::EmitCFIWindowSave() {
1151 MCStreamer::EmitCFIWindowSave();
1156 OS << "\t.cfi_window_save";
1160 void MCAsmStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
1161 MCStreamer::EmitWin64EHStartProc(Symbol);
1163 OS << ".seh_proc " << *Symbol;
1167 void MCAsmStreamer::EmitWin64EHEndProc() {
1168 MCStreamer::EmitWin64EHEndProc();
1170 OS << "\t.seh_endproc";
1174 void MCAsmStreamer::EmitWin64EHStartChained() {
1175 MCStreamer::EmitWin64EHStartChained();
1177 OS << "\t.seh_startchained";
1181 void MCAsmStreamer::EmitWin64EHEndChained() {
1182 MCStreamer::EmitWin64EHEndChained();
1184 OS << "\t.seh_endchained";
1188 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
1190 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
1192 OS << "\t.seh_handler " << *Sym;
1200 static const MCSection *getWin64EHTableSection(StringRef suffix,
1201 MCContext &context) {
1202 // FIXME: This doesn't belong in MCObjectFileInfo. However,
1203 /// this duplicate code in MCWin64EH.cpp.
1205 return context.getObjectFileInfo()->getXDataSection();
1206 return context.getCOFFSection((".xdata"+suffix).str(),
1207 COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
1208 COFF::IMAGE_SCN_MEM_READ |
1209 COFF::IMAGE_SCN_MEM_WRITE,
1210 SectionKind::getDataRel());
1213 void MCAsmStreamer::EmitWin64EHHandlerData() {
1214 MCStreamer::EmitWin64EHHandlerData();
1216 // Switch sections. Don't call SwitchSection directly, because that will
1217 // cause the section switch to be visible in the emitted assembly.
1218 // We only do this so the section switch that terminates the handler
1219 // data block is visible.
1220 MCWin64EHUnwindInfo *CurFrame = getCurrentW64UnwindInfo();
1221 StringRef suffix=MCWin64EHUnwindEmitter::GetSectionSuffix(CurFrame->Function);
1222 const MCSection *xdataSect = getWin64EHTableSection(suffix, getContext());
1224 SwitchSectionNoChange(xdataSect);
1226 OS << "\t.seh_handlerdata";
1230 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
1231 MCStreamer::EmitWin64EHPushReg(Register);
1233 OS << "\t.seh_pushreg " << Register;
1237 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
1238 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
1240 OS << "\t.seh_setframe " << Register << ", " << Offset;
1244 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
1245 MCStreamer::EmitWin64EHAllocStack(Size);
1247 OS << "\t.seh_stackalloc " << Size;
1251 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1252 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1254 OS << "\t.seh_savereg " << Register << ", " << Offset;
1258 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1259 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1261 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1265 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1266 MCStreamer::EmitWin64EHPushFrame(Code);
1268 OS << "\t.seh_pushframe";
1274 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1275 MCStreamer::EmitWin64EHEndProlog();
1277 OS << "\t.seh_endprologue";
1281 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1282 const MCSubtargetInfo &STI) {
1283 raw_ostream &OS = GetCommentOS();
1284 SmallString<256> Code;
1285 SmallVector<MCFixup, 4> Fixups;
1286 raw_svector_ostream VecOS(Code);
1287 Emitter->EncodeInstruction(Inst, VecOS, Fixups, STI);
1290 // If we are showing fixups, create symbolic markers in the encoded
1291 // representation. We do this by making a per-bit map to the fixup item index,
1292 // then trying to display it as nicely as possible.
1293 SmallVector<uint8_t, 64> FixupMap;
1294 FixupMap.resize(Code.size() * 8);
1295 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1298 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1299 MCFixup &F = Fixups[i];
1300 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1301 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1302 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1303 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1304 FixupMap[Index] = 1 + i;
1308 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1309 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1310 OS << "encoding: [";
1311 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1315 // See if all bits are the same map entry.
1316 uint8_t MapEntry = FixupMap[i * 8 + 0];
1317 for (unsigned j = 1; j != 8; ++j) {
1318 if (FixupMap[i * 8 + j] == MapEntry)
1321 MapEntry = uint8_t(~0U);
1325 if (MapEntry != uint8_t(~0U)) {
1326 if (MapEntry == 0) {
1327 OS << format("0x%02x", uint8_t(Code[i]));
1330 // FIXME: Some of the 8 bits require fix up.
1331 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1332 << char('A' + MapEntry - 1) << '\'';
1334 OS << char('A' + MapEntry - 1);
1337 // Otherwise, write out in binary.
1339 for (unsigned j = 8; j--;) {
1340 unsigned Bit = (Code[i] >> j) & 1;
1343 if (MAI->isLittleEndian())
1344 FixupBit = i * 8 + j;
1346 FixupBit = i * 8 + (7-j);
1348 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1349 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1350 OS << char('A' + MapEntry - 1);
1358 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1359 MCFixup &F = Fixups[i];
1360 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1361 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1362 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1366 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1367 assert(getCurrentSection().first &&
1368 "Cannot emit contents before setting section!");
1370 // Show the encoding in a comment if we have a code emitter.
1372 AddEncodingComment(Inst, STI);
1374 // Show the MCInst if enabled.
1376 Inst.dump_pretty(GetCommentOS(), MAI, InstPrinter.get(), "\n ");
1377 GetCommentOS() << "\n";
1380 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1382 InstPrinter->printInst(&Inst, OS, "");
1384 Inst.print(OS, MAI);
1388 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1389 OS << "\t.bundle_align_mode " << AlignPow2;
1393 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1394 OS << "\t.bundle_lock";
1396 OS << " align_to_end";
1400 void MCAsmStreamer::EmitBundleUnlock() {
1401 OS << "\t.bundle_unlock";
1405 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1406 /// the specified string in the output .s file. This capability is
1407 /// indicated by the hasRawTextSupport() predicate.
1408 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1409 if (!String.empty() && String.back() == '\n')
1410 String = String.substr(0, String.size()-1);
1415 void MCAsmStreamer::FinishImpl() {
1416 // If we are generating dwarf for assembly source files dump out the sections.
1417 if (getContext().getGenDwarfForAssembly())
1418 MCGenDwarfInfo::Emit(this, NULL);
1421 EmitFrames(AsmBackend.get(), false);
1424 MCSymbolData &MCAsmStreamer::getOrCreateSymbolData(const MCSymbol *Symbol) {
1425 MCSymbolData *&Entry = SymbolMap[Symbol];
1428 Entry = new MCSymbolData(*Symbol, 0, 0, 0);
1433 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1434 formatted_raw_ostream &OS,
1435 bool isVerboseAsm, bool useCFI,
1436 bool useDwarfDirectory, MCInstPrinter *IP,
1437 MCCodeEmitter *CE, MCAsmBackend *MAB,
1439 return new MCAsmStreamer(Context, OS, isVerboseAsm, useCFI, useDwarfDirectory,
1440 IP, CE, MAB, ShowInst);