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 it can be used for debugging transformations.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  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"
  26 #include <algorithm>
  27
  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);
  32
  33 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
  34                                    bool PrintName,
  35                                  std::map<const Type *, std::string> &TypeTable,
  36                                    SlotCalculator *Table);
  37
  38 static const Module *getModuleFromVal(const Value *V) {
  39   if (const Argument *MA = dyn_cast<Argument>(V))
  40     return MA->getParent() ? MA->getParent()->getParent() : 0;
  41   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
  42     return BB->getParent() ? BB->getParent()->getParent() : 0;
  43   else if (const Instruction *I = dyn_cast<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<GlobalValue>(V))
  47     return GV->getParent();
  48   return 0;
  49 }
  50
  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<Argument>(V)) {
  54     return new SlotCalculator(FA->getParent(), true);
  55   } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
  56     return new SlotCalculator(I->getParent()->getParent(), true);
  57   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
  58     return new SlotCalculator(BB->getParent(), true);
  59   } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
  60     return new SlotCalculator(GV->getParent(), true);
  61   } else if (const Function *Func = dyn_cast<Function>(V)) {
  62     return new SlotCalculator(Func, true);
  63   }
  64   return 0;
  65 }
  66
  67
  68 // If the module has a symbol table, take all global types and stuff their
  69 // names into the TypeNames map.
  70 //
  71 static void fillTypeNameTable(const Module *M,
  72                               std::map<const Type *, std::string> &TypeNames) {
  73   if (!M) return;
  74   const SymbolTable &ST = M->getSymbolTable();
  75   SymbolTable::const_iterator PI = ST.find(Type::TypeTy);
  76   if (PI != ST.end()) {
  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.
  81       //
  82       const Type *Ty = cast<Type>(I->second);
  83       if (!isa<PointerType>(Ty) ||
  84           !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
  85         TypeNames.insert(std::make_pair(Ty, "%"+I->first));
  86     }
  87   }
  88 }
  89
  90
  91
  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
  96
  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;
 100
 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
 104
 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.
 108   //
 109   if (Slot < CurSize)
 110     return "\\" + utostr(CurSize-Slot);       // Here's the upreference
 111
 112   TypeStack.push_back(Ty);    // Recursive case: Add us to the stack..
 113
 114   std::string Result;
 115   switch (Ty->getPrimitiveID()) {
 116   case Type::FunctionTyID: {
 117     const FunctionType *FTy = cast<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())
 123         Result += ", ";
 124       Result += calcTypeName(*I, TypeStack, TypeNames);
 125     }
 126     if (FTy->isVarArg()) {
 127       if (!FTy->getParamTypes().empty()) Result += ", ";
 128       Result += "...";
 129     }
 130     Result += ")";
 131     break;
 132   }
 133   case Type::StructTyID: {
 134     const StructType *STy = cast<StructType>(Ty);
 135     Result = "{ ";
 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())
 140         Result += ", ";
 141       Result += calcTypeName(*I, TypeStack, TypeNames);
 142     }
 143     Result += " }";
 144     break;
 145   }
 146   case Type::PointerTyID:
 147     Result = calcTypeName(cast<PointerType>(Ty)->getElementType(),
 148                           TypeStack, TypeNames) + "*";
 149     break;
 150   case Type::ArrayTyID: {
 151     const ArrayType *ATy = cast<ArrayType>(Ty);
 152     Result = "[" + utostr(ATy->getNumElements()) + " x ";
 153     Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
 154     break;
 155   }
 156   case Type::OpaqueTyID:
 157     Result = "opaque";
 158     break;
 159   default:
 160     Result = "<unrecognized-type>";
 161   }
 162
 163   TypeStack.pop_back();       // Remove self from stack...
 164   return Result;
 165 }
 166
 167
 168 // printTypeInt - The internal guts of printing out a type that has a
 169 // potentially named portion.
 170 //
 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.
 175   //
 176   if (Ty->isPrimitiveType()) return Out << Ty->getDescription();
 177
 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;
 181
 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
 184   // names.
 185   //
 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;
 190 }
 191
 192
 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;
 196 //
 197 std::ostream &WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
 198                                 const Module *M) {
 199   Out << " ";
 200
 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...
 203   if (M) {
 204     std::map<const Type *, std::string> TypeNames;
 205     fillTypeNameTable(M, TypeNames);
 206
 207     return printTypeInt(Out, Ty, TypeNames);
 208   } else {
 209     return Out << Ty->getDescription();
 210   }
 211 }
 212
 213 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
 214                              bool PrintName,
 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.
 228     //
 229     std::string StrVal = ftostr(CFP->getValue());
 230
 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.
 234     //
 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;
 241       }
 242
 243     // Otherwise we could not reparse it to exactly the same value, so we must
 244     // output the string in hexadecimal format!
 245     //
 246     // Behave nicely in the face of C TBAA rules... see:
 247     // http://www.nullstone.com/htmls/category/aliastyp.htm
 248     //
 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);
 254
 255   } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 256     if (CA->getNumOperands() > 5 && CA->isNullValue()) {
 257       Out << "zeroinitializer";
 258       return;
 259     }
 260
 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.
 263     //
 264     const Type *ETy = CA->getType()->getElementType();
 265     bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
 266
 267     if (ETy == Type::SByteTy)
 268       for (unsigned i = 0; i < CA->getNumOperands(); ++i)
 269         if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
 270           isString = false;
 271           break;
 272         }
 273
 274     if (isString) {
 275       Out << "c\"";
 276       for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
 277         unsigned char C = cast<ConstantInt>(CA->getOperand(i))->getRawValue();
 278
 279         if (isprint(C) && C != '"' && C != '\\') {
 280           Out << C;
 281         } else {
 282           Out << '\\'
 283               << (char) ((C/16  < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
 284               << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
 285         }
 286       }
 287       Out << "\"";
 288
 289     } else {                // Cannot output in string format...
 290       Out << "[";
 291       if (CA->getNumOperands()) {
 292         Out << " ";
 293         printTypeInt(Out, ETy, TypeTable);
 294         WriteAsOperandInternal(Out, CA->getOperand(0),
 295                                PrintName, TypeTable, Table);
 296         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
 297           Out << ", ";
 298           printTypeInt(Out, ETy, TypeTable);
 299           WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
 300                                  TypeTable, Table);
 301         }
 302       }
 303       Out << " ]";
 304     }
 305   } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
 306     if (CS->getNumOperands() > 5 && CS->isNullValue()) {
 307       Out << "zeroinitializer";
 308       return;
 309     }
 310
 311     Out << "{";
 312     if (CS->getNumOperands()) {
 313       Out << " ";
 314       printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
 315
 316       WriteAsOperandInternal(Out, CS->getOperand(0),
 317                              PrintName, TypeTable, Table);
 318
 319       for (unsigned i = 1; i < CS->getNumOperands(); i++) {
 320         Out << ", ";
 321         printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
 322
 323         WriteAsOperandInternal(Out, CS->getOperand(i),
 324                                PrintName, TypeTable, Table);
 325       }
 326     }
 327
 328     Out << " }";
 329   } else if (isa<ConstantPointerNull>(CV)) {
 330     Out << "null";
 331
 332   } else if (const ConstantPointerRef *PR = dyn_cast<ConstantPointerRef>(CV)) {
 333     const GlobalValue *V = PR->getValue();
 334     if (V->hasName()) {
 335       Out << "%" << V->getName();
 336     } else if (Table) {
 337       int Slot = Table->getValSlot(V);
 338       if (Slot >= 0)
 339         Out << "%" << Slot;
 340       else
 341         Out << "<pointer reference badref>";
 342     } else {
 343       Out << "<pointer reference without context info>";
 344     }
 345
 346   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 347     Out << CE->getOpcodeName() << " (";
 348
 349     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
 350       printTypeInt(Out, (*OI)->getType(), TypeTable);
 351       WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Table);
 352       if (OI+1 != CE->op_end())
 353         Out << ", ";
 354     }
 355
 356     if (CE->getOpcode() == Instruction::Cast) {
 357       Out << " to ";
 358       printTypeInt(Out, CE->getType(), TypeTable);
 359     }
 360     Out << ")";
 361
 362   } else {
 363     Out << "<placeholder or erroneous Constant>";
 364   }
 365 }
 366
 367
 368 // WriteAsOperand - Write the name of the specified value out to the specified
 369 // ostream.  This can be useful when you just want to print int %reg126, not the
 370 // whole instruction that generated it.
 371 //
 372 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
 373                                    bool PrintName,
 374                                   std::map<const Type*, std::string> &TypeTable,
 375                                    SlotCalculator *Table) {
 376   Out << " ";
 377   if (PrintName && V->hasName()) {
 378     Out << "%" << V->getName();
 379   } else {
 380     if (const Constant *CV = dyn_cast<Constant>(V)) {
 381       WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
 382     } else {
 383       int Slot;
 384       if (Table) {
 385         Slot = Table->getValSlot(V);
 386       } else {
 387         if (const Type *Ty = dyn_cast<Type>(V)) {
 388           Out << Ty->getDescription();
 389           return;
 390         }
 391
 392         Table = createSlotCalculator(V);
 393         if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
 394
 395         Slot = Table->getValSlot(V);
 396         delete Table;
 397       }
 398       if (Slot >= 0)  Out << "%" << Slot;
 399       else if (PrintName)
 400         Out << "<badref>";     // Not embeded into a location?
 401     }
 402   }
 403 }
 404
 405
 406
 407 // WriteAsOperand - Write the name of the specified value out to the specified
 408 // ostream.  This can be useful when you just want to print int %reg126, not the
 409 // whole instruction that generated it.
 410 //
 411 std::ostream &WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
 412                              bool PrintName, const Module *Context) {
 413   std::map<const Type *, std::string> TypeNames;
 414   if (Context == 0) Context = getModuleFromVal(V);
 415
 416   if (Context)
 417     fillTypeNameTable(Context, TypeNames);
 418
 419   if (PrintType)
 420     printTypeInt(Out, V->getType(), TypeNames);
 421
 422   WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
 423   return Out;
 424 }
 425
 426
 427
 428 class AssemblyWriter {
 429   std::ostream &Out;
 430   SlotCalculator &Table;
 431   const Module *TheModule;
 432   std::map<const Type *, std::string> TypeNames;
 433 public:
 434   inline AssemblyWriter(std::ostream &o, SlotCalculator &Tab, const Module *M)
 435     : Out(o), Table(Tab), TheModule(M) {
 436
 437     // If the module has a symbol table, take all global types and stuff their
 438     // names into the TypeNames map.
 439     //
 440     fillTypeNameTable(M, TypeNames);
 441   }
 442
 443   inline void write(const Module *M)         { printModule(M);      }
 444   inline void write(const GlobalVariable *G) { printGlobal(G);      }
 445   inline void write(const Function *F)       { printFunction(F);    }
 446   inline void write(const BasicBlock *BB)    { printBasicBlock(BB); }
 447   inline void write(const Instruction *I)    { printInstruction(*I); }
 448   inline void write(const Constant *CPV)     { printConstant(CPV);  }
 449   inline void write(const Type *Ty)          { printType(Ty);       }
 450
 451   void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
 452
 453 private :
 454   void printModule(const Module *M);
 455   void printSymbolTable(const SymbolTable &ST);
 456   void printConstant(const Constant *CPV);
 457   void printGlobal(const GlobalVariable *GV);
 458   void printFunction(const Function *F);
 459   void printArgument(const Argument *FA);
 460   void printBasicBlock(const BasicBlock *BB);
 461   void printInstruction(const Instruction &I);
 462
 463   // printType - Go to extreme measures to attempt to print out a short,
 464   // symbolic version of a type name.
 465   //
 466   std::ostream &printType(const Type *Ty) {
 467     return printTypeInt(Out, Ty, TypeNames);
 468   }
 469
 470   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 471   // without considering any symbolic types that we may have equal to it.
 472   //
 473   std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
 474
 475   // printInfoComment - Print a little comment after the instruction indicating
 476   // which slot it occupies.
 477   void printInfoComment(const Value &V);
 478 };
 479
 480
 481 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 482 // without considering any symbolic types that we may have equal to it.
 483 //
 484 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 485   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 486     printType(FTy->getReturnType()) << " (";
 487     for (FunctionType::ParamTypes::const_iterator
 488            I = FTy->getParamTypes().begin(),
 489            E = FTy->getParamTypes().end(); I != E; ++I) {
 490       if (I != FTy->getParamTypes().begin())
 491         Out << ", ";
 492       printType(*I);
 493     }
 494     if (FTy->isVarArg()) {
 495       if (!FTy->getParamTypes().empty()) Out << ", ";
 496       Out << "...";
 497     }
 498     Out << ")";
 499   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 500     Out << "{ ";
 501     for (StructType::ElementTypes::const_iterator
 502            I = STy->getElementTypes().begin(),
 503            E = STy->getElementTypes().end(); I != E; ++I) {
 504       if (I != STy->getElementTypes().begin())
 505         Out << ", ";
 506       printType(*I);
 507     }
 508     Out << " }";
 509   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 510     printType(PTy->getElementType()) << "*";
 511   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 512     Out << "[" << ATy->getNumElements() << " x ";
 513     printType(ATy->getElementType()) << "]";
 514   } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
 515     Out << "opaque";
 516   } else {
 517     if (!Ty->isPrimitiveType())
 518       Out << "<unknown derived type>";
 519     printType(Ty);
 520   }
 521   return Out;
 522 }
 523
 524
 525 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
 526                                   bool PrintName) {
 527   if (PrintType) { Out << " "; printType(Operand->getType()); }
 528   WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Table);
 529 }
 530
 531
 532 void AssemblyWriter::printModule(const Module *M) {
 533   Out << "target endian = " << (M->isLittleEndian() ? "little" : "big") << "\n";
 534   Out << "target pointersize = " << (M->has32BitPointers() ? 32 : 64) << "\n";
 535
 536   // Loop over the symbol table, emitting all named constants...
 537   printSymbolTable(M->getSymbolTable());
 538
 539   for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 540     printGlobal(I);
 541
 542   Out << "\nimplementation   ; Functions:\n";
 543
 544   // Output all of the functions...
 545   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 546     printFunction(I);
 547 }
 548
 549 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 550   if (GV->hasName()) Out << "%" << GV->getName() << " = ";
 551
 552   if (!GV->hasInitializer())
 553     Out << "external ";
 554   else
 555     switch (GV->getLinkage()) {
 556     case GlobalValue::InternalLinkage: Out << "internal "; break;
 557     case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
 558     case GlobalValue::AppendingLinkage: Out << "appending "; break;
 559     case GlobalValue::ExternalLinkage: break;
 560     }
 561
 562   Out << (GV->isConstant() ? "constant " : "global ");
 563   printType(GV->getType()->getElementType());
 564
 565   if (GV->hasInitializer())
 566     writeOperand(GV->getInitializer(), false, false);
 567
 568   printInfoComment(*GV);
 569   Out << "\n";
 570 }
 571
 572
 573 // printSymbolTable - Run through symbol table looking for named constants
 574 // if a named constant is found, emit it's declaration...
 575 //
 576 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
 577   for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
 578     SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
 579     SymbolTable::type_const_iterator End = ST.type_end(TI->first);
 580
 581     for (; I != End; ++I) {
 582       const Value *V = I->second;
 583       if (const Constant *CPV = dyn_cast<Constant>(V)) {
 584         printConstant(CPV);
 585       } else if (const Type *Ty = dyn_cast<Type>(V)) {
 586         Out << "\t%" << I->first << " = type ";
 587
 588         // Make sure we print out at least one level of the type structure, so
 589         // that we do not get %FILE = type %FILE
 590         //
 591         printTypeAtLeastOneLevel(Ty) << "\n";
 592       }
 593     }
 594   }
 595 }
 596
 597
 598 // printConstant - Print out a constant pool entry...
 599 //
 600 void AssemblyWriter::printConstant(const Constant *CPV) {
 601   // Don't print out unnamed constants, they will be inlined
 602   if (!CPV->hasName()) return;
 603
 604   // Print out name...
 605   Out << "\t%" << CPV->getName() << " =";
 606
 607   // Write the value out now...
 608   writeOperand(CPV, true, false);
 609
 610   printInfoComment(*CPV);
 611   Out << "\n";
 612 }
 613
 614 // printFunction - Print all aspects of a function.
 615 //
 616 void AssemblyWriter::printFunction(const Function *F) {
 617   // Print out the return type and name...
 618   Out << "\n";
 619
 620   if (F->isExternal())
 621     Out << "declare ";
 622   else
 623     switch (F->getLinkage()) {
 624     case GlobalValue::InternalLinkage: Out << "internal "; break;
 625     case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
 626     case GlobalValue::AppendingLinkage: Out << "appending "; break;
 627     case GlobalValue::ExternalLinkage: break;
 628     }
 629
 630   printType(F->getReturnType()) << " %" << F->getName() << "(";
 631   Table.incorporateFunction(F);
 632
 633   // Loop over the arguments, printing them...
 634   const FunctionType *FT = F->getFunctionType();
 635
 636   for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
 637     printArgument(I);
 638
 639   // Finish printing arguments...
 640   if (FT->isVarArg()) {
 641     if (FT->getParamTypes().size()) Out << ", ";
 642     Out << "...";  // Output varargs portion of signature!
 643   }
 644   Out << ")";
 645
 646   if (F->isExternal()) {
 647     Out << "\n";
 648   } else {
 649     Out << " {";
 650
 651     // Output all of its basic blocks... for the function
 652     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
 653       printBasicBlock(I);
 654
 655     Out << "}\n";
 656   }
 657
 658   Table.purgeFunction();
 659 }
 660
 661 // printArgument - This member is called for every argument that
 662 // is passed into the function.  Simply print it out
 663 //
 664 void AssemblyWriter::printArgument(const Argument *Arg) {
 665   // Insert commas as we go... the first arg doesn't get a comma
 666   if (Arg != &Arg->getParent()->afront()) Out << ", ";
 667
 668   // Output type...
 669   printType(Arg->getType());
 670
 671   // Output name, if available...
 672   if (Arg->hasName())
 673     Out << " %" << Arg->getName();
 674   else if (Table.getValSlot(Arg) < 0)
 675     Out << "<badref>";
 676 }
 677
 678 // printBasicBlock - This member is called for each basic block in a methd.
 679 //
 680 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
 681   if (BB->hasName()) {              // Print out the label if it exists...
 682     Out << "\n" << BB->getName() << ":";
 683   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
 684     int Slot = Table.getValSlot(BB);
 685     Out << "\n; <label>:";
 686     if (Slot >= 0)
 687       Out << Slot;         // Extra newline separates out label's
 688     else
 689       Out << "<badref>";
 690   }
 691
 692   // Output predecessors for the block...
 693   Out << "\t\t;";
 694   pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
 695
 696   if (PI == PE) {
 697     Out << " No predecessors!";
 698   } else {
 699     Out << " preds =";
 700     writeOperand(*PI, false, true);
 701     for (++PI; PI != PE; ++PI) {
 702       Out << ",";
 703       writeOperand(*PI, false, true);
 704     }
 705   }
 706
 707   Out << "\n";
 708
 709   // Output all of the instructions in the basic block...
 710   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 711     printInstruction(*I);
 712 }
 713
 714
 715 // printInfoComment - Print a little comment after the instruction indicating
 716 // which slot it occupies.
 717 //
 718 void AssemblyWriter::printInfoComment(const Value &V) {
 719   if (V.getType() != Type::VoidTy) {
 720     Out << "\t\t; <";
 721     printType(V.getType()) << ">";
 722
 723     if (!V.hasName()) {
 724       int Slot = Table.getValSlot(&V); // Print out the def slot taken...
 725       if (Slot >= 0) Out << ":" << Slot;
 726       else Out << ":<badref>";
 727     }
 728     Out << " [#uses=" << V.use_size() << "]";  // Output # uses
 729   }
 730 }
 731
 732 // printInstruction - This member is called for each Instruction in a methd.
 733 //
 734 void AssemblyWriter::printInstruction(const Instruction &I) {
 735   Out << "\t";
 736
 737   // Print out name if it exists...
 738   if (I.hasName())
 739     Out << "%" << I.getName() << " = ";
 740
 741   // Print out the opcode...
 742   Out << I.getOpcodeName();
 743
 744   // Print out the type of the operands...
 745   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
 746
 747   // Special case conditional branches to swizzle the condition out to the front
 748   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
 749     writeOperand(I.getOperand(2), true);
 750     Out << ",";
 751     writeOperand(Operand, true);
 752     Out << ",";
 753     writeOperand(I.getOperand(1), true);
 754
 755   } else if (isa<SwitchInst>(I)) {
 756     // Special case switch statement to get formatting nice and correct...
 757     writeOperand(Operand        , true); Out << ",";
 758     writeOperand(I.getOperand(1), true); Out << " [";
 759
 760     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
 761       Out << "\n\t\t";
 762       writeOperand(I.getOperand(op  ), true); Out << ",";
 763       writeOperand(I.getOperand(op+1), true);
 764     }
 765     Out << "\n\t]";
 766   } else if (isa<PHINode>(I)) {
 767     Out << " ";
 768     printType(I.getType());
 769     Out << " ";
 770
 771     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
 772       if (op) Out << ", ";
 773       Out << "[";
 774       writeOperand(I.getOperand(op  ), false); Out << ",";
 775       writeOperand(I.getOperand(op+1), false); Out << " ]";
 776     }
 777   } else if (isa<ReturnInst>(I) && !Operand) {
 778     Out << " void";
 779   } else if (isa<CallInst>(I)) {
 780     const PointerType *PTy = dyn_cast<PointerType>(Operand->getType());
 781     const FunctionType*MTy = PTy ? dyn_cast<FunctionType>(PTy->getElementType()):0;
 782     const Type      *RetTy = MTy ? MTy->getReturnType() : 0;
 783
 784     // If possible, print out the short form of the call instruction, but we can
 785     // only do this if the first argument is a pointer to a nonvararg function,
 786     // and if the value returned is not a pointer to a function.
 787     //
 788     if (RetTy && MTy && !MTy->isVarArg() &&
 789         (!isa<PointerType>(RetTy) ||
 790          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
 791       Out << " "; printType(RetTy);
 792       writeOperand(Operand, false);
 793     } else {
 794       writeOperand(Operand, true);
 795     }
 796     Out << "(";
 797     if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
 798     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
 799       Out << ",";
 800       writeOperand(I.getOperand(op), true);
 801     }
 802
 803     Out << " )";
 804   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 805     // TODO: Should try to print out short form of the Invoke instruction
 806     writeOperand(Operand, true);
 807     Out << "(";
 808     if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
 809     for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
 810       Out << ",";
 811       writeOperand(I.getOperand(op), true);
 812     }
 813
 814     Out << " )\n\t\t\tto";
 815     writeOperand(II->getNormalDest(), true);
 816     Out << " except";
 817     writeOperand(II->getExceptionalDest(), true);
 818
 819   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
 820     Out << " ";
 821     printType(AI->getType()->getElementType());
 822     if (AI->isArrayAllocation()) {
 823       Out << ",";
 824       writeOperand(AI->getArraySize(), true);
 825     }
 826   } else if (isa<CastInst>(I)) {
 827     writeOperand(Operand, true);
 828     Out << " to ";
 829     printType(I.getType());
 830   } else if (isa<VarArgInst>(I)) {
 831     writeOperand(Operand, true);
 832     Out << ", ";
 833     printType(I.getType());
 834   } else if (Operand) {   // Print the normal way...
 835
 836     // PrintAllTypes - Instructions who have operands of all the same type
 837     // omit the type from all but the first operand.  If the instruction has
 838     // different type operands (for example br), then they are all printed.
 839     bool PrintAllTypes = false;
 840     const Type *TheType = Operand->getType();
 841
 842     // Shift Left & Right print both types even for Ubyte LHS
 843     if (isa<ShiftInst>(I)) {
 844       PrintAllTypes = true;
 845     } else {
 846       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
 847         Operand = I.getOperand(i);
 848         if (Operand->getType() != TheType) {
 849           PrintAllTypes = true;    // We have differing types!  Print them all!
 850           break;
 851         }
 852       }
 853     }
 854
 855     if (!PrintAllTypes) {
 856       Out << " ";
 857       printType(TheType);
 858     }
 859
 860     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
 861       if (i) Out << ",";
 862       writeOperand(I.getOperand(i), PrintAllTypes);
 863     }
 864   }
 865
 866   printInfoComment(I);
 867   Out << "\n";
 868 }
 869
 870
 871 //===----------------------------------------------------------------------===//
 872 //                       External Interface declarations
 873 //===----------------------------------------------------------------------===//
 874
 875
 876 void Module::print(std::ostream &o) const {
 877   SlotCalculator SlotTable(this, true);
 878   AssemblyWriter W(o, SlotTable, this);
 879   W.write(this);
 880 }
 881
 882 void GlobalVariable::print(std::ostream &o) const {
 883   SlotCalculator SlotTable(getParent(), true);
 884   AssemblyWriter W(o, SlotTable, getParent());
 885   W.write(this);
 886 }
 887
 888 void Function::print(std::ostream &o) const {
 889   SlotCalculator SlotTable(getParent(), true);
 890   AssemblyWriter W(o, SlotTable, getParent());
 891
 892   W.write(this);
 893 }
 894
 895 void BasicBlock::print(std::ostream &o) const {
 896   SlotCalculator SlotTable(getParent(), true);
 897   AssemblyWriter W(o, SlotTable,
 898                    getParent() ? getParent()->getParent() : 0);
 899   W.write(this);
 900 }
 901
 902 void Instruction::print(std::ostream &o) const {
 903   const Function *F = getParent() ? getParent()->getParent() : 0;
 904   SlotCalculator SlotTable(F, true);
 905   AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0);
 906
 907   W.write(this);
 908 }
 909
 910 void Constant::print(std::ostream &o) const {
 911   if (this == 0) { o << "<null> constant value\n"; return; }
 912
 913   // Handle CPR's special, because they have context information...
 914   if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
 915     CPR->getValue()->print(o);  // Print as a global value, with context info.
 916     return;
 917   }
 918
 919   o << " " << getType()->getDescription() << " ";
 920
 921   std::map<const Type *, std::string> TypeTable;
 922   WriteConstantInt(o, this, false, TypeTable, 0);
 923 }
 924
 925 void Type::print(std::ostream &o) const {
 926   if (this == 0)
 927     o << "<null Type>";
 928   else
 929     o << getDescription();
 930 }
 931
 932 void Argument::print(std::ostream &o) const {
 933   o << getType() << " " << getName();
 934 }
 935
 936 void Value::dump() const { print(std::cerr); }
 937
 938 //===----------------------------------------------------------------------===//
 939 //  CachedWriter Class Implementation
 940 //===----------------------------------------------------------------------===//
 941
 942 void CachedWriter::setModule(const Module *M) {
 943   delete SC; delete AW;
 944   if (M) {
 945     SC = new SlotCalculator(M, true);
 946     AW = new AssemblyWriter(Out, *SC, M);
 947   } else {
 948     SC = 0; AW = 0;
 949   }
 950 }
 951
 952 CachedWriter::~CachedWriter() {
 953   delete AW;
 954   delete SC;
 955 }
 956
 957 CachedWriter &CachedWriter::operator<<(const Value *V) {
 958   assert(AW && SC && "CachedWriter does not have a current module!");
 959   switch (V->getValueType()) {
 960   case Value::ConstantVal:
 961   case Value::ArgumentVal:       AW->writeOperand(V, true, true); break;
 962   case Value::TypeVal:           AW->write(cast<Type>(V)); break;
 963   case Value::InstructionVal:    AW->write(cast<Instruction>(V)); break;
 964   case Value::BasicBlockVal:     AW->write(cast<BasicBlock>(V)); break;
 965   case Value::FunctionVal:       AW->write(cast<Function>(V)); break;
 966   case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
 967   default: Out << "<unknown value type: " << V->getValueType() << ">"; break;
 968   }
 969   return *this;
 970 }