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