lib/VMCore/AsmWriter.cpp

   1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
   2 //
   3 // This library implements the functionality defined in llvm/Assembly/Writer.h
   4 //
   5 // Note that these routines must be extremely tolerant of various errors in the
   6 // LLVM code, because of of the primary uses of it is for debugging
   7 // transformations.
   8 //
   9 //===----------------------------------------------------------------------===//
  10
  11 #include "llvm/Assembly/CachedWriter.h"
  12 #include "llvm/Assembly/Writer.h"
  13 #include "llvm/SlotCalculator.h"
  14 #include "llvm/DerivedTypes.h"
  15 #include "llvm/Module.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/iMemory.h"
  18 #include "llvm/iTerminators.h"
  19 #include "llvm/iPHINode.h"
  20 #include "llvm/iOther.h"
  21 #include "llvm/SymbolTable.h"
  22 #include "Support/StringExtras.h"
  23 #include "Support/STLExtras.h"
  24 #include <algorithm>
  25 using std::string;
  26 using std::map;
  27 using std::vector;
  28 using std::ostream;
  29
  30 static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
  31                                    map<const Type *, string> &TypeTable,
  32                                    SlotCalculator *Table);
  33
  34 static const Module *getModuleFromVal(const Value *V) {
  35   if (const Argument *MA = dyn_cast<const Argument>(V))
  36     return MA->getParent() ? MA->getParent()->getParent() : 0;
  37   else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V))
  38     return BB->getParent() ? BB->getParent()->getParent() : 0;
  39   else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
  40     const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
  41     return M ? M->getParent() : 0;
  42   } else if (const GlobalValue *GV = dyn_cast<const GlobalValue>(V))
  43     return GV->getParent();
  44   return 0;
  45 }
  46
  47 static SlotCalculator *createSlotCalculator(const Value *V) {
  48   assert(!isa<Type>(V) && "Can't create an SC for a type!");
  49   if (const Argument *FA = dyn_cast<const Argument>(V)) {
  50     return new SlotCalculator(FA->getParent(), true);
  51   } else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
  52     return new SlotCalculator(I->getParent()->getParent(), true);
  53   } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V)) {
  54     return new SlotCalculator(BB->getParent(), true);
  55   } else if (const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V)){
  56     return new SlotCalculator(GV->getParent(), true);
  57   } else if (const Function *Func = dyn_cast<const Function>(V)) {
  58     return new SlotCalculator(Func, true);
  59   }
  60   return 0;
  61 }
  62
  63
  64 // If the module has a symbol table, take all global types and stuff their
  65 // names into the TypeNames map.
  66 //
  67 static void fillTypeNameTable(const Module *M,
  68                               map<const Type *, string> &TypeNames) {
  69   if (M && M->hasSymbolTable()) {
  70     const SymbolTable *ST = M->getSymbolTable();
  71     SymbolTable::const_iterator PI = ST->find(Type::TypeTy);
  72     if (PI != ST->end()) {
  73       SymbolTable::type_const_iterator I = PI->second.begin();
  74       for (; I != PI->second.end(); ++I) {
  75         // As a heuristic, don't insert pointer to primitive types, because
  76         // they are used too often to have a single useful name.
  77         //
  78         const Type *Ty = cast<const Type>(I->second);
  79         if (!isa<PointerType>(Ty) ||
  80             !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
  81           TypeNames.insert(std::make_pair(Ty, "%"+I->first));
  82       }
  83     }
  84   }
  85 }
  86
  87
  88
  89 static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
  90                            map<const Type *, string> &TypeNames) {
  91   if (Ty->isPrimitiveType()) return Ty->getDescription();  // Base case
  92
  93   // Check to see if the type is named.
  94   map<const Type *, string>::iterator I = TypeNames.find(Ty);
  95   if (I != TypeNames.end()) return I->second;
  96
  97   // Check to see if the Type is already on the stack...
  98   unsigned Slot = 0, CurSize = TypeStack.size();
  99   while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
 100
 101   // This is another base case for the recursion.  In this case, we know
 102   // that we have looped back to a type that we have previously visited.
 103   // Generate the appropriate upreference to handle this.
 104   //
 105   if (Slot < CurSize)
 106     return "\\" + utostr(CurSize-Slot);       // Here's the upreference
 107
 108   TypeStack.push_back(Ty);    // Recursive case: Add us to the stack..
 109
 110   string Result;
 111   switch (Ty->getPrimitiveID()) {
 112   case Type::FunctionTyID: {
 113     const FunctionType *FTy = cast<const FunctionType>(Ty);
 114     Result = calcTypeName(FTy->getReturnType(), TypeStack, TypeNames) + " (";
 115     for (FunctionType::ParamTypes::const_iterator
 116            I = FTy->getParamTypes().begin(),
 117            E = FTy->getParamTypes().end(); I != E; ++I) {
 118       if (I != FTy->getParamTypes().begin())
 119         Result += ", ";
 120       Result += calcTypeName(*I, TypeStack, TypeNames);
 121     }
 122     if (FTy->isVarArg()) {
 123       if (!FTy->getParamTypes().empty()) Result += ", ";
 124       Result += "...";
 125     }
 126     Result += ")";
 127     break;
 128   }
 129   case Type::StructTyID: {
 130     const StructType *STy = cast<const StructType>(Ty);
 131     Result = "{ ";
 132     for (StructType::ElementTypes::const_iterator
 133            I = STy->getElementTypes().begin(),
 134            E = STy->getElementTypes().end(); I != E; ++I) {
 135       if (I != STy->getElementTypes().begin())
 136         Result += ", ";
 137       Result += calcTypeName(*I, TypeStack, TypeNames);
 138     }
 139     Result += " }";
 140     break;
 141   }
 142   case Type::PointerTyID:
 143     Result = calcTypeName(cast<const PointerType>(Ty)->getElementType(),
 144                           TypeStack, TypeNames) + "*";
 145     break;
 146   case Type::ArrayTyID: {
 147     const ArrayType *ATy = cast<const ArrayType>(Ty);
 148     Result = "[" + utostr(ATy->getNumElements()) + " x ";
 149     Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
 150     break;
 151   }
 152   default:
 153     assert(0 && "Unhandled case in getTypeProps!");
 154     Result = "<error>";
 155   }
 156
 157   TypeStack.pop_back();       // Remove self from stack...
 158   return Result;
 159 }
 160
 161
 162 // printTypeInt - The internal guts of printing out a type that has a
 163 // potentially named portion.
 164 //
 165 static ostream &printTypeInt(ostream &Out, const Type *Ty,
 166                              map<const Type *, string> &TypeNames) {
 167   // Primitive types always print out their description, regardless of whether
 168   // they have been named or not.
 169   //
 170   if (Ty->isPrimitiveType()) return Out << Ty->getDescription();
 171
 172   // Check to see if the type is named.
 173   map<const Type *, string>::iterator I = TypeNames.find(Ty);
 174   if (I != TypeNames.end()) return Out << I->second;
 175
 176   // Otherwise we have a type that has not been named but is a derived type.
 177   // Carefully recurse the type hierarchy to print out any contained symbolic
 178   // names.
 179   //
 180   vector<const Type *> TypeStack;
 181   string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
 182   TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
 183   return Out << TypeName;
 184 }
 185
 186
 187 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
 188 // type, iff there is an entry in the modules symbol table for the specified
 189 // type or one of it's component types.  This is slower than a simple x << Type;
 190 //
 191 ostream &WriteTypeSymbolic(ostream &Out, const Type *Ty, const Module *M) {
 192   Out << " ";
 193
 194   // If they want us to print out a type, attempt to make it symbolic if there
 195   // is a symbol table in the module...
 196   if (M && M->hasSymbolTable()) {
 197     map<const Type *, string> TypeNames;
 198     fillTypeNameTable(M, TypeNames);
 199
 200     return printTypeInt(Out, Ty, TypeNames);
 201   } else {
 202     return Out << Ty->getDescription();
 203   }
 204 }
 205
 206 static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
 207                              map<const Type *, string> &TypeTable,
 208                              SlotCalculator *Table) {
 209   if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
 210     Out << (CB == ConstantBool::True ? "true" : "false");
 211   } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
 212     Out << CI->getValue();
 213   } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
 214     Out << CI->getValue();
 215   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 216     // We would like to output the FP constant value in exponential notation,
 217     // but we cannot do this if doing so will lose precision.  Check here to
 218     // make sure that we only output it in exponential format if we can parse
 219     // the value back and get the same value.
 220     //
 221     std::string StrVal = ftostr(CFP->getValue());
 222
 223     // Check to make sure that the stringized number is not some string like
 224     // "Inf" or NaN, that atof will accept, but the lexer will not.  Check that
 225     // the string matches the "[-+]?[0-9]" regex.
 226     //
 227     if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
 228         ((StrVal[0] == '-' || StrVal[0] == '+') &&
 229          (StrVal[0] >= '0' && StrVal[0] <= '9')))
 230       // Reparse stringized version!
 231       if (atof(StrVal.c_str()) == CFP->getValue()) {
 232         Out << StrVal; return;
 233       }
 234
 235     // Otherwise we could not reparse it to exactly the same value, so we must
 236     // output the string in hexadecimal format!
 237     //
 238     // Behave nicely in the face of C TBAA rules... see:
 239     // http://www.nullstone.com/htmls/category/aliastyp.htm
 240     //
 241     double Val = CFP->getValue();
 242     char *Ptr = (char*)&Val;
 243     assert(sizeof(double) == sizeof(uint64_t) && sizeof(double) == 8 &&
 244            "assuming that double is 64 bits!");
 245     Out << "0x" << utohexstr(*(uint64_t*)Ptr);
 246
 247   } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 248     // As a special case, print the array as a string if it is an array of
 249     // ubytes or an array of sbytes with positive values.
 250     //
 251     const Type *ETy = CA->getType()->getElementType();
 252     bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
 253
 254     if (ETy == Type::SByteTy)
 255       for (unsigned i = 0; i < CA->getNumOperands(); ++i)
 256         if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
 257           isString = false;
 258           break;
 259         }
 260
 261     if (isString) {
 262       Out << "c\"";
 263       for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
 264         unsigned char C = (ETy == Type::SByteTy) ?
 265           (unsigned char)cast<ConstantSInt>(CA->getOperand(i))->getValue() :
 266           (unsigned char)cast<ConstantUInt>(CA->getOperand(i))->getValue();
 267
 268         if (isprint(C)) {
 269           Out << C;
 270         } else {
 271           Out << '\\'
 272               << (char) ((C/16  < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
 273               << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
 274         }
 275       }
 276       Out << "\"";
 277
 278     } else {                // Cannot output in string format...
 279       Out << "[";
 280       if (CA->getNumOperands()) {
 281         Out << " ";
 282         printTypeInt(Out, ETy, TypeTable);
 283         WriteAsOperandInternal(Out, CA->getOperand(0),
 284                                PrintName, TypeTable, Table);
 285         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
 286           Out << ", ";
 287           printTypeInt(Out, ETy, TypeTable);
 288           WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
 289                                  TypeTable, Table);
 290         }
 291       }
 292       Out << " ]";
 293     }
 294   } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
 295     Out << "{";
 296     if (CS->getNumOperands()) {
 297       Out << " ";
 298       printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
 299
 300       WriteAsOperandInternal(Out, CS->getOperand(0),
 301                              PrintName, TypeTable, Table);
 302
 303       for (unsigned i = 1; i < CS->getNumOperands(); i++) {
 304         Out << ", ";
 305         printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
 306
 307         WriteAsOperandInternal(Out, CS->getOperand(i),
 308                                PrintName, TypeTable, Table);
 309       }
 310     }
 311
 312     Out << " }";
 313   } else if (isa<ConstantPointerNull>(CV)) {
 314     Out << "null";
 315
 316   } else if (const ConstantPointerRef *PR = dyn_cast<ConstantPointerRef>(CV)) {
 317     const GlobalValue *V = PR->getValue();
 318     if (V->hasName()) {
 319       Out << "%" << V->getName();
 320     } else if (Table) {
 321       int Slot = Table->getValSlot(V);
 322       if (Slot >= 0)
 323         Out << "%" << Slot;
 324       else
 325         Out << "<pointer reference badref>";
 326     } else {
 327       Out << "<pointer reference without context info>";
 328     }
 329   } else {
 330     assert(0 && "Unrecognized constant value!!!");
 331   }
 332 }
 333
 334
 335 // WriteAsOperand - Write the name of the specified value out to the specified
 336 // ostream.  This can be useful when you just want to print int %reg126, not the
 337 // whole instruction that generated it.
 338 //
 339 static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
 340                                    map<const Type *, string> &TypeTable,
 341                                    SlotCalculator *Table) {
 342   Out << " ";
 343   if (PrintName && V->hasName()) {
 344     Out << "%" << V->getName();
 345   } else {
 346     if (const Constant *CV = dyn_cast<const Constant>(V)) {
 347       WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
 348     } else {
 349       int Slot;
 350       if (Table) {
 351         Slot = Table->getValSlot(V);
 352       } else {
 353         if (const Type *Ty = dyn_cast<const Type>(V)) {
 354           Out << Ty->getDescription();
 355           return;
 356         }
 357
 358         Table = createSlotCalculator(V);
 359         if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
 360
 361         Slot = Table->getValSlot(V);
 362         delete Table;
 363       }
 364       if (Slot >= 0)  Out << "%" << Slot;
 365       else if (PrintName)
 366         Out << "<badref>";     // Not embeded into a location?
 367     }
 368   }
 369 }
 370
 371
 372
 373 // WriteAsOperand - Write the name of the specified value out to the specified
 374 // ostream.  This can be useful when you just want to print int %reg126, not the
 375 // whole instruction that generated it.
 376 //
 377 ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType,
 378                         bool PrintName, SlotCalculator *Table) {
 379   map<const Type *, string> TypeNames;
 380   const Module *M = getModuleFromVal(V);
 381
 382   if (M && M->hasSymbolTable())
 383     fillTypeNameTable(M, TypeNames);
 384
 385   if (PrintType)
 386     printTypeInt(Out, V->getType(), TypeNames);
 387
 388   WriteAsOperandInternal(Out, V, PrintName, TypeNames, Table);
 389   return Out;
 390 }
 391
 392
 393
 394 class AssemblyWriter {
 395   ostream &Out;
 396   SlotCalculator &Table;
 397   const Module *TheModule;
 398   map<const Type *, string> TypeNames;
 399 public:
 400   inline AssemblyWriter(ostream &o, SlotCalculator &Tab, const Module *M)
 401     : Out(o), Table(Tab), TheModule(M) {
 402
 403     // If the module has a symbol table, take all global types and stuff their
 404     // names into the TypeNames map.
 405     //
 406     fillTypeNameTable(M, TypeNames);
 407   }
 408
 409   inline void write(const Module *M)         { printModule(M);      }
 410   inline void write(const GlobalVariable *G) { printGlobal(G);      }
 411   inline void write(const Function *F)       { printFunction(F);    }
 412   inline void write(const BasicBlock *BB)    { printBasicBlock(BB); }
 413   inline void write(const Instruction *I)    { printInstruction(*I); }
 414   inline void write(const Constant *CPV)     { printConstant(CPV);  }
 415   inline void write(const Type *Ty)          { printType(Ty);       }
 416
 417   void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
 418
 419 private :
 420   void printModule(const Module *M);
 421   void printSymbolTable(const SymbolTable &ST);
 422   void printConstant(const Constant *CPV);
 423   void printGlobal(const GlobalVariable *GV);
 424   void printFunction(const Function *F);
 425   void printArgument(const Argument *FA);
 426   void printBasicBlock(const BasicBlock *BB);
 427   void printInstruction(const Instruction &I);
 428
 429   // printType - Go to extreme measures to attempt to print out a short,
 430   // symbolic version of a type name.
 431   //
 432   ostream &printType(const Type *Ty) {
 433     return printTypeInt(Out, Ty, TypeNames);
 434   }
 435
 436   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 437   // without considering any symbolic types that we may have equal to it.
 438   //
 439   ostream &printTypeAtLeastOneLevel(const Type *Ty);
 440
 441   // printInfoComment - Print a little comment after the instruction indicating
 442   // which slot it occupies.
 443   void printInfoComment(const Value &V);
 444 };
 445
 446
 447 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 448 // without considering any symbolic types that we may have equal to it.
 449 //
 450 ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 451   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 452     printType(FTy->getReturnType()) << " (";
 453     for (FunctionType::ParamTypes::const_iterator
 454            I = FTy->getParamTypes().begin(),
 455            E = FTy->getParamTypes().end(); I != E; ++I) {
 456       if (I != FTy->getParamTypes().begin())
 457         Out << ", ";
 458       printType(*I);
 459     }
 460     if (FTy->isVarArg()) {
 461       if (!FTy->getParamTypes().empty()) Out << ", ";
 462       Out << "...";
 463     }
 464     Out << ")";
 465   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 466     Out << "{ ";
 467     for (StructType::ElementTypes::const_iterator
 468            I = STy->getElementTypes().begin(),
 469            E = STy->getElementTypes().end(); I != E; ++I) {
 470       if (I != STy->getElementTypes().begin())
 471         Out << ", ";
 472       printType(*I);
 473     }
 474     Out << " }";
 475   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 476     printType(PTy->getElementType()) << "*";
 477   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 478     Out << "[" << ATy->getNumElements() << " x ";
 479     printType(ATy->getElementType()) << "]";
 480   } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
 481     Out << OTy->getDescription();
 482   } else {
 483     assert(Ty->isPrimitiveType() && "Unknown derived type!");
 484     printType(Ty);
 485   }
 486   return Out;
 487 }
 488
 489
 490 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
 491                                   bool PrintName) {
 492   if (PrintType) { Out << " "; printType(Operand->getType()); }
 493   WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Table);
 494 }
 495
 496
 497 void AssemblyWriter::printModule(const Module *M) {
 498   // Loop over the symbol table, emitting all named constants...
 499   if (M->hasSymbolTable())
 500     printSymbolTable(*M->getSymbolTable());
 501
 502   for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 503     printGlobal(I);
 504
 505   Out << "\nimplementation   ; Functions:\n";
 506
 507   // Output all of the functions...
 508   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 509     printFunction(I);
 510 }
 511
 512 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 513   if (GV->hasName()) Out << "%" << GV->getName() << " = ";
 514
 515   if (GV->hasInternalLinkage()) Out << "internal ";
 516   if (!GV->hasInitializer()) Out << "uninitialized ";
 517
 518   Out << (GV->isConstant() ? "constant " : "global ");
 519   printType(GV->getType()->getElementType());
 520
 521   if (GV->hasInitializer())
 522     writeOperand(GV->getInitializer(), false, false);
 523
 524   printInfoComment(*GV);
 525   Out << "\n";
 526 }
 527
 528
 529 // printSymbolTable - Run through symbol table looking for named constants
 530 // if a named constant is found, emit it's declaration...
 531 //
 532 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
 533   for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
 534     SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
 535     SymbolTable::type_const_iterator End = ST.type_end(TI->first);
 536
 537     for (; I != End; ++I) {
 538       const Value *V = I->second;
 539       if (const Constant *CPV = dyn_cast<const Constant>(V)) {
 540         printConstant(CPV);
 541       } else if (const Type *Ty = dyn_cast<const Type>(V)) {
 542         Out << "\t%" << I->first << " = type ";
 543
 544         // Make sure we print out at least one level of the type structure, so
 545         // that we do not get %FILE = type %FILE
 546         //
 547         printTypeAtLeastOneLevel(Ty) << "\n";
 548       }
 549     }
 550   }
 551 }
 552
 553
 554 // printConstant - Print out a constant pool entry...
 555 //
 556 void AssemblyWriter::printConstant(const Constant *CPV) {
 557   // Don't print out unnamed constants, they will be inlined
 558   if (!CPV->hasName()) return;
 559
 560   // Print out name...
 561   Out << "\t%" << CPV->getName() << " =";
 562
 563   // Write the value out now...
 564   writeOperand(CPV, true, false);
 565
 566   printInfoComment(*CPV);
 567   Out << "\n";
 568 }
 569
 570 // printFunction - Print all aspects of a function.
 571 //
 572 void AssemblyWriter::printFunction(const Function *F) {
 573   // Print out the return type and name...
 574   Out << "\n" << (F->isExternal() ? "declare " : "")
 575       << (F->hasInternalLinkage() ? "internal " : "");
 576   printType(F->getReturnType()) << " %" << F->getName() << "(";
 577   Table.incorporateFunction(F);
 578
 579   // Loop over the arguments, printing them...
 580   const FunctionType *FT = F->getFunctionType();
 581
 582   if (!F->isExternal()) {
 583     for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
 584       printArgument(I);
 585   } else {
 586     // Loop over the arguments, printing them...
 587     for (FunctionType::ParamTypes::const_iterator I = FT->getParamTypes().begin(),
 588            E = FT->getParamTypes().end(); I != E; ++I) {
 589       if (I != FT->getParamTypes().begin()) Out << ", ";
 590       printType(*I);
 591     }
 592   }
 593
 594   // Finish printing arguments...
 595   if (FT->isVarArg()) {
 596     if (FT->getParamTypes().size()) Out << ", ";
 597     Out << "...";  // Output varargs portion of signature!
 598   }
 599   Out << ")";
 600
 601   if (F->isExternal()) {
 602     Out << "\n";
 603   } else {
 604     Out << " {";
 605
 606     // Output all of its basic blocks... for the function
 607     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
 608       printBasicBlock(I);
 609
 610     Out << "}\n";
 611   }
 612
 613   Table.purgeFunction();
 614 }
 615
 616 // printArgument - This member is called for every argument that
 617 // is passed into the function.  Simply print it out
 618 //
 619 void AssemblyWriter::printArgument(const Argument *Arg) {
 620   // Insert commas as we go... the first arg doesn't get a comma
 621   if (Arg != &Arg->getParent()->afront()) Out << ", ";
 622
 623   // Output type...
 624   printType(Arg->getType());
 625
 626   // Output name, if available...
 627   if (Arg->hasName())
 628     Out << " %" << Arg->getName();
 629   else if (Table.getValSlot(Arg) < 0)
 630     Out << "<badref>";
 631 }
 632
 633 // printBasicBlock - This member is called for each basic block in a methd.
 634 //
 635 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
 636   if (BB->hasName()) {              // Print out the label if it exists...
 637     Out << "\n" << BB->getName() << ":\t\t\t\t\t;[#uses="
 638         << BB->use_size() << "]";  // Output # uses
 639   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
 640     int Slot = Table.getValSlot(BB);
 641     Out << "\n; <label>:";
 642     if (Slot >= 0)
 643       Out << Slot;         // Extra newline seperates out label's
 644     else
 645       Out << "<badref>";
 646     Out << "\t\t\t\t\t;[#uses=" << BB->use_size() << "]";  // Output # uses
 647   }
 648
 649   Out << "\n";
 650
 651   // Output all of the instructions in the basic block...
 652   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 653     printInstruction(*I);
 654 }
 655
 656
 657 // printInfoComment - Print a little comment after the instruction indicating
 658 // which slot it occupies.
 659 //
 660 void AssemblyWriter::printInfoComment(const Value &V) {
 661   if (V.getType() != Type::VoidTy) {
 662     Out << "\t\t; <";
 663     printType(V.getType()) << ">";
 664
 665     if (!V.hasName()) {
 666       int Slot = Table.getValSlot(&V); // Print out the def slot taken...
 667       if (Slot >= 0) Out << ":" << Slot;
 668       else Out << ":<badref>";
 669     }
 670     Out << " [#uses=" << V.use_size() << "]";  // Output # uses
 671   }
 672 }
 673
 674 // printInstruction - This member is called for each Instruction in a methd.
 675 //
 676 void AssemblyWriter::printInstruction(const Instruction &I) {
 677   Out << "\t";
 678
 679   // Print out name if it exists...
 680   if (I.hasName())
 681     Out << "%" << I.getName() << " = ";
 682
 683   // Print out the opcode...
 684   Out << I.getOpcodeName();
 685
 686   // Print out the type of the operands...
 687   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
 688
 689   // Special case conditional branches to swizzle the condition out to the front
 690   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
 691     writeOperand(I.getOperand(2), true);
 692     Out << ",";
 693     writeOperand(Operand, true);
 694     Out << ",";
 695     writeOperand(I.getOperand(1), true);
 696
 697   } else if (isa<SwitchInst>(I)) {
 698     // Special case switch statement to get formatting nice and correct...
 699     writeOperand(Operand        , true); Out << ",";
 700     writeOperand(I.getOperand(1), true); Out << " [";
 701
 702     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
 703       Out << "\n\t\t";
 704       writeOperand(I.getOperand(op  ), true); Out << ",";
 705       writeOperand(I.getOperand(op+1), true);
 706     }
 707     Out << "\n\t]";
 708   } else if (isa<PHINode>(I)) {
 709     Out << " ";
 710     printType(I.getType());
 711     Out << " ";
 712
 713     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
 714       if (op) Out << ", ";
 715       Out << "[";
 716       writeOperand(I.getOperand(op  ), false); Out << ",";
 717       writeOperand(I.getOperand(op+1), false); Out << " ]";
 718     }
 719   } else if (isa<ReturnInst>(I) && !Operand) {
 720     Out << " void";
 721   } else if (isa<CallInst>(I)) {
 722     const PointerType *PTy = dyn_cast<PointerType>(Operand->getType());
 723     const FunctionType*MTy = PTy ? dyn_cast<FunctionType>(PTy->getElementType()):0;
 724     const Type      *RetTy = MTy ? MTy->getReturnType() : 0;
 725
 726     // If possible, print out the short form of the call instruction, but we can
 727     // only do this if the first argument is a pointer to a nonvararg function,
 728     // and if the value returned is not a pointer to a function.
 729     //
 730     if (RetTy && MTy && !MTy->isVarArg() &&
 731         (!isa<PointerType>(RetTy) ||
 732          !isa<FunctionType>(cast<PointerType>(RetTy)))) {
 733       Out << " "; printType(RetTy);
 734       writeOperand(Operand, false);
 735     } else {
 736       writeOperand(Operand, true);
 737     }
 738     Out << "(";
 739     if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
 740     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
 741       Out << ",";
 742       writeOperand(I.getOperand(op), true);
 743     }
 744
 745     Out << " )";
 746   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 747     // TODO: Should try to print out short form of the Invoke instruction
 748     writeOperand(Operand, true);
 749     Out << "(";
 750     if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
 751     for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
 752       Out << ",";
 753       writeOperand(I.getOperand(op), true);
 754     }
 755
 756     Out << " )\n\t\t\tto";
 757     writeOperand(II->getNormalDest(), true);
 758     Out << " except";
 759     writeOperand(II->getExceptionalDest(), true);
 760
 761   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
 762     Out << " ";
 763     printType(AI->getType()->getElementType());
 764     if (AI->isArrayAllocation()) {
 765       Out << ",";
 766       writeOperand(AI->getArraySize(), true);
 767     }
 768   } else if (isa<CastInst>(I)) {
 769     if (Operand) writeOperand(Operand, true);
 770     Out << " to ";
 771     printType(I.getType());
 772   } else if (Operand) {   // Print the normal way...
 773
 774     // PrintAllTypes - Instructions who have operands of all the same type
 775     // omit the type from all but the first operand.  If the instruction has
 776     // different type operands (for example br), then they are all printed.
 777     bool PrintAllTypes = false;
 778     const Type *TheType = Operand->getType();
 779
 780     for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
 781       Operand = I.getOperand(i);
 782       if (Operand->getType() != TheType) {
 783         PrintAllTypes = true;       // We have differing types!  Print them all!
 784         break;
 785       }
 786     }
 787
 788     // Shift Left & Right print both types even for Ubyte LHS
 789     if (isa<ShiftInst>(I)) PrintAllTypes = true;
 790
 791     if (!PrintAllTypes) {
 792       Out << " ";
 793       printType(I.getOperand(0)->getType());
 794     }
 795
 796     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
 797       if (i) Out << ",";
 798       writeOperand(I.getOperand(i), PrintAllTypes);
 799     }
 800   }
 801
 802   printInfoComment(I);
 803   Out << "\n";
 804 }
 805
 806
 807 //===----------------------------------------------------------------------===//
 808 //                       External Interface declarations
 809 //===----------------------------------------------------------------------===//
 810
 811
 812 void Module::print(std::ostream &o) const {
 813   SlotCalculator SlotTable(this, true);
 814   AssemblyWriter W(o, SlotTable, this);
 815   W.write(this);
 816 }
 817
 818 void GlobalVariable::print(std::ostream &o) const {
 819   SlotCalculator SlotTable(getParent(), true);
 820   AssemblyWriter W(o, SlotTable, getParent());
 821   W.write(this);
 822 }
 823
 824 void Function::print(std::ostream &o) const {
 825   SlotCalculator SlotTable(getParent(), true);
 826   AssemblyWriter W(o, SlotTable, getParent());
 827
 828   W.write(this);
 829 }
 830
 831 void BasicBlock::print(std::ostream &o) const {
 832   SlotCalculator SlotTable(getParent(), true);
 833   AssemblyWriter W(o, SlotTable,
 834                    getParent() ? getParent()->getParent() : 0);
 835   W.write(this);
 836 }
 837
 838 void Instruction::print(std::ostream &o) const {
 839   const Function *F = getParent() ? getParent()->getParent() : 0;
 840   SlotCalculator SlotTable(F, true);
 841   AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0);
 842
 843   W.write(this);
 844 }
 845
 846 void Constant::print(std::ostream &o) const {
 847   if (this == 0) { o << "<null> constant value\n"; return; }
 848   o << " " << getType()->getDescription() << " ";
 849
 850   map<const Type *, string> TypeTable;
 851   WriteConstantInt(o, this, false, TypeTable, 0);
 852 }
 853
 854 void Type::print(std::ostream &o) const {
 855   if (this == 0)
 856     o << "<null Type>";
 857   else
 858     o << getDescription();
 859 }
 860
 861 void Argument::print(std::ostream &o) const {
 862   o << getType() << " " << getName();
 863 }
 864
 865 void Value::dump() const { print(std::cerr); }
 866
 867 //===----------------------------------------------------------------------===//
 868 //  CachedWriter Class Implementation
 869 //===----------------------------------------------------------------------===//
 870
 871 void CachedWriter::setModule(const Module *M) {
 872   delete SC; delete AW;
 873   if (M) {
 874     SC = new SlotCalculator(M, true);
 875     AW = new AssemblyWriter(Out, *SC, M);
 876   } else {
 877     SC = 0; AW = 0;
 878   }
 879 }
 880
 881 CachedWriter::~CachedWriter() {
 882   delete AW;
 883   delete SC;
 884 }
 885
 886 CachedWriter &CachedWriter::operator<<(const Value *V) {
 887   assert(AW && SC && "CachedWriter does not have a current module!");
 888   switch (V->getValueType()) {
 889   case Value::ConstantVal:
 890   case Value::ArgumentVal:       AW->writeOperand(V, true, true); break;
 891   case Value::TypeVal:           AW->write(cast<const Type>(V)); break;
 892   case Value::InstructionVal:    AW->write(cast<Instruction>(V)); break;
 893   case Value::BasicBlockVal:     AW->write(cast<BasicBlock>(V)); break;
 894   case Value::FunctionVal:       AW->write(cast<Function>(V)); break;
 895   case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
 896   default: Out << "<unknown value type: " << V->getValueType() << ">"; break;
 897   }
 898   return *this;
 899 }