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"
12 #include "llvm/MC/MCContext.h"
13 #include "llvm/MC/MCInst.h"
14 #include "llvm/MC/MCSection.h"
15 #include "llvm/MC/MCSymbol.h"
16 #include "llvm/MC/MCValue.h"
17 #include "llvm/Support/ErrorHandling.h"
18 #include "llvm/Support/raw_ostream.h"
24 class MCAsmStreamer : public MCStreamer {
27 MCSection *CurSection;
30 MCAsmStreamer(MCContext &Context, raw_ostream &_OS)
31 : MCStreamer(Context), OS(_OS), CurSection(0) {}
34 /// @name MCStreamer Interface
37 virtual void SwitchSection(MCSection *Section);
39 virtual void EmitLabel(MCSymbol *Symbol);
41 virtual void EmitAssemblerFlag(AssemblerFlag Flag);
43 virtual void EmitAssignment(MCSymbol *Symbol, const MCValue &Value,
44 bool MakeAbsolute = false);
46 virtual void EmitSymbolAttribute(MCSymbol *Symbol, SymbolAttr Attribute);
48 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
50 virtual void EmitLocalSymbol(MCSymbol *Symbol, const MCValue &Value);
52 virtual void EmitCommonSymbol(MCSymbol *Symbol, unsigned Size,
53 unsigned Pow2Alignment, bool IsLocal);
55 virtual void EmitZerofill(MCSection *Section, MCSymbol *Symbol = NULL,
56 unsigned Size = 0, unsigned Pow2Alignment = 0);
58 virtual void EmitBytes(const StringRef &Data);
60 virtual void EmitValue(const MCValue &Value, unsigned Size);
62 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
63 unsigned ValueSize = 1,
64 unsigned MaxBytesToEmit = 0);
66 virtual void EmitValueToOffset(const MCValue &Offset,
67 unsigned char Value = 0);
69 virtual void EmitInstruction(const MCInst &Inst);
71 virtual void Finish();
78 /// NeedsQuoting - Return true if the string \arg Str needs quoting, i.e., it
79 /// does not match [a-zA-Z_.][a-zA-Z0-9_.]*.
81 // FIXME: This could be more permissive, do we care?
82 static inline bool NeedsQuoting(const StringRef &Str) {
86 // Check that first character is in [a-zA-Z_.].
87 if (!((Str[0] >= 'a' && Str[0] <= 'z') ||
88 (Str[0] >= 'A' && Str[0] <= 'Z') ||
89 (Str[0] == '_' || Str[0] == '.')))
92 // Check subsequent characters are in [a-zA-Z0-9_.].
93 for (unsigned i = 1, e = Str.size(); i != e; ++i)
94 if (!((Str[i] >= 'a' && Str[i] <= 'z') ||
95 (Str[i] >= 'A' && Str[i] <= 'Z') ||
96 (Str[i] >= '0' && Str[i] <= '9') ||
97 (Str[i] == '_' || Str[i] == '.')))
103 /// Allow printing symbols directly to a raw_ostream with proper quoting.
104 static inline raw_ostream &operator<<(raw_ostream &os, const MCSymbol *S) {
105 if (NeedsQuoting(S->getName()))
106 return os << '"' << S->getName() << '"';
107 return os << S->getName();
110 /// Allow printing values directly to a raw_ostream.
111 static inline raw_ostream &operator<<(raw_ostream &os, const MCValue &Value) {
112 if (Value.getSymA()) {
113 os << Value.getSymA();
115 os << " - " << Value.getSymB();
116 if (Value.getConstant())
117 os << " + " << Value.getConstant();
119 assert(!Value.getSymB() && "Invalid machine code value!");
120 os << Value.getConstant();
126 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
127 assert(Bytes && "Invalid size!");
128 return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
131 static inline MCValue truncateToSize(const MCValue &Value, unsigned Bytes) {
132 return MCValue::get(Value.getSymA(), Value.getSymB(),
133 truncateToSize(Value.getConstant(), Bytes));
136 void MCAsmStreamer::SwitchSection(MCSection *Section) {
137 if (Section != CurSection) {
138 CurSection = Section;
140 // FIXME: Needs TargetAsmInfo!
141 Section->PrintSwitchToSection(*(const TargetAsmInfo*)0, OS);
145 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
146 assert(Symbol->getSection() == 0 && "Cannot emit a symbol twice!");
147 assert(CurSection && "Cannot emit before setting section!");
148 assert(!getContext().GetSymbolValue(Symbol) &&
149 "Cannot emit symbol which was directly assigned to!");
151 OS << Symbol << ":\n";
152 Symbol->setSection(CurSection);
153 Symbol->setExternal(false);
156 void MCAsmStreamer::EmitAssemblerFlag(AssemblerFlag Flag) {
158 case SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
163 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCValue &Value,
165 assert(!Symbol->getSection() && "Cannot assign to a label!");
168 OS << ".set " << Symbol << ", " << Value << '\n';
170 OS << Symbol << " = " << Value << '\n';
173 getContext().SetSymbolValue(Symbol, Value);
176 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
177 SymbolAttr Attribute) {
179 case Global: OS << ".globl"; break;
180 case Hidden: OS << ".hidden"; break;
181 case IndirectSymbol: OS << ".indirect_symbol"; break;
182 case Internal: OS << ".internal"; break;
183 case LazyReference: OS << ".lazy_reference"; break;
184 case NoDeadStrip: OS << ".no_dead_strip"; break;
185 case PrivateExtern: OS << ".private_extern"; break;
186 case Protected: OS << ".protected"; break;
187 case Reference: OS << ".reference"; break;
188 case Weak: OS << ".weak"; break;
189 case WeakDefinition: OS << ".weak_definition"; break;
190 case WeakReference: OS << ".weak_reference"; break;
193 OS << ' ' << Symbol << '\n';
196 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
197 OS << ".desc" << ' ' << Symbol << ',' << DescValue << '\n';
200 void MCAsmStreamer::EmitLocalSymbol(MCSymbol *Symbol, const MCValue &Value) {
201 OS << ".lsym" << ' ' << Symbol << ',' << Value << '\n';
204 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, unsigned Size,
205 unsigned Pow2Alignment, bool IsLocal) {
210 OS << ' ' << Symbol << ',' << Size;
211 if (Pow2Alignment != 0)
212 OS << ',' << Pow2Alignment;
216 void MCAsmStreamer::EmitZerofill(MCSection *Section, MCSymbol *Symbol,
217 unsigned Size, unsigned Pow2Alignment) {
218 // Note: a .zerofill directive does not switch sections
219 // FIXME: Really we would like the segment and section names as well as the
220 // section type to be separate values instead of embedded in the name. Not
221 // all assemblers understand all this stuff though.
224 // This is a mach-o specific directive.
225 OS << '"' << ((MCSectionMachO*)Section)->getName() << '"';
228 if (Symbol != NULL) {
229 OS << ',' << Symbol << ',' << Size;
230 if (Pow2Alignment != 0)
231 OS << ',' << Pow2Alignment;
236 void MCAsmStreamer::EmitBytes(const StringRef &Data) {
237 assert(CurSection && "Cannot emit contents before setting section!");
238 for (unsigned i = 0, e = Data.size(); i != e; ++i)
239 OS << ".byte " << (unsigned) Data[i] << '\n';
242 void MCAsmStreamer::EmitValue(const MCValue &Value, unsigned Size) {
243 assert(CurSection && "Cannot emit contents before setting section!");
244 // Need target hooks to know how to print this.
247 llvm_unreachable("Invalid size for machine code value!");
248 case 1: OS << ".byte"; break;
249 case 2: OS << ".short"; break;
250 case 4: OS << ".long"; break;
251 case 8: OS << ".quad"; break;
254 OS << ' ' << truncateToSize(Value, Size) << '\n';
257 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
259 unsigned MaxBytesToEmit) {
260 // Some assemblers don't support .balign, so we always emit as .p2align if
261 // this is a power of two. Otherwise we assume the client knows the target
262 // supports .balign and use that.
263 unsigned Pow2 = Log2_32(ByteAlignment);
264 bool IsPow2 = (1U << Pow2) == ByteAlignment;
268 llvm_unreachable("Invalid size for machine code value!");
270 llvm_unreachable("Unsupported alignment size!");
271 case 1: OS << (IsPow2 ? ".p2align" : ".balign"); break;
272 case 2: OS << (IsPow2 ? ".p2alignw" : ".balignw"); break;
273 case 4: OS << (IsPow2 ? ".p2alignl" : ".balignl"); break;
276 OS << ' ' << (IsPow2 ? Pow2 : ByteAlignment);
278 OS << ", " << truncateToSize(Value, ValueSize);
280 OS << ", " << MaxBytesToEmit;
284 void MCAsmStreamer::EmitValueToOffset(const MCValue &Offset,
285 unsigned char Value) {
286 // FIXME: Verify that Offset is associated with the current section.
287 OS << ".org " << Offset << ", " << (unsigned) Value << '\n';
290 static raw_ostream &operator<<(raw_ostream &OS, const MCOperand &Op) {
292 return OS << "reg:" << Op.getReg();
294 return OS << "imm:" << Op.getImm();
296 return OS << "mbblabel:("
297 << Op.getMBBLabelFunction() << ", " << Op.getMBBLabelBlock();
298 assert(Op.isMCValue() && "Invalid operand!");
299 return OS << "val:" << Op.getMCValue();
302 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
303 assert(CurSection && "Cannot emit contents before setting section!");
304 // FIXME: Implement proper printing.
306 << "opcode=" << Inst.getOpcode() << ", "
308 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i) {
311 OS << Inst.getOperand(i);
316 void MCAsmStreamer::Finish() {
320 MCStreamer *llvm::createAsmStreamer(MCContext &Context, raw_ostream &OS) {
321 return new MCAsmStreamer(Context, OS);