blob: 0abd485ac1873af709fd6fd334aba35bf723646b [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 Lattner86e22112010-01-22 07:29:22 +000019#include "llvm/ADT/SmallString.h"
20#include "llvm/ADT/Twine.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000021#include "llvm/Support/ErrorHandling.h"
Chris Lattner663c2d22009-08-19 06:12:02 +000022#include "llvm/Support/MathExtras.h"
Daniel Dunbar4a0abd82009-08-27 00:51:57 +000023#include "llvm/Support/Format.h"
Chris Lattner86e22112010-01-22 07:29:22 +000024#include "llvm/Support/FormattedStream.h"
Daniel Dunbara11af532009-06-24 01:03:06 +000025using namespace llvm;
26
27namespace {
28
Chris Lattner46a947d2009-08-17 04:17:34 +000029class MCAsmStreamer : public MCStreamer {
Chris Lattner86e22112010-01-22 07:29:22 +000030 formatted_raw_ostream &OS;
Chris Lattner33adcfb2009-08-22 21:43:10 +000031 const MCAsmInfo &MAI;
Chris Lattner90edac02009-09-14 03:02:37 +000032 MCInstPrinter *InstPrinter;
Daniel Dunbar4a0abd82009-08-27 00:51:57 +000033 MCCodeEmitter *Emitter;
Chris Lattner86e22112010-01-22 07:29:22 +000034
35 SmallString<128> CommentToEmit;
Chris Lattnerd79d9dc2010-01-22 19:17:48 +000036 raw_svector_ostream CommentStream;
Daniel Dunbar9dee8e32010-02-03 18:18:30 +000037
38 unsigned IsLittleEndian : 1;
39 unsigned IsVerboseAsm : 1;
Daniel Dunbar6b716532010-02-09 23:00:14 +000040 unsigned ShowFixups : 1;
Daniel Dunbar9dee8e32010-02-03 18:18:30 +000041 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,
45 const MCAsmInfo &mai,
Chris Lattner07404412010-01-22 07:06:15 +000046 bool isLittleEndian, bool isVerboseAsm, MCInstPrinter *printer,
Daniel Dunbar6b716532010-02-09 23:00:14 +000047 MCCodeEmitter *emitter, bool showInst, bool showFixups)
Daniel Dunbar9dee8e32010-02-03 18:18:30 +000048 : MCStreamer(Context), OS(os), MAI(mai), InstPrinter(printer),
49 Emitter(emitter), CommentStream(CommentToEmit),
50 IsLittleEndian(isLittleEndian), IsVerboseAsm(isVerboseAsm),
Daniel Dunbar6b716532010-02-09 23:00:14 +000051 ShowFixups(showFixups), ShowInst(showInst) {}
Chris Lattner46a947d2009-08-17 04:17:34 +000052 ~MCAsmStreamer() {}
Daniel Dunbara11af532009-06-24 01:03:06 +000053
Chris Lattner16582022010-01-20 06:39:07 +000054 bool isLittleEndian() const { return IsLittleEndian; }
Daniel Dunbar6b716532010-02-09 23:00:14 +000055
Chris Lattner86e22112010-01-22 07:29:22 +000056 inline void EmitEOL() {
Chris Lattnerd79d9dc2010-01-22 19:17:48 +000057 // If we don't have any comments, just emit a \n.
58 if (!IsVerboseAsm) {
Chris Lattner86e22112010-01-22 07:29:22 +000059 OS << '\n';
60 return;
61 }
62 EmitCommentsAndEOL();
63 }
64 void EmitCommentsAndEOL();
Chris Lattner56591ab2010-02-02 23:37:42 +000065
66 /// isVerboseAsm - Return true if this streamer supports verbose assembly at
67 /// all.
68 virtual bool isVerboseAsm() const { return IsVerboseAsm; }
Daniel Dunbar6b716532010-02-09 23:00:14 +000069
Chris Lattnerd32c7cf2010-01-22 18:21:35 +000070 /// AddComment - Add a comment that can be emitted to the generated .s
Chris Lattner86e22112010-01-22 07:29:22 +000071 /// file if applicable as a QoI issue to make the output of the compiler
72 /// more readable. This only affects the MCAsmStreamer, and only when
73 /// verbose assembly output is enabled.
Chris Lattnerd32c7cf2010-01-22 18:21:35 +000074 virtual void AddComment(const Twine &T);
Daniel Dunbar6b716532010-02-09 23:00:14 +000075
76 /// AddEncodingComment - Add a comment showing the encoding of an instruction.
77 virtual void AddEncodingComment(const MCInst &Inst);
78
Chris Lattnerd79d9dc2010-01-22 19:17:48 +000079 /// GetCommentOS - Return a raw_ostream that comments can be written to.
80 /// Unlike AddComment, you are required to terminate comments with \n if you
81 /// use this method.
82 virtual raw_ostream &GetCommentOS() {
83 if (!IsVerboseAsm)
84 return nulls(); // Discard comments unless in verbose asm mode.
85 return CommentStream;
86 }
Daniel Dunbar6b716532010-02-09 23:00:14 +000087
Chris Lattner0fd90fd2010-01-22 19:52:01 +000088 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
89 virtual void AddBlankLine() {
90 EmitEOL();
91 }
Daniel Dunbar6b716532010-02-09 23:00:14 +000092
Chris Lattner46a947d2009-08-17 04:17:34 +000093 /// @name MCStreamer Interface
94 /// @{
Daniel Dunbara11af532009-06-24 01:03:06 +000095
Chris Lattner975780b2009-08-17 05:49:08 +000096 virtual void SwitchSection(const MCSection *Section);
Daniel Dunbara11af532009-06-24 01:03:06 +000097
Chris Lattner46a947d2009-08-17 04:17:34 +000098 virtual void EmitLabel(MCSymbol *Symbol);
Daniel Dunbara11af532009-06-24 01:03:06 +000099
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000100 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
Daniel Dunbara11af532009-06-24 01:03:06 +0000101
Daniel Dunbar821e3332009-08-31 08:09:28 +0000102 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
Daniel Dunbara11af532009-06-24 01:03:06 +0000103
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000104 virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
Kevin Enderbya5c78322009-07-13 21:03:15 +0000105
Chris Lattner46a947d2009-08-17 04:17:34 +0000106 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
Daniel Dunbara11af532009-06-24 01:03:06 +0000107
Chris Lattner99328ad2010-01-25 07:52:13 +0000108 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
Chris Lattner9eb158d2010-01-23 07:47:02 +0000109 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000110 unsigned ByteAlignment);
Kevin Enderby95cf30c2009-07-14 18:17:10 +0000111
Chris Lattner9eb158d2010-01-23 07:47:02 +0000112 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
113 ///
114 /// @param Symbol - The common symbol to emit.
115 /// @param Size - The size of the common symbol.
116 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
117
Daniel Dunbar8751b942009-08-28 05:48:22 +0000118 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000119 unsigned Size = 0, unsigned ByteAlignment = 0);
Kevin Enderby71148242009-07-14 21:35:03 +0000120
Chris Lattneraaec2052010-01-19 19:46:13 +0000121 virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
Chris Lattner4e4db7a2009-07-07 20:30:46 +0000122
Chris Lattneraaec2052010-01-19 19:46:13 +0000123 virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace);
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000124 virtual void EmitIntValue(uint64_t Value, unsigned Size, unsigned AddrSpace);
Chris Lattner718fb592010-01-25 21:28:50 +0000125 virtual void EmitGPRel32Value(const MCExpr *Value);
126
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000127
Chris Lattneraaec2052010-01-19 19:46:13 +0000128 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
129 unsigned AddrSpace);
Chris Lattner9be3fee2009-07-10 22:20:30 +0000130
Chris Lattner46a947d2009-08-17 04:17:34 +0000131 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
132 unsigned ValueSize = 1,
133 unsigned MaxBytesToEmit = 0);
Daniel Dunbara11af532009-06-24 01:03:06 +0000134
Daniel Dunbar821e3332009-08-31 08:09:28 +0000135 virtual void EmitValueToOffset(const MCExpr *Offset,
Chris Lattner46a947d2009-08-17 04:17:34 +0000136 unsigned char Value = 0);
Daniel Dunbara11af532009-06-24 01:03:06 +0000137
Chris Lattnera6594fc2010-01-25 18:58:59 +0000138 virtual void EmitFileDirective(StringRef Filename);
139 virtual void EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
140
141 virtual void EmitInstruction(const MCInst &Inst);
142
Chris Lattner46a947d2009-08-17 04:17:34 +0000143 virtual void Finish();
144
145 /// @}
146};
Daniel Dunbar84a29262009-06-24 19:25:34 +0000147
Chris Lattner46a947d2009-08-17 04:17:34 +0000148} // end anonymous namespace.
Daniel Dunbara11af532009-06-24 01:03:06 +0000149
Chris Lattnerd32c7cf2010-01-22 18:21:35 +0000150/// AddComment - Add a comment that can be emitted to the generated .s
Chris Lattner86e22112010-01-22 07:29:22 +0000151/// file if applicable as a QoI issue to make the output of the compiler
152/// more readable. This only affects the MCAsmStreamer, and only when
153/// verbose assembly output is enabled.
Chris Lattnerd32c7cf2010-01-22 18:21:35 +0000154void MCAsmStreamer::AddComment(const Twine &T) {
Chris Lattner86e22112010-01-22 07:29:22 +0000155 if (!IsVerboseAsm) return;
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000156
157 // Make sure that CommentStream is flushed.
158 CommentStream.flush();
159
Chris Lattner86e22112010-01-22 07:29:22 +0000160 T.toVector(CommentToEmit);
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000161 // Each comment goes on its own line.
162 CommentToEmit.push_back('\n');
Chris Lattner14ca1772010-01-22 21:16:10 +0000163
164 // Tell the comment stream that the vector changed underneath it.
165 CommentStream.resync();
Chris Lattner86e22112010-01-22 07:29:22 +0000166}
167
168void MCAsmStreamer::EmitCommentsAndEOL() {
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000169 if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
170 OS << '\n';
171 return;
172 }
173
174 CommentStream.flush();
Chris Lattner86e22112010-01-22 07:29:22 +0000175 StringRef Comments = CommentToEmit.str();
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000176
177 assert(Comments.back() == '\n' &&
178 "Comment array not newline terminated");
179 do {
Chris Lattner86e22112010-01-22 07:29:22 +0000180 // Emit a line of comments.
181 OS.PadToColumn(MAI.getCommentColumn());
182 size_t Position = Comments.find('\n');
183 OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
184
Chris Lattner86e22112010-01-22 07:29:22 +0000185 Comments = Comments.substr(Position+1);
Chris Lattnerd79d9dc2010-01-22 19:17:48 +0000186 } while (!Comments.empty());
Chris Lattner86e22112010-01-22 07:29:22 +0000187
Chris Lattner14ca1772010-01-22 21:16:10 +0000188 CommentToEmit.clear();
189 // Tell the comment stream that the vector changed underneath it.
190 CommentStream.resync();
Chris Lattner86e22112010-01-22 07:29:22 +0000191}
192
193
Daniel Dunbar304f6a42009-06-25 21:03:18 +0000194static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
195 assert(Bytes && "Invalid size!");
196 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
197}
198
Chris Lattner975780b2009-08-17 05:49:08 +0000199void MCAsmStreamer::SwitchSection(const MCSection *Section) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000200 assert(Section && "Cannot switch to a null section!");
Daniel Dunbara11af532009-06-24 01:03:06 +0000201 if (Section != CurSection) {
202 CurSection = Section;
Chris Lattner33adcfb2009-08-22 21:43:10 +0000203 Section->PrintSwitchToSection(MAI, OS);
Daniel Dunbara11af532009-06-24 01:03:06 +0000204 }
205}
206
207void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
Daniel Dunbar8906ff12009-08-22 07:22:36 +0000208 assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000209 assert(CurSection && "Cannot emit before setting section!");
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000210
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000211 OS << *Symbol << ":";
212 EmitEOL();
Daniel Dunbar8906ff12009-08-22 07:22:36 +0000213 Symbol->setSection(*CurSection);
Daniel Dunbara11af532009-06-24 01:03:06 +0000214}
215
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000216void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
Kevin Enderbyf96db462009-07-16 17:56:39 +0000217 switch (Flag) {
Daniel Dunbar011e4db2009-08-13 23:36:34 +0000218 default: assert(0 && "Invalid flag!");
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000219 case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
Kevin Enderbyf96db462009-07-16 17:56:39 +0000220 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000221 EmitEOL();
Kevin Enderbya5c78322009-07-13 21:03:15 +0000222}
223
Daniel Dunbar821e3332009-08-31 08:09:28 +0000224void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
Daniel Dunbar8906ff12009-08-22 07:22:36 +0000225 // Only absolute symbols can be redefined.
226 assert((Symbol->isUndefined() || Symbol->isAbsolute()) &&
227 "Cannot define a symbol twice!");
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000228
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000229 OS << *Symbol << " = " << *Value;
230 EmitEOL();
Daniel Dunbarfffff912009-10-16 01:34:54 +0000231
232 // FIXME: Lift context changes into super class.
Daniel Dunbar75773ff2009-10-16 01:57:39 +0000233 // FIXME: Set associated section.
Daniel Dunbarfffff912009-10-16 01:34:54 +0000234 Symbol->setValue(Value);
Daniel Dunbara11af532009-06-24 01:03:06 +0000235}
236
Daniel Dunbarfffff912009-10-16 01:34:54 +0000237void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000238 MCSymbolAttr Attribute) {
Daniel Dunbara11af532009-06-24 01:03:06 +0000239 switch (Attribute) {
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000240 case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
Chris Lattnered0ab152010-01-25 18:30:45 +0000241 case MCSA_ELF_TypeFunction: /// .type _foo, STT_FUNC # aka @function
242 case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
243 case MCSA_ELF_TypeObject: /// .type _foo, STT_OBJECT # aka @object
244 case MCSA_ELF_TypeTLS: /// .type _foo, STT_TLS # aka @tls_object
245 case MCSA_ELF_TypeCommon: /// .type _foo, STT_COMMON # aka @common
246 case MCSA_ELF_TypeNoType: /// .type _foo, STT_NOTYPE # aka @notype
247 assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
Dan Gohman523d70e2010-02-04 01:42:13 +0000248 OS << "\t.type\t" << *Symbol << ','
Chris Lattnered0ab152010-01-25 18:30:45 +0000249 << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
250 switch (Attribute) {
251 default: assert(0 && "Unknown ELF .type");
252 case MCSA_ELF_TypeFunction: OS << "function"; break;
253 case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
254 case MCSA_ELF_TypeObject: OS << "object"; break;
255 case MCSA_ELF_TypeTLS: OS << "tls_object"; break;
256 case MCSA_ELF_TypeCommon: OS << "common"; break;
257 case MCSA_ELF_TypeNoType: OS << "no_type"; break;
258 }
259 EmitEOL();
260 return;
261 case MCSA_Global: // .globl/.global
262 OS << MAI.getGlobalDirective();
263 break;
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000264 case MCSA_Hidden: OS << ".hidden "; break;
265 case MCSA_IndirectSymbol: OS << ".indirect_symbol "; break;
266 case MCSA_Internal: OS << ".internal "; break;
267 case MCSA_LazyReference: OS << ".lazy_reference "; break;
268 case MCSA_Local: OS << ".local "; break;
269 case MCSA_NoDeadStrip: OS << ".no_dead_strip "; break;
270 case MCSA_PrivateExtern: OS << ".private_extern "; break;
271 case MCSA_Protected: OS << ".protected "; break;
272 case MCSA_Reference: OS << ".reference "; break;
273 case MCSA_Weak: OS << ".weak "; break;
274 case MCSA_WeakDefinition: OS << ".weak_definition "; break;
275 // .weak_reference
276 case MCSA_WeakReference: OS << MAI.getWeakRefDirective(); break;
Daniel Dunbara11af532009-06-24 01:03:06 +0000277 }
278
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000279 OS << *Symbol;
280 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000281}
282
Kevin Enderby95cf30c2009-07-14 18:17:10 +0000283void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000284 OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
285 EmitEOL();
Kevin Enderby95cf30c2009-07-14 18:17:10 +0000286}
287
Chris Lattner99328ad2010-01-25 07:52:13 +0000288void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
289 assert(MAI.hasDotTypeDotSizeDirective());
290 OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
291}
292
Chris Lattner9eb158d2010-01-23 07:47:02 +0000293void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000294 unsigned ByteAlignment) {
Chris Lattner9eb158d2010-01-23 07:47:02 +0000295 OS << "\t.comm\t" << *Symbol << ',' << Size;
Chris Lattner6559d762010-01-25 07:29:13 +0000296 if (ByteAlignment != 0) {
Rafael Espindola2e2563b2010-01-26 20:21:43 +0000297 if (MAI.getCOMMDirectiveAlignmentIsInBytes())
Chris Lattner4ed54382010-01-19 06:01:04 +0000298 OS << ',' << ByteAlignment;
299 else
300 OS << ',' << Log2_32(ByteAlignment);
301 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000302 EmitEOL();
Chris Lattner4e4db7a2009-07-07 20:30:46 +0000303}
304
Chris Lattner9eb158d2010-01-23 07:47:02 +0000305/// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
306///
307/// @param Symbol - The common symbol to emit.
308/// @param Size - The size of the common symbol.
309void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
310 assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
311 OS << "\t.lcomm\t" << *Symbol << ',' << Size;
312 EmitEOL();
313}
314
Daniel Dunbar8751b942009-08-28 05:48:22 +0000315void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000316 unsigned Size, unsigned ByteAlignment) {
Daniel Dunbar011e4db2009-08-13 23:36:34 +0000317 // Note: a .zerofill directive does not switch sections.
Chris Lattner93b6db32009-08-08 23:39:42 +0000318 OS << ".zerofill ";
319
320 // This is a mach-o specific directive.
Chris Lattnerff4bc462009-08-10 01:39:42 +0000321 const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
Daniel Dunbar12de0df2009-08-14 18:51:45 +0000322 OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
Chris Lattner93b6db32009-08-08 23:39:42 +0000323
Chris Lattner9be3fee2009-07-10 22:20:30 +0000324 if (Symbol != NULL) {
Chris Lattner10b318b2010-01-17 21:43:43 +0000325 OS << ',' << *Symbol << ',' << Size;
Daniel Dunbar7092c7e2009-08-30 06:17:16 +0000326 if (ByteAlignment != 0)
327 OS << ',' << Log2_32(ByteAlignment);
Chris Lattner9be3fee2009-07-10 22:20:30 +0000328 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000329 EmitEOL();
Chris Lattner9be3fee2009-07-10 22:20:30 +0000330}
331
Chris Lattner12e555c2010-01-23 00:15:00 +0000332static inline char toOctal(int X) { return (X&7)+'0'; }
333
Chris Lattnera6594fc2010-01-25 18:58:59 +0000334static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
335 OS << '"';
336
337 for (unsigned i = 0, e = Data.size(); i != e; ++i) {
338 unsigned char C = Data[i];
339 if (C == '"' || C == '\\') {
340 OS << '\\' << (char)C;
341 continue;
342 }
343
344 if (isprint((unsigned char)C)) {
345 OS << (char)C;
346 continue;
347 }
348
349 switch (C) {
350 case '\b': OS << "\\b"; break;
351 case '\f': OS << "\\f"; break;
352 case '\n': OS << "\\n"; break;
353 case '\r': OS << "\\r"; break;
354 case '\t': OS << "\\t"; break;
355 default:
356 OS << '\\';
357 OS << toOctal(C >> 6);
358 OS << toOctal(C >> 3);
359 OS << toOctal(C >> 0);
360 break;
361 }
362 }
363
364 OS << '"';
365}
366
367
Chris Lattneraaec2052010-01-19 19:46:13 +0000368void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000369 assert(CurSection && "Cannot emit contents before setting section!");
Chris Lattner12e555c2010-01-23 00:15:00 +0000370 if (Data.empty()) return;
371
372 if (Data.size() == 1) {
373 OS << MAI.getData8bitsDirective(AddrSpace);
374 OS << (unsigned)(unsigned char)Data[0];
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000375 EmitEOL();
Chris Lattner12e555c2010-01-23 00:15:00 +0000376 return;
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000377 }
Chris Lattner12e555c2010-01-23 00:15:00 +0000378
379 // If the data ends with 0 and the target supports .asciz, use it, otherwise
380 // use .ascii
381 if (MAI.getAscizDirective() && Data.back() == 0) {
382 OS << MAI.getAscizDirective();
383 Data = Data.substr(0, Data.size()-1);
384 } else {
385 OS << MAI.getAsciiDirective();
386 }
387
Chris Lattnera6594fc2010-01-25 18:58:59 +0000388 OS << ' ';
389 PrintQuotedString(Data, OS);
Chris Lattner12e555c2010-01-23 00:15:00 +0000390 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000391}
392
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000393/// EmitIntValue - Special case of EmitValue that avoids the client having
394/// to pass in a MCExpr for constant integers.
395void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
396 unsigned AddrSpace) {
397 assert(CurSection && "Cannot emit contents before setting section!");
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000398 const char *Directive = 0;
399 switch (Size) {
400 default: break;
401 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
402 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
403 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
Chris Lattner5eaa54e2010-01-20 06:45:39 +0000404 case 8:
405 Directive = MAI.getData64bitsDirective(AddrSpace);
406 // If the target doesn't support 64-bit data, emit as two 32-bit halves.
407 if (Directive) break;
408 if (isLittleEndian()) {
409 EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
410 EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
411 } else {
412 EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
413 EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
414 }
415 return;
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000416 }
417
418 assert(Directive && "Invalid size for machine code value!");
Chris Lattner86e22112010-01-22 07:29:22 +0000419 OS << Directive << truncateToSize(Value, Size);
420 EmitEOL();
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000421}
422
Chris Lattneraaec2052010-01-19 19:46:13 +0000423void MCAsmStreamer::EmitValue(const MCExpr *Value, unsigned Size,
424 unsigned AddrSpace) {
Daniel Dunbar71d259b2009-06-24 17:00:42 +0000425 assert(CurSection && "Cannot emit contents before setting section!");
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000426 const char *Directive = 0;
Daniel Dunbara11af532009-06-24 01:03:06 +0000427 switch (Size) {
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000428 default: break;
429 case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
430 case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
431 case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
432 case 8: Directive = MAI.getData64bitsDirective(AddrSpace); break;
Daniel Dunbara11af532009-06-24 01:03:06 +0000433 }
Chris Lattneraaec2052010-01-19 19:46:13 +0000434
Chris Lattner32ae3fe2010-01-19 22:03:38 +0000435 assert(Directive && "Invalid size for machine code value!");
Chris Lattner718fb592010-01-25 21:28:50 +0000436 OS << Directive << *Value;
Chris Lattner86e22112010-01-22 07:29:22 +0000437 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000438}
439
Chris Lattner718fb592010-01-25 21:28:50 +0000440void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
441 assert(MAI.getGPRel32Directive() != 0);
442 OS << MAI.getGPRel32Directive() << *Value;
443 EmitEOL();
444}
445
446
Chris Lattner6113b3d2010-01-19 18:52:28 +0000447/// EmitFill - Emit NumBytes bytes worth of the value specified by
448/// FillValue. This implements directives such as '.space'.
Chris Lattneraaec2052010-01-19 19:46:13 +0000449void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
450 unsigned AddrSpace) {
Chris Lattner8a6d7ac2010-01-19 18:58:52 +0000451 if (NumBytes == 0) return;
452
Chris Lattneraaec2052010-01-19 19:46:13 +0000453 if (AddrSpace == 0)
454 if (const char *ZeroDirective = MAI.getZeroDirective()) {
455 OS << ZeroDirective << NumBytes;
456 if (FillValue != 0)
457 OS << ',' << (int)FillValue;
Chris Lattner86e22112010-01-22 07:29:22 +0000458 EmitEOL();
Chris Lattneraaec2052010-01-19 19:46:13 +0000459 return;
460 }
461
462 // Emit a byte at a time.
463 MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
Chris Lattner6113b3d2010-01-19 18:52:28 +0000464}
465
Daniel Dunbar84a29262009-06-24 19:25:34 +0000466void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
467 unsigned ValueSize,
468 unsigned MaxBytesToEmit) {
Chris Lattner663c2d22009-08-19 06:12:02 +0000469 // Some assemblers don't support non-power of two alignments, so we always
470 // emit alignments as a power of two if possible.
471 if (isPowerOf2_32(ByteAlignment)) {
Chris Lattner6e579c62009-08-19 06:35:36 +0000472 switch (ValueSize) {
473 default: llvm_unreachable("Invalid size for machine code value!");
Chris Lattner33adcfb2009-08-22 21:43:10 +0000474 case 1: OS << MAI.getAlignDirective(); break;
475 // FIXME: use MAI for this!
Chris Lattner6e579c62009-08-19 06:35:36 +0000476 case 2: OS << ".p2alignw "; break;
477 case 4: OS << ".p2alignl "; break;
478 case 8: llvm_unreachable("Unsupported alignment size!");
479 }
Chris Lattner663c2d22009-08-19 06:12:02 +0000480
Chris Lattner33adcfb2009-08-22 21:43:10 +0000481 if (MAI.getAlignmentIsInBytes())
Chris Lattner663c2d22009-08-19 06:12:02 +0000482 OS << ByteAlignment;
483 else
484 OS << Log2_32(ByteAlignment);
Daniel Dunbar84a29262009-06-24 19:25:34 +0000485
Chris Lattner663c2d22009-08-19 06:12:02 +0000486 if (Value || MaxBytesToEmit) {
Chris Lattner579531c2009-09-03 04:01:10 +0000487 OS << ", 0x";
488 OS.write_hex(truncateToSize(Value, ValueSize));
Chris Lattner663c2d22009-08-19 06:12:02 +0000489
490 if (MaxBytesToEmit)
491 OS << ", " << MaxBytesToEmit;
492 }
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000493 EmitEOL();
Chris Lattner663c2d22009-08-19 06:12:02 +0000494 return;
495 }
496
497 // Non-power of two alignment. This is not widely supported by assemblers.
Chris Lattner33adcfb2009-08-22 21:43:10 +0000498 // FIXME: Parameterize this based on MAI.
Daniel Dunbar84a29262009-06-24 19:25:34 +0000499 switch (ValueSize) {
Chris Lattner663c2d22009-08-19 06:12:02 +0000500 default: llvm_unreachable("Invalid size for machine code value!");
501 case 1: OS << ".balign"; break;
502 case 2: OS << ".balignw"; break;
503 case 4: OS << ".balignl"; break;
504 case 8: llvm_unreachable("Unsupported alignment size!");
Daniel Dunbar84a29262009-06-24 19:25:34 +0000505 }
506
Chris Lattner663c2d22009-08-19 06:12:02 +0000507 OS << ' ' << ByteAlignment;
Daniel Dunbar304f6a42009-06-25 21:03:18 +0000508 OS << ", " << truncateToSize(Value, ValueSize);
Daniel Dunbar84a29262009-06-24 19:25:34 +0000509 if (MaxBytesToEmit)
510 OS << ", " << MaxBytesToEmit;
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000511 EmitEOL();
Daniel Dunbar84a29262009-06-24 19:25:34 +0000512}
513
Daniel Dunbar821e3332009-08-31 08:09:28 +0000514void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
Daniel Dunbar84a29262009-06-24 19:25:34 +0000515 unsigned char Value) {
516 // FIXME: Verify that Offset is associated with the current section.
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000517 OS << ".org " << *Offset << ", " << (unsigned) Value;
518 EmitEOL();
Daniel Dunbar84a29262009-06-24 19:25:34 +0000519}
520
Chris Lattnera6594fc2010-01-25 18:58:59 +0000521
522void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
523 assert(MAI.hasSingleParameterDotFile());
524 OS << "\t.file\t";
525 PrintQuotedString(Filename, OS);
526 EmitEOL();
527}
528
529void MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
530 OS << "\t.file\t" << FileNo << ' ';
531 PrintQuotedString(Filename, OS);
532 EmitEOL();
533}
534
Daniel Dunbar6b716532010-02-09 23:00:14 +0000535void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
536 raw_ostream &OS = GetCommentOS();
537 SmallString<256> Code;
538 SmallVector<MCFixup, 4> Fixups;
539 raw_svector_ostream VecOS(Code);
540 Emitter->EncodeInstruction(Inst, VecOS, Fixups);
541 VecOS.flush();
Chris Lattnera6594fc2010-01-25 18:58:59 +0000542
Daniel Dunbar6b716532010-02-09 23:00:14 +0000543 // If we aren't showing fixups, just show the bytes.
544 if (!ShowFixups) {
Chris Lattner8ef2cef2010-02-03 06:28:13 +0000545 OS << "encoding: [";
546 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
547 if (i)
548 OS << ',';
Chris Lattner342cbdc2010-02-05 22:20:08 +0000549 OS << format("0x%02x", uint8_t(Code[i]));
Chris Lattner8ef2cef2010-02-03 06:28:13 +0000550 }
551 OS << "]\n";
552 }
Daniel Dunbarc22e0b22009-08-14 03:48:55 +0000553
Daniel Dunbar6b716532010-02-09 23:00:14 +0000554 // If we are showing fixups, create symbolic markers in the encoded
555 // representation. We do this by making a per-bit map to the fixup item index,
556 // then trying to display it as nicely as possible.
557 uint8_t *FixupMap = new uint8_t[Code.size() * 8];
558 for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
559 FixupMap[i] = 0;
560
561 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
562 MCFixup &F = Fixups[i];
563 MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
564 for (unsigned j = 0; j != Info.TargetSize; ++j) {
565 unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
566 assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
567 FixupMap[Index] = 1 + i;
568 }
569 }
570
571 OS << "encoding: [";
572 for (unsigned i = 0, e = Code.size(); i != e; ++i) {
573 if (i)
574 OS << ',';
575
576 // See if all bits are the same map entry.
577 uint8_t MapEntry = FixupMap[i * 8 + 0];
578 for (unsigned j = 1; j != 8; ++j) {
579 if (FixupMap[i * 8 + j] == MapEntry)
580 continue;
581
582 MapEntry = uint8_t(~0U);
583 break;
584 }
585
586 if (MapEntry != uint8_t(~0U)) {
587 if (MapEntry == 0) {
588 OS << format("0x%02x", uint8_t(Code[i]));
589 } else {
590 assert(Code[i] == 0 && "Encoder wrote into fixed up bit!");
591 OS << char('A' + MapEntry - 1);
592 }
593 } else {
594 // Otherwise, write out in binary.
595 OS << "0b";
596 for (unsigned j = 8; j--;) {
597 unsigned Bit = (Code[i] >> j) & 1;
598 if (uint8_t MapEntry = FixupMap[i * 8 + j]) {
599 assert(Bit == 0 && "Encoder wrote into fixed up bit!");
600 OS << char('A' + MapEntry - 1);
601 } else
602 OS << Bit;
603 }
604 }
605 }
606 OS << "]\n";
607
608 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
609 MCFixup &F = Fixups[i];
610 MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
611 OS << " fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
612 << ", op: " << F.getOpIndex() << ", kind: " << Info.Name << "\n";
613 }
614}
615
616void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
617 assert(CurSection && "Cannot emit contents before setting section!");
618
619 // Show the encoding in a comment if we have a code emitter.
620 if (Emitter)
621 AddEncodingComment(Inst);
622
Chris Lattner30d9a642010-02-09 00:54:51 +0000623 // Show the MCInst if enabled.
624 if (ShowInst) {
625 raw_ostream &OS = GetCommentOS();
626 OS << "<MCInst #" << Inst.getOpcode();
627
628 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i) {
629 OS << "\n ";
630 Inst.getOperand(i).print(OS, &MAI);
631 }
632 OS << ">\n";
633 }
634
Daniel Dunbar9dee8e32010-02-03 18:18:30 +0000635 // If we have an AsmPrinter, use that to print, otherwise dump the MCInst.
636 if (InstPrinter)
637 InstPrinter->printInst(&Inst);
638 else
639 Inst.print(OS, &MAI);
Chris Lattner7d1e49c2010-01-22 07:36:39 +0000640 EmitEOL();
Daniel Dunbara11af532009-06-24 01:03:06 +0000641}
642
643void MCAsmStreamer::Finish() {
644 OS.flush();
645}
Daniel Dunbar9dee8e32010-02-03 18:18:30 +0000646
Chris Lattner86e22112010-01-22 07:29:22 +0000647MCStreamer *llvm::createAsmStreamer(MCContext &Context,
648 formatted_raw_ostream &OS,
Chris Lattner16582022010-01-20 06:39:07 +0000649 const MCAsmInfo &MAI, bool isLittleEndian,
Chris Lattner07404412010-01-22 07:06:15 +0000650 bool isVerboseAsm, MCInstPrinter *IP,
Daniel Dunbar6b716532010-02-09 23:00:14 +0000651 MCCodeEmitter *CE, bool ShowInst,
652 bool ShowFixups) {
Chris Lattner07404412010-01-22 07:06:15 +0000653 return new MCAsmStreamer(Context, OS, MAI, isLittleEndian, isVerboseAsm,
Daniel Dunbar6b716532010-02-09 23:00:14 +0000654 IP, CE, ShowInst, ShowFixups);
Daniel Dunbara11af532009-06-24 01:03:06 +0000655}