1 //===-- Writer.cpp - Library for Printing VM assembly files ------*- C++ -*--=//
3 // This library implements the functionality defined in llvm/Assembly/Writer.h
5 // This library uses the Analysis library to figure out offsets for
6 // variables in the method tables...
8 // TODO: print out the type name instead of the full type if a particular type
9 // is in the symbol table...
11 //===----------------------------------------------------------------------===//
13 #include "llvm/Assembly/Writer.h"
14 #include "llvm/Analysis/SlotCalculator.h"
15 #include "llvm/Module.h"
16 #include "llvm/Method.h"
17 #include "llvm/BasicBlock.h"
18 #include "llvm/ConstPoolVals.h"
19 #include "llvm/iOther.h"
20 #include "llvm/iMemory.h"
22 void DebugValue(const Value *V) {
26 // WriteAsOperand - Write the name of the specified value out to the specified
27 // ostream. This can be useful when you just want to print int %reg126, not the
28 // whole instruction that generated it.
30 ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType,
31 bool PrintName, SlotCalculator *Table) {
33 Out << " " << V->getType();
35 if (V->hasName() && PrintName) {
36 Out << " %" << V->getName();
38 if (const ConstPoolVal *CPV = V->castConstant()) {
39 Out << " " << CPV->getStrValue();
43 Slot = Table->getValSlot(V);
45 if (const Type *Ty = V->castType()) {
46 return Out << " " << Ty;
47 } else if (const MethodArgument *MA = V->castMethodArgument()) {
48 Table = new SlotCalculator(MA->getParent(), true);
49 } else if (const Instruction *I = V->castInstruction()) {
50 Table = new SlotCalculator(I->getParent()->getParent(), true);
51 } else if (const BasicBlock *BB = V->castBasicBlock()) {
52 Table = new SlotCalculator(BB->getParent(), true);
53 } else if (const Method *Meth = V->castMethod()) {
54 Table = new SlotCalculator(Meth, true);
55 } else if (const Module *Mod = V->castModule()) {
56 Table = new SlotCalculator(Mod, true);
58 return Out << "BAD VALUE TYPE!";
60 Slot = Table->getValSlot(V);
63 if (Slot >= 0) Out << " %" << Slot;
65 Out << "<badref>"; // Not embeded into a location?
73 class AssemblyWriter : public ModuleAnalyzer {
75 SlotCalculator &Table;
77 inline AssemblyWriter(ostream &o, SlotCalculator &Tab) : Out(o), Table(Tab) {
80 inline void write(const Module *M) { processModule(M); }
81 inline void write(const Method *M) { processMethod(M); }
82 inline void write(const BasicBlock *BB) { processBasicBlock(BB); }
83 inline void write(const Instruction *I) { processInstruction(I); }
84 inline void write(const ConstPoolVal *CPV) { processConstant(CPV); }
87 virtual bool visitMethod(const Method *M);
88 virtual bool processConstPool(const ConstantPool &CP, bool isMethod);
89 virtual bool processConstant(const ConstPoolVal *CPV);
90 virtual bool processMethod(const Method *M);
91 virtual bool processMethodArgument(const MethodArgument *MA);
92 virtual bool processBasicBlock(const BasicBlock *BB);
93 virtual bool processInstruction(const Instruction *I);
96 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
101 // visitMethod - This member is called after the above two steps, visting each
102 // method, because they are effectively values that go into the constant pool.
104 bool AssemblyWriter::visitMethod(const Method *M) {
108 bool AssemblyWriter::processConstPool(const ConstantPool &CP, bool isMethod) {
109 // Done printing arguments...
111 const MethodType *MT = CP.getParentV()->castMethodAsserting()->getType()->
113 if (MT->isVarArg()) {
114 if (MT->getParamTypes().size())
116 Out << "..."; // Output varargs portion of signature!
121 ModuleAnalyzer::processConstPool(CP, isMethod);
124 if (!CP.getParentV()->castMethodAsserting()->isExternal())
127 Out << "implementation\n";
133 // processConstant - Print out a constant pool entry...
135 bool AssemblyWriter::processConstant(const ConstPoolVal *CPV) {
137 return false; // Don't print out unnamed constants, they will be inlined
140 Out << "\t%" << CPV->getName() << " = ";
142 // Print out the constant type...
143 Out << CPV->getType();
145 // Write the value out now...
146 writeOperand(CPV, false, false);
148 if (!CPV->hasName() && CPV->getType() != Type::VoidTy) {
149 int Slot = Table.getValSlot(CPV); // Print out the def slot taken...
150 Out << "\t\t; <" << CPV->getType() << ">:";
151 if (Slot >= 0) Out << Slot;
152 else Out << "<badref>";
159 // processMethod - Process all aspects of a method.
161 bool AssemblyWriter::processMethod(const Method *M) {
162 // Print out the return type and name...
163 Out << "\n" << (M->isExternal() ? "declare " : "")
164 << M->getReturnType() << " \"" << M->getName() << "\"(";
165 Table.incorporateMethod(M);
166 ModuleAnalyzer::processMethod(M);
168 if (!M->isExternal())
173 // processMethodArgument - This member is called for every argument that
174 // is passed into the method. Simply print it out
176 bool AssemblyWriter::processMethodArgument(const MethodArgument *Arg) {
177 // Insert commas as we go... the first arg doesn't get a comma
178 if (Arg != Arg->getParent()->getArgumentList().front()) Out << ", ";
181 Out << Arg->getType();
183 // Output name, if available...
185 Out << " %" << Arg->getName();
186 else if (Table.getValSlot(Arg) < 0)
192 // processBasicBlock - This member is called for each basic block in a methd.
194 bool AssemblyWriter::processBasicBlock(const BasicBlock *BB) {
195 if (BB->hasName()) { // Print out the label if it exists...
196 Out << "\n" << BB->getName() << ":";
198 int Slot = Table.getValSlot(BB);
199 Out << "\n; <label>:";
201 Out << Slot; // Extra newline seperates out label's
205 Out << "\t\t\t\t\t;[#uses=" << BB->use_size() << "]\n"; // Output # uses
207 ModuleAnalyzer::processBasicBlock(BB);
211 // processInstruction - This member is called for each Instruction in a methd.
213 bool AssemblyWriter::processInstruction(const Instruction *I) {
216 // Print out name if it exists...
217 if (I && I->hasName())
218 Out << "%" << I->getName() << " = ";
220 // Print out the opcode...
221 Out << I->getOpcodeName();
223 // Print out the type of the operands...
224 const Value *Operand = I->getNumOperands() ? I->getOperand(0) : 0;
226 // Special case conditional branches to swizzle the condition out to the front
227 if (I->getOpcode() == Instruction::Br && I->getNumOperands() > 1) {
228 writeOperand(I->getOperand(2), true);
230 writeOperand(Operand, true);
232 writeOperand(I->getOperand(1), true);
234 } else if (I->getOpcode() == Instruction::Switch) {
235 // Special case switch statement to get formatting nice and correct...
236 writeOperand(Operand , true); Out << ",";
237 writeOperand(I->getOperand(1), true); Out << " [";
239 for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; op += 2) {
241 writeOperand(I->getOperand(op ), true); Out << ",";
242 writeOperand(I->getOperand(op+1), true);
245 } else if (I->isPHINode()) {
246 Out << " " << Operand->getType();
248 Out << " ["; writeOperand(Operand, false); Out << ",";
249 writeOperand(I->getOperand(1), false); Out << " ]";
250 for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; op += 2) {
252 writeOperand(I->getOperand(op ), false); Out << ",";
253 writeOperand(I->getOperand(op+1), false); Out << " ]";
255 } else if (I->getOpcode() == Instruction::Ret && !Operand) {
257 } else if (I->getOpcode() == Instruction::Call) {
258 writeOperand(Operand, true);
260 if (I->getNumOperands() > 1) writeOperand(I->getOperand(1), true);
261 for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; ++op) {
263 writeOperand(I->getOperand(op), true);
267 } else if (I->getOpcode() == Instruction::Malloc ||
268 I->getOpcode() == Instruction::Alloca) {
269 Out << " " << ((const PointerType*)I->getType())->getValueType();
270 if (I->getNumOperands()) {
272 writeOperand(I->getOperand(0), true);
274 } else if (I->getOpcode() == Instruction::Cast) {
275 writeOperand(Operand, true);
276 Out << " to " << I->getType();
277 } else if (Operand) { // Print the normal way...
279 // PrintAllTypes - Instructions who have operands of all the same type
280 // omit the type from all but the first operand. If the instruction has
281 // different type operands (for example br), then they are all printed.
282 bool PrintAllTypes = false;
283 const Type *TheType = Operand->getType();
285 for (unsigned i = 1, E = I->getNumOperands(); i != E; ++i) {
286 Operand = I->getOperand(i);
287 if (Operand->getType() != TheType) {
288 PrintAllTypes = true; // We have differing types! Print them all!
294 Out << " " << I->getOperand(0)->getType();
296 for (unsigned i = 0, E = I->getNumOperands(); i != E; ++i) {
298 writeOperand(I->getOperand(i), PrintAllTypes);
302 // Print a little comment after the instruction indicating which slot it
305 if (I->getType() != Type::VoidTy) {
306 Out << "\t\t; <" << I->getType() << ">";
309 int Slot = Table.getValSlot(I); // Print out the def slot taken...
310 if (Slot >= 0) Out << ":" << Slot;
311 else Out << ":<badref>";
313 Out << "\t[#uses=" << I->use_size() << "]"; // Output # uses
321 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
323 WriteAsOperand(Out, Operand, PrintType, PrintName, &Table);
327 //===----------------------------------------------------------------------===//
328 // External Interface declarations
329 //===----------------------------------------------------------------------===//
333 void WriteToAssembly(const Module *M, ostream &o) {
334 if (M == 0) { o << "<null> module\n"; return; }
335 SlotCalculator SlotTable(M, true);
336 AssemblyWriter W(o, SlotTable);
341 void WriteToAssembly(const Method *M, ostream &o) {
342 if (M == 0) { o << "<null> method\n"; return; }
343 SlotCalculator SlotTable(M->getParent(), true);
344 AssemblyWriter W(o, SlotTable);
350 void WriteToAssembly(const BasicBlock *BB, ostream &o) {
351 if (BB == 0) { o << "<null> basic block\n"; return; }
353 SlotCalculator SlotTable(BB->getParent(), true);
354 AssemblyWriter W(o, SlotTable);
359 void WriteToAssembly(const ConstPoolVal *CPV, ostream &o) {
360 if (CPV == 0) { o << "<null> constant pool value\n"; return; }
361 WriteAsOperand(o, CPV, true, true, 0);
364 void WriteToAssembly(const Instruction *I, ostream &o) {
365 if (I == 0) { o << "<null> instruction\n"; return; }
367 SlotCalculator SlotTable(I->getParent() ? I->getParent()->getParent() : 0,
369 AssemblyWriter W(o, SlotTable);