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 "Support/StringExtras.h"
  25 #include "Support/STLExtras.h"
  26 #include <algorithm>
  27 using std::string;
  28 using std::map;
  29 using std::vector;
  30 using std::ostream;
  31
  32 static RegisterPass<PrintModulePass>
  33 X("printm", "Print module to stderr",PassInfo::Analysis|PassInfo::Optimization);
  34 static RegisterPass<PrintFunctionPass>
  35 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
  36
  37 static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
  38                                    map<const Type *, string> &TypeTable,
  39                                    SlotCalculator *Table);
  40
  41 static const Module *getModuleFromVal(const Value *V) {
  42   if (const Argument *MA = dyn_cast<const Argument>(V))
  43     return MA->getParent() ? MA->getParent()->getParent() : 0;
  44   else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V))
  45     return BB->getParent() ? BB->getParent()->getParent() : 0;
  46   else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
  47     const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
  48     return M ? M->getParent() : 0;
  49   } else if (const GlobalValue *GV = dyn_cast<const GlobalValue>(V))
  50     return GV->getParent();
  51   return 0;
  52 }
  53
  54 static SlotCalculator *createSlotCalculator(const Value *V) {
  55   assert(!isa<Type>(V) && "Can't create an SC for a type!");
  56   if (const Argument *FA = dyn_cast<const Argument>(V)) {
  57     return new SlotCalculator(FA->getParent(), true);
  58   } else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
  59     return new SlotCalculator(I->getParent()->getParent(), true);
  60   } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V)) {
  61     return new SlotCalculator(BB->getParent(), true);
  62   } else if (const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V)){
  63     return new SlotCalculator(GV->getParent(), true);
  64   } else if (const Function *Func = dyn_cast<const Function>(V)) {
  65     return new SlotCalculator(Func, true);
  66   }
  67   return 0;
  68 }
  69
  70
  71 // If the module has a symbol table, take all global types and stuff their
  72 // names into the TypeNames map.
  73 //
  74 static void fillTypeNameTable(const Module *M,
  75                               map<const Type *, string> &TypeNames) {
  76   if (M && M->hasSymbolTable()) {
  77     const SymbolTable *ST = M->getSymbolTable();
  78     SymbolTable::const_iterator PI = ST->find(Type::TypeTy);
  79     if (PI != ST->end()) {
  80       SymbolTable::type_const_iterator I = PI->second.begin();
  81       for (; I != PI->second.end(); ++I) {
  82         // As a heuristic, don't insert pointer to primitive types, because
  83         // they are used too often to have a single useful name.
  84         //
  85         const Type *Ty = cast<const Type>(I->second);
  86         if (!isa<PointerType>(Ty) ||
  87             !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
  88           TypeNames.insert(std::make_pair(Ty, "%"+I->first));
  89       }
  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 && M->hasSymbolTable()) {
 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     bool isGEP = CE->getOpcode() == Instruction::GetElementPtr;
 340     Out << (isGEP ? " (" : " ");
 341
 342     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
 343       printTypeInt(Out, (*OI)->getType(), TypeTable);
 344       WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Table);
 345       if (OI+1 != CE->op_end())
 346         Out << ", ";
 347     }
 348
 349     if (isGEP)
 350       Out << ")";
 351     else if (CE->getOpcode() == Instruction::Cast) {
 352       Out << " to ";
 353       printTypeInt(Out, CE->getType(), TypeTable);
 354     }
 355
 356   } else {
 357     Out << "<placeholder or erroneous Constant>";
 358   }
 359 }
 360
 361
 362 // WriteAsOperand - Write the name of the specified value out to the specified
 363 // ostream.  This can be useful when you just want to print int %reg126, not the
 364 // whole instruction that generated it.
 365 //
 366 static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
 367                                    map<const Type *, string> &TypeTable,
 368                                    SlotCalculator *Table) {
 369   Out << " ";
 370   if (PrintName && V->hasName()) {
 371     Out << "%" << V->getName();
 372   } else {
 373     if (const Constant *CV = dyn_cast<const Constant>(V)) {
 374       WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
 375     } else {
 376       int Slot;
 377       if (Table) {
 378         Slot = Table->getValSlot(V);
 379       } else {
 380         if (const Type *Ty = dyn_cast<const Type>(V)) {
 381           Out << Ty->getDescription();
 382           return;
 383         }
 384
 385         Table = createSlotCalculator(V);
 386         if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
 387
 388         Slot = Table->getValSlot(V);
 389         delete Table;
 390       }
 391       if (Slot >= 0)  Out << "%" << Slot;
 392       else if (PrintName)
 393         Out << "<badref>";     // Not embeded into a location?
 394     }
 395   }
 396 }
 397
 398
 399
 400 // WriteAsOperand - Write the name of the specified value out to the specified
 401 // ostream.  This can be useful when you just want to print int %reg126, not the
 402 // whole instruction that generated it.
 403 //
 404 ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType,
 405                         bool PrintName, const Module *Context) {
 406   map<const Type *, string> TypeNames;
 407   if (Context == 0) Context = getModuleFromVal(V);
 408
 409   if (Context && Context->hasSymbolTable())
 410     fillTypeNameTable(Context, TypeNames);
 411
 412   if (PrintType)
 413     printTypeInt(Out, V->getType(), TypeNames);
 414
 415   WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
 416   return Out;
 417 }
 418
 419
 420
 421 class AssemblyWriter {
 422   ostream &Out;
 423   SlotCalculator &Table;
 424   const Module *TheModule;
 425   map<const Type *, string> TypeNames;
 426 public:
 427   inline AssemblyWriter(ostream &o, SlotCalculator &Tab, const Module *M)
 428     : Out(o), Table(Tab), TheModule(M) {
 429
 430     // If the module has a symbol table, take all global types and stuff their
 431     // names into the TypeNames map.
 432     //
 433     fillTypeNameTable(M, TypeNames);
 434   }
 435
 436   inline void write(const Module *M)         { printModule(M);      }
 437   inline void write(const GlobalVariable *G) { printGlobal(G);      }
 438   inline void write(const Function *F)       { printFunction(F);    }
 439   inline void write(const BasicBlock *BB)    { printBasicBlock(BB); }
 440   inline void write(const Instruction *I)    { printInstruction(*I); }
 441   inline void write(const Constant *CPV)     { printConstant(CPV);  }
 442   inline void write(const Type *Ty)          { printType(Ty);       }
 443
 444   void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
 445
 446 private :
 447   void printModule(const Module *M);
 448   void printSymbolTable(const SymbolTable &ST);
 449   void printConstant(const Constant *CPV);
 450   void printGlobal(const GlobalVariable *GV);
 451   void printFunction(const Function *F);
 452   void printArgument(const Argument *FA);
 453   void printBasicBlock(const BasicBlock *BB);
 454   void printInstruction(const Instruction &I);
 455
 456   // printType - Go to extreme measures to attempt to print out a short,
 457   // symbolic version of a type name.
 458   //
 459   ostream &printType(const Type *Ty) {
 460     return printTypeInt(Out, Ty, TypeNames);
 461   }
 462
 463   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 464   // without considering any symbolic types that we may have equal to it.
 465   //
 466   ostream &printTypeAtLeastOneLevel(const Type *Ty);
 467
 468   // printInfoComment - Print a little comment after the instruction indicating
 469   // which slot it occupies.
 470   void printInfoComment(const Value &V);
 471 };
 472
 473
 474 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 475 // without considering any symbolic types that we may have equal to it.
 476 //
 477 ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 478   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 479     printType(FTy->getReturnType()) << " (";
 480     for (FunctionType::ParamTypes::const_iterator
 481            I = FTy->getParamTypes().begin(),
 482            E = FTy->getParamTypes().end(); I != E; ++I) {
 483       if (I != FTy->getParamTypes().begin())
 484         Out << ", ";
 485       printType(*I);
 486     }
 487     if (FTy->isVarArg()) {
 488       if (!FTy->getParamTypes().empty()) Out << ", ";
 489       Out << "...";
 490     }
 491     Out << ")";
 492   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 493     Out << "{ ";
 494     for (StructType::ElementTypes::const_iterator
 495            I = STy->getElementTypes().begin(),
 496            E = STy->getElementTypes().end(); I != E; ++I) {
 497       if (I != STy->getElementTypes().begin())
 498         Out << ", ";
 499       printType(*I);
 500     }
 501     Out << " }";
 502   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 503     printType(PTy->getElementType()) << "*";
 504   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 505     Out << "[" << ATy->getNumElements() << " x ";
 506     printType(ATy->getElementType()) << "]";
 507   } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
 508     Out << OTy->getDescription();
 509   } else {
 510     if (!Ty->isPrimitiveType())
 511       Out << "<unknown derived type>";
 512     printType(Ty);
 513   }
 514   return Out;
 515 }
 516
 517
 518 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
 519                                   bool PrintName) {
 520   if (PrintType) { Out << " "; printType(Operand->getType()); }
 521   WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Table);
 522 }
 523
 524
 525 void AssemblyWriter::printModule(const Module *M) {
 526   // Loop over the symbol table, emitting all named constants...
 527   if (M->hasSymbolTable())
 528     printSymbolTable(*M->getSymbolTable());
 529
 530   for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 531     printGlobal(I);
 532
 533   Out << "\nimplementation   ; Functions:\n";
 534
 535   // Output all of the functions...
 536   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 537     printFunction(I);
 538 }
 539
 540 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 541   if (GV->hasName()) Out << "%" << GV->getName() << " = ";
 542
 543   if (GV->hasInternalLinkage()) Out << "internal ";
 544   if (!GV->hasInitializer()) Out << "uninitialized ";
 545
 546   Out << (GV->isConstant() ? "constant " : "global ");
 547   printType(GV->getType()->getElementType());
 548
 549   if (GV->hasInitializer())
 550     writeOperand(GV->getInitializer(), false, false);
 551
 552   printInfoComment(*GV);
 553   Out << "\n";
 554 }
 555
 556
 557 // printSymbolTable - Run through symbol table looking for named constants
 558 // if a named constant is found, emit it's declaration...
 559 //
 560 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
 561   for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
 562     SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
 563     SymbolTable::type_const_iterator End = ST.type_end(TI->first);
 564
 565     for (; I != End; ++I) {
 566       const Value *V = I->second;
 567       if (const Constant *CPV = dyn_cast<const Constant>(V)) {
 568         printConstant(CPV);
 569       } else if (const Type *Ty = dyn_cast<const Type>(V)) {
 570         Out << "\t%" << I->first << " = type ";
 571
 572         // Make sure we print out at least one level of the type structure, so
 573         // that we do not get %FILE = type %FILE
 574         //
 575         printTypeAtLeastOneLevel(Ty) << "\n";
 576       }
 577     }
 578   }
 579 }
 580
 581
 582 // printConstant - Print out a constant pool entry...
 583 //
 584 void AssemblyWriter::printConstant(const Constant *CPV) {
 585   // Don't print out unnamed constants, they will be inlined
 586   if (!CPV->hasName()) return;
 587
 588   // Print out name...
 589   Out << "\t%" << CPV->getName() << " =";
 590
 591   // Write the value out now...
 592   writeOperand(CPV, true, false);
 593
 594   printInfoComment(*CPV);
 595   Out << "\n";
 596 }
 597
 598 // printFunction - Print all aspects of a function.
 599 //
 600 void AssemblyWriter::printFunction(const Function *F) {
 601   // Print out the return type and name...
 602   Out << "\n" << (F->isExternal() ? "declare " : "")
 603       << (F->hasInternalLinkage() ? "internal " : "");
 604   printType(F->getReturnType()) << " %" << F->getName() << "(";
 605   Table.incorporateFunction(F);
 606
 607   // Loop over the arguments, printing them...
 608   const FunctionType *FT = F->getFunctionType();
 609
 610   if (!F->isExternal()) {
 611     for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
 612       printArgument(I);
 613   } else {
 614     // Loop over the arguments, printing them...
 615     for (FunctionType::ParamTypes::const_iterator I = FT->getParamTypes().begin(),
 616            E = FT->getParamTypes().end(); I != E; ++I) {
 617       if (I != FT->getParamTypes().begin()) Out << ", ";
 618       printType(*I);
 619     }
 620   }
 621
 622   // Finish printing arguments...
 623   if (FT->isVarArg()) {
 624     if (FT->getParamTypes().size()) Out << ", ";
 625     Out << "...";  // Output varargs portion of signature!
 626   }
 627   Out << ")";
 628
 629   if (F->isExternal()) {
 630     Out << "\n";
 631   } else {
 632     Out << " {";
 633
 634     // Output all of its basic blocks... for the function
 635     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
 636       printBasicBlock(I);
 637
 638     Out << "}\n";
 639   }
 640
 641   Table.purgeFunction();
 642 }
 643
 644 // printArgument - This member is called for every argument that
 645 // is passed into the function.  Simply print it out
 646 //
 647 void AssemblyWriter::printArgument(const Argument *Arg) {
 648   // Insert commas as we go... the first arg doesn't get a comma
 649   if (Arg != &Arg->getParent()->afront()) Out << ", ";
 650
 651   // Output type...
 652   printType(Arg->getType());
 653
 654   // Output name, if available...
 655   if (Arg->hasName())
 656     Out << " %" << Arg->getName();
 657   else if (Table.getValSlot(Arg) < 0)
 658     Out << "<badref>";
 659 }
 660
 661 // printBasicBlock - This member is called for each basic block in a methd.
 662 //
 663 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
 664   if (BB->hasName()) {              // Print out the label if it exists...
 665     Out << "\n" << BB->getName() << ":\t\t\t\t\t;[#uses="
 666         << BB->use_size() << "]";  // Output # uses
 667   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
 668     int Slot = Table.getValSlot(BB);
 669     Out << "\n; <label>:";
 670     if (Slot >= 0)
 671       Out << Slot;         // Extra newline seperates out label's
 672     else
 673       Out << "<badref>";
 674     Out << "\t\t\t\t\t;[#uses=" << BB->use_size() << "]";  // Output # uses
 675   }
 676
 677   Out << "\n";
 678
 679   // Output all of the instructions in the basic block...
 680   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 681     printInstruction(*I);
 682 }
 683
 684
 685 // printInfoComment - Print a little comment after the instruction indicating
 686 // which slot it occupies.
 687 //
 688 void AssemblyWriter::printInfoComment(const Value &V) {
 689   if (V.getType() != Type::VoidTy) {
 690     Out << "\t\t; <";
 691     printType(V.getType()) << ">";
 692
 693     if (!V.hasName()) {
 694       int Slot = Table.getValSlot(&V); // Print out the def slot taken...
 695       if (Slot >= 0) Out << ":" << Slot;
 696       else Out << ":<badref>";
 697     }
 698     Out << " [#uses=" << V.use_size() << "]";  // Output # uses
 699   }
 700 }
 701
 702 // printInstruction - This member is called for each Instruction in a methd.
 703 //
 704 void AssemblyWriter::printInstruction(const Instruction &I) {
 705   Out << "\t";
 706
 707   // Print out name if it exists...
 708   if (I.hasName())
 709     Out << "%" << I.getName() << " = ";
 710
 711   // Print out the opcode...
 712   Out << I.getOpcodeName();
 713
 714   // Print out the type of the operands...
 715   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
 716
 717   // Special case conditional branches to swizzle the condition out to the front
 718   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
 719     writeOperand(I.getOperand(2), true);
 720     Out << ",";
 721     writeOperand(Operand, true);
 722     Out << ",";
 723     writeOperand(I.getOperand(1), true);
 724
 725   } else if (isa<SwitchInst>(I)) {
 726     // Special case switch statement to get formatting nice and correct...
 727     writeOperand(Operand        , true); Out << ",";
 728     writeOperand(I.getOperand(1), true); Out << " [";
 729
 730     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
 731       Out << "\n\t\t";
 732       writeOperand(I.getOperand(op  ), true); Out << ",";
 733       writeOperand(I.getOperand(op+1), true);
 734     }
 735     Out << "\n\t]";
 736   } else if (isa<PHINode>(I)) {
 737     Out << " ";
 738     printType(I.getType());
 739     Out << " ";
 740
 741     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
 742       if (op) Out << ", ";
 743       Out << "[";
 744       writeOperand(I.getOperand(op  ), false); Out << ",";
 745       writeOperand(I.getOperand(op+1), false); Out << " ]";
 746     }
 747   } else if (isa<ReturnInst>(I) && !Operand) {
 748     Out << " void";
 749   } else if (isa<CallInst>(I)) {
 750     const PointerType *PTy = dyn_cast<PointerType>(Operand->getType());
 751     const FunctionType*MTy = PTy ? dyn_cast<FunctionType>(PTy->getElementType()):0;
 752     const Type      *RetTy = MTy ? MTy->getReturnType() : 0;
 753
 754     // If possible, print out the short form of the call instruction, but we can
 755     // only do this if the first argument is a pointer to a nonvararg function,
 756     // and if the value returned is not a pointer to a function.
 757     //
 758     if (RetTy && MTy && !MTy->isVarArg() &&
 759         (!isa<PointerType>(RetTy) ||
 760          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
 761       Out << " "; printType(RetTy);
 762       writeOperand(Operand, false);
 763     } else {
 764       writeOperand(Operand, true);
 765     }
 766     Out << "(";
 767     if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
 768     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
 769       Out << ",";
 770       writeOperand(I.getOperand(op), true);
 771     }
 772
 773     Out << " )";
 774   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 775     // TODO: Should try to print out short form of the Invoke instruction
 776     writeOperand(Operand, true);
 777     Out << "(";
 778     if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
 779     for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
 780       Out << ",";
 781       writeOperand(I.getOperand(op), true);
 782     }
 783
 784     Out << " )\n\t\t\tto";
 785     writeOperand(II->getNormalDest(), true);
 786     Out << " except";
 787     writeOperand(II->getExceptionalDest(), true);
 788
 789   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
 790     Out << " ";
 791     printType(AI->getType()->getElementType());
 792     if (AI->isArrayAllocation()) {
 793       Out << ",";
 794       writeOperand(AI->getArraySize(), true);
 795     }
 796   } else if (isa<CastInst>(I)) {
 797     if (Operand) writeOperand(Operand, true);
 798     Out << " to ";
 799     printType(I.getType());
 800   } else if (Operand) {   // Print the normal way...
 801
 802     // PrintAllTypes - Instructions who have operands of all the same type
 803     // omit the type from all but the first operand.  If the instruction has
 804     // different type operands (for example br), then they are all printed.
 805     bool PrintAllTypes = false;
 806     const Type *TheType = Operand->getType();
 807
 808     for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
 809       Operand = I.getOperand(i);
 810       if (Operand->getType() != TheType) {
 811         PrintAllTypes = true;       // We have differing types!  Print them all!
 812         break;
 813       }
 814     }
 815
 816     // Shift Left & Right print both types even for Ubyte LHS
 817     if (isa<ShiftInst>(I)) PrintAllTypes = true;
 818
 819     if (!PrintAllTypes) {
 820       Out << " ";
 821       printType(I.getOperand(0)->getType());
 822     }
 823
 824     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
 825       if (i) Out << ",";
 826       writeOperand(I.getOperand(i), PrintAllTypes);
 827     }
 828   }
 829
 830   printInfoComment(I);
 831   Out << "\n";
 832 }
 833
 834
 835 //===----------------------------------------------------------------------===//
 836 //                       External Interface declarations
 837 //===----------------------------------------------------------------------===//
 838
 839
 840 void Module::print(std::ostream &o) const {
 841   SlotCalculator SlotTable(this, true);
 842   AssemblyWriter W(o, SlotTable, this);
 843   W.write(this);
 844 }
 845
 846 void GlobalVariable::print(std::ostream &o) const {
 847   SlotCalculator SlotTable(getParent(), true);
 848   AssemblyWriter W(o, SlotTable, getParent());
 849   W.write(this);
 850 }
 851
 852 void Function::print(std::ostream &o) const {
 853   SlotCalculator SlotTable(getParent(), true);
 854   AssemblyWriter W(o, SlotTable, getParent());
 855
 856   W.write(this);
 857 }
 858
 859 void BasicBlock::print(std::ostream &o) const {
 860   SlotCalculator SlotTable(getParent(), true);
 861   AssemblyWriter W(o, SlotTable,
 862                    getParent() ? getParent()->getParent() : 0);
 863   W.write(this);
 864 }
 865
 866 void Instruction::print(std::ostream &o) const {
 867   const Function *F = getParent() ? getParent()->getParent() : 0;
 868   SlotCalculator SlotTable(F, true);
 869   AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0);
 870
 871   W.write(this);
 872 }
 873
 874 void Constant::print(std::ostream &o) const {
 875   if (this == 0) { o << "<null> constant value\n"; return; }
 876   o << " " << getType()->getDescription() << " ";
 877
 878   map<const Type *, string> TypeTable;
 879   WriteConstantInt(o, this, false, TypeTable, 0);
 880 }
 881
 882 void Type::print(std::ostream &o) const {
 883   if (this == 0)
 884     o << "<null Type>";
 885   else
 886     o << getDescription();
 887 }
 888
 889 void Argument::print(std::ostream &o) const {
 890   o << getType() << " " << getName();
 891 }
 892
 893 void Value::dump() const { print(std::cerr); }
 894
 895 //===----------------------------------------------------------------------===//
 896 //  CachedWriter Class Implementation
 897 //===----------------------------------------------------------------------===//
 898
 899 void CachedWriter::setModule(const Module *M) {
 900   delete SC; delete AW;
 901   if (M) {
 902     SC = new SlotCalculator(M, true);
 903     AW = new AssemblyWriter(Out, *SC, M);
 904   } else {
 905     SC = 0; AW = 0;
 906   }
 907 }
 908
 909 CachedWriter::~CachedWriter() {
 910   delete AW;
 911   delete SC;
 912 }
 913
 914 CachedWriter &CachedWriter::operator<<(const Value *V) {
 915   assert(AW && SC && "CachedWriter does not have a current module!");
 916   switch (V->getValueType()) {
 917   case Value::ConstantVal:
 918   case Value::ArgumentVal:       AW->writeOperand(V, true, true); break;
 919   case Value::TypeVal:           AW->write(cast<const Type>(V)); break;
 920   case Value::InstructionVal:    AW->write(cast<Instruction>(V)); break;
 921   case Value::BasicBlockVal:     AW->write(cast<BasicBlock>(V)); break;
 922   case Value::FunctionVal:       AW->write(cast<Function>(V)); break;
 923   case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
 924   default: Out << "<unknown value type: " << V->getValueType() << ">"; break;
 925   }
 926   return *this;
 927 }