2001-06-06 20:29:01 +00:00
|
|
|
//===-- Writer.cpp - Library for Printing VM assembly files ------*- C++ -*--=//
|
|
|
|
//
|
|
|
|
// This library implements the functionality defined in llvm/Assembly/Writer.h
|
|
|
|
//
|
|
|
|
// This library uses the Analysis library to figure out offsets for
|
|
|
|
// variables in the method tables...
|
|
|
|
//
|
|
|
|
// TODO: print out the type name instead of the full type if a particular type
|
|
|
|
// is in the symbol table...
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "llvm/Assembly/Writer.h"
|
|
|
|
#include "llvm/Analysis/SlotCalculator.h"
|
|
|
|
#include "llvm/Module.h"
|
|
|
|
#include "llvm/Method.h"
|
|
|
|
#include "llvm/BasicBlock.h"
|
|
|
|
#include "llvm/ConstPoolVals.h"
|
|
|
|
#include "llvm/iOther.h"
|
|
|
|
#include "llvm/iMemory.h"
|
2001-09-07 16:36:04 +00:00
|
|
|
#include "llvm/Support/STLExtras.h"
|
|
|
|
#include "llvm/SymbolTable.h"
|
|
|
|
#include <algorithm>
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-07-12 23:35:26 +00:00
|
|
|
void DebugValue(const Value *V) {
|
|
|
|
cerr << V << endl;
|
|
|
|
}
|
|
|
|
|
2001-07-20 19:15:21 +00:00
|
|
|
// WriteAsOperand - Write the name of the specified value out to the specified
|
|
|
|
// ostream. This can be useful when you just want to print int %reg126, not the
|
|
|
|
// whole instruction that generated it.
|
|
|
|
//
|
|
|
|
ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType,
|
|
|
|
bool PrintName, SlotCalculator *Table) {
|
|
|
|
if (PrintType)
|
|
|
|
Out << " " << V->getType();
|
|
|
|
|
2001-09-07 16:36:04 +00:00
|
|
|
if (PrintName && V->hasName()) {
|
2001-07-20 19:15:21 +00:00
|
|
|
Out << " %" << V->getName();
|
|
|
|
} else {
|
|
|
|
if (const ConstPoolVal *CPV = V->castConstant()) {
|
|
|
|
Out << " " << CPV->getStrValue();
|
|
|
|
} else {
|
|
|
|
int Slot;
|
|
|
|
if (Table) {
|
|
|
|
Slot = Table->getValSlot(V);
|
|
|
|
} else {
|
|
|
|
if (const Type *Ty = V->castType()) {
|
|
|
|
return Out << " " << Ty;
|
|
|
|
} else if (const MethodArgument *MA = V->castMethodArgument()) {
|
|
|
|
Table = new SlotCalculator(MA->getParent(), true);
|
|
|
|
} else if (const Instruction *I = V->castInstruction()) {
|
|
|
|
Table = new SlotCalculator(I->getParent()->getParent(), true);
|
|
|
|
} else if (const BasicBlock *BB = V->castBasicBlock()) {
|
|
|
|
Table = new SlotCalculator(BB->getParent(), true);
|
|
|
|
} else if (const Method *Meth = V->castMethod()) {
|
|
|
|
Table = new SlotCalculator(Meth, true);
|
|
|
|
} else if (const Module *Mod = V->castModule()) {
|
|
|
|
Table = new SlotCalculator(Mod, true);
|
|
|
|
} else {
|
|
|
|
return Out << "BAD VALUE TYPE!";
|
|
|
|
}
|
|
|
|
Slot = Table->getValSlot(V);
|
|
|
|
delete Table;
|
|
|
|
}
|
|
|
|
if (Slot >= 0) Out << " %" << Slot;
|
|
|
|
else if (PrintName)
|
|
|
|
Out << "<badref>"; // Not embeded into a location?
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Out;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2001-07-12 23:35:26 +00:00
|
|
|
|
2001-09-07 16:36:04 +00:00
|
|
|
class AssemblyWriter {
|
2001-06-06 20:29:01 +00:00
|
|
|
ostream &Out;
|
|
|
|
SlotCalculator &Table;
|
|
|
|
public:
|
|
|
|
inline AssemblyWriter(ostream &o, SlotCalculator &Tab) : Out(o), Table(Tab) {
|
|
|
|
}
|
|
|
|
|
|
|
|
inline void write(const Module *M) { processModule(M); }
|
|
|
|
inline void write(const Method *M) { processMethod(M); }
|
|
|
|
inline void write(const BasicBlock *BB) { processBasicBlock(BB); }
|
|
|
|
inline void write(const Instruction *I) { processInstruction(I); }
|
|
|
|
inline void write(const ConstPoolVal *CPV) { processConstant(CPV); }
|
|
|
|
|
|
|
|
private :
|
2001-09-07 16:36:04 +00:00
|
|
|
void processModule(const Module *M);
|
|
|
|
void processSymbolTable(const SymbolTable &ST);
|
|
|
|
void processConstant(const ConstPoolVal *CPV);
|
|
|
|
void processMethod(const Method *M);
|
|
|
|
void processMethodArgument(const MethodArgument *MA);
|
|
|
|
void processBasicBlock(const BasicBlock *BB);
|
|
|
|
void processInstruction(const Instruction *I);
|
|
|
|
|
2001-06-06 20:29:01 +00:00
|
|
|
void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2001-09-07 16:36:04 +00:00
|
|
|
void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
|
|
|
|
bool PrintName) {
|
|
|
|
WriteAsOperand(Out, Operand, PrintType, PrintName, &Table);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void AssemblyWriter::processModule(const Module *M) {
|
|
|
|
// Loop over the symbol table, emitting all named constants...
|
|
|
|
if (M->hasSymbolTable())
|
|
|
|
processSymbolTable(*M->getSymbolTable());
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-09-07 16:36:04 +00:00
|
|
|
Out << "implementation\n";
|
|
|
|
|
|
|
|
// Output all of the methods...
|
|
|
|
for_each(M->begin(), M->end(), bind_obj(this,&AssemblyWriter::processMethod));
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2001-09-07 16:36:04 +00:00
|
|
|
// processSymbolTable - Run through symbol table looking for named constants
|
|
|
|
// if a named constant is found, emit it's declaration...
|
|
|
|
//
|
|
|
|
void AssemblyWriter::processSymbolTable(const SymbolTable &ST) {
|
|
|
|
for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
|
|
|
|
SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
|
|
|
|
SymbolTable::type_const_iterator End = ST.type_end(TI->first);
|
|
|
|
|
|
|
|
for (; I != End; ++I) {
|
|
|
|
const Value *V = I->second;
|
|
|
|
if (const ConstPoolVal *CPV = V->castConstant()) {
|
|
|
|
processConstant(CPV);
|
|
|
|
} else if (const Type *Ty = V->castType()) {
|
|
|
|
Out << "\t%" << I->first << " = type " << Ty->getDescription() << endl;
|
|
|
|
}
|
|
|
|
}
|
2001-07-15 06:35:59 +00:00
|
|
|
}
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// processConstant - Print out a constant pool entry...
|
|
|
|
//
|
2001-09-07 16:36:04 +00:00
|
|
|
void AssemblyWriter::processConstant(const ConstPoolVal *CPV) {
|
|
|
|
// Don't print out unnamed constants, they will be inlined
|
|
|
|
if (!CPV->hasName()) return;
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-07-26 16:29:38 +00:00
|
|
|
// Print out name...
|
|
|
|
Out << "\t%" << CPV->getName() << " = ";
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-07-26 16:29:38 +00:00
|
|
|
// Print out the constant type...
|
2001-06-06 20:29:01 +00:00
|
|
|
Out << CPV->getType();
|
|
|
|
|
|
|
|
// Write the value out now...
|
|
|
|
writeOperand(CPV, false, false);
|
|
|
|
|
|
|
|
if (!CPV->hasName() && CPV->getType() != Type::VoidTy) {
|
|
|
|
int Slot = Table.getValSlot(CPV); // Print out the def slot taken...
|
|
|
|
Out << "\t\t; <" << CPV->getType() << ">:";
|
|
|
|
if (Slot >= 0) Out << Slot;
|
|
|
|
else Out << "<badref>";
|
|
|
|
}
|
|
|
|
|
|
|
|
Out << endl;
|
|
|
|
}
|
|
|
|
|
|
|
|
// processMethod - Process all aspects of a method.
|
|
|
|
//
|
2001-09-07 16:36:04 +00:00
|
|
|
void AssemblyWriter::processMethod(const Method *M) {
|
2001-06-06 20:29:01 +00:00
|
|
|
// Print out the return type and name...
|
2001-07-15 06:35:59 +00:00
|
|
|
Out << "\n" << (M->isExternal() ? "declare " : "")
|
|
|
|
<< M->getReturnType() << " \"" << M->getName() << "\"(";
|
2001-06-06 20:29:01 +00:00
|
|
|
Table.incorporateMethod(M);
|
2001-09-07 16:36:04 +00:00
|
|
|
|
|
|
|
// Loop over the arguments, processing them...
|
|
|
|
for_each(M->getArgumentList().begin(), M->getArgumentList().end(),
|
|
|
|
bind_obj(this, &AssemblyWriter::processMethodArgument));
|
|
|
|
|
|
|
|
|
|
|
|
// Finish printing arguments...
|
|
|
|
const MethodType *MT = (const MethodType*)M->getType();
|
|
|
|
if (MT->isVarArg()) {
|
|
|
|
if (MT->getParamTypes().size()) Out << ", ";
|
|
|
|
Out << "..."; // Output varargs portion of signature!
|
|
|
|
}
|
|
|
|
Out << ")\n";
|
|
|
|
|
|
|
|
if (!M->isExternal()) {
|
|
|
|
// Loop over the symbol table, emitting all named constants...
|
|
|
|
if (M->hasSymbolTable())
|
|
|
|
processSymbolTable(*M->getSymbolTable());
|
|
|
|
|
|
|
|
Out << "begin";
|
|
|
|
|
|
|
|
// Output all of its basic blocks... for the method
|
|
|
|
for_each(M->begin(), M->end(),
|
|
|
|
bind_obj(this, &AssemblyWriter::processBasicBlock));
|
|
|
|
|
2001-07-15 06:35:59 +00:00
|
|
|
Out << "end\n";
|
2001-09-07 16:36:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
Table.purgeMethod();
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// processMethodArgument - This member is called for every argument that
|
|
|
|
// is passed into the method. Simply print it out
|
|
|
|
//
|
2001-09-07 16:36:04 +00:00
|
|
|
void AssemblyWriter::processMethodArgument(const MethodArgument *Arg) {
|
2001-06-06 20:29:01 +00:00
|
|
|
// Insert commas as we go... the first arg doesn't get a comma
|
|
|
|
if (Arg != Arg->getParent()->getArgumentList().front()) Out << ", ";
|
|
|
|
|
|
|
|
// Output type...
|
|
|
|
Out << Arg->getType();
|
|
|
|
|
|
|
|
// Output name, if available...
|
|
|
|
if (Arg->hasName())
|
|
|
|
Out << " %" << Arg->getName();
|
|
|
|
else if (Table.getValSlot(Arg) < 0)
|
|
|
|
Out << "<badref>";
|
|
|
|
}
|
|
|
|
|
|
|
|
// processBasicBlock - This member is called for each basic block in a methd.
|
|
|
|
//
|
2001-09-07 16:36:04 +00:00
|
|
|
void AssemblyWriter::processBasicBlock(const BasicBlock *BB) {
|
2001-06-06 20:29:01 +00:00
|
|
|
if (BB->hasName()) { // Print out the label if it exists...
|
2001-06-07 16:58:55 +00:00
|
|
|
Out << "\n" << BB->getName() << ":";
|
2001-06-06 20:29:01 +00:00
|
|
|
} else {
|
|
|
|
int Slot = Table.getValSlot(BB);
|
2001-06-07 16:58:55 +00:00
|
|
|
Out << "\n; <label>:";
|
2001-06-06 20:29:01 +00:00
|
|
|
if (Slot >= 0)
|
2001-06-07 16:58:55 +00:00
|
|
|
Out << Slot; // Extra newline seperates out label's
|
2001-06-06 20:29:01 +00:00
|
|
|
else
|
2001-06-07 16:58:55 +00:00
|
|
|
Out << "<badref>";
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
2001-06-07 16:58:55 +00:00
|
|
|
Out << "\t\t\t\t\t;[#uses=" << BB->use_size() << "]\n"; // Output # uses
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-09-07 16:36:04 +00:00
|
|
|
// Output all of the instructions in the basic block...
|
|
|
|
for_each(BB->begin(), BB->end(),
|
|
|
|
bind_obj(this, &AssemblyWriter::processInstruction));
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// processInstruction - This member is called for each Instruction in a methd.
|
|
|
|
//
|
2001-09-07 16:36:04 +00:00
|
|
|
void AssemblyWriter::processInstruction(const Instruction *I) {
|
2001-06-06 20:29:01 +00:00
|
|
|
Out << "\t";
|
|
|
|
|
|
|
|
// Print out name if it exists...
|
|
|
|
if (I && I->hasName())
|
|
|
|
Out << "%" << I->getName() << " = ";
|
|
|
|
|
|
|
|
// Print out the opcode...
|
2001-07-07 19:24:15 +00:00
|
|
|
Out << I->getOpcodeName();
|
2001-06-06 20:29:01 +00:00
|
|
|
|
|
|
|
// Print out the type of the operands...
|
2001-07-07 08:36:50 +00:00
|
|
|
const Value *Operand = I->getNumOperands() ? I->getOperand(0) : 0;
|
2001-06-06 20:29:01 +00:00
|
|
|
|
|
|
|
// Special case conditional branches to swizzle the condition out to the front
|
2001-07-07 19:24:15 +00:00
|
|
|
if (I->getOpcode() == Instruction::Br && I->getNumOperands() > 1) {
|
2001-06-06 20:29:01 +00:00
|
|
|
writeOperand(I->getOperand(2), true);
|
|
|
|
Out << ",";
|
|
|
|
writeOperand(Operand, true);
|
|
|
|
Out << ",";
|
|
|
|
writeOperand(I->getOperand(1), true);
|
|
|
|
|
2001-07-07 19:24:15 +00:00
|
|
|
} else if (I->getOpcode() == Instruction::Switch) {
|
2001-06-06 20:29:01 +00:00
|
|
|
// Special case switch statement to get formatting nice and correct...
|
|
|
|
writeOperand(Operand , true); Out << ",";
|
|
|
|
writeOperand(I->getOperand(1), true); Out << " [";
|
|
|
|
|
2001-07-07 08:36:50 +00:00
|
|
|
for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; op += 2) {
|
2001-06-06 20:29:01 +00:00
|
|
|
Out << "\n\t\t";
|
2001-07-07 08:36:50 +00:00
|
|
|
writeOperand(I->getOperand(op ), true); Out << ",";
|
2001-06-06 20:29:01 +00:00
|
|
|
writeOperand(I->getOperand(op+1), true);
|
|
|
|
}
|
|
|
|
Out << "\n\t]";
|
2001-06-27 23:41:11 +00:00
|
|
|
} else if (I->isPHINode()) {
|
2001-06-11 15:04:20 +00:00
|
|
|
Out << " " << Operand->getType();
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-06-11 15:04:20 +00:00
|
|
|
Out << " ["; writeOperand(Operand, false); Out << ",";
|
2001-06-21 05:29:56 +00:00
|
|
|
writeOperand(I->getOperand(1), false); Out << " ]";
|
2001-07-07 08:36:50 +00:00
|
|
|
for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; op += 2) {
|
|
|
|
Out << ", [";
|
|
|
|
writeOperand(I->getOperand(op ), false); Out << ",";
|
2001-06-21 05:29:56 +00:00
|
|
|
writeOperand(I->getOperand(op+1), false); Out << " ]";
|
2001-06-11 15:04:20 +00:00
|
|
|
}
|
2001-07-07 19:24:15 +00:00
|
|
|
} else if (I->getOpcode() == Instruction::Ret && !Operand) {
|
2001-06-06 20:29:01 +00:00
|
|
|
Out << " void";
|
2001-07-07 19:24:15 +00:00
|
|
|
} else if (I->getOpcode() == Instruction::Call) {
|
2001-06-06 20:29:01 +00:00
|
|
|
writeOperand(Operand, true);
|
|
|
|
Out << "(";
|
2001-07-07 08:36:50 +00:00
|
|
|
if (I->getNumOperands() > 1) writeOperand(I->getOperand(1), true);
|
|
|
|
for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; ++op) {
|
2001-06-06 20:29:01 +00:00
|
|
|
Out << ",";
|
2001-07-07 08:36:50 +00:00
|
|
|
writeOperand(I->getOperand(op), true);
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
Out << " )";
|
2001-07-07 19:24:15 +00:00
|
|
|
} else if (I->getOpcode() == Instruction::Malloc ||
|
|
|
|
I->getOpcode() == Instruction::Alloca) {
|
2001-07-07 08:36:50 +00:00
|
|
|
Out << " " << ((const PointerType*)I->getType())->getValueType();
|
|
|
|
if (I->getNumOperands()) {
|
|
|
|
Out << ",";
|
|
|
|
writeOperand(I->getOperand(0), true);
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
2001-07-08 04:57:15 +00:00
|
|
|
} else if (I->getOpcode() == Instruction::Cast) {
|
|
|
|
writeOperand(Operand, true);
|
|
|
|
Out << " to " << I->getType();
|
2001-06-06 20:29:01 +00:00
|
|
|
} else if (Operand) { // Print the normal way...
|
|
|
|
|
|
|
|
// PrintAllTypes - Instructions who have operands of all the same type
|
|
|
|
// omit the type from all but the first operand. If the instruction has
|
|
|
|
// different type operands (for example br), then they are all printed.
|
|
|
|
bool PrintAllTypes = false;
|
|
|
|
const Type *TheType = Operand->getType();
|
|
|
|
|
2001-07-07 08:36:50 +00:00
|
|
|
for (unsigned i = 1, E = I->getNumOperands(); i != E; ++i) {
|
|
|
|
Operand = I->getOperand(i);
|
2001-06-06 20:29:01 +00:00
|
|
|
if (Operand->getType() != TheType) {
|
|
|
|
PrintAllTypes = true; // We have differing types! Print them all!
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!PrintAllTypes)
|
|
|
|
Out << " " << I->getOperand(0)->getType();
|
|
|
|
|
2001-07-07 08:36:50 +00:00
|
|
|
for (unsigned i = 0, E = I->getNumOperands(); i != E; ++i) {
|
2001-06-06 20:29:01 +00:00
|
|
|
if (i) Out << ",";
|
2001-07-07 08:36:50 +00:00
|
|
|
writeOperand(I->getOperand(i), PrintAllTypes);
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Print a little comment after the instruction indicating which slot it
|
|
|
|
// occupies.
|
|
|
|
//
|
2001-06-07 16:58:55 +00:00
|
|
|
if (I->getType() != Type::VoidTy) {
|
|
|
|
Out << "\t\t; <" << I->getType() << ">";
|
2001-06-06 20:29:01 +00:00
|
|
|
|
2001-06-07 16:58:55 +00:00
|
|
|
if (!I->hasName()) {
|
|
|
|
int Slot = Table.getValSlot(I); // Print out the def slot taken...
|
|
|
|
if (Slot >= 0) Out << ":" << Slot;
|
|
|
|
else Out << ":<badref>";
|
|
|
|
}
|
2001-06-06 20:29:01 +00:00
|
|
|
Out << "\t[#uses=" << I->use_size() << "]"; // Output # uses
|
|
|
|
}
|
|
|
|
Out << endl;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// External Interface declarations
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void WriteToAssembly(const Module *M, ostream &o) {
|
|
|
|
if (M == 0) { o << "<null> module\n"; return; }
|
|
|
|
SlotCalculator SlotTable(M, true);
|
|
|
|
AssemblyWriter W(o, SlotTable);
|
|
|
|
|
|
|
|
W.write(M);
|
|
|
|
}
|
|
|
|
|
|
|
|
void WriteToAssembly(const Method *M, ostream &o) {
|
|
|
|
if (M == 0) { o << "<null> method\n"; return; }
|
|
|
|
SlotCalculator SlotTable(M->getParent(), true);
|
|
|
|
AssemblyWriter W(o, SlotTable);
|
|
|
|
|
|
|
|
W.write(M);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void WriteToAssembly(const BasicBlock *BB, ostream &o) {
|
|
|
|
if (BB == 0) { o << "<null> basic block\n"; return; }
|
|
|
|
|
|
|
|
SlotCalculator SlotTable(BB->getParent(), true);
|
|
|
|
AssemblyWriter W(o, SlotTable);
|
|
|
|
|
|
|
|
W.write(BB);
|
|
|
|
}
|
|
|
|
|
|
|
|
void WriteToAssembly(const ConstPoolVal *CPV, ostream &o) {
|
|
|
|
if (CPV == 0) { o << "<null> constant pool value\n"; return; }
|
2001-07-28 17:49:02 +00:00
|
|
|
WriteAsOperand(o, CPV, true, true, 0);
|
2001-06-06 20:29:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void WriteToAssembly(const Instruction *I, ostream &o) {
|
|
|
|
if (I == 0) { o << "<null> instruction\n"; return; }
|
|
|
|
|
|
|
|
SlotCalculator SlotTable(I->getParent() ? I->getParent()->getParent() : 0,
|
|
|
|
true);
|
|
|
|
AssemblyWriter W(o, SlotTable);
|
|
|
|
|
|
|
|
W.write(I);
|
|
|
|
}
|