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/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 OwningPtr<MCInstPrinter> InstPrinter;
44 OwningPtr<MCCodeEmitter> Emitter;
45 OwningPtr<MCAsmBackend> AsmBackend;
47 SmallString<128> CommentToEmit;
48 raw_svector_ostream CommentStream;
50 unsigned IsVerboseAsm : 1;
51 unsigned ShowInst : 1;
54 unsigned UseDwarfDirectory : 1;
56 enum EHSymbolFlags { EHGlobal = 1,
57 EHWeakDefinition = 1 << 1,
58 EHPrivateExtern = 1 << 2 };
59 DenseMap<const MCSymbol*, unsigned> FlagMap;
61 bool needsSet(const MCExpr *Value);
63 void EmitRegisterName(int64_t Register);
64 virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
65 virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame);
68 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
69 bool isVerboseAsm, bool useLoc, bool useCFI,
70 bool useDwarfDirectory,
71 MCInstPrinter *printer, MCCodeEmitter *emitter,
72 MCAsmBackend *asmbackend,
74 : MCStreamer(SK_AsmStreamer, Context), OS(os), MAI(Context.getAsmInfo()),
75 InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
76 CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
77 ShowInst(showInst), UseLoc(useLoc), UseCFI(useCFI),
78 UseDwarfDirectory(useDwarfDirectory) {
79 if (InstPrinter && IsVerboseAsm)
80 InstPrinter->setCommentStream(CommentStream);
84 inline void EmitEOL() {
85 // If we don't have any comments, just emit a \n.
92 void EmitCommentsAndEOL();
94 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
96 virtual bool isVerboseAsm() const { return IsVerboseAsm; }
98 /// hasRawTextSupport - We support EmitRawText.
99 virtual bool hasRawTextSupport() const { return true; }
101 /// AddComment - Add a comment that can be emitted to the generated .s
102 /// file if applicable as a QoI issue to make the output of the compiler
103 /// more readable. This only affects the MCAsmStreamer, and only when
104 /// verbose assembly output is enabled.
105 virtual void AddComment(const Twine &T);
107 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
108 virtual void AddEncodingComment(const MCInst &Inst);
110 /// GetCommentOS - Return a raw_ostream that comments can be written to.
111 /// Unlike AddComment, you are required to terminate comments with \n if you
113 virtual raw_ostream &GetCommentOS() {
115 return nulls(); // Discard comments unless in verbose asm mode.
116 return CommentStream;
119 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
120 virtual void AddBlankLine() {
124 /// @name MCStreamer Interface
127 virtual void ChangeSection(const MCSection *Section,
128 const MCExpr *Subsection);
130 virtual void InitSections() {
134 virtual void InitToTextSection() {
135 SwitchSection(getContext().getObjectFileInfo()->getTextSection());
138 virtual void EmitLabel(MCSymbol *Symbol);
139 virtual void EmitDebugLabel(MCSymbol *Symbol);
141 virtual void EmitEHSymAttributes(const MCSymbol *Symbol,
143 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
144 virtual void EmitLinkerOptions(ArrayRef<std::string> Options);
145 virtual void EmitDataRegion(MCDataRegionType Kind);
146 virtual void EmitThumbFunc(MCSymbol *Func);
148 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
149 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
150 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
151 const MCSymbol *LastLabel,
152 const MCSymbol *Label,
153 unsigned PointerSize);
154 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
155 const MCSymbol *Label);
157 virtual bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
159 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
160 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
161 virtual void EmitCOFFSymbolStorageClass(int StorageClass);
162 virtual void EmitCOFFSymbolType(int Type);
163 virtual void EndCOFFSymbolDef();
164 virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
165 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
166 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
167 unsigned ByteAlignment);
169 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
171 /// @param Symbol - The common symbol to emit.
172 /// @param Size - The size of the common symbol.
173 /// @param ByteAlignment - The alignment of the common symbol in bytes.
174 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
175 unsigned ByteAlignment);
177 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
178 uint64_t Size = 0, unsigned ByteAlignment = 0);
180 virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
181 uint64_t Size, unsigned ByteAlignment = 0);
183 virtual void EmitBytes(StringRef Data);
185 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size);
186 virtual void EmitIntValue(uint64_t Value, unsigned Size);
188 virtual void EmitULEB128Value(const MCExpr *Value);
190 virtual void EmitSLEB128Value(const MCExpr *Value);
192 virtual void EmitGPRel64Value(const MCExpr *Value);
194 virtual void EmitGPRel32Value(const MCExpr *Value);
197 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
199 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
200 unsigned ValueSize = 1,
201 unsigned MaxBytesToEmit = 0);
203 virtual void EmitCodeAlignment(unsigned ByteAlignment,
204 unsigned MaxBytesToEmit = 0);
206 virtual bool EmitValueToOffset(const MCExpr *Offset,
207 unsigned char Value = 0);
209 virtual void EmitFileDirective(StringRef Filename);
210 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
211 StringRef Filename, unsigned CUID = 0);
212 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
213 unsigned Column, unsigned Flags,
214 unsigned Isa, unsigned Discriminator,
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);
233 virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
234 virtual void EmitWin64EHEndProc();
235 virtual void EmitWin64EHStartChained();
236 virtual void EmitWin64EHEndChained();
237 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
239 virtual void EmitWin64EHHandlerData();
240 virtual void EmitWin64EHPushReg(unsigned Register);
241 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
242 virtual void EmitWin64EHAllocStack(unsigned Size);
243 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
244 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
245 virtual void EmitWin64EHPushFrame(bool Code);
246 virtual void EmitWin64EHEndProlog();
248 virtual void EmitFnStart();
249 virtual void EmitFnEnd();
250 virtual void EmitCantUnwind();
251 virtual void EmitPersonality(const MCSymbol *Personality);
252 virtual void EmitHandlerData();
253 virtual void EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0);
254 virtual void EmitPad(int64_t Offset);
255 virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool);
257 virtual void EmitTCEntry(const MCSymbol &S);
259 virtual void EmitInstruction(const MCInst &Inst);
261 virtual void EmitBundleAlignMode(unsigned AlignPow2);
262 virtual void EmitBundleLock(bool AlignToEnd);
263 virtual void EmitBundleUnlock();
265 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
266 /// the specified string in the output .s file. This capability is
267 /// indicated by the hasRawTextSupport() predicate.
268 virtual void EmitRawText(StringRef String);
270 virtual void FinishImpl();
274 static bool classof(const MCStreamer *S) {
275 return S->getKind() == SK_AsmStreamer;
279 } // end anonymous namespace.
281 /// AddComment - Add a comment that can be emitted to the generated .s
282 /// file if applicable as a QoI issue to make the output of the compiler
283 /// more readable. This only affects the MCAsmStreamer, and only when
284 /// verbose assembly output is enabled.
285 void MCAsmStreamer::AddComment(const Twine &T) {
286 if (!IsVerboseAsm) return;
288 // Make sure that CommentStream is flushed.
289 CommentStream.flush();
291 T.toVector(CommentToEmit);
292 // Each comment goes on its own line.
293 CommentToEmit.push_back('\n');
295 // Tell the comment stream that the vector changed underneath it.
296 CommentStream.resync();
299 void MCAsmStreamer::EmitCommentsAndEOL() {
300 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
305 CommentStream.flush();
306 StringRef Comments = CommentToEmit.str();
308 assert(Comments.back() == '\n' &&
309 "Comment array not newline terminated");
311 // Emit a line of comments.
312 OS.PadToColumn(MAI->getCommentColumn());
313 size_t Position = Comments.find('\n');
314 OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
316 Comments = Comments.substr(Position+1);
317 } while (!Comments.empty());
319 CommentToEmit.clear();
320 // Tell the comment stream that the vector changed underneath it.
321 CommentStream.resync();
324 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
325 assert(Bytes && "Invalid size!");
326 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
329 void MCAsmStreamer::ChangeSection(const MCSection *Section,
330 const MCExpr *Subsection) {
331 assert(Section && "Cannot switch to a null section!");
332 Section->PrintSwitchToSection(*MAI, OS, Subsection);
335 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
336 MCSymbol *EHSymbol) {
340 unsigned Flags = FlagMap.lookup(Symbol);
342 if (Flags & EHGlobal)
343 EmitSymbolAttribute(EHSymbol, MCSA_Global);
344 if (Flags & EHWeakDefinition)
345 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
346 if (Flags & EHPrivateExtern)
347 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
350 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
351 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
352 MCStreamer::EmitLabel(Symbol);
354 OS << *Symbol << MAI->getLabelSuffix();
358 void MCAsmStreamer::EmitDebugLabel(MCSymbol *Symbol) {
359 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
360 MCStreamer::EmitDebugLabel(Symbol);
362 OS << *Symbol << MAI->getDebugLabelSuffix();
366 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
368 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
369 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
370 case MCAF_Code16: OS << '\t'<< MAI->getCode16Directive();break;
371 case MCAF_Code32: OS << '\t'<< MAI->getCode32Directive();break;
372 case MCAF_Code64: OS << '\t'<< MAI->getCode64Directive();break;
377 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
378 assert(!Options.empty() && "At least one option is required!");
379 OS << "\t.linker_option \"" << Options[0] << '"';
380 for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
381 ie = Options.end(); it != ie; ++it) {
382 OS << ", " << '"' << *it << '"';
387 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
388 if (!MAI->doesSupportDataRegionDirectives())
391 case MCDR_DataRegion: OS << "\t.data_region"; break;
392 case MCDR_DataRegionJT8: OS << "\t.data_region jt8"; break;
393 case MCDR_DataRegionJT16: OS << "\t.data_region jt16"; break;
394 case MCDR_DataRegionJT32: OS << "\t.data_region jt32"; break;
395 case MCDR_DataRegionEnd: OS << "\t.end_data_region"; break;
400 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
401 // This needs to emit to a temporary string to get properly quoted
402 // MCSymbols when they have spaces in them.
403 OS << "\t.thumb_func";
404 // Only Mach-O hasSubsectionsViaSymbols()
405 if (MAI->hasSubsectionsViaSymbols())
410 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
411 OS << *Symbol << " = " << *Value;
414 // FIXME: Lift context changes into super class.
415 Symbol->setVariableValue(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::EmitCOFFSecRel32(MCSymbol const *Symbol) {
525 OS << "\t.secrel32\t" << *Symbol << '\n';
529 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
530 assert(MAI->hasDotTypeDotSizeDirective());
531 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
534 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
535 unsigned ByteAlignment) {
536 const MCSection *Section = getContext().getObjectFileInfo()->getBSSSection();
537 AssignSection(Symbol, Section);
539 OS << "\t.comm\t" << *Symbol << ',' << Size;
540 if (ByteAlignment != 0) {
541 if (MAI->getCOMMDirectiveAlignmentIsInBytes())
542 OS << ',' << ByteAlignment;
544 OS << ',' << Log2_32(ByteAlignment);
549 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
551 /// @param Symbol - The common symbol to emit.
552 /// @param Size - The size of the common symbol.
553 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
554 unsigned ByteAlign) {
555 const MCSection *Section = getContext().getObjectFileInfo()->getBSSSection();
556 AssignSection(Symbol, Section);
558 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
560 switch (MAI->getLCOMMDirectiveAlignmentType()) {
561 case LCOMM::NoAlignment:
562 llvm_unreachable("alignment not supported on .lcomm!");
563 case LCOMM::ByteAlignment:
564 OS << ',' << ByteAlign;
566 case LCOMM::Log2Alignment:
567 assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
568 OS << ',' << Log2_32(ByteAlign);
575 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
576 uint64_t Size, unsigned ByteAlignment) {
578 AssignSection(Symbol, Section);
580 // Note: a .zerofill directive does not switch sections.
583 // This is a mach-o specific directive.
584 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
585 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
587 if (Symbol != NULL) {
588 OS << ',' << *Symbol << ',' << Size;
589 if (ByteAlignment != 0)
590 OS << ',' << Log2_32(ByteAlignment);
595 // .tbss sym, size, align
596 // This depends that the symbol has already been mangled from the original,
598 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
599 uint64_t Size, unsigned ByteAlignment) {
600 AssignSection(Symbol, Section);
602 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
603 // Instead of using the Section we'll just use the shortcut.
604 // This is a mach-o specific directive and section.
605 OS << ".tbss " << *Symbol << ", " << Size;
607 // Output align if we have it. We default to 1 so don't bother printing
609 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
614 static inline char toOctal(int X) { return (X&7)+'0'; }
616 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
619 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
620 unsigned char C = Data[i];
621 if (C == '"' || C == '\\') {
622 OS << '\\' << (char)C;
626 if (isprint((unsigned char)C)) {
632 case '\b': OS << "\\b"; break;
633 case '\f': OS << "\\f"; break;
634 case '\n': OS << "\\n"; break;
635 case '\r': OS << "\\r"; break;
636 case '\t': OS << "\\t"; break;
639 OS << toOctal(C >> 6);
640 OS << toOctal(C >> 3);
641 OS << toOctal(C >> 0);
650 void MCAsmStreamer::EmitBytes(StringRef Data) {
651 assert(getCurrentSection().first &&
652 "Cannot emit contents before setting section!");
653 if (Data.empty()) return;
655 if (Data.size() == 1) {
656 OS << MAI->getData8bitsDirective();
657 OS << (unsigned)(unsigned char)Data[0];
662 // If the data ends with 0 and the target supports .asciz, use it, otherwise
664 if (MAI->getAscizDirective() && Data.back() == 0) {
665 OS << MAI->getAscizDirective();
666 Data = Data.substr(0, Data.size()-1);
668 OS << MAI->getAsciiDirective();
671 PrintQuotedString(Data, OS);
675 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
676 EmitValue(MCConstantExpr::Create(Value, getContext()), Size);
679 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size) {
680 assert(getCurrentSection().first &&
681 "Cannot emit contents before setting section!");
682 const char *Directive = 0;
685 case 1: Directive = MAI->getData8bitsDirective(); break;
686 case 2: Directive = MAI->getData16bitsDirective(); break;
687 case 4: Directive = MAI->getData32bitsDirective(); break;
689 Directive = MAI->getData64bitsDirective();
690 // If the target doesn't support 64-bit data, emit as two 32-bit halves.
691 if (Directive) break;
693 if (!Value->EvaluateAsAbsolute(IntValue))
694 report_fatal_error("Don't know how to emit this value.");
695 if (MAI->isLittleEndian()) {
696 EmitIntValue((uint32_t)(IntValue >> 0 ), 4);
697 EmitIntValue((uint32_t)(IntValue >> 32), 4);
699 EmitIntValue((uint32_t)(IntValue >> 32), 4);
700 EmitIntValue((uint32_t)(IntValue >> 0 ), 4);
705 assert(Directive && "Invalid size for machine code value!");
706 OS << Directive << *Value;
710 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
712 if (Value->EvaluateAsAbsolute(IntValue)) {
713 EmitULEB128IntValue(IntValue);
716 assert(MAI->hasLEB128() && "Cannot print a .uleb");
717 OS << ".uleb128 " << *Value;
721 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
723 if (Value->EvaluateAsAbsolute(IntValue)) {
724 EmitSLEB128IntValue(IntValue);
727 assert(MAI->hasLEB128() && "Cannot print a .sleb");
728 OS << ".sleb128 " << *Value;
732 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
733 assert(MAI->getGPRel64Directive() != 0);
734 OS << MAI->getGPRel64Directive() << *Value;
738 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
739 assert(MAI->getGPRel32Directive() != 0);
740 OS << MAI->getGPRel32Directive() << *Value;
745 /// EmitFill - Emit NumBytes bytes worth of the value specified by
746 /// FillValue. This implements directives such as '.space'.
747 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
748 if (NumBytes == 0) return;
750 if (const char *ZeroDirective = MAI->getZeroDirective()) {
751 OS << ZeroDirective << NumBytes;
753 OS << ',' << (int)FillValue;
758 // Emit a byte at a time.
759 MCStreamer::EmitFill(NumBytes, FillValue);
762 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
764 unsigned MaxBytesToEmit) {
765 // Some assemblers don't support non-power of two alignments, so we always
766 // emit alignments as a power of two if possible.
767 if (isPowerOf2_32(ByteAlignment)) {
769 default: llvm_unreachable("Invalid size for machine code value!");
770 case 1: OS << MAI->getAlignDirective(); break;
771 // FIXME: use MAI for this!
772 case 2: OS << ".p2alignw "; break;
773 case 4: OS << ".p2alignl "; break;
774 case 8: llvm_unreachable("Unsupported alignment size!");
777 if (MAI->getAlignmentIsInBytes())
780 OS << Log2_32(ByteAlignment);
782 if (Value || MaxBytesToEmit) {
784 OS.write_hex(truncateToSize(Value, ValueSize));
787 OS << ", " << MaxBytesToEmit;
793 // Non-power of two alignment. This is not widely supported by assemblers.
794 // FIXME: Parameterize this based on MAI.
796 default: llvm_unreachable("Invalid size for machine code value!");
797 case 1: OS << ".balign"; break;
798 case 2: OS << ".balignw"; break;
799 case 4: OS << ".balignl"; break;
800 case 8: llvm_unreachable("Unsupported alignment size!");
803 OS << ' ' << ByteAlignment;
804 OS << ", " << truncateToSize(Value, ValueSize);
806 OS << ", " << MaxBytesToEmit;
810 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
811 unsigned MaxBytesToEmit) {
812 // Emit with a text fill value.
813 EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
817 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
818 unsigned char Value) {
819 // FIXME: Verify that Offset is associated with the current section.
820 OS << ".org " << *Offset << ", " << (unsigned) Value;
826 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
827 assert(MAI->hasSingleParameterDotFile());
829 PrintQuotedString(Filename, OS);
833 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
834 StringRef Filename, unsigned CUID) {
835 if (!UseDwarfDirectory && !Directory.empty()) {
836 if (sys::path::is_absolute(Filename))
837 return EmitDwarfFileDirective(FileNo, "", Filename, CUID);
839 SmallString<128> FullPathName = Directory;
840 sys::path::append(FullPathName, Filename);
841 return EmitDwarfFileDirective(FileNo, "", FullPathName, CUID);
845 OS << "\t.file\t" << FileNo << ' ';
846 if (!Directory.empty()) {
847 PrintQuotedString(Directory, OS);
850 PrintQuotedString(Filename, OS);
852 // All .file will belong to a single CUID.
855 return this->MCStreamer::EmitDwarfFileDirective(FileNo, Directory, Filename,
859 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
860 unsigned Column, unsigned Flags,
862 unsigned Discriminator,
863 StringRef FileName) {
864 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
865 Isa, Discriminator, FileName);
869 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
870 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
871 OS << " basic_block";
872 if (Flags & DWARF2_FLAG_PROLOGUE_END)
873 OS << " prologue_end";
874 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
875 OS << " epilogue_begin";
877 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
878 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
881 if (Flags & DWARF2_FLAG_IS_STMT)
890 OS << "discriminator " << Discriminator;
893 OS.PadToColumn(MAI->getCommentColumn());
894 OS << MAI->getCommentString() << ' ' << FileName << ':'
895 << Line << ':' << Column;
900 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
901 MCStreamer::EmitCFISections(EH, Debug);
906 OS << "\t.cfi_sections ";
910 OS << ", .debug_frame";
912 OS << ".debug_frame";
918 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
920 RecordProcStart(Frame);
924 OS << "\t.cfi_startproc";
928 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
930 RecordProcEnd(Frame);
934 // Put a dummy non-null value in Frame.End to mark that this frame has been
936 Frame.End = (MCSymbol *) 1;
938 OS << "\t.cfi_endproc";
942 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
943 if (InstPrinter && !MAI->useDwarfRegNumForCFI()) {
944 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
945 unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
946 InstPrinter->printRegName(OS, LLVMRegister);
952 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
953 MCStreamer::EmitCFIDefCfa(Register, Offset);
958 OS << "\t.cfi_def_cfa ";
959 EmitRegisterName(Register);
960 OS << ", " << Offset;
964 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
965 MCStreamer::EmitCFIDefCfaOffset(Offset);
970 OS << "\t.cfi_def_cfa_offset " << Offset;
974 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
975 MCStreamer::EmitCFIDefCfaRegister(Register);
980 OS << "\t.cfi_def_cfa_register ";
981 EmitRegisterName(Register);
985 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
986 this->MCStreamer::EmitCFIOffset(Register, Offset);
991 OS << "\t.cfi_offset ";
992 EmitRegisterName(Register);
993 OS << ", " << Offset;
997 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
999 MCStreamer::EmitCFIPersonality(Sym, Encoding);
1004 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
1008 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1009 MCStreamer::EmitCFILsda(Sym, Encoding);
1014 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
1018 void MCAsmStreamer::EmitCFIRememberState() {
1019 MCStreamer::EmitCFIRememberState();
1024 OS << "\t.cfi_remember_state";
1028 void MCAsmStreamer::EmitCFIRestoreState() {
1029 MCStreamer::EmitCFIRestoreState();
1034 OS << "\t.cfi_restore_state";
1038 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1039 MCStreamer::EmitCFISameValue(Register);
1044 OS << "\t.cfi_same_value ";
1045 EmitRegisterName(Register);
1049 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1050 MCStreamer::EmitCFIRelOffset(Register, Offset);
1055 OS << "\t.cfi_rel_offset ";
1056 EmitRegisterName(Register);
1057 OS << ", " << Offset;
1061 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1062 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1067 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1071 void MCAsmStreamer::EmitCFISignalFrame() {
1072 MCStreamer::EmitCFISignalFrame();
1077 OS << "\t.cfi_signal_frame";
1081 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1082 MCStreamer::EmitCFIUndefined(Register);
1087 OS << "\t.cfi_undefined " << Register;
1091 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1092 MCStreamer::EmitCFIRegister(Register1, Register2);
1097 OS << "\t.cfi_register " << Register1 << ", " << Register2;
1101 void MCAsmStreamer::EmitWin64EHStartProc(const MCSymbol *Symbol) {
1102 MCStreamer::EmitWin64EHStartProc(Symbol);
1104 OS << ".seh_proc " << *Symbol;
1108 void MCAsmStreamer::EmitWin64EHEndProc() {
1109 MCStreamer::EmitWin64EHEndProc();
1111 OS << "\t.seh_endproc";
1115 void MCAsmStreamer::EmitWin64EHStartChained() {
1116 MCStreamer::EmitWin64EHStartChained();
1118 OS << "\t.seh_startchained";
1122 void MCAsmStreamer::EmitWin64EHEndChained() {
1123 MCStreamer::EmitWin64EHEndChained();
1125 OS << "\t.seh_endchained";
1129 void MCAsmStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
1131 MCStreamer::EmitWin64EHHandler(Sym, Unwind, Except);
1133 OS << "\t.seh_handler " << *Sym;
1141 static const MCSection *getWin64EHTableSection(StringRef suffix,
1142 MCContext &context) {
1143 // FIXME: This doesn't belong in MCObjectFileInfo. However,
1144 /// this duplicate code in MCWin64EH.cpp.
1146 return context.getObjectFileInfo()->getXDataSection();
1147 return context.getCOFFSection((".xdata"+suffix).str(),
1148 COFF::IMAGE_SCN_CNT_INITIALIZED_DATA |
1149 COFF::IMAGE_SCN_MEM_READ |
1150 COFF::IMAGE_SCN_MEM_WRITE,
1151 SectionKind::getDataRel());
1154 void MCAsmStreamer::EmitWin64EHHandlerData() {
1155 MCStreamer::EmitWin64EHHandlerData();
1157 // Switch sections. Don't call SwitchSection directly, because that will
1158 // cause the section switch to be visible in the emitted assembly.
1159 // We only do this so the section switch that terminates the handler
1160 // data block is visible.
1161 MCWin64EHUnwindInfo *CurFrame = getCurrentW64UnwindInfo();
1162 StringRef suffix=MCWin64EHUnwindEmitter::GetSectionSuffix(CurFrame->Function);
1163 const MCSection *xdataSect = getWin64EHTableSection(suffix, getContext());
1165 SwitchSectionNoChange(xdataSect);
1167 OS << "\t.seh_handlerdata";
1171 void MCAsmStreamer::EmitWin64EHPushReg(unsigned Register) {
1172 MCStreamer::EmitWin64EHPushReg(Register);
1174 OS << "\t.seh_pushreg " << Register;
1178 void MCAsmStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
1179 MCStreamer::EmitWin64EHSetFrame(Register, Offset);
1181 OS << "\t.seh_setframe " << Register << ", " << Offset;
1185 void MCAsmStreamer::EmitWin64EHAllocStack(unsigned Size) {
1186 MCStreamer::EmitWin64EHAllocStack(Size);
1188 OS << "\t.seh_stackalloc " << Size;
1192 void MCAsmStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
1193 MCStreamer::EmitWin64EHSaveReg(Register, Offset);
1195 OS << "\t.seh_savereg " << Register << ", " << Offset;
1199 void MCAsmStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
1200 MCStreamer::EmitWin64EHSaveXMM(Register, Offset);
1202 OS << "\t.seh_savexmm " << Register << ", " << Offset;
1206 void MCAsmStreamer::EmitWin64EHPushFrame(bool Code) {
1207 MCStreamer::EmitWin64EHPushFrame(Code);
1209 OS << "\t.seh_pushframe";
1215 void MCAsmStreamer::EmitWin64EHEndProlog(void) {
1216 MCStreamer::EmitWin64EHEndProlog();
1218 OS << "\t.seh_endprologue";
1222 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
1223 raw_ostream &OS = GetCommentOS();
1224 SmallString<256> Code;
1225 SmallVector<MCFixup, 4> Fixups;
1226 raw_svector_ostream VecOS(Code);
1227 Emitter->EncodeInstruction(Inst, VecOS, Fixups);
1230 // If we are showing fixups, create symbolic markers in the encoded
1231 // representation. We do this by making a per-bit map to the fixup item index,
1232 // then trying to display it as nicely as possible.
1233 SmallVector<uint8_t, 64> FixupMap;
1234 FixupMap.resize(Code.size() * 8);
1235 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1238 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1239 MCFixup &F = Fixups[i];
1240 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1241 for (unsigned j = 0; j != Info.TargetSize; ++j) {
1242 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1243 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1244 FixupMap[Index] = 1 + i;
1248 // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1249 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1250 OS << "encoding: [";
1251 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1255 // See if all bits are the same map entry.
1256 uint8_t MapEntry = FixupMap[i * 8 + 0];
1257 for (unsigned j = 1; j != 8; ++j) {
1258 if (FixupMap[i * 8 + j] == MapEntry)
1261 MapEntry = uint8_t(~0U);
1265 if (MapEntry != uint8_t(~0U)) {
1266 if (MapEntry == 0) {
1267 OS << format("0x%02x", uint8_t(Code[i]));
1270 // FIXME: Some of the 8 bits require fix up.
1271 OS << format("0x%02x", uint8_t(Code[i])) << '\''
1272 << char('A' + MapEntry - 1) << '\'';
1274 OS << char('A' + MapEntry - 1);
1277 // Otherwise, write out in binary.
1279 for (unsigned j = 8; j--;) {
1280 unsigned Bit = (Code[i] >> j) & 1;
1283 if (MAI->isLittleEndian())
1284 FixupBit = i * 8 + j;
1286 FixupBit = i * 8 + (7-j);
1288 if (uint8_t MapEntry = FixupMap[FixupBit]) {
1289 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1290 OS << char('A' + MapEntry - 1);
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 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1302 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1306 void MCAsmStreamer::EmitFnStart() {
1311 void MCAsmStreamer::EmitFnEnd() {
1316 void MCAsmStreamer::EmitCantUnwind() {
1317 OS << "\t.cantunwind";
1321 void MCAsmStreamer::EmitHandlerData() {
1322 OS << "\t.handlerdata";
1326 void MCAsmStreamer::EmitPersonality(const MCSymbol *Personality) {
1327 OS << "\t.personality " << Personality->getName();
1331 void MCAsmStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
1333 InstPrinter->printRegName(OS, FpReg);
1335 InstPrinter->printRegName(OS, SpReg);
1337 OS << ", #" << Offset;
1341 void MCAsmStreamer::EmitPad(int64_t Offset) {
1342 OS << "\t.pad\t#" << Offset;
1346 void MCAsmStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
1348 assert(RegList.size() && "RegList should not be empty");
1350 OS << "\t.vsave\t{";
1354 InstPrinter->printRegName(OS, RegList[0]);
1356 for (unsigned i = 1, e = RegList.size(); i != e; ++i) {
1358 InstPrinter->printRegName(OS, RegList[i]);
1365 void MCAsmStreamer::EmitTCEntry(const MCSymbol &S) {
1373 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
1374 assert(getCurrentSection().first &&
1375 "Cannot emit contents before setting section!");
1377 // Show the encoding in a comment if we have a code emitter.
1379 AddEncodingComment(Inst);
1381 // Show the MCInst if enabled.
1383 Inst.dump_pretty(GetCommentOS(), MAI, InstPrinter.get(), "\n ");
1384 GetCommentOS() << "\n";
1387 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1389 InstPrinter->printInst(&Inst, OS, "");
1391 Inst.print(OS, MAI);
1395 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1396 OS << "\t.bundle_align_mode " << AlignPow2;
1400 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1401 OS << "\t.bundle_lock";
1403 OS << " align_to_end";
1407 void MCAsmStreamer::EmitBundleUnlock() {
1408 OS << "\t.bundle_unlock";
1412 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1413 /// the specified string in the output .s file. This capability is
1414 /// indicated by the hasRawTextSupport() predicate.
1415 void MCAsmStreamer::EmitRawText(StringRef String) {
1416 if (!String.empty() && String.back() == '\n')
1417 String = String.substr(0, String.size()-1);
1422 void MCAsmStreamer::FinishImpl() {
1423 // FIXME: This header is duplicated with MCObjectStreamer
1424 // Dump out the dwarf file & directory tables and line tables.
1425 const MCSymbol *LineSectionSymbol = NULL;
1426 if (getContext().hasDwarfFiles() && !UseLoc)
1427 LineSectionSymbol = MCDwarfFileTable::Emit(this);
1429 // If we are generating dwarf for assembly source files dump out the sections.
1430 if (getContext().getGenDwarfForAssembly())
1431 MCGenDwarfInfo::Emit(this, LineSectionSymbol);
1434 EmitFrames(AsmBackend.get(), false);
1437 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1438 formatted_raw_ostream &OS,
1439 bool isVerboseAsm, bool useLoc,
1440 bool useCFI, bool useDwarfDirectory,
1441 MCInstPrinter *IP, MCCodeEmitter *CE,
1442 MCAsmBackend *MAB, bool ShowInst) {
1443 return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc, useCFI,
1444 useDwarfDirectory, IP, CE, MAB, ShowInst);