blob: 6cdbf9def32314f12f09d21c8ce00d2695e357ff [file] [log] [blame]
Chris Lattnerf7e79482002-04-07 22:31:46 +00001//===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00002//
3// This library implements the functionality defined in llvm/Assembly/Writer.h
4//
Chris Lattner2f7c9632001-06-06 20:29:01 +00005// TODO: print out the type name instead of the full type if a particular type
6// is in the symbol table...
7//
8//===----------------------------------------------------------------------===//
9
Chris Lattner7db79582001-11-07 04:21:57 +000010#include "llvm/Assembly/CachedWriter.h"
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +000011#include "llvm/Assembly/Writer.h"
Chris Lattner6915f8f2002-04-07 22:49:37 +000012#include "llvm/SlotCalculator.h"
Chris Lattner2f7c9632001-06-06 20:29:01 +000013#include "llvm/Module.h"
Chris Lattner57698e22002-03-26 18:01:55 +000014#include "llvm/Function.h"
Chris Lattnerda975502001-09-10 07:58:01 +000015#include "llvm/GlobalVariable.h"
Chris Lattner2f7c9632001-06-06 20:29:01 +000016#include "llvm/BasicBlock.h"
Chris Lattner3462ae32001-12-03 22:26:30 +000017#include "llvm/ConstantVals.h"
Chris Lattner2f7c9632001-06-06 20:29:01 +000018#include "llvm/iMemory.h"
Chris Lattner862e3382001-10-13 06:42:36 +000019#include "llvm/iTerminators.h"
Chris Lattnerfb5ae022001-12-03 18:02:31 +000020#include "llvm/iPHINode.h"
21#include "llvm/iOther.h"
Chris Lattnerfee714f2001-09-07 16:36:04 +000022#include "llvm/SymbolTable.h"
Chris Lattner2e9fa6d2002-04-09 19:48:49 +000023#include "llvm/Argument.h"
Chris Lattner5de22042001-11-27 00:03:19 +000024#include "Support/StringExtras.h"
25#include "Support/STLExtras.h"
Chris Lattnerfee714f2001-09-07 16:36:04 +000026#include <algorithm>
Chris Lattner7bfee412001-10-29 16:05:51 +000027#include <map>
Chris Lattner7f74a562002-01-20 22:54:45 +000028using std::string;
29using std::map;
30using std::vector;
31using std::ostream;
Chris Lattner7bfee412001-10-29 16:05:51 +000032
Chris Lattnerb86620e2001-10-29 16:37:48 +000033static const Module *getModuleFromVal(const Value *V) {
Chris Lattner2e9fa6d2002-04-09 19:48:49 +000034 if (const Argument *MA = dyn_cast<const Argument>(V))
Chris Lattnerb86620e2001-10-29 16:37:48 +000035 return MA->getParent() ? MA->getParent()->getParent() : 0;
36 else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V))
37 return BB->getParent() ? BB->getParent()->getParent() : 0;
38 else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
Chris Lattner57698e22002-03-26 18:01:55 +000039 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
Chris Lattnerb86620e2001-10-29 16:37:48 +000040 return M ? M->getParent() : 0;
Chris Lattner57698e22002-03-26 18:01:55 +000041 } else if (const GlobalValue *GV = dyn_cast<const GlobalValue>(V))
Chris Lattnerb86620e2001-10-29 16:37:48 +000042 return GV->getParent();
43 else if (const Module *Mod = dyn_cast<const Module>(V))
44 return Mod;
45 return 0;
46}
47
Chris Lattner7bfee412001-10-29 16:05:51 +000048static SlotCalculator *createSlotCalculator(const Value *V) {
49 assert(!isa<Type>(V) && "Can't create an SC for a type!");
Chris Lattner2e9fa6d2002-04-09 19:48:49 +000050 if (const Argument *FA = dyn_cast<const Argument>(V)) {
Chris Lattner57698e22002-03-26 18:01:55 +000051 return new SlotCalculator(FA->getParent(), true);
Chris Lattner7bfee412001-10-29 16:05:51 +000052 } else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
53 return new SlotCalculator(I->getParent()->getParent(), true);
54 } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V)) {
55 return new SlotCalculator(BB->getParent(), true);
Chris Lattner57698e22002-03-26 18:01:55 +000056 } else if (const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V)){
Chris Lattner7bfee412001-10-29 16:05:51 +000057 return new SlotCalculator(GV->getParent(), true);
Chris Lattner57698e22002-03-26 18:01:55 +000058 } else if (const Function *Func = dyn_cast<const Function>(V)) {
59 return new SlotCalculator(Func, true);
Chris Lattner7bfee412001-10-29 16:05:51 +000060 } else if (const Module *Mod = dyn_cast<const Module>(V)) {
61 return new SlotCalculator(Mod, true);
62 }
63 return 0;
64}
Chris Lattner2f7c9632001-06-06 20:29:01 +000065
Chris Lattner5e5abe32001-07-20 19:15:21 +000066// WriteAsOperand - Write the name of the specified value out to the specified
67// ostream. This can be useful when you just want to print int %reg126, not the
68// whole instruction that generated it.
69//
Chris Lattnerb86620e2001-10-29 16:37:48 +000070static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
71 SlotCalculator *Table) {
Chris Lattnerfee714f2001-09-07 16:36:04 +000072 if (PrintName && V->hasName()) {
Chris Lattner5e5abe32001-07-20 19:15:21 +000073 Out << " %" << V->getName();
74 } else {
Chris Lattner3462ae32001-12-03 22:26:30 +000075 if (const Constant *CPV = dyn_cast<const Constant>(V)) {
Chris Lattner5e5abe32001-07-20 19:15:21 +000076 Out << " " << CPV->getStrValue();
77 } else {
78 int Slot;
79 if (Table) {
80 Slot = Table->getValSlot(V);
81 } else {
Chris Lattnerb86620e2001-10-29 16:37:48 +000082 if (const Type *Ty = dyn_cast<const Type>(V)) {
83 Out << " " << Ty->getDescription();
84 return;
85 }
Chris Lattner7bfee412001-10-29 16:05:51 +000086
87 Table = createSlotCalculator(V);
Chris Lattnerb86620e2001-10-29 16:37:48 +000088 if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
Chris Lattner7bfee412001-10-29 16:05:51 +000089
Chris Lattner5e5abe32001-07-20 19:15:21 +000090 Slot = Table->getValSlot(V);
91 delete Table;
92 }
93 if (Slot >= 0) Out << " %" << Slot;
94 else if (PrintName)
95 Out << "<badref>"; // Not embeded into a location?
96 }
97 }
Chris Lattnerb86620e2001-10-29 16:37:48 +000098}
99
100
101// If the module has a symbol table, take all global types and stuff their
102// names into the TypeNames map.
103//
104static void fillTypeNameTable(const Module *M,
105 map<const Type *, string> &TypeNames) {
106 if (M && M->hasSymbolTable()) {
107 const SymbolTable *ST = M->getSymbolTable();
108 SymbolTable::const_iterator PI = ST->find(Type::TypeTy);
109 if (PI != ST->end()) {
110 SymbolTable::type_const_iterator I = PI->second.begin();
111 for (; I != PI->second.end(); ++I) {
112 // As a heuristic, don't insert pointer to primitive types, because
113 // they are used too often to have a single useful name.
114 //
115 const Type *Ty = cast<const Type>(I->second);
116 if (!isa<PointerType>(Ty) ||
Chris Lattner2413b162001-12-04 00:03:30 +0000117 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
Chris Lattner7f74a562002-01-20 22:54:45 +0000118 TypeNames.insert(std::make_pair(Ty, "%"+I->first));
Chris Lattnerb86620e2001-10-29 16:37:48 +0000119 }
120 }
121 }
122}
123
124
125
126static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
127 map<const Type *, string> &TypeNames) {
128 if (Ty->isPrimitiveType()) return Ty->getDescription(); // Base case
129
130 // Check to see if the type is named.
131 map<const Type *, string>::iterator I = TypeNames.find(Ty);
132 if (I != TypeNames.end()) return I->second;
133
134 // Check to see if the Type is already on the stack...
135 unsigned Slot = 0, CurSize = TypeStack.size();
136 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
137
138 // This is another base case for the recursion. In this case, we know
139 // that we have looped back to a type that we have previously visited.
140 // Generate the appropriate upreference to handle this.
141 //
142 if (Slot < CurSize)
143 return "\\" + utostr(CurSize-Slot); // Here's the upreference
144
145 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
146
147 string Result;
148 switch (Ty->getPrimitiveID()) {
Chris Lattner91db5822002-03-29 03:44:36 +0000149 case Type::FunctionTyID: {
150 const FunctionType *MTy = cast<const FunctionType>(Ty);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000151 Result = calcTypeName(MTy->getReturnType(), TypeStack, TypeNames) + " (";
Chris Lattner91db5822002-03-29 03:44:36 +0000152 for (FunctionType::ParamTypes::const_iterator
Chris Lattnerb86620e2001-10-29 16:37:48 +0000153 I = MTy->getParamTypes().begin(),
154 E = MTy->getParamTypes().end(); I != E; ++I) {
155 if (I != MTy->getParamTypes().begin())
156 Result += ", ";
157 Result += calcTypeName(*I, TypeStack, TypeNames);
158 }
159 if (MTy->isVarArg()) {
160 if (!MTy->getParamTypes().empty()) Result += ", ";
161 Result += "...";
162 }
163 Result += ")";
164 break;
165 }
166 case Type::StructTyID: {
167 const StructType *STy = cast<const StructType>(Ty);
168 Result = "{ ";
169 for (StructType::ElementTypes::const_iterator
170 I = STy->getElementTypes().begin(),
171 E = STy->getElementTypes().end(); I != E; ++I) {
172 if (I != STy->getElementTypes().begin())
173 Result += ", ";
174 Result += calcTypeName(*I, TypeStack, TypeNames);
175 }
176 Result += " }";
177 break;
178 }
179 case Type::PointerTyID:
Chris Lattner2413b162001-12-04 00:03:30 +0000180 Result = calcTypeName(cast<const PointerType>(Ty)->getElementType(),
Chris Lattnerb86620e2001-10-29 16:37:48 +0000181 TypeStack, TypeNames) + " *";
182 break;
183 case Type::ArrayTyID: {
184 const ArrayType *ATy = cast<const ArrayType>(Ty);
185 int NumElements = ATy->getNumElements();
186 Result = "[";
187 if (NumElements != -1) Result += itostr(NumElements) + " x ";
188 Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
189 break;
190 }
191 default:
192 assert(0 && "Unhandled case in getTypeProps!");
193 Result = "<error>";
194 }
195
196 TypeStack.pop_back(); // Remove self from stack...
197 return Result;
198}
199
200
201// printTypeInt - The internal guts of printing out a type that has a
202// potentially named portion.
203//
204static ostream &printTypeInt(ostream &Out, const Type *Ty,
205 map<const Type *, string> &TypeNames) {
206 // Primitive types always print out their description, regardless of whether
207 // they have been named or not.
208 //
209 if (Ty->isPrimitiveType()) return Out << Ty->getDescription();
210
211 // Check to see if the type is named.
212 map<const Type *, string>::iterator I = TypeNames.find(Ty);
213 if (I != TypeNames.end()) return Out << I->second;
214
215 // Otherwise we have a type that has not been named but is a derived type.
216 // Carefully recurse the type hierarchy to print out any contained symbolic
217 // names.
218 //
219 vector<const Type *> TypeStack;
220 string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
Chris Lattner7f74a562002-01-20 22:54:45 +0000221 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
Chris Lattnerb86620e2001-10-29 16:37:48 +0000222 return Out << TypeName;
223}
224
Chris Lattner34b95182001-10-31 04:33:19 +0000225
Chris Lattnerb86620e2001-10-29 16:37:48 +0000226// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
227// type, iff there is an entry in the modules symbol table for the specified
228// type or one of it's component types. This is slower than a simple x << Type;
229//
230ostream &WriteTypeSymbolic(ostream &Out, const Type *Ty, const Module *M) {
231 Out << " ";
232
233 // If they want us to print out a type, attempt to make it symbolic if there
234 // is a symbol table in the module...
235 if (M && M->hasSymbolTable()) {
236 map<const Type *, string> TypeNames;
237 fillTypeNameTable(M, TypeNames);
238
Chris Lattner72f866e2001-10-29 16:40:32 +0000239 return printTypeInt(Out, Ty, TypeNames);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000240 } else {
Chris Lattner72f866e2001-10-29 16:40:32 +0000241 return Out << Ty->getDescription();
Chris Lattnerb86620e2001-10-29 16:37:48 +0000242 }
243}
244
245
246// WriteAsOperand - Write the name of the specified value out to the specified
247// ostream. This can be useful when you just want to print int %reg126, not the
248// whole instruction that generated it.
249//
250ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType,
251 bool PrintName, SlotCalculator *Table) {
Chris Lattner72f866e2001-10-29 16:40:32 +0000252 if (PrintType)
253 WriteTypeSymbolic(Out, V->getType(), getModuleFromVal(V));
Chris Lattnerb86620e2001-10-29 16:37:48 +0000254
255 WriteAsOperandInternal(Out, V, PrintName, Table);
Chris Lattner5e5abe32001-07-20 19:15:21 +0000256 return Out;
257}
258
259
Chris Lattner2e9fee42001-07-12 23:35:26 +0000260
Chris Lattnerfee714f2001-09-07 16:36:04 +0000261class AssemblyWriter {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000262 ostream &Out;
263 SlotCalculator &Table;
Chris Lattner7bfee412001-10-29 16:05:51 +0000264 const Module *TheModule;
265 map<const Type *, string> TypeNames;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000266public:
Chris Lattner7bfee412001-10-29 16:05:51 +0000267 inline AssemblyWriter(ostream &o, SlotCalculator &Tab, const Module *M)
268 : Out(o), Table(Tab), TheModule(M) {
269
270 // If the module has a symbol table, take all global types and stuff their
271 // names into the TypeNames map.
272 //
Chris Lattnerb86620e2001-10-29 16:37:48 +0000273 fillTypeNameTable(M, TypeNames);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000274 }
275
Chris Lattner7bfee412001-10-29 16:05:51 +0000276 inline void write(const Module *M) { printModule(M); }
277 inline void write(const GlobalVariable *G) { printGlobal(G); }
Chris Lattner57698e22002-03-26 18:01:55 +0000278 inline void write(const Function *F) { printFunction(F); }
Chris Lattner7bfee412001-10-29 16:05:51 +0000279 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
280 inline void write(const Instruction *I) { printInstruction(I); }
Chris Lattner3462ae32001-12-03 22:26:30 +0000281 inline void write(const Constant *CPV) { printConstant(CPV); }
Chris Lattner7db79582001-11-07 04:21:57 +0000282 inline void write(const Type *Ty) { printType(Ty); }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000283
Chris Lattner2f7c9632001-06-06 20:29:01 +0000284private :
Chris Lattner7bfee412001-10-29 16:05:51 +0000285 void printModule(const Module *M);
286 void printSymbolTable(const SymbolTable &ST);
Chris Lattner3462ae32001-12-03 22:26:30 +0000287 void printConstant(const Constant *CPV);
Chris Lattner7bfee412001-10-29 16:05:51 +0000288 void printGlobal(const GlobalVariable *GV);
Chris Lattner57698e22002-03-26 18:01:55 +0000289 void printFunction(const Function *F);
Chris Lattner2e9fa6d2002-04-09 19:48:49 +0000290 void printArgument(const Argument *FA);
Chris Lattner7bfee412001-10-29 16:05:51 +0000291 void printBasicBlock(const BasicBlock *BB);
292 void printInstruction(const Instruction *I);
293 ostream &printType(const Type *Ty);
294
Chris Lattner2f7c9632001-06-06 20:29:01 +0000295 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
Chris Lattner862e3382001-10-13 06:42:36 +0000296
297 // printInfoComment - Print a little comment after the instruction indicating
298 // which slot it occupies.
299 void printInfoComment(const Value *V);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000300};
301
302
Chris Lattnerfee714f2001-09-07 16:36:04 +0000303void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
304 bool PrintName) {
Chris Lattner7bfee412001-10-29 16:05:51 +0000305 if (PrintType) { Out << " "; printType(Operand->getType()); }
Chris Lattnerb86620e2001-10-29 16:37:48 +0000306 WriteAsOperandInternal(Out, Operand, PrintName, &Table);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000307}
308
Chris Lattner2f7c9632001-06-06 20:29:01 +0000309
Chris Lattner7bfee412001-10-29 16:05:51 +0000310void AssemblyWriter::printModule(const Module *M) {
Chris Lattnerfee714f2001-09-07 16:36:04 +0000311 // Loop over the symbol table, emitting all named constants...
312 if (M->hasSymbolTable())
Chris Lattner7bfee412001-10-29 16:05:51 +0000313 printSymbolTable(*M->getSymbolTable());
Chris Lattnerda975502001-09-10 07:58:01 +0000314
315 for_each(M->gbegin(), M->gend(),
Chris Lattner7bfee412001-10-29 16:05:51 +0000316 bind_obj(this, &AssemblyWriter::printGlobal));
Chris Lattnerfee714f2001-09-07 16:36:04 +0000317
Vikram S. Adve13ba19a2001-09-18 12:48:16 +0000318 Out << "implementation\n";
319
Chris Lattner6915f8f2002-04-07 22:49:37 +0000320 // Output all of the functions...
Chris Lattner57698e22002-03-26 18:01:55 +0000321 for_each(M->begin(), M->end(), bind_obj(this,&AssemblyWriter::printFunction));
Chris Lattnerfee714f2001-09-07 16:36:04 +0000322}
323
Chris Lattner7bfee412001-10-29 16:05:51 +0000324void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
Chris Lattnerda975502001-09-10 07:58:01 +0000325 if (GV->hasName()) Out << "%" << GV->getName() << " = ";
Chris Lattner37798642001-09-18 04:01:05 +0000326
Chris Lattner841d8b92001-11-26 18:54:16 +0000327 if (GV->hasInternalLinkage()) Out << "internal ";
Chris Lattner37798642001-09-18 04:01:05 +0000328 if (!GV->hasInitializer()) Out << "uninitialized ";
329
Chris Lattner7bfee412001-10-29 16:05:51 +0000330 Out << (GV->isConstant() ? "constant " : "global ");
Chris Lattner2413b162001-12-04 00:03:30 +0000331 printType(GV->getType()->getElementType());
Chris Lattner37798642001-09-18 04:01:05 +0000332
333 if (GV->hasInitializer())
334 writeOperand(GV->getInitializer(), false, false);
335
Chris Lattner862e3382001-10-13 06:42:36 +0000336 printInfoComment(GV);
Chris Lattner7f74a562002-01-20 22:54:45 +0000337 Out << "\n";
Chris Lattnerda975502001-09-10 07:58:01 +0000338}
339
Chris Lattnerfee714f2001-09-07 16:36:04 +0000340
Chris Lattner7bfee412001-10-29 16:05:51 +0000341// printSymbolTable - Run through symbol table looking for named constants
Chris Lattnerfee714f2001-09-07 16:36:04 +0000342// if a named constant is found, emit it's declaration...
343//
Chris Lattner7bfee412001-10-29 16:05:51 +0000344void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
Chris Lattnerfee714f2001-09-07 16:36:04 +0000345 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
346 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
347 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
348
349 for (; I != End; ++I) {
350 const Value *V = I->second;
Chris Lattner3462ae32001-12-03 22:26:30 +0000351 if (const Constant *CPV = dyn_cast<const Constant>(V)) {
Chris Lattner7bfee412001-10-29 16:05:51 +0000352 printConstant(CPV);
Chris Lattner38569342001-10-01 20:11:19 +0000353 } else if (const Type *Ty = dyn_cast<const Type>(V)) {
Chris Lattner7f74a562002-01-20 22:54:45 +0000354 Out << "\t%" << I->first << " = type " << Ty->getDescription() << "\n";
Chris Lattnerfee714f2001-09-07 16:36:04 +0000355 }
356 }
Chris Lattnera7620d92001-07-15 06:35:59 +0000357 }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000358}
359
360
Chris Lattner7bfee412001-10-29 16:05:51 +0000361// printConstant - Print out a constant pool entry...
Chris Lattner2f7c9632001-06-06 20:29:01 +0000362//
Chris Lattner3462ae32001-12-03 22:26:30 +0000363void AssemblyWriter::printConstant(const Constant *CPV) {
Chris Lattnerfee714f2001-09-07 16:36:04 +0000364 // Don't print out unnamed constants, they will be inlined
365 if (!CPV->hasName()) return;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000366
Chris Lattneree998be2001-07-26 16:29:38 +0000367 // Print out name...
368 Out << "\t%" << CPV->getName() << " = ";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000369
Chris Lattneree998be2001-07-26 16:29:38 +0000370 // Print out the constant type...
Chris Lattner7bfee412001-10-29 16:05:51 +0000371 printType(CPV->getType());
Chris Lattner2f7c9632001-06-06 20:29:01 +0000372
373 // Write the value out now...
374 writeOperand(CPV, false, false);
375
376 if (!CPV->hasName() && CPV->getType() != Type::VoidTy) {
377 int Slot = Table.getValSlot(CPV); // Print out the def slot taken...
Chris Lattner7bfee412001-10-29 16:05:51 +0000378 Out << "\t\t; <";
379 printType(CPV->getType()) << ">:";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000380 if (Slot >= 0) Out << Slot;
381 else Out << "<badref>";
382 }
383
Chris Lattner7f74a562002-01-20 22:54:45 +0000384 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000385}
386
Chris Lattner6915f8f2002-04-07 22:49:37 +0000387// printFunction - Print all aspects of a function.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000388//
Chris Lattner57698e22002-03-26 18:01:55 +0000389void AssemblyWriter::printFunction(const Function *M) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000390 // Print out the return type and name...
Chris Lattner841d8b92001-11-26 18:54:16 +0000391 Out << "\n" << (M->isExternal() ? "declare " : "")
392 << (M->hasInternalLinkage() ? "internal " : "");
Chris Lattner7bfee412001-10-29 16:05:51 +0000393 printType(M->getReturnType()) << " \"" << M->getName() << "\"(";
Chris Lattner6915f8f2002-04-07 22:49:37 +0000394 Table.incorporateFunction(M);
Chris Lattnerfee714f2001-09-07 16:36:04 +0000395
Chris Lattner7bfee412001-10-29 16:05:51 +0000396 // Loop over the arguments, printing them...
Chris Lattner91db5822002-03-29 03:44:36 +0000397 const FunctionType *MT = M->getFunctionType();
Chris Lattnerfee714f2001-09-07 16:36:04 +0000398
Chris Lattner862e3382001-10-13 06:42:36 +0000399 if (!M->isExternal()) {
400 for_each(M->getArgumentList().begin(), M->getArgumentList().end(),
Chris Lattner2e9fa6d2002-04-09 19:48:49 +0000401 bind_obj(this, &AssemblyWriter::printArgument));
Chris Lattner862e3382001-10-13 06:42:36 +0000402 } else {
Chris Lattner7bfee412001-10-29 16:05:51 +0000403 // Loop over the arguments, printing them...
Chris Lattner91db5822002-03-29 03:44:36 +0000404 const FunctionType *MT = M->getFunctionType();
405 for (FunctionType::ParamTypes::const_iterator I = MT->getParamTypes().begin(),
Chris Lattner862e3382001-10-13 06:42:36 +0000406 E = MT->getParamTypes().end(); I != E; ++I) {
407 if (I != MT->getParamTypes().begin()) Out << ", ";
Chris Lattner7bfee412001-10-29 16:05:51 +0000408 printType(*I);
Chris Lattner862e3382001-10-13 06:42:36 +0000409 }
410 }
Chris Lattnerfee714f2001-09-07 16:36:04 +0000411
412 // Finish printing arguments...
Chris Lattnerfee714f2001-09-07 16:36:04 +0000413 if (MT->isVarArg()) {
414 if (MT->getParamTypes().size()) Out << ", ";
415 Out << "..."; // Output varargs portion of signature!
416 }
417 Out << ")\n";
418
419 if (!M->isExternal()) {
420 // Loop over the symbol table, emitting all named constants...
421 if (M->hasSymbolTable())
Chris Lattner7bfee412001-10-29 16:05:51 +0000422 printSymbolTable(*M->getSymbolTable());
Chris Lattnerfee714f2001-09-07 16:36:04 +0000423
424 Out << "begin";
425
Chris Lattner6915f8f2002-04-07 22:49:37 +0000426 // Output all of its basic blocks... for the function
Chris Lattnerfee714f2001-09-07 16:36:04 +0000427 for_each(M->begin(), M->end(),
Chris Lattner7bfee412001-10-29 16:05:51 +0000428 bind_obj(this, &AssemblyWriter::printBasicBlock));
Chris Lattnerfee714f2001-09-07 16:36:04 +0000429
Chris Lattnera7620d92001-07-15 06:35:59 +0000430 Out << "end\n";
Chris Lattnerfee714f2001-09-07 16:36:04 +0000431 }
432
Chris Lattner6915f8f2002-04-07 22:49:37 +0000433 Table.purgeFunction();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000434}
435
Chris Lattner2e9fa6d2002-04-09 19:48:49 +0000436// printArgument - This member is called for every argument that
Chris Lattner6915f8f2002-04-07 22:49:37 +0000437// is passed into the function. Simply print it out
Chris Lattner2f7c9632001-06-06 20:29:01 +0000438//
Chris Lattner2e9fa6d2002-04-09 19:48:49 +0000439void AssemblyWriter::printArgument(const Argument *Arg) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000440 // Insert commas as we go... the first arg doesn't get a comma
441 if (Arg != Arg->getParent()->getArgumentList().front()) Out << ", ";
442
443 // Output type...
Chris Lattner7bfee412001-10-29 16:05:51 +0000444 printType(Arg->getType());
Chris Lattner2f7c9632001-06-06 20:29:01 +0000445
446 // Output name, if available...
447 if (Arg->hasName())
448 Out << " %" << Arg->getName();
449 else if (Table.getValSlot(Arg) < 0)
450 Out << "<badref>";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000451}
452
Chris Lattner7bfee412001-10-29 16:05:51 +0000453// printBasicBlock - This member is called for each basic block in a methd.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000454//
Chris Lattner7bfee412001-10-29 16:05:51 +0000455void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000456 if (BB->hasName()) { // Print out the label if it exists...
Chris Lattnera2f01872001-06-07 16:58:55 +0000457 Out << "\n" << BB->getName() << ":";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000458 } else {
459 int Slot = Table.getValSlot(BB);
Chris Lattnera2f01872001-06-07 16:58:55 +0000460 Out << "\n; <label>:";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000461 if (Slot >= 0)
Chris Lattnera2f01872001-06-07 16:58:55 +0000462 Out << Slot; // Extra newline seperates out label's
Chris Lattner2f7c9632001-06-06 20:29:01 +0000463 else
Chris Lattnera2f01872001-06-07 16:58:55 +0000464 Out << "<badref>";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000465 }
Chris Lattnera2f01872001-06-07 16:58:55 +0000466 Out << "\t\t\t\t\t;[#uses=" << BB->use_size() << "]\n"; // Output # uses
Chris Lattner2f7c9632001-06-06 20:29:01 +0000467
Chris Lattnerfee714f2001-09-07 16:36:04 +0000468 // Output all of the instructions in the basic block...
469 for_each(BB->begin(), BB->end(),
Chris Lattner7bfee412001-10-29 16:05:51 +0000470 bind_obj(this, &AssemblyWriter::printInstruction));
Chris Lattner2f7c9632001-06-06 20:29:01 +0000471}
472
Chris Lattner862e3382001-10-13 06:42:36 +0000473
474// printInfoComment - Print a little comment after the instruction indicating
475// which slot it occupies.
476//
477void AssemblyWriter::printInfoComment(const Value *V) {
478 if (V->getType() != Type::VoidTy) {
Chris Lattner7bfee412001-10-29 16:05:51 +0000479 Out << "\t\t; <";
480 printType(V->getType()) << ">";
Chris Lattner862e3382001-10-13 06:42:36 +0000481
482 if (!V->hasName()) {
483 int Slot = Table.getValSlot(V); // Print out the def slot taken...
484 if (Slot >= 0) Out << ":" << Slot;
485 else Out << ":<badref>";
486 }
Chris Lattner3cb3a1f2001-12-14 16:29:12 +0000487 Out << " [#uses=" << V->use_size() << "]"; // Output # uses
Chris Lattner862e3382001-10-13 06:42:36 +0000488 }
489}
490
Chris Lattner7bfee412001-10-29 16:05:51 +0000491// printInstruction - This member is called for each Instruction in a methd.
Chris Lattner2f7c9632001-06-06 20:29:01 +0000492//
Chris Lattner7bfee412001-10-29 16:05:51 +0000493void AssemblyWriter::printInstruction(const Instruction *I) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000494 Out << "\t";
495
496 // Print out name if it exists...
497 if (I && I->hasName())
498 Out << "%" << I->getName() << " = ";
499
500 // Print out the opcode...
Chris Lattnerb1ca9cb2001-07-07 19:24:15 +0000501 Out << I->getOpcodeName();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000502
503 // Print out the type of the operands...
Chris Lattnera073acb2001-07-07 08:36:50 +0000504 const Value *Operand = I->getNumOperands() ? I->getOperand(0) : 0;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000505
506 // Special case conditional branches to swizzle the condition out to the front
Chris Lattnerb1ca9cb2001-07-07 19:24:15 +0000507 if (I->getOpcode() == Instruction::Br && I->getNumOperands() > 1) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000508 writeOperand(I->getOperand(2), true);
509 Out << ",";
510 writeOperand(Operand, true);
511 Out << ",";
512 writeOperand(I->getOperand(1), true);
513
Chris Lattnerb1ca9cb2001-07-07 19:24:15 +0000514 } else if (I->getOpcode() == Instruction::Switch) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000515 // Special case switch statement to get formatting nice and correct...
516 writeOperand(Operand , true); Out << ",";
517 writeOperand(I->getOperand(1), true); Out << " [";
518
Chris Lattnera073acb2001-07-07 08:36:50 +0000519 for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; op += 2) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000520 Out << "\n\t\t";
Chris Lattnera073acb2001-07-07 08:36:50 +0000521 writeOperand(I->getOperand(op ), true); Out << ",";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000522 writeOperand(I->getOperand(op+1), true);
523 }
524 Out << "\n\t]";
Chris Lattnerda558102001-10-02 03:41:24 +0000525 } else if (isa<PHINode>(I)) {
Chris Lattner7bfee412001-10-29 16:05:51 +0000526 Out << " ";
Chris Lattner29644b32001-11-06 01:48:45 +0000527 printType(I->getType());
Chris Lattner9d3292d2001-11-06 08:33:46 +0000528 Out << " ";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000529
Chris Lattner29644b32001-11-06 01:48:45 +0000530 for (unsigned op = 0, Eop = I->getNumOperands(); op < Eop; op += 2) {
531 if (op) Out << ", ";
532 Out << "[";
Chris Lattnera073acb2001-07-07 08:36:50 +0000533 writeOperand(I->getOperand(op ), false); Out << ",";
Chris Lattner4b94e232001-06-21 05:29:56 +0000534 writeOperand(I->getOperand(op+1), false); Out << " ]";
Chris Lattner931ef3b2001-06-11 15:04:20 +0000535 }
Chris Lattner862e3382001-10-13 06:42:36 +0000536 } else if (isa<ReturnInst>(I) && !Operand) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000537 Out << " void";
Chris Lattner862e3382001-10-13 06:42:36 +0000538 } else if (isa<CallInst>(I)) {
Chris Lattner2f2d9472001-11-06 21:28:12 +0000539 const PointerType *PTy = dyn_cast<PointerType>(Operand->getType());
Chris Lattner91db5822002-03-29 03:44:36 +0000540 const FunctionType*MTy = PTy ? dyn_cast<FunctionType>(PTy->getElementType()):0;
Chris Lattner2f2d9472001-11-06 21:28:12 +0000541 const Type *RetTy = MTy ? MTy->getReturnType() : 0;
542
543 // If possible, print out the short form of the call instruction, but we can
Chris Lattner6915f8f2002-04-07 22:49:37 +0000544 // only do this if the first argument is a pointer to a nonvararg function,
545 // and if the value returned is not a pointer to a function.
Chris Lattner2f2d9472001-11-06 21:28:12 +0000546 //
547 if (RetTy && !MTy->isVarArg() &&
Chris Lattner91db5822002-03-29 03:44:36 +0000548 (!isa<PointerType>(RetTy)||!isa<FunctionType>(cast<PointerType>(RetTy)))){
Chris Lattner2f2d9472001-11-06 21:28:12 +0000549 Out << " "; printType(RetTy);
550 writeOperand(Operand, false);
551 } else {
552 writeOperand(Operand, true);
553 }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000554 Out << "(";
Chris Lattnera073acb2001-07-07 08:36:50 +0000555 if (I->getNumOperands() > 1) writeOperand(I->getOperand(1), true);
556 for (unsigned op = 2, Eop = I->getNumOperands(); op < Eop; ++op) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000557 Out << ",";
Chris Lattnera073acb2001-07-07 08:36:50 +0000558 writeOperand(I->getOperand(op), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000559 }
560
561 Out << " )";
Chris Lattner862e3382001-10-13 06:42:36 +0000562 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(I)) {
563 // TODO: Should try to print out short form of the Invoke instruction
564 writeOperand(Operand, true);
565 Out << "(";
566 if (I->getNumOperands() > 3) writeOperand(I->getOperand(3), true);
567 for (unsigned op = 4, Eop = I->getNumOperands(); op < Eop; ++op) {
568 Out << ",";
569 writeOperand(I->getOperand(op), true);
570 }
571
572 Out << " )\n\t\t\tto";
573 writeOperand(II->getNormalDest(), true);
574 Out << " except";
575 writeOperand(II->getExceptionalDest(), true);
576
Chris Lattnerb1ca9cb2001-07-07 19:24:15 +0000577 } else if (I->getOpcode() == Instruction::Malloc ||
578 I->getOpcode() == Instruction::Alloca) {
Chris Lattner7bfee412001-10-29 16:05:51 +0000579 Out << " ";
Chris Lattner2413b162001-12-04 00:03:30 +0000580 printType(cast<const PointerType>(I->getType())->getElementType());
Chris Lattnera073acb2001-07-07 08:36:50 +0000581 if (I->getNumOperands()) {
582 Out << ",";
583 writeOperand(I->getOperand(0), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000584 }
Chris Lattner862e3382001-10-13 06:42:36 +0000585 } else if (isa<CastInst>(I)) {
Chris Lattnera6821822001-07-08 04:57:15 +0000586 writeOperand(Operand, true);
Chris Lattner7bfee412001-10-29 16:05:51 +0000587 Out << " to ";
588 printType(I->getType());
Chris Lattner2f7c9632001-06-06 20:29:01 +0000589 } else if (Operand) { // Print the normal way...
590
591 // PrintAllTypes - Instructions who have operands of all the same type
592 // omit the type from all but the first operand. If the instruction has
593 // different type operands (for example br), then they are all printed.
594 bool PrintAllTypes = false;
595 const Type *TheType = Operand->getType();
Chris Lattner2f7c9632001-06-06 20:29:01 +0000596
Chris Lattnera073acb2001-07-07 08:36:50 +0000597 for (unsigned i = 1, E = I->getNumOperands(); i != E; ++i) {
598 Operand = I->getOperand(i);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000599 if (Operand->getType() != TheType) {
600 PrintAllTypes = true; // We have differing types! Print them all!
601 break;
602 }
603 }
604
Chris Lattnerb6fe2342001-10-20 09:33:10 +0000605 // Shift Left & Right print both types even for Ubyte LHS
606 if (isa<ShiftInst>(I)) PrintAllTypes = true;
607
Chris Lattner7bfee412001-10-29 16:05:51 +0000608 if (!PrintAllTypes) {
609 Out << " ";
610 printType(I->getOperand(0)->getType());
611 }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000612
Chris Lattnera073acb2001-07-07 08:36:50 +0000613 for (unsigned i = 0, E = I->getNumOperands(); i != E; ++i) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000614 if (i) Out << ",";
Chris Lattnera073acb2001-07-07 08:36:50 +0000615 writeOperand(I->getOperand(i), PrintAllTypes);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000616 }
617 }
618
Chris Lattner862e3382001-10-13 06:42:36 +0000619 printInfoComment(I);
Chris Lattner7f74a562002-01-20 22:54:45 +0000620 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +0000621}
622
623
Chris Lattner7bfee412001-10-29 16:05:51 +0000624// printType - Go to extreme measures to attempt to print out a short, symbolic
625// version of a type name.
626//
627ostream &AssemblyWriter::printType(const Type *Ty) {
Chris Lattnerb86620e2001-10-29 16:37:48 +0000628 return printTypeInt(Out, Ty, TypeNames);
Chris Lattner7bfee412001-10-29 16:05:51 +0000629}
630
631
Chris Lattner2f7c9632001-06-06 20:29:01 +0000632//===----------------------------------------------------------------------===//
633// External Interface declarations
634//===----------------------------------------------------------------------===//
635
636
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000637void Module::print(std::ostream &o) const {
638 SlotCalculator SlotTable(this, true);
639 AssemblyWriter W(o, SlotTable, this);
640 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000641}
642
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000643void GlobalVariable::print(std::ostream &o) const {
644 SlotCalculator SlotTable(getParent(), true);
645 AssemblyWriter W(o, SlotTable, getParent());
646 W.write(this);
Chris Lattneradfe0d12001-09-10 20:08:19 +0000647}
648
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000649void Function::print(std::ostream &o) const {
650 SlotCalculator SlotTable(getParent(), true);
651 AssemblyWriter W(o, SlotTable, getParent());
Chris Lattner2f7c9632001-06-06 20:29:01 +0000652
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000653 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000654}
655
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000656void BasicBlock::print(std::ostream &o) const {
657 SlotCalculator SlotTable(getParent(), true);
Chris Lattner7bfee412001-10-29 16:05:51 +0000658 AssemblyWriter W(o, SlotTable,
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000659 getParent() ? getParent()->getParent() : 0);
660 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000661}
662
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000663void Instruction::print(std::ostream &o) const {
664 const Function *F = getParent() ? getParent()->getParent() : 0;
Chris Lattner57698e22002-03-26 18:01:55 +0000665 SlotCalculator SlotTable(F, true);
666 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000667
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000668 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000669}
Chris Lattner7db79582001-11-07 04:21:57 +0000670
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000671void Constant::print(std::ostream &o) const {
672 if (this == 0) { o << "<null> constant value\n"; return; }
673 o << " " << getType()->getDescription() << " " << getStrValue();
674}
675
676void Type::print(std::ostream &o) const {
677 if (this == 0)
678 o << "<null Type>";
679 else
680 o << getDescription();
681}
682
Chris Lattner2e9fa6d2002-04-09 19:48:49 +0000683void Argument::print(std::ostream &o) const {
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +0000684 o << getType() << " " << getName();
685}
686
687void Value::dump() const { print(std::cerr); }
688
689//===----------------------------------------------------------------------===//
690// CachedWriter Class Implementation
691//===----------------------------------------------------------------------===//
692
Chris Lattner7db79582001-11-07 04:21:57 +0000693void CachedWriter::setModule(const Module *M) {
694 delete SC; delete AW;
695 if (M) {
696 SC = new SlotCalculator(M, true);
697 AW = new AssemblyWriter(Out, *SC, M);
698 } else {
699 SC = 0; AW = 0;
700 }
701}
702
703CachedWriter::~CachedWriter() {
704 delete AW;
705 delete SC;
706}
707
708CachedWriter &CachedWriter::operator<<(const Value *V) {
709 assert(AW && SC && "CachedWriter does not have a current module!");
710 switch (V->getValueType()) {
711 case Value::ConstantVal:
712 Out << " "; AW->write(V->getType());
Chris Lattner3462ae32001-12-03 22:26:30 +0000713 Out << " " << cast<Constant>(V)->getStrValue(); break;
Chris Lattner2e9fa6d2002-04-09 19:48:49 +0000714 case Value::ArgumentVal:
Chris Lattner7db79582001-11-07 04:21:57 +0000715 AW->write(V->getType()); Out << " " << V->getName(); break;
716 case Value::TypeVal: AW->write(cast<const Type>(V)); break;
717 case Value::InstructionVal: AW->write(cast<Instruction>(V)); break;
718 case Value::BasicBlockVal: AW->write(cast<BasicBlock>(V)); break;
Chris Lattner57698e22002-03-26 18:01:55 +0000719 case Value::FunctionVal: AW->write(cast<Function>(V)); break;
Chris Lattner7db79582001-11-07 04:21:57 +0000720 case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
721 case Value::ModuleVal: AW->write(cast<Module>(V)); break;
722 default: Out << "<unknown value type: " << V->getValueType() << ">"; break;
723 }
724 return *this;
725}