blob: 1d231bbffa0ef89eac2952da797f5b599020a944 [file] [log] [blame]
Daniel Dunbara11af532009-06-24 01:03:06 +00001//===- lib/MC/MCAsmStreamer.cpp - Text Assembly Output --------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "llvm/MC/MCStreamer.h"
Daniel Dunbar8c2eebe2009-08-31 08:08:38 +000011#include "llvm/MC/MCAsmInfo.h"
Daniel Dunbar4a0abd82009-08-27 00:51:57 +000012#include "llvm/MC/MCCodeEmitter.h"
Daniel Dunbara11af532009-06-24 01:03:06 +000013#include "llvm/MC/MCContext.h"
Daniel Dunbar8c2eebe2009-08-31 08:08:38 +000014#include "llvm/MC/MCExpr.h"
Daniel Dunbarabde2982009-07-01 06:35:03 +000015#include "llvm/MC/MCInst.h"
Chris Lattner90edac02009-09-14 03:02:37 +000016#include "llvm/MC/MCInstPrinter.h"
Chris Lattnerf9bdedd2009-08-10 18:15:01 +000017#include "llvm/MC/MCSectionMachO.h"
Daniel Dunbara11af532009-06-24 01:03:06 +000018#include "llvm/MC/MCSymbol.h"
Chris Lattner4c42a6d2010-03-19 05:48:53 +000019#include "llvm/ADT/OwningPtr.h"
Chris Lattner86e22112010-01-22 07:29:22 +000020#include "llvm/ADT/SmallString.h"
21#include "llvm/ADT/Twine.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000022#include "llvm/Support/ErrorHandling.h"
Chris Lattner663c2d22009-08-19 06:12:02 +000023#include "llvm/Support/MathExtras.h"
Daniel Dunbar4a0abd82009-08-27 00:51:57 +000024#include "llvm/Support/Format.h"
Chris Lattner86e22112010-01-22 07:29:22 +000025#include "llvm/Support/FormattedStream.h"
Daniel Dunbara11af532009-06-24 01:03:06 +000026using namespace llvm;
27
28namespace {
29
Chris Lattner46a947d2009-08-17 04:17:34 +000030class MCAsmStreamer : public MCStreamer {
Chris Lattner86e22112010-01-22 07:29:22 +000031 formatted_raw_ostream &OS;
Chris Lattner33adcfb2009-08-22 21:43:10 +000032 const MCAsmInfo &MAI;
Chris Lattner4c42a6d2010-03-19 05:48:53 +000033 OwningPtr<MCInstPrinter> InstPrinter;
Daniel Dunbar4a0abd82009-08-27 00:51:57 +000034 MCCodeEmitter *Emitter;
Chris Lattner86e22112010-01-22 07:29:22 +000035
36 SmallString<128> CommentToEmit;
Chris Lattnerd79d9dc2010-01-22 19:17:48 +000037 raw_svector_ostream CommentStream;
Daniel Dunbar9dee8e32010-02-03 18:18:30 +000038
39 unsigned IsLittleEndian : 1;
40 unsigned IsVerboseAsm : 1;
41 unsigned ShowInst : 1;
42
Chris Lattner46a947d2009-08-17 04:17:34 +000043public:
Chris Lattner86e22112010-01-22 07:29:22 +000044 MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
Chris Lattner07404412010-01-22 07:06:15 +000045 bool isLittleEndian, bool isVerboseAsm, MCInstPrinter *printer,
Daniel Dunbar5532cf42010-02-10 01:41:14 +000046 MCCodeEmitter *emitter, bool showInst)
Chris Lattnerfdab14b2010-03-12 18:28:53 +000047 : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
48 InstPrinter(printer), Emitter(emitter), CommentStream(CommentToEmit),
Daniel Dunbar9dee8e32010-02-03 18:18:30 +000049 IsLittleEndian(isLittleEndian), IsVerboseAsm(isVerboseAsm),
Daniel Dunbar5532cf42010-02-10 01:41:14 +000050 ShowInst(showInst) {
Chris Lattner5d672cf2010-02-10 00:10:18 +000051 if (InstPrinter && IsVerboseAsm)
52 InstPrinter->setCommentStream(CommentStream);
53 }
Chris Lattner46a947d2009-08-17 04:17:34 +000054 ~MCAsmStreamer() {}
Daniel Dunbara11af532009-06-24 01:03:06 +000055
Chris Lattner16582022010-01-20 06:39:07 +000056 bool isLittleEndian() const { return IsLittleEndian; }
Daniel Dunbar6b716532010-02-09 23:00:14 +000057
Chris Lattner86e22112010-01-22 07:29:22 +000058 inline void EmitEOL() {
Chris Lattnerd79d9dc2010-01-22 19:17:48 +000059 // If we don't have any comments, just emit a \n.
60 if (!IsVerboseAsm) {
Chris Lattner86e22112010-01-22 07:29:22 +000061 OS << '\n';
62 return;
63 }
64 EmitCommentsAndEOL();
65 }
66 void EmitCommentsAndEOL();
Chris Lattner56591ab2010-02-02 23:37:42 +000067
68 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
69 /// all.
70 virtual bool isVerboseAsm() const { return IsVerboseAsm; }
Chris Lattner91bead72010-04-03 21:35:55 +000071
72 /// hasRawTextSupport - We support EmitRawText.
73 virtual bool hasRawTextSupport() const { return true; }
Daniel Dunbar6b716532010-02-09 23:00:14 +000074
Chris Lattnerd32c7cf2010-01-22 18:21:35 +000075 /// AddComment - Add a comment that can be emitted to the generated .s
Chris Lattner86e22112010-01-22 07:29:22 +000076 /// file if applicable as a QoI issue to make the output of the compiler
77 /// more readable. This only affects the MCAsmStreamer, and only when
78 /// verbose assembly output is enabled.
Chris Lattnerd32c7cf2010-01-22 18:21:35 +000079 virtual void AddComment(const Twine &T);
Daniel Dunbar6b716532010-02-09 23:00:14 +000080
81 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
82 virtual void AddEncodingComment(const MCInst &Inst);
83
Chris Lattnerd79d9dc2010-01-22 19:17:48 +000084 /// GetCommentOS - Return a raw_ostream that comments can be written to.
85 /// Unlike AddComment, you are required to terminate comments with \n if you
86 /// use this method.
87 virtual raw_ostream &GetCommentOS() {
88 if (!IsVerboseAsm)
89 return nulls(); // Discard comments unless in verbose asm mode.
90 return CommentStream;
91 }
Daniel Dunbar6b716532010-02-09 23:00:14 +000092
Chris Lattner0fd90fd2010-01-22 19:52:01 +000093 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
94 virtual void AddBlankLine() {
95 EmitEOL();
96 }
Daniel Dunbar6b716532010-02-09 23:00:14 +000097
Chris Lattner46a947d2009-08-17 04:17:34 +000098 /// @name MCStreamer Interface
99 /// @{
Daniel Dunbara11af532009-06-24 01:03:06 +0000100
Chris Lattner975780b2009-08-17 05:49:08 +0000101 virtual void SwitchSection(const MCSection *Section);
Daniel Dunbara11af532009-06-24 01:03:06 +0000102
Chris Lattner46a947d2009-08-17 04:17:34 +0000103 virtual void EmitLabel(MCSymbol *Symbol);
Daniel Dunbara11af532009-06-24 01:03:06 +0000104
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000105 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
Daniel Dunbara11af532009-06-24 01:03:06 +0000106
Daniel Dunbar821e3332009-08-31 08:09:28 +0000107 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
Daniel Dunbara11af532009-06-24 01:03:06 +0000108
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000109 virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
Kevin Enderbya5c78322009-07-13 21:03:15 +0000110
Chris Lattner46a947d2009-08-17 04:17:34 +0000111 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
Daniel Dunbara11af532009-06-24 01:03:06 +0000112
Chris Lattner99328ad2010-01-25 07:52:13 +0000113 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
Chris Lattner9eb158d2010-01-23 07:47:02 +0000114 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000115 unsigned ByteAlignment);
Kevin Enderby95cf30c2009-07-14 18:17:10 +0000116
Chris Lattner9eb158d2010-01-23 07:47:02 +0000117 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
118 ///
119 /// @param Symbol - The common symbol to emit.
120 /// @param Size - The size of the common symbol.
121 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
122
Daniel Dunbar8751b942009-08-28 05:48:22 +0000123 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000124 unsigned Size = 0, unsigned ByteAlignment = 0);
Kevin Enderby71148242009-07-14 21:35:03 +0000125
Chris Lattneraaec2052010-01-19 19:46:13 +0000126 virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
Chris Lattner4e4db7a2009-07-07 20:30:46 +0000127
Chris Lattneraaec2052010-01-19 19:46:13 +0000128 virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace);
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000129 virtual void EmitIntValue(uint64_t Value, unsigned Size, unsigned AddrSpace);
Chris Lattner718fb592010-01-25 21:28:50 +0000130 virtual void EmitGPRel32Value(const MCExpr *Value);
131
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000132
Chris Lattneraaec2052010-01-19 19:46:13 +0000133 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
134 unsigned AddrSpace);
Chris Lattner9be3fee2009-07-10 22:20:30 +0000135
Chris Lattner46a947d2009-08-17 04:17:34 +0000136 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
137 unsigned ValueSize = 1,
138 unsigned MaxBytesToEmit = 0);
Daniel Dunbara11af532009-06-24 01:03:06 +0000139
Kevin Enderby6e720482010-02-23 18:26:34 +0000140 virtual void EmitCodeAlignment(unsigned ByteAlignment,
141 unsigned MaxBytesToEmit = 0);
142
Daniel Dunbar821e3332009-08-31 08:09:28 +0000143 virtual void EmitValueToOffset(const MCExpr *Offset,
Chris Lattner46a947d2009-08-17 04:17:34 +0000144 unsigned char Value = 0);
Daniel Dunbara11af532009-06-24 01:03:06 +0000145
Chris Lattnera6594fc2010-01-25 18:58:59 +0000146 virtual void EmitFileDirective(StringRef Filename);
147 virtual void EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
148
149 virtual void EmitInstruction(const MCInst &Inst);
150
Chris Lattner91bead72010-04-03 21:35:55 +0000151 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
152 /// the specified string in the output .s file. This capability is
153 /// indicated by the hasRawTextSupport() predicate.
154 virtual void EmitRawText(StringRef String);
155
Chris Lattner46a947d2009-08-17 04:17:34 +0000156 virtual void Finish();
157
158 /// @}
159};
Daniel Dunbar84a29262009-06-24 19:25:34 +0000160
Chris Lattner46a947d2009-08-17 04:17:34 +0000161} // end anonymous namespace.
Daniel Dunbara11af532009-06-24 01:03:06 +0000162
Chris Lattnerd32c7cf2010-01-22 18:21:35 +0000163/// AddComment - Add a comment that can be emitted to the generated .s
Chris Lattner86e22112010-01-22 07:29:22 +0000164/// file if applicable as a QoI issue to make the output of the compiler
165/// more readable. This only affects the MCAsmStreamer, and only when
166/// verbose assembly output is enabled.
Chris Lattnerd32c7cf2010-01-22 18:21:35 +0000167void MCAsmStreamer::AddComment(const Twine &T) {
Chris Lattner86e22112010-01-22 07:29:22 +0000168 if (!IsVerboseAsm) return;
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000169
170 // Make sure that CommentStream is flushed.
171 CommentStream.flush();
172
Chris Lattner86e22112010-01-22 07:29:22 +0000173 T.toVector(CommentToEmit);
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000174 // Each comment goes on its own line.
175 CommentToEmit.push_back('\n');
Chris Lattner14ca1772010-01-22 21:16:10 +0000176
177 // Tell the comment stream that the vector changed underneath it.
178 CommentStream.resync();
Chris Lattner86e22112010-01-22 07:29:22 +0000179}
180
181void MCAsmStreamer::EmitCommentsAndEOL() {
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000182 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
183 OS << '\n';
184 return;
185 }
186
187 CommentStream.flush();
Chris Lattner86e22112010-01-22 07:29:22 +0000188 StringRef Comments = CommentToEmit.str();
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000189
190 assert(Comments.back() == '\n' &&
191 "Comment array not newline terminated");
192 do {
Chris Lattner86e22112010-01-22 07:29:22 +0000193 // Emit a line of comments.
194 OS.PadToColumn(MAI.getCommentColumn());
195 size_t Position = Comments.find('\n');
196 OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
197
Chris Lattner86e22112010-01-22 07:29:22 +0000198 Comments = Comments.substr(Position+1);
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000199 } while (!Comments.empty());
Chris Lattner86e22112010-01-22 07:29:22 +0000200
Chris Lattner14ca1772010-01-22 21:16:10 +0000201 CommentToEmit.clear();
202 // Tell the comment stream that the vector changed underneath it.
203 CommentStream.resync();
Chris Lattner86e22112010-01-22 07:29:22 +0000204}
205
Daniel Dunbar304f6a42009-06-25 21:03:18 +0000206static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
207 assert(Bytes && "Invalid size!");
208 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
209}
210
Chris Lattner975780b2009-08-17 05:49:08 +0000211void MCAsmStreamer::SwitchSection(const MCSection *Section) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000212 assert(Section && "Cannot switch to a null section!");
Daniel Dunbara11af532009-06-24 01:03:06 +0000213 if (Section != CurSection) {
214 CurSection = Section;
Chris Lattner33adcfb2009-08-22 21:43:10 +0000215 Section->PrintSwitchToSection(MAI, OS);
Daniel Dunbara11af532009-06-24 01:03:06 +0000216 }
217}
218
219void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
Daniel Dunbar8906ff12009-08-22 07:22:36 +0000220 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
Daniel Dunbarc3047182010-05-05 19:01:00 +0000221 assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000222 assert(CurSection && "Cannot emit before setting section!");
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000223
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000224 OS << *Symbol << ":";
225 EmitEOL();
Daniel Dunbar8906ff12009-08-22 07:22:36 +0000226 Symbol->setSection(*CurSection);
Daniel Dunbara11af532009-06-24 01:03:06 +0000227}
228
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000229void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
Kevin Enderbyf96db462009-07-16 17:56:39 +0000230 switch (Flag) {
Daniel Dunbar011e4db2009-08-13 23:36:34 +0000231 default: assert(0 && "Invalid flag!");
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000232 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
Kevin Enderbyf96db462009-07-16 17:56:39 +0000233 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000234 EmitEOL();
Kevin Enderbya5c78322009-07-13 21:03:15 +0000235}
236
Daniel Dunbar821e3332009-08-31 08:09:28 +0000237void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000238 OS << *Symbol << " = " << *Value;
239 EmitEOL();
Daniel Dunbarfffff912009-10-16 01:34:54 +0000240
241 // FIXME: Lift context changes into super class.
Daniel Dunbar75773ff2009-10-16 01:57:39 +0000242 // FIXME: Set associated section.
Daniel Dunbar08a408a2010-05-05 17:41:00 +0000243 Symbol->setVariableValue(Value);
Daniel Dunbara11af532009-06-24 01:03:06 +0000244}
245
Daniel Dunbarfffff912009-10-16 01:34:54 +0000246void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000247 MCSymbolAttr Attribute) {
Daniel Dunbara11af532009-06-24 01:03:06 +0000248 switch (Attribute) {
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000249 case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
Chris Lattnered0ab152010-01-25 18:30:45 +0000250 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
251 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
252 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
253 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
254 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
255 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
256 assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
Dan Gohman523d70e2010-02-04 01:42:13 +0000257 OS << "\t.type\t" << *Symbol << ','
Chris Lattnered0ab152010-01-25 18:30:45 +0000258 << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
259 switch (Attribute) {
260 default: assert(0 && "Unknown ELF .type");
261 case MCSA_ELF_TypeFunction: OS << "function"; break;
262 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
263 case MCSA_ELF_TypeObject: OS << "object"; break;
264 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
265 case MCSA_ELF_TypeCommon: OS << "common"; break;
266 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
267 }
268 EmitEOL();
269 return;
270 case MCSA_Global: // .globl/.global
271 OS << MAI.getGlobalDirective();
272 break;
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000273 case MCSA_Hidden: OS << ".hidden "; break;
274 case MCSA_IndirectSymbol: OS << ".indirect_symbol "; break;
275 case MCSA_Internal: OS << ".internal "; break;
276 case MCSA_LazyReference: OS << ".lazy_reference "; break;
277 case MCSA_Local: OS << ".local "; break;
278 case MCSA_NoDeadStrip: OS << ".no_dead_strip "; break;
279 case MCSA_PrivateExtern: OS << ".private_extern "; break;
280 case MCSA_Protected: OS << ".protected "; break;
281 case MCSA_Reference: OS << ".reference "; break;
282 case MCSA_Weak: OS << ".weak "; break;
283 case MCSA_WeakDefinition: OS << ".weak_definition "; break;
284 // .weak_reference
285 case MCSA_WeakReference: OS << MAI.getWeakRefDirective(); break;
Daniel Dunbara11af532009-06-24 01:03:06 +0000286 }
287
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000288 OS << *Symbol;
289 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000290}
291
Kevin Enderby95cf30c2009-07-14 18:17:10 +0000292void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000293 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
294 EmitEOL();
Kevin Enderby95cf30c2009-07-14 18:17:10 +0000295}
296
Chris Lattner99328ad2010-01-25 07:52:13 +0000297void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
298 assert(MAI.hasDotTypeDotSizeDirective());
299 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
300}
301
Chris Lattner9eb158d2010-01-23 07:47:02 +0000302void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000303 unsigned ByteAlignment) {
Chris Lattner9eb158d2010-01-23 07:47:02 +0000304 OS << "\t.comm\t" << *Symbol << ',' << Size;
Chris Lattner6559d762010-01-25 07:29:13 +0000305 if (ByteAlignment != 0) {
Rafael Espindola2e2563b2010-01-26 20:21:43 +0000306 if (MAI.getCOMMDirectiveAlignmentIsInBytes())
Chris Lattner4ed54382010-01-19 06:01:04 +0000307 OS << ',' << ByteAlignment;
308 else
309 OS << ',' << Log2_32(ByteAlignment);
310 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000311 EmitEOL();
Chris Lattner4e4db7a2009-07-07 20:30:46 +0000312}
313
Chris Lattner9eb158d2010-01-23 07:47:02 +0000314/// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
315///
316/// @param Symbol - The common symbol to emit.
317/// @param Size - The size of the common symbol.
318void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
319 assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
320 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
321 EmitEOL();
322}
323
Daniel Dunbar8751b942009-08-28 05:48:22 +0000324void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000325 unsigned Size, unsigned ByteAlignment) {
Daniel Dunbar011e4db2009-08-13 23:36:34 +0000326 // Note: a .zerofill directive does not switch sections.
Chris Lattner93b6db32009-08-08 23:39:42 +0000327 OS << ".zerofill ";
328
329 // This is a mach-o specific directive.
Chris Lattnerff4bc462009-08-10 01:39:42 +0000330 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
Daniel Dunbar12de0df2009-08-14 18:51:45 +0000331 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
Chris Lattner93b6db32009-08-08 23:39:42 +0000332
Chris Lattner9be3fee2009-07-10 22:20:30 +0000333 if (Symbol != NULL) {
Chris Lattner10b318b2010-01-17 21:43:43 +0000334 OS << ',' << *Symbol << ',' << Size;
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000335 if (ByteAlignment != 0)
336 OS << ',' << Log2_32(ByteAlignment);
Chris Lattner9be3fee2009-07-10 22:20:30 +0000337 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000338 EmitEOL();
Chris Lattner9be3fee2009-07-10 22:20:30 +0000339}
340
Chris Lattner12e555c2010-01-23 00:15:00 +0000341static inline char toOctal(int X) { return (X&7)+'0'; }
342
Chris Lattnera6594fc2010-01-25 18:58:59 +0000343static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
344 OS << '"';
345
346 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
347 unsigned char C = Data[i];
348 if (C == '"' || C == '\\') {
349 OS << '\\' << (char)C;
350 continue;
351 }
352
353 if (isprint((unsigned char)C)) {
354 OS << (char)C;
355 continue;
356 }
357
358 switch (C) {
359 case '\b': OS << "\\b"; break;
360 case '\f': OS << "\\f"; break;
361 case '\n': OS << "\\n"; break;
362 case '\r': OS << "\\r"; break;
363 case '\t': OS << "\\t"; break;
364 default:
365 OS << '\\';
366 OS << toOctal(C >> 6);
367 OS << toOctal(C >> 3);
368 OS << toOctal(C >> 0);
369 break;
370 }
371 }
372
373 OS << '"';
374}
375
376
Chris Lattneraaec2052010-01-19 19:46:13 +0000377void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000378 assert(CurSection && "Cannot emit contents before setting section!");
Chris Lattner12e555c2010-01-23 00:15:00 +0000379 if (Data.empty()) return;
380
381 if (Data.size() == 1) {
382 OS << MAI.getData8bitsDirective(AddrSpace);
383 OS << (unsigned)(unsigned char)Data[0];
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000384 EmitEOL();
Chris Lattner12e555c2010-01-23 00:15:00 +0000385 return;
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000386 }
Chris Lattner12e555c2010-01-23 00:15:00 +0000387
388 // If the data ends with 0 and the target supports .asciz, use it, otherwise
389 // use .ascii
390 if (MAI.getAscizDirective() && Data.back() == 0) {
391 OS << MAI.getAscizDirective();
392 Data = Data.substr(0, Data.size()-1);
393 } else {
394 OS << MAI.getAsciiDirective();
395 }
396
Chris Lattnera6594fc2010-01-25 18:58:59 +0000397 OS << ' ';
398 PrintQuotedString(Data, OS);
Chris Lattner12e555c2010-01-23 00:15:00 +0000399 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000400}
401
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000402/// EmitIntValue - Special case of EmitValue that avoids the client having
403/// to pass in a MCExpr for constant integers.
404void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
405 unsigned AddrSpace) {
406 assert(CurSection && "Cannot emit contents before setting section!");
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000407 const char *Directive = 0;
408 switch (Size) {
409 default: break;
410 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
411 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
412 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
Chris Lattner5eaa54e2010-01-20 06:45:39 +0000413 case 8:
414 Directive = MAI.getData64bitsDirective(AddrSpace);
415 // If the target doesn't support 64-bit data, emit as two 32-bit halves.
416 if (Directive) break;
417 if (isLittleEndian()) {
418 EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
419 EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
420 } else {
421 EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
422 EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
423 }
424 return;
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000425 }
426
427 assert(Directive && "Invalid size for machine code value!");
Chris Lattner86e22112010-01-22 07:29:22 +0000428 OS << Directive << truncateToSize(Value, Size);
429 EmitEOL();
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000430}
431
Chris Lattneraaec2052010-01-19 19:46:13 +0000432void MCAsmStreamer::EmitValue(const MCExpr *Value, unsigned Size,
433 unsigned AddrSpace) {
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000434 assert(CurSection && "Cannot emit contents before setting section!");
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000435 const char *Directive = 0;
Daniel Dunbara11af532009-06-24 01:03:06 +0000436 switch (Size) {
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000437 default: break;
438 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
439 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
440 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
441 case 8: Directive = MAI.getData64bitsDirective(AddrSpace); break;
Daniel Dunbara11af532009-06-24 01:03:06 +0000442 }
Chris Lattneraaec2052010-01-19 19:46:13 +0000443
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000444 assert(Directive && "Invalid size for machine code value!");
Chris Lattner718fb592010-01-25 21:28:50 +0000445 OS << Directive << *Value;
Chris Lattner86e22112010-01-22 07:29:22 +0000446 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000447}
448
Chris Lattner718fb592010-01-25 21:28:50 +0000449void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
450 assert(MAI.getGPRel32Directive() != 0);
451 OS << MAI.getGPRel32Directive() << *Value;
452 EmitEOL();
453}
454
455
Chris Lattner6113b3d2010-01-19 18:52:28 +0000456/// EmitFill - Emit NumBytes bytes worth of the value specified by
457/// FillValue. This implements directives such as '.space'.
Chris Lattneraaec2052010-01-19 19:46:13 +0000458void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
459 unsigned AddrSpace) {
Chris Lattner8a6d7ac2010-01-19 18:58:52 +0000460 if (NumBytes == 0) return;
461
Chris Lattneraaec2052010-01-19 19:46:13 +0000462 if (AddrSpace == 0)
463 if (const char *ZeroDirective = MAI.getZeroDirective()) {
464 OS << ZeroDirective << NumBytes;
465 if (FillValue != 0)
466 OS << ',' << (int)FillValue;
Chris Lattner86e22112010-01-22 07:29:22 +0000467 EmitEOL();
Chris Lattneraaec2052010-01-19 19:46:13 +0000468 return;
469 }
470
471 // Emit a byte at a time.
472 MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
Chris Lattner6113b3d2010-01-19 18:52:28 +0000473}
474
Daniel Dunbar84a29262009-06-24 19:25:34 +0000475void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
476 unsigned ValueSize,
477 unsigned MaxBytesToEmit) {
Chris Lattner663c2d22009-08-19 06:12:02 +0000478 // Some assemblers don't support non-power of two alignments, so we always
479 // emit alignments as a power of two if possible.
480 if (isPowerOf2_32(ByteAlignment)) {
Chris Lattner6e579c62009-08-19 06:35:36 +0000481 switch (ValueSize) {
482 default: llvm_unreachable("Invalid size for machine code value!");
Chris Lattner33adcfb2009-08-22 21:43:10 +0000483 case 1: OS << MAI.getAlignDirective(); break;
484 // FIXME: use MAI for this!
Chris Lattner6e579c62009-08-19 06:35:36 +0000485 case 2: OS << ".p2alignw "; break;
486 case 4: OS << ".p2alignl "; break;
487 case 8: llvm_unreachable("Unsupported alignment size!");
488 }
Chris Lattner663c2d22009-08-19 06:12:02 +0000489
Chris Lattner33adcfb2009-08-22 21:43:10 +0000490 if (MAI.getAlignmentIsInBytes())
Chris Lattner663c2d22009-08-19 06:12:02 +0000491 OS << ByteAlignment;
492 else
493 OS << Log2_32(ByteAlignment);
Daniel Dunbar84a29262009-06-24 19:25:34 +0000494
Chris Lattner663c2d22009-08-19 06:12:02 +0000495 if (Value || MaxBytesToEmit) {
Chris Lattner579531c2009-09-03 04:01:10 +0000496 OS << ", 0x";
497 OS.write_hex(truncateToSize(Value, ValueSize));
Chris Lattner663c2d22009-08-19 06:12:02 +0000498
499 if (MaxBytesToEmit)
500 OS << ", " << MaxBytesToEmit;
501 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000502 EmitEOL();
Chris Lattner663c2d22009-08-19 06:12:02 +0000503 return;
504 }
505
506 // Non-power of two alignment. This is not widely supported by assemblers.
Chris Lattner33adcfb2009-08-22 21:43:10 +0000507 // FIXME: Parameterize this based on MAI.
Daniel Dunbar84a29262009-06-24 19:25:34 +0000508 switch (ValueSize) {
Chris Lattner663c2d22009-08-19 06:12:02 +0000509 default: llvm_unreachable("Invalid size for machine code value!");
510 case 1: OS << ".balign"; break;
511 case 2: OS << ".balignw"; break;
512 case 4: OS << ".balignl"; break;
513 case 8: llvm_unreachable("Unsupported alignment size!");
Daniel Dunbar84a29262009-06-24 19:25:34 +0000514 }
515
Chris Lattner663c2d22009-08-19 06:12:02 +0000516 OS << ' ' << ByteAlignment;
Daniel Dunbar304f6a42009-06-25 21:03:18 +0000517 OS << ", " << truncateToSize(Value, ValueSize);
Daniel Dunbar84a29262009-06-24 19:25:34 +0000518 if (MaxBytesToEmit)
519 OS << ", " << MaxBytesToEmit;
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000520 EmitEOL();
Daniel Dunbar84a29262009-06-24 19:25:34 +0000521}
522
Kevin Enderby6e720482010-02-23 18:26:34 +0000523void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
524 unsigned MaxBytesToEmit) {
Chris Lattnerec167fd2010-02-23 18:44:31 +0000525 // Emit with a text fill value.
526 EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
527 1, MaxBytesToEmit);
Kevin Enderby6e720482010-02-23 18:26:34 +0000528}
529
Daniel Dunbar821e3332009-08-31 08:09:28 +0000530void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
Daniel Dunbar84a29262009-06-24 19:25:34 +0000531 unsigned char Value) {
532 // FIXME: Verify that Offset is associated with the current section.
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000533 OS << ".org " << *Offset << ", " << (unsigned) Value;
534 EmitEOL();
Daniel Dunbar84a29262009-06-24 19:25:34 +0000535}
536
Chris Lattnera6594fc2010-01-25 18:58:59 +0000537
538void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
539 assert(MAI.hasSingleParameterDotFile());
540 OS << "\t.file\t";
541 PrintQuotedString(Filename, OS);
542 EmitEOL();
543}
544
545void MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
546 OS << "\t.file\t" << FileNo << ' ';
547 PrintQuotedString(Filename, OS);
548 EmitEOL();
549}
550
Daniel Dunbar6b716532010-02-09 23:00:14 +0000551void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
552 raw_ostream &OS = GetCommentOS();
553 SmallString<256> Code;
554 SmallVector<MCFixup, 4> Fixups;
555 raw_svector_ostream VecOS(Code);
556 Emitter->EncodeInstruction(Inst, VecOS, Fixups);
557 VecOS.flush();
Chris Lattnera6594fc2010-01-25 18:58:59 +0000558
Daniel Dunbar6b716532010-02-09 23:00:14 +0000559 // If we are showing fixups, create symbolic markers in the encoded
560 // representation. We do this by making a per-bit map to the fixup item index,
561 // then trying to display it as nicely as possible.
Daniel Dunbar5532cf42010-02-10 01:41:14 +0000562 SmallVector<uint8_t, 64> FixupMap;
563 FixupMap.resize(Code.size() * 8);
Daniel Dunbar6b716532010-02-09 23:00:14 +0000564 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
565 FixupMap[i] = 0;
566
567 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
568 MCFixup &F = Fixups[i];
Chris Lattner8d31de62010-02-11 21:27:18 +0000569 const MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
Daniel Dunbar6b716532010-02-09 23:00:14 +0000570 for (unsigned j = 0; j != Info.TargetSize; ++j) {
571 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
572 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
573 FixupMap[Index] = 1 + i;
574 }
575 }
576
577 OS << "encoding: [";
578 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
579 if (i)
580 OS << ',';
581
582 // See if all bits are the same map entry.
583 uint8_t MapEntry = FixupMap[i * 8 + 0];
584 for (unsigned j = 1; j != 8; ++j) {
585 if (FixupMap[i * 8 + j] == MapEntry)
586 continue;
587
588 MapEntry = uint8_t(~0U);
589 break;
590 }
591
592 if (MapEntry != uint8_t(~0U)) {
593 if (MapEntry == 0) {
594 OS << format("0x%02x", uint8_t(Code[i]));
595 } else {
596 assert(Code[i] == 0 && "Encoder wrote into fixed up bit!");
597 OS << char('A' + MapEntry - 1);
598 }
599 } else {
600 // Otherwise, write out in binary.
601 OS << "0b";
602 for (unsigned j = 8; j--;) {
603 unsigned Bit = (Code[i] >> j) & 1;
604 if (uint8_t MapEntry = FixupMap[i * 8 + j]) {
605 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
606 OS << char('A' + MapEntry - 1);
607 } else
608 OS << Bit;
609 }
610 }
611 }
612 OS << "]\n";
613
614 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
615 MCFixup &F = Fixups[i];
Chris Lattner8d31de62010-02-11 21:27:18 +0000616 const MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
Daniel Dunbar6b716532010-02-09 23:00:14 +0000617 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
Daniel Dunbar5d5a1e12010-02-10 04:47:08 +0000618 << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
Daniel Dunbar6b716532010-02-09 23:00:14 +0000619 }
620}
621
622void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
623 assert(CurSection && "Cannot emit contents before setting section!");
624
625 // Show the encoding in a comment if we have a code emitter.
626 if (Emitter)
627 AddEncodingComment(Inst);
628
Chris Lattner30d9a642010-02-09 00:54:51 +0000629 // Show the MCInst if enabled.
Daniel Dunbar67c076c2010-03-22 21:49:34 +0000630 if (ShowInst)
631 Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
Chris Lattner30d9a642010-02-09 00:54:51 +0000632
Daniel Dunbar67c076c2010-03-22 21:49:34 +0000633 // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
Daniel Dunbar9dee8e32010-02-03 18:18:30 +0000634 if (InstPrinter)
Chris Lattnerd3740872010-04-04 05:04:31 +0000635 InstPrinter->printInst(&Inst, OS);
Daniel Dunbar9dee8e32010-02-03 18:18:30 +0000636 else
637 Inst.print(OS, &MAI);
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000638 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000639}
640
Chris Lattner91bead72010-04-03 21:35:55 +0000641/// EmitRawText - If this file is backed by a assembly streamer, this dumps
642/// the specified string in the output .s file. This capability is
643/// indicated by the hasRawTextSupport() predicate.
644void MCAsmStreamer::EmitRawText(StringRef String) {
Chris Lattnerd5928dc2010-04-03 22:06:56 +0000645 if (!String.empty() && String.back() == '\n')
646 String = String.substr(0, String.size()-1);
Chris Lattner91bead72010-04-03 21:35:55 +0000647 OS << String;
Chris Lattnerd5928dc2010-04-03 22:06:56 +0000648 EmitEOL();
Chris Lattner91bead72010-04-03 21:35:55 +0000649}
650
Daniel Dunbara11af532009-06-24 01:03:06 +0000651void MCAsmStreamer::Finish() {
652 OS.flush();
653}
Daniel Dunbar9dee8e32010-02-03 18:18:30 +0000654
Chris Lattner86e22112010-01-22 07:29:22 +0000655MCStreamer *llvm::createAsmStreamer(MCContext &Context,
656 formatted_raw_ostream &OS,
Chris Lattnerfdab14b2010-03-12 18:28:53 +0000657 bool isLittleEndian,
Chris Lattner07404412010-01-22 07:06:15 +0000658 bool isVerboseAsm, MCInstPrinter *IP,
Daniel Dunbar5532cf42010-02-10 01:41:14 +0000659 MCCodeEmitter *CE, bool ShowInst) {
Chris Lattnerfdab14b2010-03-12 18:28:53 +0000660 return new MCAsmStreamer(Context, OS, isLittleEndian, isVerboseAsm,
Daniel Dunbar5532cf42010-02-10 01:41:14 +0000661 IP, CE, ShowInst);
Daniel Dunbara11af532009-06-24 01:03:06 +0000662}