1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // This library implements the functionality defined in llvm/Assembly/Writer.h
5 // Note that these routines must be extremely tolerant of various errors in the
6 // LLVM code, because it can be used for debugging transformations.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Assembly/CachedWriter.h"
11 #include "llvm/Assembly/Writer.h"
12 #include "llvm/Assembly/PrintModulePass.h"
13 #include "llvm/SlotCalculator.h"
14 #include "llvm/DerivedTypes.h"
15 #include "llvm/Instruction.h"
16 #include "llvm/Module.h"
17 #include "llvm/Constants.h"
18 #include "llvm/iMemory.h"
19 #include "llvm/iTerminators.h"
20 #include "llvm/iPHINode.h"
21 #include "llvm/iOther.h"
22 #include "llvm/SymbolTable.h"
23 #include "llvm/Support/CFG.h"
24 #include "Support/StringExtras.h"
25 #include "Support/STLExtras.h"
28 static RegisterPass<PrintModulePass>
29 X("printm", "Print module to stderr",PassInfo::Analysis|PassInfo::Optimization);
30 static RegisterPass<PrintFunctionPass>
31 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
33 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
35 std::map<const Type *, std::string> &TypeTable,
36 SlotCalculator *Table);
38 static const Module *getModuleFromVal(const Value *V) {
39 if (const Argument *MA = dyn_cast<const Argument>(V))
40 return MA->getParent() ? MA->getParent()->getParent() : 0;
41 else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V))
42 return BB->getParent() ? BB->getParent()->getParent() : 0;
43 else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
44 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
45 return M ? M->getParent() : 0;
46 } else if (const GlobalValue *GV = dyn_cast<const GlobalValue>(V))
47 return GV->getParent();
51 static SlotCalculator *createSlotCalculator(const Value *V) {
52 assert(!isa<Type>(V) && "Can't create an SC for a type!");
53 if (const Argument *FA = dyn_cast<const Argument>(V)) {
54 return new SlotCalculator(FA->getParent(), true);
55 } else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
56 return new SlotCalculator(I->getParent()->getParent(), true);
57 } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V)) {
58 return new SlotCalculator(BB->getParent(), true);
59 } else if (const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V)){
60 return new SlotCalculator(GV->getParent(), true);
61 } else if (const Function *Func = dyn_cast<const Function>(V)) {
62 return new SlotCalculator(Func, true);
68 // If the module has a symbol table, take all global types and stuff their
69 // names into the TypeNames map.
71 static void fillTypeNameTable(const Module *M,
72 std::map<const Type *, std::string> &TypeNames) {
74 const SymbolTable &ST = M->getSymbolTable();
75 SymbolTable::const_iterator PI = ST.find(Type::TypeTy);
77 SymbolTable::type_const_iterator I = PI->second.begin();
78 for (; I != PI->second.end(); ++I) {
79 // As a heuristic, don't insert pointer to primitive types, because
80 // they are used too often to have a single useful name.
82 const Type *Ty = cast<const Type>(I->second);
83 if (!isa<PointerType>(Ty) ||
84 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
85 TypeNames.insert(std::make_pair(Ty, "%"+I->first));
92 static std::string calcTypeName(const Type *Ty,
93 std::vector<const Type *> &TypeStack,
94 std::map<const Type *, std::string> &TypeNames){
95 if (Ty->isPrimitiveType()) return Ty->getDescription(); // Base case
97 // Check to see if the type is named.
98 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
99 if (I != TypeNames.end()) return I->second;
101 // Check to see if the Type is already on the stack...
102 unsigned Slot = 0, CurSize = TypeStack.size();
103 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
105 // This is another base case for the recursion. In this case, we know
106 // that we have looped back to a type that we have previously visited.
107 // Generate the appropriate upreference to handle this.
110 return "\\" + utostr(CurSize-Slot); // Here's the upreference
112 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
115 switch (Ty->getPrimitiveID()) {
116 case Type::FunctionTyID: {
117 const FunctionType *FTy = cast<const FunctionType>(Ty);
118 Result = calcTypeName(FTy->getReturnType(), TypeStack, TypeNames) + " (";
119 for (FunctionType::ParamTypes::const_iterator
120 I = FTy->getParamTypes().begin(),
121 E = FTy->getParamTypes().end(); I != E; ++I) {
122 if (I != FTy->getParamTypes().begin())
124 Result += calcTypeName(*I, TypeStack, TypeNames);
126 if (FTy->isVarArg()) {
127 if (!FTy->getParamTypes().empty()) Result += ", ";
133 case Type::StructTyID: {
134 const StructType *STy = cast<const StructType>(Ty);
136 for (StructType::ElementTypes::const_iterator
137 I = STy->getElementTypes().begin(),
138 E = STy->getElementTypes().end(); I != E; ++I) {
139 if (I != STy->getElementTypes().begin())
141 Result += calcTypeName(*I, TypeStack, TypeNames);
146 case Type::PointerTyID:
147 Result = calcTypeName(cast<const PointerType>(Ty)->getElementType(),
148 TypeStack, TypeNames) + "*";
150 case Type::ArrayTyID: {
151 const ArrayType *ATy = cast<const ArrayType>(Ty);
152 Result = "[" + utostr(ATy->getNumElements()) + " x ";
153 Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
156 case Type::OpaqueTyID:
160 Result = "<unrecognized-type>";
163 TypeStack.pop_back(); // Remove self from stack...
168 // printTypeInt - The internal guts of printing out a type that has a
169 // potentially named portion.
171 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
172 std::map<const Type *, std::string> &TypeNames) {
173 // Primitive types always print out their description, regardless of whether
174 // they have been named or not.
176 if (Ty->isPrimitiveType()) return Out << Ty->getDescription();
178 // Check to see if the type is named.
179 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
180 if (I != TypeNames.end()) return Out << I->second;
182 // Otherwise we have a type that has not been named but is a derived type.
183 // Carefully recurse the type hierarchy to print out any contained symbolic
186 std::vector<const Type *> TypeStack;
187 std::string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
188 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
189 return Out << TypeName;
193 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
194 // type, iff there is an entry in the modules symbol table for the specified
195 // type or one of it's component types. This is slower than a simple x << Type;
197 std::ostream &WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
201 // If they want us to print out a type, attempt to make it symbolic if there
202 // is a symbol table in the module...
204 std::map<const Type *, std::string> TypeNames;
205 fillTypeNameTable(M, TypeNames);
207 return printTypeInt(Out, Ty, TypeNames);
209 return Out << Ty->getDescription();
213 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
215 std::map<const Type *, std::string> &TypeTable,
216 SlotCalculator *Table) {
217 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
218 Out << (CB == ConstantBool::True ? "true" : "false");
219 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
220 Out << CI->getValue();
221 } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
222 Out << CI->getValue();
223 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
224 // We would like to output the FP constant value in exponential notation,
225 // but we cannot do this if doing so will lose precision. Check here to
226 // make sure that we only output it in exponential format if we can parse
227 // the value back and get the same value.
229 std::string StrVal = ftostr(CFP->getValue());
231 // Check to make sure that the stringized number is not some string like
232 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
233 // the string matches the "[-+]?[0-9]" regex.
235 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
236 ((StrVal[0] == '-' || StrVal[0] == '+') &&
237 (StrVal[1] >= '0' && StrVal[1] <= '9')))
238 // Reparse stringized version!
239 if (atof(StrVal.c_str()) == CFP->getValue()) {
240 Out << StrVal; return;
243 // Otherwise we could not reparse it to exactly the same value, so we must
244 // output the string in hexadecimal format!
246 // Behave nicely in the face of C TBAA rules... see:
247 // http://www.nullstone.com/htmls/category/aliastyp.htm
249 double Val = CFP->getValue();
250 char *Ptr = (char*)&Val;
251 assert(sizeof(double) == sizeof(uint64_t) && sizeof(double) == 8 &&
252 "assuming that double is 64 bits!");
253 Out << "0x" << utohexstr(*(uint64_t*)Ptr);
255 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
256 if (CA->getNumOperands() > 5 && CA->isNullValue()) {
257 Out << "zeroinitializer";
261 // As a special case, print the array as a string if it is an array of
262 // ubytes or an array of sbytes with positive values.
264 const Type *ETy = CA->getType()->getElementType();
265 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
267 if (ETy == Type::SByteTy)
268 for (unsigned i = 0; i < CA->getNumOperands(); ++i)
269 if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
276 for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
277 unsigned char C = (ETy == Type::SByteTy) ?
278 (unsigned char)cast<ConstantSInt>(CA->getOperand(i))->getValue() :
279 (unsigned char)cast<ConstantUInt>(CA->getOperand(i))->getValue();
281 if (isprint(C) && C != '"' && C != '\\') {
285 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
286 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
291 } else { // Cannot output in string format...
293 if (CA->getNumOperands()) {
295 printTypeInt(Out, ETy, TypeTable);
296 WriteAsOperandInternal(Out, CA->getOperand(0),
297 PrintName, TypeTable, Table);
298 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
300 printTypeInt(Out, ETy, TypeTable);
301 WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
307 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
308 if (CS->getNumOperands() > 5 && CS->isNullValue()) {
309 Out << "zeroinitializer";
314 if (CS->getNumOperands()) {
316 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
318 WriteAsOperandInternal(Out, CS->getOperand(0),
319 PrintName, TypeTable, Table);
321 for (unsigned i = 1; i < CS->getNumOperands(); i++) {
323 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
325 WriteAsOperandInternal(Out, CS->getOperand(i),
326 PrintName, TypeTable, Table);
331 } else if (isa<ConstantPointerNull>(CV)) {
334 } else if (const ConstantPointerRef *PR = dyn_cast<ConstantPointerRef>(CV)) {
335 const GlobalValue *V = PR->getValue();
337 Out << "%" << V->getName();
339 int Slot = Table->getValSlot(V);
343 Out << "<pointer reference badref>";
345 Out << "<pointer reference without context info>";
348 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
349 Out << CE->getOpcodeName() << " (";
351 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
352 printTypeInt(Out, (*OI)->getType(), TypeTable);
353 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Table);
354 if (OI+1 != CE->op_end())
358 if (CE->getOpcode() == Instruction::Cast) {
360 printTypeInt(Out, CE->getType(), TypeTable);
365 Out << "<placeholder or erroneous Constant>";
370 // WriteAsOperand - Write the name of the specified value out to the specified
371 // ostream. This can be useful when you just want to print int %reg126, not the
372 // whole instruction that generated it.
374 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
376 std::map<const Type*, std::string> &TypeTable,
377 SlotCalculator *Table) {
379 if (PrintName && V->hasName()) {
380 Out << "%" << V->getName();
382 if (const Constant *CV = dyn_cast<const Constant>(V)) {
383 WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
387 Slot = Table->getValSlot(V);
389 if (const Type *Ty = dyn_cast<const Type>(V)) {
390 Out << Ty->getDescription();
394 Table = createSlotCalculator(V);
395 if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
397 Slot = Table->getValSlot(V);
400 if (Slot >= 0) Out << "%" << Slot;
402 Out << "<badref>"; // Not embeded into a location?
409 // WriteAsOperand - Write the name of the specified value out to the specified
410 // ostream. This can be useful when you just want to print int %reg126, not the
411 // whole instruction that generated it.
413 std::ostream &WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
414 bool PrintName, const Module *Context) {
415 std::map<const Type *, std::string> TypeNames;
416 if (Context == 0) Context = getModuleFromVal(V);
419 fillTypeNameTable(Context, TypeNames);
422 printTypeInt(Out, V->getType(), TypeNames);
424 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
430 class AssemblyWriter {
432 SlotCalculator &Table;
433 const Module *TheModule;
434 std::map<const Type *, std::string> TypeNames;
436 inline AssemblyWriter(std::ostream &o, SlotCalculator &Tab, const Module *M)
437 : Out(o), Table(Tab), TheModule(M) {
439 // If the module has a symbol table, take all global types and stuff their
440 // names into the TypeNames map.
442 fillTypeNameTable(M, TypeNames);
445 inline void write(const Module *M) { printModule(M); }
446 inline void write(const GlobalVariable *G) { printGlobal(G); }
447 inline void write(const Function *F) { printFunction(F); }
448 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
449 inline void write(const Instruction *I) { printInstruction(*I); }
450 inline void write(const Constant *CPV) { printConstant(CPV); }
451 inline void write(const Type *Ty) { printType(Ty); }
453 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
456 void printModule(const Module *M);
457 void printSymbolTable(const SymbolTable &ST);
458 void printConstant(const Constant *CPV);
459 void printGlobal(const GlobalVariable *GV);
460 void printFunction(const Function *F);
461 void printArgument(const Argument *FA);
462 void printBasicBlock(const BasicBlock *BB);
463 void printInstruction(const Instruction &I);
465 // printType - Go to extreme measures to attempt to print out a short,
466 // symbolic version of a type name.
468 std::ostream &printType(const Type *Ty) {
469 return printTypeInt(Out, Ty, TypeNames);
472 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
473 // without considering any symbolic types that we may have equal to it.
475 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
477 // printInfoComment - Print a little comment after the instruction indicating
478 // which slot it occupies.
479 void printInfoComment(const Value &V);
483 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
484 // without considering any symbolic types that we may have equal to it.
486 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
487 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
488 printType(FTy->getReturnType()) << " (";
489 for (FunctionType::ParamTypes::const_iterator
490 I = FTy->getParamTypes().begin(),
491 E = FTy->getParamTypes().end(); I != E; ++I) {
492 if (I != FTy->getParamTypes().begin())
496 if (FTy->isVarArg()) {
497 if (!FTy->getParamTypes().empty()) Out << ", ";
501 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
503 for (StructType::ElementTypes::const_iterator
504 I = STy->getElementTypes().begin(),
505 E = STy->getElementTypes().end(); I != E; ++I) {
506 if (I != STy->getElementTypes().begin())
511 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
512 printType(PTy->getElementType()) << "*";
513 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
514 Out << "[" << ATy->getNumElements() << " x ";
515 printType(ATy->getElementType()) << "]";
516 } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
519 if (!Ty->isPrimitiveType())
520 Out << "<unknown derived type>";
527 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
529 if (PrintType) { Out << " "; printType(Operand->getType()); }
530 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Table);
534 void AssemblyWriter::printModule(const Module *M) {
535 Out << "target endian = " << (M->isLittleEndian() ? "little" : "big") << "\n";
536 Out << "target pointersize = " << (M->has32BitPointers() ? 32 : 64) << "\n";
538 // Loop over the symbol table, emitting all named constants...
539 printSymbolTable(M->getSymbolTable());
541 for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
544 Out << "\nimplementation ; Functions:\n";
546 // Output all of the functions...
547 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
551 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
552 if (GV->hasName()) Out << "%" << GV->getName() << " = ";
554 if (!GV->hasInitializer())
557 switch (GV->getLinkage()) {
558 case GlobalValue::InternalLinkage: Out << "internal "; break;
559 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
560 case GlobalValue::AppendingLinkage: Out << "appending "; break;
561 case GlobalValue::ExternalLinkage: break;
564 Out << (GV->isConstant() ? "constant " : "global ");
565 printType(GV->getType()->getElementType());
567 if (GV->hasInitializer())
568 writeOperand(GV->getInitializer(), false, false);
570 printInfoComment(*GV);
575 // printSymbolTable - Run through symbol table looking for named constants
576 // if a named constant is found, emit it's declaration...
578 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
579 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
580 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
581 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
583 for (; I != End; ++I) {
584 const Value *V = I->second;
585 if (const Constant *CPV = dyn_cast<const Constant>(V)) {
587 } else if (const Type *Ty = dyn_cast<const Type>(V)) {
588 Out << "\t%" << I->first << " = type ";
590 // Make sure we print out at least one level of the type structure, so
591 // that we do not get %FILE = type %FILE
593 printTypeAtLeastOneLevel(Ty) << "\n";
600 // printConstant - Print out a constant pool entry...
602 void AssemblyWriter::printConstant(const Constant *CPV) {
603 // Don't print out unnamed constants, they will be inlined
604 if (!CPV->hasName()) return;
607 Out << "\t%" << CPV->getName() << " =";
609 // Write the value out now...
610 writeOperand(CPV, true, false);
612 printInfoComment(*CPV);
616 // printFunction - Print all aspects of a function.
618 void AssemblyWriter::printFunction(const Function *F) {
619 // Print out the return type and name...
625 switch (F->getLinkage()) {
626 case GlobalValue::InternalLinkage: Out << "internal "; break;
627 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
628 case GlobalValue::AppendingLinkage: Out << "appending "; break;
629 case GlobalValue::ExternalLinkage: break;
632 printType(F->getReturnType()) << " %" << F->getName() << "(";
633 Table.incorporateFunction(F);
635 // Loop over the arguments, printing them...
636 const FunctionType *FT = F->getFunctionType();
638 for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
641 // Finish printing arguments...
642 if (FT->isVarArg()) {
643 if (FT->getParamTypes().size()) Out << ", ";
644 Out << "..."; // Output varargs portion of signature!
648 if (F->isExternal()) {
653 // Output all of its basic blocks... for the function
654 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
660 Table.purgeFunction();
663 // printArgument - This member is called for every argument that
664 // is passed into the function. Simply print it out
666 void AssemblyWriter::printArgument(const Argument *Arg) {
667 // Insert commas as we go... the first arg doesn't get a comma
668 if (Arg != &Arg->getParent()->afront()) Out << ", ";
671 printType(Arg->getType());
673 // Output name, if available...
675 Out << " %" << Arg->getName();
676 else if (Table.getValSlot(Arg) < 0)
680 // printBasicBlock - This member is called for each basic block in a methd.
682 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
683 if (BB->hasName()) { // Print out the label if it exists...
684 Out << "\n" << BB->getName() << ":";
685 } else if (!BB->use_empty()) { // Don't print block # of no uses...
686 int Slot = Table.getValSlot(BB);
687 Out << "\n; <label>:";
689 Out << Slot; // Extra newline seperates out label's
694 // Output predecessors for the block...
696 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
699 Out << " No predecessors!";
702 writeOperand(*PI, false, true);
703 for (++PI; PI != PE; ++PI) {
705 writeOperand(*PI, false, true);
711 // Output all of the instructions in the basic block...
712 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
713 printInstruction(*I);
717 // printInfoComment - Print a little comment after the instruction indicating
718 // which slot it occupies.
720 void AssemblyWriter::printInfoComment(const Value &V) {
721 if (V.getType() != Type::VoidTy) {
723 printType(V.getType()) << ">";
726 int Slot = Table.getValSlot(&V); // Print out the def slot taken...
727 if (Slot >= 0) Out << ":" << Slot;
728 else Out << ":<badref>";
730 Out << " [#uses=" << V.use_size() << "]"; // Output # uses
734 // printInstruction - This member is called for each Instruction in a methd.
736 void AssemblyWriter::printInstruction(const Instruction &I) {
739 // Print out name if it exists...
741 Out << "%" << I.getName() << " = ";
743 // Print out the opcode...
744 Out << I.getOpcodeName();
746 // Print out the type of the operands...
747 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
749 // Special case conditional branches to swizzle the condition out to the front
750 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
751 writeOperand(I.getOperand(2), true);
753 writeOperand(Operand, true);
755 writeOperand(I.getOperand(1), true);
757 } else if (isa<SwitchInst>(I)) {
758 // Special case switch statement to get formatting nice and correct...
759 writeOperand(Operand , true); Out << ",";
760 writeOperand(I.getOperand(1), true); Out << " [";
762 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
764 writeOperand(I.getOperand(op ), true); Out << ",";
765 writeOperand(I.getOperand(op+1), true);
768 } else if (isa<PHINode>(I)) {
770 printType(I.getType());
773 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
776 writeOperand(I.getOperand(op ), false); Out << ",";
777 writeOperand(I.getOperand(op+1), false); Out << " ]";
779 } else if (isa<ReturnInst>(I) && !Operand) {
781 } else if (isa<CallInst>(I)) {
782 const PointerType *PTy = dyn_cast<PointerType>(Operand->getType());
783 const FunctionType*MTy = PTy ? dyn_cast<FunctionType>(PTy->getElementType()):0;
784 const Type *RetTy = MTy ? MTy->getReturnType() : 0;
786 // If possible, print out the short form of the call instruction, but we can
787 // only do this if the first argument is a pointer to a nonvararg function,
788 // and if the value returned is not a pointer to a function.
790 if (RetTy && MTy && !MTy->isVarArg() &&
791 (!isa<PointerType>(RetTy) ||
792 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
793 Out << " "; printType(RetTy);
794 writeOperand(Operand, false);
796 writeOperand(Operand, true);
799 if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
800 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
802 writeOperand(I.getOperand(op), true);
806 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
807 // TODO: Should try to print out short form of the Invoke instruction
808 writeOperand(Operand, true);
810 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
811 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
813 writeOperand(I.getOperand(op), true);
816 Out << " )\n\t\t\tto";
817 writeOperand(II->getNormalDest(), true);
819 writeOperand(II->getExceptionalDest(), true);
821 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
823 printType(AI->getType()->getElementType());
824 if (AI->isArrayAllocation()) {
826 writeOperand(AI->getArraySize(), true);
828 } else if (isa<CastInst>(I)) {
829 writeOperand(Operand, true);
831 printType(I.getType());
832 } else if (isa<VarArgInst>(I)) {
833 writeOperand(Operand, true);
835 printType(I.getType());
836 } else if (Operand) { // Print the normal way...
838 // PrintAllTypes - Instructions who have operands of all the same type
839 // omit the type from all but the first operand. If the instruction has
840 // different type operands (for example br), then they are all printed.
841 bool PrintAllTypes = false;
842 const Type *TheType = Operand->getType();
844 // Shift Left & Right print both types even for Ubyte LHS
845 if (isa<ShiftInst>(I)) {
846 PrintAllTypes = true;
848 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
849 Operand = I.getOperand(i);
850 if (Operand->getType() != TheType) {
851 PrintAllTypes = true; // We have differing types! Print them all!
857 if (!PrintAllTypes) {
862 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
864 writeOperand(I.getOperand(i), PrintAllTypes);
873 //===----------------------------------------------------------------------===//
874 // External Interface declarations
875 //===----------------------------------------------------------------------===//
878 void Module::print(std::ostream &o) const {
879 SlotCalculator SlotTable(this, true);
880 AssemblyWriter W(o, SlotTable, this);
884 void GlobalVariable::print(std::ostream &o) const {
885 SlotCalculator SlotTable(getParent(), true);
886 AssemblyWriter W(o, SlotTable, getParent());
890 void Function::print(std::ostream &o) const {
891 SlotCalculator SlotTable(getParent(), true);
892 AssemblyWriter W(o, SlotTable, getParent());
897 void BasicBlock::print(std::ostream &o) const {
898 SlotCalculator SlotTable(getParent(), true);
899 AssemblyWriter W(o, SlotTable,
900 getParent() ? getParent()->getParent() : 0);
904 void Instruction::print(std::ostream &o) const {
905 const Function *F = getParent() ? getParent()->getParent() : 0;
906 SlotCalculator SlotTable(F, true);
907 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0);
912 void Constant::print(std::ostream &o) const {
913 if (this == 0) { o << "<null> constant value\n"; return; }
915 // Handle CPR's special, because they have context information...
916 if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
917 CPR->getValue()->print(o); // Print as a global value, with context info.
921 o << " " << getType()->getDescription() << " ";
923 std::map<const Type *, std::string> TypeTable;
924 WriteConstantInt(o, this, false, TypeTable, 0);
927 void Type::print(std::ostream &o) const {
931 o << getDescription();
934 void Argument::print(std::ostream &o) const {
935 o << getType() << " " << getName();
938 void Value::dump() const { print(std::cerr); }
940 //===----------------------------------------------------------------------===//
941 // CachedWriter Class Implementation
942 //===----------------------------------------------------------------------===//
944 void CachedWriter::setModule(const Module *M) {
945 delete SC; delete AW;
947 SC = new SlotCalculator(M, true);
948 AW = new AssemblyWriter(Out, *SC, M);
954 CachedWriter::~CachedWriter() {
959 CachedWriter &CachedWriter::operator<<(const Value *V) {
960 assert(AW && SC && "CachedWriter does not have a current module!");
961 switch (V->getValueType()) {
962 case Value::ConstantVal:
963 case Value::ArgumentVal: AW->writeOperand(V, true, true); break;
964 case Value::TypeVal: AW->write(cast<const Type>(V)); break;
965 case Value::InstructionVal: AW->write(cast<Instruction>(V)); break;
966 case Value::BasicBlockVal: AW->write(cast<BasicBlock>(V)); break;
967 case Value::FunctionVal: AW->write(cast<Function>(V)); break;
968 case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
969 default: Out << "<unknown value type: " << V->getValueType() << ">"; break;