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/MC/MCAsmInfo.h"
12 #include "llvm/MC/MCCodeEmitter.h"
13 #include "llvm/MC/MCContext.h"
14 #include "llvm/MC/MCExpr.h"
15 #include "llvm/MC/MCFixupKindInfo.h"
16 #include "llvm/MC/MCInst.h"
17 #include "llvm/MC/MCInstPrinter.h"
18 #include "llvm/MC/MCSectionMachO.h"
19 #include "llvm/MC/MCSymbol.h"
20 #include "llvm/ADT/OwningPtr.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/MathExtras.h"
25 #include "llvm/Support/Format.h"
26 #include "llvm/Support/FormattedStream.h"
27 #include "llvm/Target/TargetAsmBackend.h"
28 #include "llvm/Target/TargetAsmInfo.h"
29 #include "llvm/Target/TargetLoweringObjectFile.h"
35 class MCAsmStreamer : public MCStreamer {
36 formatted_raw_ostream &OS;
38 OwningPtr<MCInstPrinter> InstPrinter;
39 OwningPtr<MCCodeEmitter> Emitter;
40 OwningPtr<TargetAsmBackend> AsmBackend;
42 SmallString<128> CommentToEmit;
43 raw_svector_ostream CommentStream;
45 unsigned IsVerboseAsm : 1;
46 unsigned ShowInst : 1;
50 enum EHSymbolFlags { EHGlobal = 1,
51 EHWeakDefinition = 1 << 1,
52 EHPrivateExtern = 1 << 2 };
53 DenseMap<const MCSymbol*, unsigned> FlagMap;
55 bool needsSet(const MCExpr *Value);
58 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
59 bool isVerboseAsm, bool useLoc, bool useCFI,
60 MCInstPrinter *printer, MCCodeEmitter *emitter,
61 TargetAsmBackend *asmbackend,
63 : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
64 InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
65 CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
66 ShowInst(showInst), UseLoc(useLoc), UseCFI(useCFI) {
67 if (InstPrinter && IsVerboseAsm)
68 InstPrinter->setCommentStream(CommentStream);
72 inline void EmitEOL() {
73 // If we don't have any comments, just emit a \n.
80 void EmitCommentsAndEOL();
82 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
84 virtual bool isVerboseAsm() const { return IsVerboseAsm; }
86 /// hasRawTextSupport - We support EmitRawText.
87 virtual bool hasRawTextSupport() const { return true; }
89 /// AddComment - Add a comment that can be emitted to the generated .s
90 /// file if applicable as a QoI issue to make the output of the compiler
91 /// more readable. This only affects the MCAsmStreamer, and only when
92 /// verbose assembly output is enabled.
93 virtual void AddComment(const Twine &T);
95 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
96 virtual void AddEncodingComment(const MCInst &Inst);
98 /// GetCommentOS - Return a raw_ostream that comments can be written to.
99 /// Unlike AddComment, you are required to terminate comments with \n if you
101 virtual raw_ostream &GetCommentOS() {
103 return nulls(); // Discard comments unless in verbose asm mode.
104 return CommentStream;
107 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
108 virtual void AddBlankLine() {
112 /// @name MCStreamer Interface
115 virtual void ChangeSection(const MCSection *Section);
117 virtual void InitSections() {
118 // FIXME, this is MachO specific, but the testsuite
120 SwitchSection(getContext().getMachOSection("__TEXT", "__text",
121 MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
122 0, SectionKind::getText()));
125 virtual void EmitLabel(MCSymbol *Symbol);
126 virtual void EmitEHSymAttributes(const MCSymbol *Symbol,
128 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
129 virtual void EmitThumbFunc(MCSymbol *Func);
131 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
132 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
133 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
134 const MCSymbol *LastLabel,
135 const MCSymbol *Label);
136 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
137 const MCSymbol *Label);
139 virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
141 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
142 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
143 virtual void EmitCOFFSymbolStorageClass(int StorageClass);
144 virtual void EmitCOFFSymbolType(int Type);
145 virtual void EndCOFFSymbolDef();
146 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
147 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
148 unsigned ByteAlignment);
150 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
152 /// @param Symbol - The common symbol to emit.
153 /// @param Size - The size of the common symbol.
154 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
156 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
157 unsigned Size = 0, unsigned ByteAlignment = 0);
159 virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
160 uint64_t Size, unsigned ByteAlignment = 0);
162 virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
164 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
166 virtual void EmitIntValue(uint64_t Value, unsigned Size,
167 unsigned AddrSpace = 0);
169 virtual void EmitULEB128Value(const MCExpr *Value);
171 virtual void EmitSLEB128Value(const MCExpr *Value);
173 virtual void EmitGPRel32Value(const MCExpr *Value);
176 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
179 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
180 unsigned ValueSize = 1,
181 unsigned MaxBytesToEmit = 0);
183 virtual void EmitCodeAlignment(unsigned ByteAlignment,
184 unsigned MaxBytesToEmit = 0);
186 virtual void EmitValueToOffset(const MCExpr *Offset,
187 unsigned char Value = 0);
189 virtual void EmitFileDirective(StringRef Filename);
190 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
191 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
192 unsigned Column, unsigned Flags,
193 unsigned Isa, unsigned Discriminator,
196 virtual void EmitCFIStartProc();
197 virtual void EmitCFIEndProc();
198 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
199 virtual void EmitCFIDefCfaOffset(int64_t Offset);
200 virtual void EmitCFIDefCfaRegister(int64_t Register);
201 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
202 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
203 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
204 virtual void EmitCFIRememberState();
205 virtual void EmitCFIRestoreState();
206 virtual void EmitCFISameValue(int64_t Register);
207 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
208 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
210 virtual void EmitFnStart();
211 virtual void EmitFnEnd();
212 virtual void EmitCantUnwind();
213 virtual void EmitPersonality(const MCSymbol *Personality);
214 virtual void EmitHandlerData();
215 virtual void EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0);
216 virtual void EmitPad(int64_t Offset);
217 virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool);
220 virtual void EmitInstruction(const MCInst &Inst);
222 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
223 /// the specified string in the output .s file. This capability is
224 /// indicated by the hasRawTextSupport() predicate.
225 virtual void EmitRawText(StringRef String);
227 virtual void Finish();
232 } // end anonymous namespace.
234 /// AddComment - Add a comment that can be emitted to the generated .s
235 /// file if applicable as a QoI issue to make the output of the compiler
236 /// more readable. This only affects the MCAsmStreamer, and only when
237 /// verbose assembly output is enabled.
238 void MCAsmStreamer::AddComment(const Twine &T) {
239 if (!IsVerboseAsm) return;
241 // Make sure that CommentStream is flushed.
242 CommentStream.flush();
244 T.toVector(CommentToEmit);
245 // Each comment goes on its own line.
246 CommentToEmit.push_back('\n');
248 // Tell the comment stream that the vector changed underneath it.
249 CommentStream.resync();
252 void MCAsmStreamer::EmitCommentsAndEOL() {
253 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
258 CommentStream.flush();
259 StringRef Comments = CommentToEmit.str();
261 assert(Comments.back() == '\n' &&
262 "Comment array not newline terminated");
264 // Emit a line of comments.
265 OS.PadToColumn(MAI.getCommentColumn());
266 size_t Position = Comments.find('\n');
267 OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
269 Comments = Comments.substr(Position+1);
270 } while (!Comments.empty());
272 CommentToEmit.clear();
273 // Tell the comment stream that the vector changed underneath it.
274 CommentStream.resync();
277 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
278 assert(Bytes && "Invalid size!");
279 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
282 void MCAsmStreamer::ChangeSection(const MCSection *Section) {
283 assert(Section && "Cannot switch to a null section!");
284 Section->PrintSwitchToSection(MAI, OS);
287 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
288 MCSymbol *EHSymbol) {
292 unsigned Flags = FlagMap.lookup(Symbol);
294 if (Flags & EHGlobal)
295 EmitSymbolAttribute(EHSymbol, MCSA_Global);
296 if (Flags & EHWeakDefinition)
297 EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
298 if (Flags & EHPrivateExtern)
299 EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
302 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
303 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
304 MCStreamer::EmitLabel(Symbol);
306 OS << *Symbol << MAI.getLabelSuffix();
310 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
312 default: assert(0 && "Invalid flag!");
313 case MCAF_SyntaxUnified: OS << "\t.syntax unified"; break;
314 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
315 case MCAF_Code16: OS << "\t.code\t16"; break;
316 case MCAF_Code32: OS << "\t.code\t32"; break;
321 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
322 // This needs to emit to a temporary string to get properly quoted
323 // MCSymbols when they have spaces in them.
324 OS << "\t.thumb_func";
330 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
331 OS << *Symbol << " = " << *Value;
334 // FIXME: Lift context changes into super class.
335 Symbol->setVariableValue(Value);
338 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
339 OS << ".weakref " << *Alias << ", " << *Symbol;
343 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
344 const MCSymbol *LastLabel,
345 const MCSymbol *Label) {
346 EmitDwarfSetLineAddr(LineDelta, Label,
347 getContext().getTargetAsmInfo().getPointerSize());
350 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
351 const MCSymbol *Label) {
352 EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
353 const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
354 AddrDelta = ForceExpAbs(this, getContext(), AddrDelta);
355 EmitValue(AddrDelta, 4);
359 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
360 MCSymbolAttr Attribute) {
362 case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
363 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
364 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
365 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
366 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
367 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
368 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
369 case MCSA_ELF_TypeGnuUniqueObject: /// .type _foo, @gnu_unique_object
370 assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
371 OS << "\t.type\t" << *Symbol << ','
372 << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
374 default: assert(0 && "Unknown ELF .type");
375 case MCSA_ELF_TypeFunction: OS << "function"; break;
376 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
377 case MCSA_ELF_TypeObject: OS << "object"; break;
378 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
379 case MCSA_ELF_TypeCommon: OS << "common"; break;
380 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
381 case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
385 case MCSA_Global: // .globl/.global
386 OS << MAI.getGlobalDirective();
387 FlagMap[Symbol] |= EHGlobal;
389 case MCSA_Hidden: OS << "\t.hidden\t"; break;
390 case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
391 case MCSA_Internal: OS << "\t.internal\t"; break;
392 case MCSA_LazyReference: OS << "\t.lazy_reference\t"; break;
393 case MCSA_Local: OS << "\t.local\t"; break;
394 case MCSA_NoDeadStrip: OS << "\t.no_dead_strip\t"; break;
395 case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
396 case MCSA_PrivateExtern:
397 OS << "\t.private_extern\t";
398 FlagMap[Symbol] |= EHPrivateExtern;
400 case MCSA_Protected: OS << "\t.protected\t"; break;
401 case MCSA_Reference: OS << "\t.reference\t"; break;
402 case MCSA_Weak: OS << "\t.weak\t"; break;
403 case MCSA_WeakDefinition:
404 OS << "\t.weak_definition\t";
405 FlagMap[Symbol] |= EHWeakDefinition;
408 case MCSA_WeakReference: OS << MAI.getWeakRefDirective(); break;
409 case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
416 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
417 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
421 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
422 OS << "\t.def\t " << *Symbol << ';';
426 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
427 OS << "\t.scl\t" << StorageClass << ';';
431 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
432 OS << "\t.type\t" << Type << ';';
436 void MCAsmStreamer::EndCOFFSymbolDef() {
441 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
442 assert(MAI.hasDotTypeDotSizeDirective());
443 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
446 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
447 unsigned ByteAlignment) {
448 OS << "\t.comm\t" << *Symbol << ',' << Size;
449 if (ByteAlignment != 0) {
450 if (MAI.getCOMMDirectiveAlignmentIsInBytes())
451 OS << ',' << ByteAlignment;
453 OS << ',' << Log2_32(ByteAlignment);
458 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
460 /// @param Symbol - The common symbol to emit.
461 /// @param Size - The size of the common symbol.
462 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
463 assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
464 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
468 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
469 unsigned Size, unsigned ByteAlignment) {
470 // Note: a .zerofill directive does not switch sections.
473 // This is a mach-o specific directive.
474 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
475 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
477 if (Symbol != NULL) {
478 OS << ',' << *Symbol << ',' << Size;
479 if (ByteAlignment != 0)
480 OS << ',' << Log2_32(ByteAlignment);
485 // .tbss sym, size, align
486 // This depends that the symbol has already been mangled from the original,
488 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
489 uint64_t Size, unsigned ByteAlignment) {
490 assert(Symbol != NULL && "Symbol shouldn't be NULL!");
491 // Instead of using the Section we'll just use the shortcut.
492 // This is a mach-o specific directive and section.
493 OS << ".tbss " << *Symbol << ", " << Size;
495 // Output align if we have it. We default to 1 so don't bother printing
497 if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
502 static inline char toOctal(int X) { return (X&7)+'0'; }
504 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
507 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
508 unsigned char C = Data[i];
509 if (C == '"' || C == '\\') {
510 OS << '\\' << (char)C;
514 if (isprint((unsigned char)C)) {
520 case '\b': OS << "\\b"; break;
521 case '\f': OS << "\\f"; break;
522 case '\n': OS << "\\n"; break;
523 case '\r': OS << "\\r"; break;
524 case '\t': OS << "\\t"; break;
527 OS << toOctal(C >> 6);
528 OS << toOctal(C >> 3);
529 OS << toOctal(C >> 0);
538 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
539 assert(getCurrentSection() && "Cannot emit contents before setting section!");
540 if (Data.empty()) return;
542 if (Data.size() == 1) {
543 OS << MAI.getData8bitsDirective(AddrSpace);
544 OS << (unsigned)(unsigned char)Data[0];
549 // If the data ends with 0 and the target supports .asciz, use it, otherwise
551 if (MAI.getAscizDirective() && Data.back() == 0) {
552 OS << MAI.getAscizDirective();
553 Data = Data.substr(0, Data.size()-1);
555 OS << MAI.getAsciiDirective();
559 PrintQuotedString(Data, OS);
563 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
564 unsigned AddrSpace) {
565 EmitValue(MCConstantExpr::Create(Value, getContext()), Size, AddrSpace);
568 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
569 unsigned AddrSpace) {
570 assert(getCurrentSection() && "Cannot emit contents before setting section!");
571 const char *Directive = 0;
574 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
575 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
576 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
578 Directive = MAI.getData64bitsDirective(AddrSpace);
579 // If the target doesn't support 64-bit data, emit as two 32-bit halves.
580 if (Directive) break;
582 if (!Value->EvaluateAsAbsolute(IntValue))
583 report_fatal_error("Don't know how to emit this value.");
584 if (getContext().getTargetAsmInfo().isLittleEndian()) {
585 EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
586 EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
588 EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
589 EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
594 assert(Directive && "Invalid size for machine code value!");
595 OS << Directive << *Value;
599 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
601 if (Value->EvaluateAsAbsolute(IntValue)) {
602 EmitULEB128IntValue(IntValue);
605 assert(MAI.hasLEB128() && "Cannot print a .uleb");
606 OS << ".uleb128 " << *Value;
610 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
612 if (Value->EvaluateAsAbsolute(IntValue)) {
613 EmitSLEB128IntValue(IntValue);
616 assert(MAI.hasLEB128() && "Cannot print a .sleb");
617 OS << ".sleb128 " << *Value;
621 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
622 assert(MAI.getGPRel32Directive() != 0);
623 OS << MAI.getGPRel32Directive() << *Value;
628 /// EmitFill - Emit NumBytes bytes worth of the value specified by
629 /// FillValue. This implements directives such as '.space'.
630 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
631 unsigned AddrSpace) {
632 if (NumBytes == 0) return;
635 if (const char *ZeroDirective = MAI.getZeroDirective()) {
636 OS << ZeroDirective << NumBytes;
638 OS << ',' << (int)FillValue;
643 // Emit a byte at a time.
644 MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
647 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
649 unsigned MaxBytesToEmit) {
650 // Some assemblers don't support non-power of two alignments, so we always
651 // emit alignments as a power of two if possible.
652 if (isPowerOf2_32(ByteAlignment)) {
654 default: llvm_unreachable("Invalid size for machine code value!");
655 case 1: OS << MAI.getAlignDirective(); break;
656 // FIXME: use MAI for this!
657 case 2: OS << ".p2alignw "; break;
658 case 4: OS << ".p2alignl "; break;
659 case 8: llvm_unreachable("Unsupported alignment size!");
662 if (MAI.getAlignmentIsInBytes())
665 OS << Log2_32(ByteAlignment);
667 if (Value || MaxBytesToEmit) {
669 OS.write_hex(truncateToSize(Value, ValueSize));
672 OS << ", " << MaxBytesToEmit;
678 // Non-power of two alignment. This is not widely supported by assemblers.
679 // FIXME: Parameterize this based on MAI.
681 default: llvm_unreachable("Invalid size for machine code value!");
682 case 1: OS << ".balign"; break;
683 case 2: OS << ".balignw"; break;
684 case 4: OS << ".balignl"; break;
685 case 8: llvm_unreachable("Unsupported alignment size!");
688 OS << ' ' << ByteAlignment;
689 OS << ", " << truncateToSize(Value, ValueSize);
691 OS << ", " << MaxBytesToEmit;
695 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
696 unsigned MaxBytesToEmit) {
697 // Emit with a text fill value.
698 EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
702 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
703 unsigned char Value) {
704 // FIXME: Verify that Offset is associated with the current section.
705 OS << ".org " << *Offset << ", " << (unsigned) Value;
710 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
711 assert(MAI.hasSingleParameterDotFile());
713 PrintQuotedString(Filename, OS);
717 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
719 OS << "\t.file\t" << FileNo << ' ';
720 PrintQuotedString(Filename, OS);
723 return this->MCStreamer::EmitDwarfFileDirective(FileNo, Filename);
726 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
727 unsigned Column, unsigned Flags,
729 unsigned Discriminator,
730 StringRef FileName) {
731 this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
732 Isa, Discriminator, FileName);
736 OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
737 if (Flags & DWARF2_FLAG_BASIC_BLOCK)
738 OS << " basic_block";
739 if (Flags & DWARF2_FLAG_PROLOGUE_END)
740 OS << " prologue_end";
741 if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
742 OS << " epilogue_begin";
744 unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
745 if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
748 if (Flags & DWARF2_FLAG_IS_STMT)
757 OS << "discriminator " << Discriminator;
760 OS.PadToColumn(MAI.getCommentColumn());
761 OS << MAI.getCommentString() << ' ' << FileName << ':'
762 << Line << ':' << Column;
767 void MCAsmStreamer::EmitCFIStartProc() {
768 MCStreamer::EmitCFIStartProc();
773 OS << "\t.cfi_startproc";
777 void MCAsmStreamer::EmitCFIEndProc() {
778 MCStreamer::EmitCFIEndProc();
783 OS << "\t.cfi_endproc";
787 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
788 MCStreamer::EmitCFIDefCfa(Register, Offset);
793 OS << ".cfi_def_cfa " << Register << ", " << Offset;
797 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
798 MCStreamer::EmitCFIDefCfaOffset(Offset);
803 OS << "\t.cfi_def_cfa_offset " << Offset;
807 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
808 MCStreamer::EmitCFIDefCfaRegister(Register);
813 OS << "\t.cfi_def_cfa_register " << Register;
817 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
818 this->MCStreamer::EmitCFIOffset(Register, Offset);
823 OS << "\t.cfi_offset " << Register << ", " << Offset;
827 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
829 MCStreamer::EmitCFIPersonality(Sym, Encoding);
834 OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
838 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
839 MCStreamer::EmitCFILsda(Sym, Encoding);
844 OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
848 void MCAsmStreamer::EmitCFIRememberState() {
849 MCStreamer::EmitCFIRememberState();
854 OS << "\t.cfi_remember_state";
858 void MCAsmStreamer::EmitCFIRestoreState() {
859 MCStreamer::EmitCFIRestoreState();
864 OS << "\t.cfi_restore_state";
868 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
869 MCStreamer::EmitCFISameValue(Register);
874 OS << "\t.cfi_same_value " << Register;
878 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
879 MCStreamer::EmitCFIRelOffset(Register, Offset);
884 OS << "\t.cfi_rel_offset " << Register << ", " << Offset;
888 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
889 MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
894 OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
898 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
899 raw_ostream &OS = GetCommentOS();
900 SmallString<256> Code;
901 SmallVector<MCFixup, 4> Fixups;
902 raw_svector_ostream VecOS(Code);
903 Emitter->EncodeInstruction(Inst, VecOS, Fixups);
906 // If we are showing fixups, create symbolic markers in the encoded
907 // representation. We do this by making a per-bit map to the fixup item index,
908 // then trying to display it as nicely as possible.
909 SmallVector<uint8_t, 64> FixupMap;
910 FixupMap.resize(Code.size() * 8);
911 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
914 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
915 MCFixup &F = Fixups[i];
916 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
917 for (unsigned j = 0; j != Info.TargetSize; ++j) {
918 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
919 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
920 FixupMap[Index] = 1 + i;
924 // FIXME: Node the fixup comments for Thumb2 are completely bogus since the
925 // high order halfword of a 32-bit Thumb2 instruction is emitted first.
927 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
931 // See if all bits are the same map entry.
932 uint8_t MapEntry = FixupMap[i * 8 + 0];
933 for (unsigned j = 1; j != 8; ++j) {
934 if (FixupMap[i * 8 + j] == MapEntry)
937 MapEntry = uint8_t(~0U);
941 if (MapEntry != uint8_t(~0U)) {
943 OS << format("0x%02x", uint8_t(Code[i]));
946 // FIXME: Some of the 8 bits require fix up.
947 OS << format("0x%02x", uint8_t(Code[i])) << '\''
948 << char('A' + MapEntry - 1) << '\'';
950 OS << char('A' + MapEntry - 1);
953 // Otherwise, write out in binary.
955 for (unsigned j = 8; j--;) {
956 unsigned Bit = (Code[i] >> j) & 1;
959 if (getContext().getTargetAsmInfo().isLittleEndian())
960 FixupBit = i * 8 + j;
962 FixupBit = i * 8 + (7-j);
964 if (uint8_t MapEntry = FixupMap[FixupBit]) {
965 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
966 OS << char('A' + MapEntry - 1);
974 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
975 MCFixup &F = Fixups[i];
976 const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
977 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
978 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
982 void MCAsmStreamer::EmitFnStart() {
987 void MCAsmStreamer::EmitFnEnd() {
992 void MCAsmStreamer::EmitCantUnwind() {
993 OS << "\t.cantunwind";
997 void MCAsmStreamer::EmitHandlerData() {
998 OS << "\t.handlerdata";
1002 void MCAsmStreamer::EmitPersonality(const MCSymbol *Personality) {
1003 OS << "\t.personality " << Personality->getName();
1007 void MCAsmStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
1008 OS << "\t.setfp\t" << InstPrinter->getRegName(FpReg)
1009 << ", " << InstPrinter->getRegName(SpReg);
1011 OS << ", #" << Offset;
1015 void MCAsmStreamer::EmitPad(int64_t Offset) {
1016 OS << "\t.pad\t#" << Offset;
1020 void MCAsmStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
1022 assert(RegList.size() && "RegList should not be empty");
1024 OS << "\t.vsave\t{";
1028 OS << InstPrinter->getRegName(RegList[0]);
1030 for (unsigned i = 1, e = RegList.size(); i != e; ++i)
1031 OS << ", " << InstPrinter->getRegName(RegList[i]);
1037 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
1038 assert(getCurrentSection() && "Cannot emit contents before setting section!");
1040 // Show the encoding in a comment if we have a code emitter.
1042 AddEncodingComment(Inst);
1044 // Show the MCInst if enabled.
1046 Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
1047 GetCommentOS() << "\n";
1050 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1052 InstPrinter->printInst(&Inst, OS);
1054 Inst.print(OS, &MAI);
1058 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1059 /// the specified string in the output .s file. This capability is
1060 /// indicated by the hasRawTextSupport() predicate.
1061 void MCAsmStreamer::EmitRawText(StringRef String) {
1062 if (!String.empty() && String.back() == '\n')
1063 String = String.substr(0, String.size()-1);
1068 void MCAsmStreamer::Finish() {
1069 // Dump out the dwarf file & directory tables and line tables.
1070 if (getContext().hasDwarfFiles() && !UseLoc)
1071 MCDwarfFileTable::Emit(this);
1074 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1075 formatted_raw_ostream &OS,
1076 bool isVerboseAsm, bool useLoc,
1078 MCInstPrinter *IP, MCCodeEmitter *CE,
1079 TargetAsmBackend *TAB, bool ShowInst) {
1080 return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc, useCFI,
1081 IP, CE, TAB, ShowInst);