lib/VMCore/AsmWriter.cpp

   1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This library implements the functionality defined in llvm/Assembly/Writer.h
  11 //
  12 // Note that these routines must be extremely tolerant of various errors in the
  13 // LLVM code, because it can be used for debugging transformations.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Assembly/Writer.h"
  18 #include "llvm/Assembly/PrintModulePass.h"
  19 #include "llvm/Assembly/AsmAnnotationWriter.h"
  20 #include "llvm/LLVMContext.h"
  21 #include "llvm/CallingConv.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/DerivedTypes.h"
  24 #include "llvm/InlineAsm.h"
  25 #include "llvm/IntrinsicInst.h"
  26 #include "llvm/Operator.h"
  27 #include "llvm/Module.h"
  28 #include "llvm/ValueSymbolTable.h"
  29 #include "llvm/TypeSymbolTable.h"
  30 #include "llvm/ADT/DenseSet.h"
  31 #include "llvm/ADT/SmallString.h"
  32 #include "llvm/ADT/StringExtras.h"
  33 #include "llvm/ADT/STLExtras.h"
  34 #include "llvm/Support/CFG.h"
  35 #include "llvm/Support/Debug.h"
  36 #include "llvm/Support/Dwarf.h"
  37 #include "llvm/Support/ErrorHandling.h"
  38 #include "llvm/Support/MathExtras.h"
  39 #include "llvm/Support/FormattedStream.h"
  40 #include <algorithm>
  41 #include <cctype>
  42 #include <map>
  43 using namespace llvm;
  44
  45 // Make virtual table appear in this compilation unit.
  46 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
  47
  48 //===----------------------------------------------------------------------===//
  49 // Helper Functions
  50 //===----------------------------------------------------------------------===//
  51
  52 static const Module *getModuleFromVal(const Value *V) {
  53   if (const Argument *MA = dyn_cast<Argument>(V))
  54     return MA->getParent() ? MA->getParent()->getParent() : 0;
  55
  56   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
  57     return BB->getParent() ? BB->getParent()->getParent() : 0;
  58
  59   if (const Instruction *I = dyn_cast<Instruction>(V)) {
  60     const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
  61     return M ? M->getParent() : 0;
  62   }
  63
  64   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
  65     return GV->getParent();
  66   if (const NamedMDNode *NMD = dyn_cast<NamedMDNode>(V))
  67     return NMD->getParent();
  68   return 0;
  69 }
  70
  71 // PrintEscapedString - Print each character of the specified string, escaping
  72 // it if it is not printable or if it is an escape char.
  73 static void PrintEscapedString(const StringRef &Name,
  74                                raw_ostream &Out) {
  75   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
  76     unsigned char C = Name[i];
  77     if (isprint(C) && C != '\\' && C != '"')
  78       Out << C;
  79     else
  80       Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
  81   }
  82 }
  83
  84 enum PrefixType {
  85   GlobalPrefix,
  86   LabelPrefix,
  87   LocalPrefix,
  88   NoPrefix
  89 };
  90
  91 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
  92 /// prefixed with % (if the string only contains simple characters) or is
  93 /// surrounded with ""'s (if it has special chars in it).  Print it out.
  94 static void PrintLLVMName(raw_ostream &OS, const StringRef &Name,
  95                           PrefixType Prefix) {
  96   assert(Name.data() && "Cannot get empty name!");
  97   switch (Prefix) {
  98   default: llvm_unreachable("Bad prefix!");
  99   case NoPrefix: break;
 100   case GlobalPrefix: OS << '@'; break;
 101   case LabelPrefix:  break;
 102   case LocalPrefix:  OS << '%'; break;
 103   }
 104
 105   // Scan the name to see if it needs quotes first.
 106   bool NeedsQuotes = isdigit(Name[0]);
 107   if (!NeedsQuotes) {
 108     for (unsigned i = 0, e = Name.size(); i != e; ++i) {
 109       char C = Name[i];
 110       if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
 111         NeedsQuotes = true;
 112         break;
 113       }
 114     }
 115   }
 116
 117   // If we didn't need any quotes, just write out the name in one blast.
 118   if (!NeedsQuotes) {
 119     OS << Name;
 120     return;
 121   }
 122
 123   // Okay, we need quotes.  Output the quotes and escape any scary characters as
 124   // needed.
 125   OS << '"';
 126   PrintEscapedString(Name, OS);
 127   OS << '"';
 128 }
 129
 130 /// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
 131 /// prefixed with % (if the string only contains simple characters) or is
 132 /// surrounded with ""'s (if it has special chars in it).  Print it out.
 133 static void PrintLLVMName(raw_ostream &OS, const Value *V) {
 134   PrintLLVMName(OS, V->getName(),
 135                 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
 136 }
 137
 138 //===----------------------------------------------------------------------===//
 139 // TypePrinting Class: Type printing machinery
 140 //===----------------------------------------------------------------------===//
 141
 142 static DenseMap<const Type *, std::string> &getTypeNamesMap(void *M) {
 143   return *static_cast<DenseMap<const Type *, std::string>*>(M);
 144 }
 145
 146 void TypePrinting::clear() {
 147   getTypeNamesMap(TypeNames).clear();
 148 }
 149
 150 bool TypePrinting::hasTypeName(const Type *Ty) const {
 151   return getTypeNamesMap(TypeNames).count(Ty);
 152 }
 153
 154 void TypePrinting::addTypeName(const Type *Ty, const std::string &N) {
 155   getTypeNamesMap(TypeNames).insert(std::make_pair(Ty, N));
 156 }
 157
 158
 159 TypePrinting::TypePrinting() {
 160   TypeNames = new DenseMap<const Type *, std::string>();
 161 }
 162
 163 TypePrinting::~TypePrinting() {
 164   delete &getTypeNamesMap(TypeNames);
 165 }
 166
 167 /// CalcTypeName - Write the specified type to the specified raw_ostream, making
 168 /// use of type names or up references to shorten the type name where possible.
 169 void TypePrinting::CalcTypeName(const Type *Ty,
 170                                 SmallVectorImpl<const Type *> &TypeStack,
 171                                 raw_ostream &OS, bool IgnoreTopLevelName) {
 172   // Check to see if the type is named.
 173   if (!IgnoreTopLevelName) {
 174     DenseMap<const Type *, std::string> &TM = getTypeNamesMap(TypeNames);
 175     DenseMap<const Type *, std::string>::iterator I = TM.find(Ty);
 176     if (I != TM.end()) {
 177       OS << I->second;
 178       return;
 179     }
 180   }
 181
 182   // Check to see if the Type is already on the stack...
 183   unsigned Slot = 0, CurSize = TypeStack.size();
 184   while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
 185
 186   // This is another base case for the recursion.  In this case, we know
 187   // that we have looped back to a type that we have previously visited.
 188   // Generate the appropriate upreference to handle this.
 189   if (Slot < CurSize) {
 190     OS << '\\' << unsigned(CurSize-Slot);     // Here's the upreference
 191     return;
 192   }
 193
 194   TypeStack.push_back(Ty);    // Recursive case: Add us to the stack..
 195
 196   switch (Ty->getTypeID()) {
 197   case Type::VoidTyID:      OS << "void"; break;
 198   case Type::FloatTyID:     OS << "float"; break;
 199   case Type::DoubleTyID:    OS << "double"; break;
 200   case Type::X86_FP80TyID:  OS << "x86_fp80"; break;
 201   case Type::FP128TyID:     OS << "fp128"; break;
 202   case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
 203   case Type::LabelTyID:     OS << "label"; break;
 204   case Type::MetadataTyID:  OS << "metadata"; break;
 205   case Type::IntegerTyID:
 206     OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
 207     break;
 208
 209   case Type::FunctionTyID: {
 210     const FunctionType *FTy = cast<FunctionType>(Ty);
 211     CalcTypeName(FTy->getReturnType(), TypeStack, OS);
 212     OS << " (";
 213     for (FunctionType::param_iterator I = FTy->param_begin(),
 214          E = FTy->param_end(); I != E; ++I) {
 215       if (I != FTy->param_begin())
 216         OS << ", ";
 217       CalcTypeName(*I, TypeStack, OS);
 218     }
 219     if (FTy->isVarArg()) {
 220       if (FTy->getNumParams()) OS << ", ";
 221       OS << "...";
 222     }
 223     OS << ')';
 224     break;
 225   }
 226   case Type::StructTyID: {
 227     const StructType *STy = cast<StructType>(Ty);
 228     if (STy->isPacked())
 229       OS << '<';
 230     OS << '{';
 231     for (StructType::element_iterator I = STy->element_begin(),
 232          E = STy->element_end(); I != E; ++I) {
 233       OS << ' ';
 234       CalcTypeName(*I, TypeStack, OS);
 235       if (next(I) == STy->element_end())
 236         OS << ' ';
 237       else
 238         OS << ',';
 239     }
 240     OS << '}';
 241     if (STy->isPacked())
 242       OS << '>';
 243     break;
 244   }
 245   case Type::UnionTyID: {
 246     const UnionType *UTy = cast<UnionType>(Ty);
 247     OS << "union {";
 248     for (StructType::element_iterator I = UTy->element_begin(),
 249          E = UTy->element_end(); I != E; ++I) {
 250       OS << ' ';
 251       CalcTypeName(*I, TypeStack, OS);
 252       if (next(I) == UTy->element_end())
 253         OS << ' ';
 254       else
 255         OS << ',';
 256     }
 257     OS << '}';
 258     break;
 259   }
 260   case Type::PointerTyID: {
 261     const PointerType *PTy = cast<PointerType>(Ty);
 262     CalcTypeName(PTy->getElementType(), TypeStack, OS);
 263     if (unsigned AddressSpace = PTy->getAddressSpace())
 264       OS << " addrspace(" << AddressSpace << ')';
 265     OS << '*';
 266     break;
 267   }
 268   case Type::ArrayTyID: {
 269     const ArrayType *ATy = cast<ArrayType>(Ty);
 270     OS << '[' << ATy->getNumElements() << " x ";
 271     CalcTypeName(ATy->getElementType(), TypeStack, OS);
 272     OS << ']';
 273     break;
 274   }
 275   case Type::VectorTyID: {
 276     const VectorType *PTy = cast<VectorType>(Ty);
 277     OS << "<" << PTy->getNumElements() << " x ";
 278     CalcTypeName(PTy->getElementType(), TypeStack, OS);
 279     OS << '>';
 280     break;
 281   }
 282   case Type::OpaqueTyID:
 283     OS << "opaque";
 284     break;
 285   default:
 286     OS << "<unrecognized-type>";
 287     break;
 288   }
 289
 290   TypeStack.pop_back();       // Remove self from stack.
 291 }
 292
 293 /// printTypeInt - The internal guts of printing out a type that has a
 294 /// potentially named portion.
 295 ///
 296 void TypePrinting::print(const Type *Ty, raw_ostream &OS,
 297                          bool IgnoreTopLevelName) {
 298   // Check to see if the type is named.
 299   DenseMap<const Type*, std::string> &TM = getTypeNamesMap(TypeNames);
 300   if (!IgnoreTopLevelName) {
 301     DenseMap<const Type*, std::string>::iterator I = TM.find(Ty);
 302     if (I != TM.end()) {
 303       OS << I->second;
 304       return;
 305     }
 306   }
 307
 308   // Otherwise we have a type that has not been named but is a derived type.
 309   // Carefully recurse the type hierarchy to print out any contained symbolic
 310   // names.
 311   SmallVector<const Type *, 16> TypeStack;
 312   std::string TypeName;
 313
 314   raw_string_ostream TypeOS(TypeName);
 315   CalcTypeName(Ty, TypeStack, TypeOS, IgnoreTopLevelName);
 316   OS << TypeOS.str();
 317
 318   // Cache type name for later use.
 319   if (!IgnoreTopLevelName)
 320     TM.insert(std::make_pair(Ty, TypeOS.str()));
 321 }
 322
 323 namespace {
 324   class TypeFinder {
 325     // To avoid walking constant expressions multiple times and other IR
 326     // objects, we keep several helper maps.
 327     DenseSet<const Value*> VisitedConstants;
 328     DenseSet<const Type*> VisitedTypes;
 329
 330     TypePrinting &TP;
 331     std::vector<const Type*> &NumberedTypes;
 332   public:
 333     TypeFinder(TypePrinting &tp, std::vector<const Type*> &numberedTypes)
 334       : TP(tp), NumberedTypes(numberedTypes) {}
 335
 336     void Run(const Module &M) {
 337       // Get types from the type symbol table.  This gets opaque types referened
 338       // only through derived named types.
 339       const TypeSymbolTable &ST = M.getTypeSymbolTable();
 340       for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
 341            TI != E; ++TI)
 342         IncorporateType(TI->second);
 343
 344       // Get types from global variables.
 345       for (Module::const_global_iterator I = M.global_begin(),
 346            E = M.global_end(); I != E; ++I) {
 347         IncorporateType(I->getType());
 348         if (I->hasInitializer())
 349           IncorporateValue(I->getInitializer());
 350       }
 351
 352       // Get types from aliases.
 353       for (Module::const_alias_iterator I = M.alias_begin(),
 354            E = M.alias_end(); I != E; ++I) {
 355         IncorporateType(I->getType());
 356         IncorporateValue(I->getAliasee());
 357       }
 358
 359       // Get types from functions.
 360       for (Module::const_iterator FI = M.begin(), E = M.end(); FI != E; ++FI) {
 361         IncorporateType(FI->getType());
 362
 363         for (Function::const_iterator BB = FI->begin(), E = FI->end();
 364              BB != E;++BB)
 365           for (BasicBlock::const_iterator II = BB->begin(),
 366                E = BB->end(); II != E; ++II) {
 367             const Instruction &I = *II;
 368             // Incorporate the type of the instruction and all its operands.
 369             IncorporateType(I.getType());
 370             for (User::const_op_iterator OI = I.op_begin(), OE = I.op_end();
 371                  OI != OE; ++OI)
 372               IncorporateValue(*OI);
 373           }
 374       }
 375     }
 376
 377   private:
 378     void IncorporateType(const Type *Ty) {
 379       // Check to see if we're already visited this type.
 380       if (!VisitedTypes.insert(Ty).second)
 381         return;
 382
 383       // If this is a structure or opaque type, add a name for the type.
 384       if (((Ty->isStructTy() && cast<StructType>(Ty)->getNumElements())
 385             || Ty->isOpaqueTy()) && !TP.hasTypeName(Ty)) {
 386         TP.addTypeName(Ty, "%"+utostr(unsigned(NumberedTypes.size())));
 387         NumberedTypes.push_back(Ty);
 388       }
 389
 390       // Recursively walk all contained types.
 391       for (Type::subtype_iterator I = Ty->subtype_begin(),
 392            E = Ty->subtype_end(); I != E; ++I)
 393         IncorporateType(*I);
 394     }
 395
 396     /// IncorporateValue - This method is used to walk operand lists finding
 397     /// types hiding in constant expressions and other operands that won't be
 398     /// walked in other ways.  GlobalValues, basic blocks, instructions, and
 399     /// inst operands are all explicitly enumerated.
 400     void IncorporateValue(const Value *V) {
 401       if (V == 0 || !isa<Constant>(V) || isa<GlobalValue>(V)) return;
 402
 403       // Already visited?
 404       if (!VisitedConstants.insert(V).second)
 405         return;
 406
 407       // Check this type.
 408       IncorporateType(V->getType());
 409
 410       // Look in operands for types.
 411       const Constant *C = cast<Constant>(V);
 412       for (Constant::const_op_iterator I = C->op_begin(),
 413            E = C->op_end(); I != E;++I)
 414         IncorporateValue(*I);
 415     }
 416   };
 417 } // end anonymous namespace
 418
 419
 420 /// AddModuleTypesToPrinter - Add all of the symbolic type names for types in
 421 /// the specified module to the TypePrinter and all numbered types to it and the
 422 /// NumberedTypes table.
 423 static void AddModuleTypesToPrinter(TypePrinting &TP,
 424                                     std::vector<const Type*> &NumberedTypes,
 425                                     const Module *M) {
 426   if (M == 0) return;
 427
 428   // If the module has a symbol table, take all global types and stuff their
 429   // names into the TypeNames map.
 430   const TypeSymbolTable &ST = M->getTypeSymbolTable();
 431   for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
 432        TI != E; ++TI) {
 433     const Type *Ty = cast<Type>(TI->second);
 434
 435     // As a heuristic, don't insert pointer to primitive types, because
 436     // they are used too often to have a single useful name.
 437     if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 438       const Type *PETy = PTy->getElementType();
 439       if ((PETy->isPrimitiveType() || PETy->isIntegerTy()) &&
 440           !PETy->isOpaqueTy())
 441         continue;
 442     }
 443
 444     // Likewise don't insert primitives either.
 445     if (Ty->isIntegerTy() || Ty->isPrimitiveType())
 446       continue;
 447
 448     // Get the name as a string and insert it into TypeNames.
 449     std::string NameStr;
 450     raw_string_ostream NameROS(NameStr);
 451     formatted_raw_ostream NameOS(NameROS);
 452     PrintLLVMName(NameOS, TI->first, LocalPrefix);
 453     NameOS.flush();
 454     TP.addTypeName(Ty, NameStr);
 455   }
 456
 457   // Walk the entire module to find references to unnamed structure and opaque
 458   // types.  This is required for correctness by opaque types (because multiple
 459   // uses of an unnamed opaque type needs to be referred to by the same ID) and
 460   // it shrinks complex recursive structure types substantially in some cases.
 461   TypeFinder(TP, NumberedTypes).Run(*M);
 462 }
 463
 464
 465 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
 466 /// type, iff there is an entry in the modules symbol table for the specified
 467 /// type or one of it's component types.
 468 ///
 469 void llvm::WriteTypeSymbolic(raw_ostream &OS, const Type *Ty, const Module *M) {
 470   TypePrinting Printer;
 471   std::vector<const Type*> NumberedTypes;
 472   AddModuleTypesToPrinter(Printer, NumberedTypes, M);
 473   Printer.print(Ty, OS);
 474 }
 475
 476 //===----------------------------------------------------------------------===//
 477 // SlotTracker Class: Enumerate slot numbers for unnamed values
 478 //===----------------------------------------------------------------------===//
 479
 480 namespace {
 481
 482 /// This class provides computation of slot numbers for LLVM Assembly writing.
 483 ///
 484 class SlotTracker {
 485 public:
 486   /// ValueMap - A mapping of Values to slot numbers.
 487   typedef DenseMap<const Value*, unsigned> ValueMap;
 488
 489 private:
 490   /// TheModule - The module for which we are holding slot numbers.
 491   const Module* TheModule;
 492
 493   /// TheFunction - The function for which we are holding slot numbers.
 494   const Function* TheFunction;
 495   bool FunctionProcessed;
 496
 497   /// mMap - The TypePlanes map for the module level data.
 498   ValueMap mMap;
 499   unsigned mNext;
 500
 501   /// fMap - The TypePlanes map for the function level data.
 502   ValueMap fMap;
 503   unsigned fNext;
 504
 505   /// mdnMap - Map for MDNodes.
 506   DenseMap<const MDNode*, unsigned> mdnMap;
 507   unsigned mdnNext;
 508 public:
 509   /// Construct from a module
 510   explicit SlotTracker(const Module *M);
 511   /// Construct from a function, starting out in incorp state.
 512   explicit SlotTracker(const Function *F);
 513
 514   /// Return the slot number of the specified value in it's type
 515   /// plane.  If something is not in the SlotTracker, return -1.
 516   int getLocalSlot(const Value *V);
 517   int getGlobalSlot(const GlobalValue *V);
 518   int getMetadataSlot(const MDNode *N);
 519
 520   /// If you'd like to deal with a function instead of just a module, use
 521   /// this method to get its data into the SlotTracker.
 522   void incorporateFunction(const Function *F) {
 523     TheFunction = F;
 524     FunctionProcessed = false;
 525   }
 526
 527   /// After calling incorporateFunction, use this method to remove the
 528   /// most recently incorporated function from the SlotTracker. This
 529   /// will reset the state of the machine back to just the module contents.
 530   void purgeFunction();
 531
 532   /// MDNode map iterators.
 533   typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
 534   mdn_iterator mdn_begin() { return mdnMap.begin(); }
 535   mdn_iterator mdn_end() { return mdnMap.end(); }
 536   unsigned mdn_size() const { return mdnMap.size(); }
 537   bool mdn_empty() const { return mdnMap.empty(); }
 538
 539   /// This function does the actual initialization.
 540   inline void initialize();
 541
 542   // Implementation Details
 543 private:
 544   /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 545   void CreateModuleSlot(const GlobalValue *V);
 546
 547   /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
 548   void CreateMetadataSlot(const MDNode *N);
 549
 550   /// CreateFunctionSlot - Insert the specified Value* into the slot table.
 551   void CreateFunctionSlot(const Value *V);
 552
 553   /// Add all of the module level global variables (and their initializers)
 554   /// and function declarations, but not the contents of those functions.
 555   void processModule();
 556
 557   /// Add all of the functions arguments, basic blocks, and instructions.
 558   void processFunction();
 559
 560   SlotTracker(const SlotTracker &);  // DO NOT IMPLEMENT
 561   void operator=(const SlotTracker &);  // DO NOT IMPLEMENT
 562 };
 563
 564 }  // end anonymous namespace
 565
 566
 567 static SlotTracker *createSlotTracker(const Value *V) {
 568   if (const Argument *FA = dyn_cast<Argument>(V))
 569     return new SlotTracker(FA->getParent());
 570
 571   if (const Instruction *I = dyn_cast<Instruction>(V))
 572     return new SlotTracker(I->getParent()->getParent());
 573
 574   if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
 575     return new SlotTracker(BB->getParent());
 576
 577   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
 578     return new SlotTracker(GV->getParent());
 579
 580   if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
 581     return new SlotTracker(GA->getParent());
 582
 583   if (const Function *Func = dyn_cast<Function>(V))
 584     return new SlotTracker(Func);
 585
 586   if (isa<MDNode>(V))
 587     return new SlotTracker((Function *)0);
 588
 589   return 0;
 590 }
 591
 592 #if 0
 593 #define ST_DEBUG(X) dbgs() << X
 594 #else
 595 #define ST_DEBUG(X)
 596 #endif
 597
 598 // Module level constructor. Causes the contents of the Module (sans functions)
 599 // to be added to the slot table.
 600 SlotTracker::SlotTracker(const Module *M)
 601   : TheModule(M), TheFunction(0), FunctionProcessed(false),
 602     mNext(0), fNext(0),  mdnNext(0) {
 603 }
 604
 605 // Function level constructor. Causes the contents of the Module and the one
 606 // function provided to be added to the slot table.
 607 SlotTracker::SlotTracker(const Function *F)
 608   : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
 609     mNext(0), fNext(0), mdnNext(0) {
 610 }
 611
 612 inline void SlotTracker::initialize() {
 613   if (TheModule) {
 614     processModule();
 615     TheModule = 0; ///< Prevent re-processing next time we're called.
 616   }
 617
 618   if (TheFunction && !FunctionProcessed)
 619     processFunction();
 620 }
 621
 622 // Iterate through all the global variables, functions, and global
 623 // variable initializers and create slots for them.
 624 void SlotTracker::processModule() {
 625   ST_DEBUG("begin processModule!\n");
 626
 627   // Add all of the unnamed global variables to the value table.
 628   for (Module::const_global_iterator I = TheModule->global_begin(),
 629          E = TheModule->global_end(); I != E; ++I) {
 630     if (!I->hasName())
 631       CreateModuleSlot(I);
 632   }
 633
 634   // Add metadata used by named metadata.
 635   for (Module::const_named_metadata_iterator
 636          I = TheModule->named_metadata_begin(),
 637          E = TheModule->named_metadata_end(); I != E; ++I) {
 638     const NamedMDNode *NMD = I;
 639     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
 640       if (MDNode *MD = NMD->getOperand(i))
 641         CreateMetadataSlot(MD);
 642     }
 643   }
 644
 645   // Add all the unnamed functions to the table.
 646   for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
 647        I != E; ++I)
 648     if (!I->hasName())
 649       CreateModuleSlot(I);
 650
 651   ST_DEBUG("end processModule!\n");
 652 }
 653
 654 // Process the arguments, basic blocks, and instructions  of a function.
 655 void SlotTracker::processFunction() {
 656   ST_DEBUG("begin processFunction!\n");
 657   fNext = 0;
 658
 659   // Add all the function arguments with no names.
 660   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
 661       AE = TheFunction->arg_end(); AI != AE; ++AI)
 662     if (!AI->hasName())
 663       CreateFunctionSlot(AI);
 664
 665   ST_DEBUG("Inserting Instructions:\n");
 666
 667   SmallVector<std::pair<unsigned, MDNode*>, 4> MDForInst;
 668
 669   // Add all of the basic blocks and instructions with no names.
 670   for (Function::const_iterator BB = TheFunction->begin(),
 671        E = TheFunction->end(); BB != E; ++BB) {
 672     if (!BB->hasName())
 673       CreateFunctionSlot(BB);
 674
 675     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
 676          ++I) {
 677       if (!I->getType()->isVoidTy() && !I->hasName())
 678         CreateFunctionSlot(I);
 679
 680       // Intrinsics can directly use metadata.  We allow direct calls to any
 681       // llvm.foo function here, because the target may not be linked into the
 682       // optimizer.
 683       if (const CallInst *CI = dyn_cast<CallInst>(I)) {
 684         if (Function *F = CI->getCalledFunction())
 685           if (F->getName().startswith("llvm."))
 686             for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 687               if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
 688                 CreateMetadataSlot(N);
 689       }
 690
 691       // Process metadata attached with this instruction.
 692       I->getAllMetadata(MDForInst);
 693       for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
 694         CreateMetadataSlot(MDForInst[i].second);
 695       MDForInst.clear();
 696     }
 697   }
 698
 699   FunctionProcessed = true;
 700
 701   ST_DEBUG("end processFunction!\n");
 702 }
 703
 704 /// Clean up after incorporating a function. This is the only way to get out of
 705 /// the function incorporation state that affects get*Slot/Create*Slot. Function
 706 /// incorporation state is indicated by TheFunction != 0.
 707 void SlotTracker::purgeFunction() {
 708   ST_DEBUG("begin purgeFunction!\n");
 709   fMap.clear(); // Simply discard the function level map
 710   TheFunction = 0;
 711   FunctionProcessed = false;
 712   ST_DEBUG("end purgeFunction!\n");
 713 }
 714
 715 /// getGlobalSlot - Get the slot number of a global value.
 716 int SlotTracker::getGlobalSlot(const GlobalValue *V) {
 717   // Check for uninitialized state and do lazy initialization.
 718   initialize();
 719
 720   // Find the type plane in the module map
 721   ValueMap::iterator MI = mMap.find(V);
 722   return MI == mMap.end() ? -1 : (int)MI->second;
 723 }
 724
 725 /// getMetadataSlot - Get the slot number of a MDNode.
 726 int SlotTracker::getMetadataSlot(const MDNode *N) {
 727   // Check for uninitialized state and do lazy initialization.
 728   initialize();
 729
 730   // Find the type plane in the module map
 731   mdn_iterator MI = mdnMap.find(N);
 732   return MI == mdnMap.end() ? -1 : (int)MI->second;
 733 }
 734
 735
 736 /// getLocalSlot - Get the slot number for a value that is local to a function.
 737 int SlotTracker::getLocalSlot(const Value *V) {
 738   assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
 739
 740   // Check for uninitialized state and do lazy initialization.
 741   initialize();
 742
 743   ValueMap::iterator FI = fMap.find(V);
 744   return FI == fMap.end() ? -1 : (int)FI->second;
 745 }
 746
 747
 748 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
 749 void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
 750   assert(V && "Can't insert a null Value into SlotTracker!");
 751   assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
 752   assert(!V->hasName() && "Doesn't need a slot!");
 753
 754   unsigned DestSlot = mNext++;
 755   mMap[V] = DestSlot;
 756
 757   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
 758            DestSlot << " [");
 759   // G = Global, F = Function, A = Alias, o = other
 760   ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
 761             (isa<Function>(V) ? 'F' :
 762              (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
 763 }
 764
 765 /// CreateSlot - Create a new slot for the specified value if it has no name.
 766 void SlotTracker::CreateFunctionSlot(const Value *V) {
 767   assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
 768
 769   unsigned DestSlot = fNext++;
 770   fMap[V] = DestSlot;
 771
 772   // G = Global, F = Function, o = other
 773   ST_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
 774            DestSlot << " [o]\n");
 775 }
 776
 777 /// CreateModuleSlot - Insert the specified MDNode* into the slot table.
 778 void SlotTracker::CreateMetadataSlot(const MDNode *N) {
 779   assert(N && "Can't insert a null Value into SlotTracker!");
 780
 781   // Don't insert if N is a function-local metadata, these are always printed
 782   // inline.
 783   if (N->isFunctionLocal())
 784     return;
 785
 786   mdn_iterator I = mdnMap.find(N);
 787   if (I != mdnMap.end())
 788     return;
 789
 790   unsigned DestSlot = mdnNext++;
 791   mdnMap[N] = DestSlot;
 792
 793   // Recursively add any MDNodes referenced by operands.
 794   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
 795     if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
 796       CreateMetadataSlot(Op);
 797 }
 798
 799 //===----------------------------------------------------------------------===//
 800 // AsmWriter Implementation
 801 //===----------------------------------------------------------------------===//
 802
 803 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
 804                                    TypePrinting *TypePrinter,
 805                                    SlotTracker *Machine);
 806
 807
 808
 809 static const char *getPredicateText(unsigned predicate) {
 810   const char * pred = "unknown";
 811   switch (predicate) {
 812   case FCmpInst::FCMP_FALSE: pred = "false"; break;
 813   case FCmpInst::FCMP_OEQ:   pred = "oeq"; break;
 814   case FCmpInst::FCMP_OGT:   pred = "ogt"; break;
 815   case FCmpInst::FCMP_OGE:   pred = "oge"; break;
 816   case FCmpInst::FCMP_OLT:   pred = "olt"; break;
 817   case FCmpInst::FCMP_OLE:   pred = "ole"; break;
 818   case FCmpInst::FCMP_ONE:   pred = "one"; break;
 819   case FCmpInst::FCMP_ORD:   pred = "ord"; break;
 820   case FCmpInst::FCMP_UNO:   pred = "uno"; break;
 821   case FCmpInst::FCMP_UEQ:   pred = "ueq"; break;
 822   case FCmpInst::FCMP_UGT:   pred = "ugt"; break;
 823   case FCmpInst::FCMP_UGE:   pred = "uge"; break;
 824   case FCmpInst::FCMP_ULT:   pred = "ult"; break;
 825   case FCmpInst::FCMP_ULE:   pred = "ule"; break;
 826   case FCmpInst::FCMP_UNE:   pred = "une"; break;
 827   case FCmpInst::FCMP_TRUE:  pred = "true"; break;
 828   case ICmpInst::ICMP_EQ:    pred = "eq"; break;
 829   case ICmpInst::ICMP_NE:    pred = "ne"; break;
 830   case ICmpInst::ICMP_SGT:   pred = "sgt"; break;
 831   case ICmpInst::ICMP_SGE:   pred = "sge"; break;
 832   case ICmpInst::ICMP_SLT:   pred = "slt"; break;
 833   case ICmpInst::ICMP_SLE:   pred = "sle"; break;
 834   case ICmpInst::ICMP_UGT:   pred = "ugt"; break;
 835   case ICmpInst::ICMP_UGE:   pred = "uge"; break;
 836   case ICmpInst::ICMP_ULT:   pred = "ult"; break;
 837   case ICmpInst::ICMP_ULE:   pred = "ule"; break;
 838   }
 839   return pred;
 840 }
 841
 842
 843 static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
 844   if (const OverflowingBinaryOperator *OBO =
 845         dyn_cast<OverflowingBinaryOperator>(U)) {
 846     if (OBO->hasNoUnsignedWrap())
 847       Out << " nuw";
 848     if (OBO->hasNoSignedWrap())
 849       Out << " nsw";
 850   } else if (const SDivOperator *Div = dyn_cast<SDivOperator>(U)) {
 851     if (Div->isExact())
 852       Out << " exact";
 853   } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
 854     if (GEP->isInBounds())
 855       Out << " inbounds";
 856   }
 857 }
 858
 859 static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
 860                              TypePrinting &TypePrinter, SlotTracker *Machine) {
 861   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
 862     if (CI->getType()->isIntegerTy(1)) {
 863       Out << (CI->getZExtValue() ? "true" : "false");
 864       return;
 865     }
 866     Out << CI->getValue();
 867     return;
 868   }
 869
 870   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 871     if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
 872         &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
 873       // We would like to output the FP constant value in exponential notation,
 874       // but we cannot do this if doing so will lose precision.  Check here to
 875       // make sure that we only output it in exponential format if we can parse
 876       // the value back and get the same value.
 877       //
 878       bool ignored;
 879       bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
 880       double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
 881                               CFP->getValueAPF().convertToFloat();
 882       SmallString<128> StrVal;
 883       raw_svector_ostream(StrVal) << Val;
 884
 885       // Check to make sure that the stringized number is not some string like
 886       // "Inf" or NaN, that atof will accept, but the lexer will not.  Check
 887       // that the string matches the "[-+]?[0-9]" regex.
 888       //
 889       if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
 890           ((StrVal[0] == '-' || StrVal[0] == '+') &&
 891            (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
 892         // Reparse stringized version!
 893         if (atof(StrVal.c_str()) == Val) {
 894           Out << StrVal.str();
 895           return;
 896         }
 897       }
 898       // Otherwise we could not reparse it to exactly the same value, so we must
 899       // output the string in hexadecimal format!  Note that loading and storing
 900       // floating point types changes the bits of NaNs on some hosts, notably
 901       // x86, so we must not use these types.
 902       assert(sizeof(double) == sizeof(uint64_t) &&
 903              "assuming that double is 64 bits!");
 904       char Buffer[40];
 905       APFloat apf = CFP->getValueAPF();
 906       // Floats are represented in ASCII IR as double, convert.
 907       if (!isDouble)
 908         apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
 909                           &ignored);
 910       Out << "0x" <<
 911               utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
 912                             Buffer+40);
 913       return;
 914     }
 915
 916     // Some form of long double.  These appear as a magic letter identifying
 917     // the type, then a fixed number of hex digits.
 918     Out << "0x";
 919     if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
 920       Out << 'K';
 921       // api needed to prevent premature destruction
 922       APInt api = CFP->getValueAPF().bitcastToAPInt();
 923       const uint64_t* p = api.getRawData();
 924       uint64_t word = p[1];
 925       int shiftcount=12;
 926       int width = api.getBitWidth();
 927       for (int j=0; j<width; j+=4, shiftcount-=4) {
 928         unsigned int nibble = (word>>shiftcount) & 15;
 929         if (nibble < 10)
 930           Out << (unsigned char)(nibble + '0');
 931         else
 932           Out << (unsigned char)(nibble - 10 + 'A');
 933         if (shiftcount == 0 && j+4 < width) {
 934           word = *p;
 935           shiftcount = 64;
 936           if (width-j-4 < 64)
 937             shiftcount = width-j-4;
 938         }
 939       }
 940       return;
 941     } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
 942       Out << 'L';
 943     else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
 944       Out << 'M';
 945     else
 946       llvm_unreachable("Unsupported floating point type");
 947     // api needed to prevent premature destruction
 948     APInt api = CFP->getValueAPF().bitcastToAPInt();
 949     const uint64_t* p = api.getRawData();
 950     uint64_t word = *p;
 951     int shiftcount=60;
 952     int width = api.getBitWidth();
 953     for (int j=0; j<width; j+=4, shiftcount-=4) {
 954       unsigned int nibble = (word>>shiftcount) & 15;
 955       if (nibble < 10)
 956         Out << (unsigned char)(nibble + '0');
 957       else
 958         Out << (unsigned char)(nibble - 10 + 'A');
 959       if (shiftcount == 0 && j+4 < width) {
 960         word = *(++p);
 961         shiftcount = 64;
 962         if (width-j-4 < 64)
 963           shiftcount = width-j-4;
 964       }
 965     }
 966     return;
 967   }
 968
 969   if (isa<ConstantAggregateZero>(CV)) {
 970     Out << "zeroinitializer";
 971     return;
 972   }
 973
 974   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
 975     Out << "blockaddress(";
 976     WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine);
 977     Out << ", ";
 978     WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine);
 979     Out << ")";
 980     return;
 981   }
 982
 983   if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 984     // As a special case, print the array as a string if it is an array of
 985     // i8 with ConstantInt values.
 986     //
 987     const Type *ETy = CA->getType()->getElementType();
 988     if (CA->isString()) {
 989       Out << "c\"";
 990       PrintEscapedString(CA->getAsString(), Out);
 991       Out << '"';
 992     } else {                // Cannot output in string format...
 993       Out << '[';
 994       if (CA->getNumOperands()) {
 995         TypePrinter.print(ETy, Out);
 996         Out << ' ';
 997         WriteAsOperandInternal(Out, CA->getOperand(0),
 998                                &TypePrinter, Machine);
 999         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1000           Out << ", ";
1001           TypePrinter.print(ETy, Out);
1002           Out << ' ';
1003           WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine);
1004         }
1005       }
1006       Out << ']';
1007     }
1008     return;
1009   }
1010
1011   if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
1012     if (CS->getType()->isPacked())
1013       Out << '<';
1014     Out << '{';
1015     unsigned N = CS->getNumOperands();
1016     if (N) {
1017       Out << ' ';
1018       TypePrinter.print(CS->getOperand(0)->getType(), Out);
1019       Out << ' ';
1020
1021       WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine);
1022
1023       for (unsigned i = 1; i < N; i++) {
1024         Out << ", ";
1025         TypePrinter.print(CS->getOperand(i)->getType(), Out);
1026         Out << ' ';
1027
1028         WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine);
1029       }
1030       Out << ' ';
1031     }
1032
1033     Out << '}';
1034     if (CS->getType()->isPacked())
1035       Out << '>';
1036     return;
1037   }
1038
1039   if (const ConstantUnion *CU = dyn_cast<ConstantUnion>(CV)) {
1040     Out << "{ ";
1041     TypePrinter.print(CU->getOperand(0)->getType(), Out);
1042     Out << ' ';
1043     WriteAsOperandInternal(Out, CU->getOperand(0), &TypePrinter, Machine);
1044     Out << " }";
1045     return;
1046   }
1047
1048   if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1049     const Type *ETy = CP->getType()->getElementType();
1050     assert(CP->getNumOperands() > 0 &&
1051            "Number of operands for a PackedConst must be > 0");
1052     Out << '<';
1053     TypePrinter.print(ETy, Out);
1054     Out << ' ';
1055     WriteAsOperandInternal(Out, CP->getOperand(0), &TypePrinter, Machine);
1056     for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
1057       Out << ", ";
1058       TypePrinter.print(ETy, Out);
1059       Out << ' ';
1060       WriteAsOperandInternal(Out, CP->getOperand(i), &TypePrinter, Machine);
1061     }
1062     Out << '>';
1063     return;
1064   }
1065
1066   if (isa<ConstantPointerNull>(CV)) {
1067     Out << "null";
1068     return;
1069   }
1070
1071   if (isa<UndefValue>(CV)) {
1072     Out << "undef";
1073     return;
1074   }
1075
1076   if (const MDNode *Node = dyn_cast<MDNode>(CV)) {
1077     Out << "!" << Machine->getMetadataSlot(Node);
1078     return;
1079   }
1080
1081   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
1082     Out << CE->getOpcodeName();
1083     WriteOptimizationInfo(Out, CE);
1084     if (CE->isCompare())
1085       Out << ' ' << getPredicateText(CE->getPredicate());
1086     Out << " (";
1087
1088     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
1089       TypePrinter.print((*OI)->getType(), Out);
1090       Out << ' ';
1091       WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine);
1092       if (OI+1 != CE->op_end())
1093         Out << ", ";
1094     }
1095
1096     if (CE->hasIndices()) {
1097       const SmallVector<unsigned, 4> &Indices = CE->getIndices();
1098       for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1099         Out << ", " << Indices[i];
1100     }
1101
1102     if (CE->isCast()) {
1103       Out << " to ";
1104       TypePrinter.print(CE->getType(), Out);
1105     }
1106
1107     Out << ')';
1108     return;
1109   }
1110
1111   Out << "<placeholder or erroneous Constant>";
1112 }
1113
1114 static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
1115                                     TypePrinting *TypePrinter,
1116                                     SlotTracker *Machine) {
1117   Out << "!{";
1118   for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
1119     const Value *V = Node->getOperand(mi);
1120     if (V == 0)
1121       Out << "null";
1122     else {
1123       TypePrinter->print(V->getType(), Out);
1124       Out << ' ';
1125       WriteAsOperandInternal(Out, Node->getOperand(mi),
1126                              TypePrinter, Machine);
1127     }
1128     if (mi + 1 != me)
1129       Out << ", ";
1130   }
1131
1132   Out << "}";
1133 }
1134
1135
1136 /// WriteAsOperand - Write the name of the specified value out to the specified
1137 /// ostream.  This can be useful when you just want to print int %reg126, not
1138 /// the whole instruction that generated it.
1139 ///
1140 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
1141                                    TypePrinting *TypePrinter,
1142                                    SlotTracker *Machine) {
1143   if (V->hasName()) {
1144     PrintLLVMName(Out, V);
1145     return;
1146   }
1147
1148   const Constant *CV = dyn_cast<Constant>(V);
1149   if (CV && !isa<GlobalValue>(CV)) {
1150     assert(TypePrinter && "Constants require TypePrinting!");
1151     WriteConstantInt(Out, CV, *TypePrinter, Machine);
1152     return;
1153   }
1154
1155   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1156     Out << "asm ";
1157     if (IA->hasSideEffects())
1158       Out << "sideeffect ";
1159     if (IA->isAlignStack())
1160       Out << "alignstack ";
1161     Out << '"';
1162     PrintEscapedString(IA->getAsmString(), Out);
1163     Out << "\", \"";
1164     PrintEscapedString(IA->getConstraintString(), Out);
1165     Out << '"';
1166     return;
1167   }
1168
1169   if (const MDNode *N = dyn_cast<MDNode>(V)) {
1170     if (N->isFunctionLocal()) {
1171       // Print metadata inline, not via slot reference number.
1172       WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine);
1173       return;
1174     }
1175
1176     if (!Machine)
1177       Machine = createSlotTracker(V);
1178     Out << '!' << Machine->getMetadataSlot(N);
1179     return;
1180   }
1181
1182   if (const MDString *MDS = dyn_cast<MDString>(V)) {
1183     Out << "!\"";
1184     PrintEscapedString(MDS->getString(), Out);
1185     Out << '"';
1186     return;
1187   }
1188
1189   if (V->getValueID() == Value::PseudoSourceValueVal ||
1190       V->getValueID() == Value::FixedStackPseudoSourceValueVal) {
1191     V->print(Out);
1192     return;
1193   }
1194
1195   char Prefix = '%';
1196   int Slot;
1197   if (Machine) {
1198     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1199       Slot = Machine->getGlobalSlot(GV);
1200       Prefix = '@';
1201     } else {
1202       Slot = Machine->getLocalSlot(V);
1203     }
1204   } else {
1205     Machine = createSlotTracker(V);
1206     if (Machine) {
1207       if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1208         Slot = Machine->getGlobalSlot(GV);
1209         Prefix = '@';
1210       } else {
1211         Slot = Machine->getLocalSlot(V);
1212       }
1213       delete Machine;
1214     } else {
1215       Slot = -1;
1216     }
1217   }
1218
1219   if (Slot != -1)
1220     Out << Prefix << Slot;
1221   else
1222     Out << "<badref>";
1223 }
1224
1225 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1226                           bool PrintType, const Module *Context) {
1227
1228   // Fast path: Don't construct and populate a TypePrinting object if we
1229   // won't be needing any types printed.
1230   if (!PrintType &&
1231       (!isa<Constant>(V) || V->hasName() || isa<GlobalValue>(V))) {
1232     WriteAsOperandInternal(Out, V, 0, 0);
1233     return;
1234   }
1235
1236   if (Context == 0) Context = getModuleFromVal(V);
1237
1238   TypePrinting TypePrinter;
1239   std::vector<const Type*> NumberedTypes;
1240   AddModuleTypesToPrinter(TypePrinter, NumberedTypes, Context);
1241   if (PrintType) {
1242     TypePrinter.print(V->getType(), Out);
1243     Out << ' ';
1244   }
1245
1246   WriteAsOperandInternal(Out, V, &TypePrinter, 0);
1247 }
1248
1249 namespace {
1250
1251 class AssemblyWriter {
1252   formatted_raw_ostream &Out;
1253   SlotTracker &Machine;
1254   const Module *TheModule;
1255   TypePrinting TypePrinter;
1256   AssemblyAnnotationWriter *AnnotationWriter;
1257   std::vector<const Type*> NumberedTypes;
1258
1259 public:
1260   inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1261                         const Module *M,
1262                         AssemblyAnnotationWriter *AAW)
1263     : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
1264     AddModuleTypesToPrinter(TypePrinter, NumberedTypes, M);
1265   }
1266
1267   void printMDNodeBody(const MDNode *MD);
1268   void printNamedMDNode(const NamedMDNode *NMD);
1269
1270   void printModule(const Module *M);
1271
1272   void writeOperand(const Value *Op, bool PrintType);
1273   void writeParamOperand(const Value *Operand, Attributes Attrs);
1274
1275   void writeAllMDNodes();
1276
1277   void printTypeSymbolTable(const TypeSymbolTable &ST);
1278   void printGlobal(const GlobalVariable *GV);
1279   void printAlias(const GlobalAlias *GV);
1280   void printFunction(const Function *F);
1281   void printArgument(const Argument *FA, Attributes Attrs);
1282   void printBasicBlock(const BasicBlock *BB);
1283   void printInstruction(const Instruction &I);
1284
1285 private:
1286   // printInfoComment - Print a little comment after the instruction indicating
1287   // which slot it occupies.
1288   void printInfoComment(const Value &V);
1289 };
1290 }  // end of anonymous namespace
1291
1292 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1293   if (Operand == 0) {
1294     Out << "<null operand!>";
1295     return;
1296   }
1297   if (PrintType) {
1298     TypePrinter.print(Operand->getType(), Out);
1299     Out << ' ';
1300   }
1301   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
1302 }
1303
1304 void AssemblyWriter::writeParamOperand(const Value *Operand,
1305                                        Attributes Attrs) {
1306   if (Operand == 0) {
1307     Out << "<null operand!>";
1308     return;
1309   }
1310
1311   // Print the type
1312   TypePrinter.print(Operand->getType(), Out);
1313   // Print parameter attributes list
1314   if (Attrs != Attribute::None)
1315     Out << ' ' << Attribute::getAsString(Attrs);
1316   Out << ' ';
1317   // Print the operand
1318   WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
1319 }
1320
1321 void AssemblyWriter::printModule(const Module *M) {
1322   if (!M->getModuleIdentifier().empty() &&
1323       // Don't print the ID if it will start a new line (which would
1324       // require a comment char before it).
1325       M->getModuleIdentifier().find('\n') == std::string::npos)
1326     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1327
1328   if (!M->getDataLayout().empty())
1329     Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1330   if (!M->getTargetTriple().empty())
1331     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1332
1333   if (!M->getModuleInlineAsm().empty()) {
1334     // Split the string into lines, to make it easier to read the .ll file.
1335     std::string Asm = M->getModuleInlineAsm();
1336     size_t CurPos = 0;
1337     size_t NewLine = Asm.find_first_of('\n', CurPos);
1338     Out << '\n';
1339     while (NewLine != std::string::npos) {
1340       // We found a newline, print the portion of the asm string from the
1341       // last newline up to this newline.
1342       Out << "module asm \"";
1343       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1344                          Out);
1345       Out << "\"\n";
1346       CurPos = NewLine+1;
1347       NewLine = Asm.find_first_of('\n', CurPos);
1348     }
1349     Out << "module asm \"";
1350     PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1351     Out << "\"\n";
1352   }
1353
1354   // Loop over the dependent libraries and emit them.
1355   Module::lib_iterator LI = M->lib_begin();
1356   Module::lib_iterator LE = M->lib_end();
1357   if (LI != LE) {
1358     Out << '\n';
1359     Out << "deplibs = [ ";
1360     while (LI != LE) {
1361       Out << '"' << *LI << '"';
1362       ++LI;
1363       if (LI != LE)
1364         Out << ", ";
1365     }
1366     Out << " ]";
1367   }
1368
1369   // Loop over the symbol table, emitting all id'd types.
1370   if (!M->getTypeSymbolTable().empty() || !NumberedTypes.empty()) Out << '\n';
1371   printTypeSymbolTable(M->getTypeSymbolTable());
1372
1373   // Output all globals.
1374   if (!M->global_empty()) Out << '\n';
1375   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1376        I != E; ++I)
1377     printGlobal(I);
1378
1379   // Output all aliases.
1380   if (!M->alias_empty()) Out << "\n";
1381   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1382        I != E; ++I)
1383     printAlias(I);
1384
1385   // Output all of the functions.
1386   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1387     printFunction(I);
1388
1389   // Output named metadata.
1390   if (!M->named_metadata_empty()) Out << '\n';
1391
1392   for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
1393        E = M->named_metadata_end(); I != E; ++I)
1394     printNamedMDNode(I);
1395
1396   // Output metadata.
1397   if (!Machine.mdn_empty()) {
1398     Out << '\n';
1399     writeAllMDNodes();
1400   }
1401 }
1402
1403 void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1404   Out << "!" << NMD->getName() << " = !{";
1405   for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1406     if (i) Out << ", ";
1407     if (MDNode *MD = NMD->getOperand(i))
1408       Out << '!' << Machine.getMetadataSlot(MD);
1409     else
1410       Out << "null";
1411   }
1412   Out << "}\n";
1413 }
1414
1415
1416 static void PrintLinkage(GlobalValue::LinkageTypes LT,
1417                          formatted_raw_ostream &Out) {
1418   switch (LT) {
1419   case GlobalValue::ExternalLinkage: break;
1420   case GlobalValue::PrivateLinkage:       Out << "private ";        break;
1421   case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
1422   case GlobalValue::InternalLinkage:      Out << "internal ";       break;
1423   case GlobalValue::LinkOnceAnyLinkage:   Out << "linkonce ";       break;
1424   case GlobalValue::LinkOnceODRLinkage:   Out << "linkonce_odr ";   break;
1425   case GlobalValue::WeakAnyLinkage:       Out << "weak ";           break;
1426   case GlobalValue::WeakODRLinkage:       Out << "weak_odr ";       break;
1427   case GlobalValue::CommonLinkage:        Out << "common ";         break;
1428   case GlobalValue::AppendingLinkage:     Out << "appending ";      break;
1429   case GlobalValue::DLLImportLinkage:     Out << "dllimport ";      break;
1430   case GlobalValue::DLLExportLinkage:     Out << "dllexport ";      break;
1431   case GlobalValue::ExternalWeakLinkage:  Out << "extern_weak ";    break;
1432   case GlobalValue::AvailableExternallyLinkage:
1433     Out << "available_externally ";
1434     break;
1435   }
1436 }
1437
1438
1439 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1440                             formatted_raw_ostream &Out) {
1441   switch (Vis) {
1442   case GlobalValue::DefaultVisibility: break;
1443   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
1444   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1445   }
1446 }
1447
1448 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1449   if (GV->isMaterializable())
1450     Out << "; Materializable\n";
1451
1452   WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine);
1453   Out << " = ";
1454
1455   if (!GV->hasInitializer() && GV->hasExternalLinkage())
1456     Out << "external ";
1457
1458   PrintLinkage(GV->getLinkage(), Out);
1459   PrintVisibility(GV->getVisibility(), Out);
1460
1461   if (GV->isThreadLocal()) Out << "thread_local ";
1462   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1463     Out << "addrspace(" << AddressSpace << ") ";
1464   Out << (GV->isConstant() ? "constant " : "global ");
1465   TypePrinter.print(GV->getType()->getElementType(), Out);
1466
1467   if (GV->hasInitializer()) {
1468     Out << ' ';
1469     writeOperand(GV->getInitializer(), false);
1470   }
1471
1472   if (GV->hasSection())
1473     Out << ", section \"" << GV->getSection() << '"';
1474   if (GV->getAlignment())
1475     Out << ", align " << GV->getAlignment();
1476
1477   printInfoComment(*GV);
1478   Out << '\n';
1479 }
1480
1481 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1482   if (GA->isMaterializable())
1483     Out << "; Materializable\n";
1484
1485   // Don't crash when dumping partially built GA
1486   if (!GA->hasName())
1487     Out << "<<nameless>> = ";
1488   else {
1489     PrintLLVMName(Out, GA);
1490     Out << " = ";
1491   }
1492   PrintVisibility(GA->getVisibility(), Out);
1493
1494   Out << "alias ";
1495
1496   PrintLinkage(GA->getLinkage(), Out);
1497
1498   const Constant *Aliasee = GA->getAliasee();
1499
1500   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1501     TypePrinter.print(GV->getType(), Out);
1502     Out << ' ';
1503     PrintLLVMName(Out, GV);
1504   } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1505     TypePrinter.print(F->getFunctionType(), Out);
1506     Out << "* ";
1507
1508     WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
1509   } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1510     TypePrinter.print(GA->getType(), Out);
1511     Out << ' ';
1512     PrintLLVMName(Out, GA);
1513   } else {
1514     const ConstantExpr *CE = cast<ConstantExpr>(Aliasee);
1515     // The only valid GEP is an all zero GEP.
1516     assert((CE->getOpcode() == Instruction::BitCast ||
1517             CE->getOpcode() == Instruction::GetElementPtr) &&
1518            "Unsupported aliasee");
1519     writeOperand(CE, false);
1520   }
1521
1522   printInfoComment(*GA);
1523   Out << '\n';
1524 }
1525
1526 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1527   // Emit all numbered types.
1528   for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
1529     Out << '%' << i << " = type ";
1530
1531     // Make sure we print out at least one level of the type structure, so
1532     // that we do not get %2 = type %2
1533     TypePrinter.printAtLeastOneLevel(NumberedTypes[i], Out);
1534     Out << '\n';
1535   }
1536
1537   // Print the named types.
1538   for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1539        TI != TE; ++TI) {
1540     PrintLLVMName(Out, TI->first, LocalPrefix);
1541     Out << " = type ";
1542
1543     // Make sure we print out at least one level of the type structure, so
1544     // that we do not get %FILE = type %FILE
1545     TypePrinter.printAtLeastOneLevel(TI->second, Out);
1546     Out << '\n';
1547   }
1548 }
1549
1550 /// printFunction - Print all aspects of a function.
1551 ///
1552 void AssemblyWriter::printFunction(const Function *F) {
1553   // Print out the return type and name.
1554   Out << '\n';
1555
1556   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1557
1558   if (F->isMaterializable())
1559     Out << "; Materializable\n";
1560
1561   if (F->isDeclaration())
1562     Out << "declare ";
1563   else
1564     Out << "define ";
1565
1566   PrintLinkage(F->getLinkage(), Out);
1567   PrintVisibility(F->getVisibility(), Out);
1568
1569   // Print the calling convention.
1570   switch (F->getCallingConv()) {
1571   case CallingConv::C: break;   // default
1572   case CallingConv::Fast:         Out << "fastcc "; break;
1573   case CallingConv::Cold:         Out << "coldcc "; break;
1574   case CallingConv::X86_StdCall:  Out << "x86_stdcallcc "; break;
1575   case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1576   case CallingConv::X86_ThisCall: Out << "x86_thiscallcc "; break;
1577   case CallingConv::ARM_APCS:     Out << "arm_apcscc "; break;
1578   case CallingConv::ARM_AAPCS:    Out << "arm_aapcscc "; break;
1579   case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc "; break;
1580   case CallingConv::MSP430_INTR:  Out << "msp430_intrcc "; break;
1581   default: Out << "cc" << F->getCallingConv() << " "; break;
1582   }
1583
1584   const FunctionType *FT = F->getFunctionType();
1585   const AttrListPtr &Attrs = F->getAttributes();
1586   Attributes RetAttrs = Attrs.getRetAttributes();
1587   if (RetAttrs != Attribute::None)
1588     Out <<  Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1589   TypePrinter.print(F->getReturnType(), Out);
1590   Out << ' ';
1591   WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
1592   Out << '(';
1593   Machine.incorporateFunction(F);
1594
1595   // Loop over the arguments, printing them...
1596
1597   unsigned Idx = 1;
1598   if (!F->isDeclaration()) {
1599     // If this isn't a declaration, print the argument names as well.
1600     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1601          I != E; ++I) {
1602       // Insert commas as we go... the first arg doesn't get a comma
1603       if (I != F->arg_begin()) Out << ", ";
1604       printArgument(I, Attrs.getParamAttributes(Idx));
1605       Idx++;
1606     }
1607   } else {
1608     // Otherwise, print the types from the function type.
1609     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1610       // Insert commas as we go... the first arg doesn't get a comma
1611       if (i) Out << ", ";
1612
1613       // Output type...
1614       TypePrinter.print(FT->getParamType(i), Out);
1615
1616       Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1617       if (ArgAttrs != Attribute::None)
1618         Out << ' ' << Attribute::getAsString(ArgAttrs);
1619     }
1620   }
1621
1622   // Finish printing arguments...
1623   if (FT->isVarArg()) {
1624     if (FT->getNumParams()) Out << ", ";
1625     Out << "...";  // Output varargs portion of signature!
1626   }
1627   Out << ')';
1628   Attributes FnAttrs = Attrs.getFnAttributes();
1629   if (FnAttrs != Attribute::None)
1630     Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1631   if (F->hasSection())
1632     Out << " section \"" << F->getSection() << '"';
1633   if (F->getAlignment())
1634     Out << " align " << F->getAlignment();
1635   if (F->hasGC())
1636     Out << " gc \"" << F->getGC() << '"';
1637   if (F->isDeclaration()) {
1638     Out << "\n";
1639   } else {
1640     Out << " {";
1641
1642     // Output all of its basic blocks... for the function
1643     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1644       printBasicBlock(I);
1645
1646     Out << "}\n";
1647   }
1648
1649   Machine.purgeFunction();
1650 }
1651
1652 /// printArgument - This member is called for every argument that is passed into
1653 /// the function.  Simply print it out
1654 ///
1655 void AssemblyWriter::printArgument(const Argument *Arg,
1656                                    Attributes Attrs) {
1657   // Output type...
1658   TypePrinter.print(Arg->getType(), Out);
1659
1660   // Output parameter attributes list
1661   if (Attrs != Attribute::None)
1662     Out << ' ' << Attribute::getAsString(Attrs);
1663
1664   // Output name, if available...
1665   if (Arg->hasName()) {
1666     Out << ' ';
1667     PrintLLVMName(Out, Arg);
1668   }
1669 }
1670
1671 /// printBasicBlock - This member is called for each basic block in a method.
1672 ///
1673 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1674   if (BB->hasName()) {              // Print out the label if it exists...
1675     Out << "\n";
1676     PrintLLVMName(Out, BB->getName(), LabelPrefix);
1677     Out << ':';
1678   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
1679     Out << "\n; <label>:";
1680     int Slot = Machine.getLocalSlot(BB);
1681     if (Slot != -1)
1682       Out << Slot;
1683     else
1684       Out << "<badref>";
1685   }
1686
1687   if (BB->getParent() == 0) {
1688     Out.PadToColumn(50);
1689     Out << "; Error: Block without parent!";
1690   } else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
1691     // Output predecessors for the block...
1692     Out.PadToColumn(50);
1693     Out << ";";
1694     const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
1695
1696     if (PI == PE) {
1697       Out << " No predecessors!";
1698     } else {
1699       Out << " preds = ";
1700       writeOperand(*PI, false);
1701       for (++PI; PI != PE; ++PI) {
1702         Out << ", ";
1703         writeOperand(*PI, false);
1704       }
1705     }
1706   }
1707
1708   Out << "\n";
1709
1710   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1711
1712   // Output all of the instructions in the basic block...
1713   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1714     printInstruction(*I);
1715     Out << '\n';
1716   }
1717
1718   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1719 }
1720
1721 /// printInfoComment - Print a little comment after the instruction indicating
1722 /// which slot it occupies.
1723 ///
1724 void AssemblyWriter::printInfoComment(const Value &V) {
1725   if (AnnotationWriter) {
1726     AnnotationWriter->printInfoComment(V, Out);
1727     return;
1728   }
1729
1730   if (V.getType()->isVoidTy()) return;
1731
1732   Out.PadToColumn(50);
1733   Out << "; <";
1734   TypePrinter.print(V.getType(), Out);
1735   Out << "> [#uses=" << V.getNumUses() << ']';  // Output # uses
1736 }
1737
1738 // This member is called for each Instruction in a function..
1739 void AssemblyWriter::printInstruction(const Instruction &I) {
1740   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1741
1742   // Print out indentation for an instruction.
1743   Out << "  ";
1744
1745   // Print out name if it exists...
1746   if (I.hasName()) {
1747     PrintLLVMName(Out, &I);
1748     Out << " = ";
1749   } else if (!I.getType()->isVoidTy()) {
1750     // Print out the def slot taken.
1751     int SlotNum = Machine.getLocalSlot(&I);
1752     if (SlotNum == -1)
1753       Out << "<badref> = ";
1754     else
1755       Out << '%' << SlotNum << " = ";
1756   }
1757
1758   // If this is a volatile load or store, print out the volatile marker.
1759   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
1760       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1761       Out << "volatile ";
1762   } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1763     // If this is a call, check if it's a tail call.
1764     Out << "tail ";
1765   }
1766
1767   // Print out the opcode...
1768   Out << I.getOpcodeName();
1769
1770   // Print out optimization information.
1771   WriteOptimizationInfo(Out, &I);
1772
1773   // Print out the compare instruction predicates
1774   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1775     Out << ' ' << getPredicateText(CI->getPredicate());
1776
1777   // Print out the type of the operands...
1778   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1779
1780   // Special case conditional branches to swizzle the condition out to the front
1781   if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1782     BranchInst &BI(cast<BranchInst>(I));
1783     Out << ' ';
1784     writeOperand(BI.getCondition(), true);
1785     Out << ", ";
1786     writeOperand(BI.getSuccessor(0), true);
1787     Out << ", ";
1788     writeOperand(BI.getSuccessor(1), true);
1789
1790   } else if (isa<SwitchInst>(I)) {
1791     // Special case switch instruction to get formatting nice and correct.
1792     Out << ' ';
1793     writeOperand(Operand        , true);
1794     Out << ", ";
1795     writeOperand(I.getOperand(1), true);
1796     Out << " [";
1797
1798     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1799       Out << "\n    ";
1800       writeOperand(I.getOperand(op  ), true);
1801       Out << ", ";
1802       writeOperand(I.getOperand(op+1), true);
1803     }
1804     Out << "\n  ]";
1805   } else if (isa<IndirectBrInst>(I)) {
1806     // Special case indirectbr instruction to get formatting nice and correct.
1807     Out << ' ';
1808     writeOperand(Operand, true);
1809     Out << ", [";
1810
1811     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
1812       if (i != 1)
1813         Out << ", ";
1814       writeOperand(I.getOperand(i), true);
1815     }
1816     Out << ']';
1817   } else if (isa<PHINode>(I)) {
1818     Out << ' ';
1819     TypePrinter.print(I.getType(), Out);
1820     Out << ' ';
1821
1822     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1823       if (op) Out << ", ";
1824       Out << "[ ";
1825       writeOperand(I.getOperand(op  ), false); Out << ", ";
1826       writeOperand(I.getOperand(op+1), false); Out << " ]";
1827     }
1828   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1829     Out << ' ';
1830     writeOperand(I.getOperand(0), true);
1831     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1832       Out << ", " << *i;
1833   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1834     Out << ' ';
1835     writeOperand(I.getOperand(0), true); Out << ", ";
1836     writeOperand(I.getOperand(1), true);
1837     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1838       Out << ", " << *i;
1839   } else if (isa<ReturnInst>(I) && !Operand) {
1840     Out << " void";
1841   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1842     // Print the calling convention being used.
1843     switch (CI->getCallingConv()) {
1844     case CallingConv::C: break;   // default
1845     case CallingConv::Fast:  Out << " fastcc"; break;
1846     case CallingConv::Cold:  Out << " coldcc"; break;
1847     case CallingConv::X86_StdCall:  Out << " x86_stdcallcc"; break;
1848     case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1849     case CallingConv::X86_ThisCall: Out << " x86_thiscallcc"; break;
1850     case CallingConv::ARM_APCS:     Out << " arm_apcscc "; break;
1851     case CallingConv::ARM_AAPCS:    Out << " arm_aapcscc "; break;
1852     case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1853     case CallingConv::MSP430_INTR:  Out << " msp430_intrcc "; break;
1854     default: Out << " cc" << CI->getCallingConv(); break;
1855     }
1856
1857     const PointerType    *PTy = cast<PointerType>(Operand->getType());
1858     const FunctionType   *FTy = cast<FunctionType>(PTy->getElementType());
1859     const Type         *RetTy = FTy->getReturnType();
1860     const AttrListPtr &PAL = CI->getAttributes();
1861
1862     if (PAL.getRetAttributes() != Attribute::None)
1863       Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1864
1865     // If possible, print out the short form of the call instruction.  We can
1866     // only do this if the first argument is a pointer to a nonvararg function,
1867     // and if the return type is not a pointer to a function.
1868     //
1869     Out << ' ';
1870     if (!FTy->isVarArg() &&
1871         (!RetTy->isPointerTy() ||
1872          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
1873       TypePrinter.print(RetTy, Out);
1874       Out << ' ';
1875       writeOperand(Operand, false);
1876     } else {
1877       writeOperand(Operand, true);
1878     }
1879     Out << '(';
1880     for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1881       if (op > 1)
1882         Out << ", ";
1883       writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1884     }
1885     Out << ')';
1886     if (PAL.getFnAttributes() != Attribute::None)
1887       Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1888   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1889     Operand = II->getCalledValue();
1890     const PointerType    *PTy = cast<PointerType>(Operand->getType());
1891     const FunctionType   *FTy = cast<FunctionType>(PTy->getElementType());
1892     const Type         *RetTy = FTy->getReturnType();
1893     const AttrListPtr &PAL = II->getAttributes();
1894
1895     // Print the calling convention being used.
1896     switch (II->getCallingConv()) {
1897     case CallingConv::C: break;   // default
1898     case CallingConv::Fast:  Out << " fastcc"; break;
1899     case CallingConv::Cold:  Out << " coldcc"; break;
1900     case CallingConv::X86_StdCall:  Out << " x86_stdcallcc"; break;
1901     case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1902     case CallingConv::X86_ThisCall: Out << " x86_thiscallcc"; break;
1903     case CallingConv::ARM_APCS:     Out << " arm_apcscc "; break;
1904     case CallingConv::ARM_AAPCS:    Out << " arm_aapcscc "; break;
1905     case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
1906     case CallingConv::MSP430_INTR:  Out << " msp430_intrcc "; break;
1907     default: Out << " cc" << II->getCallingConv(); break;
1908     }
1909
1910     if (PAL.getRetAttributes() != Attribute::None)
1911       Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1912
1913     // If possible, print out the short form of the invoke instruction. We can
1914     // only do this if the first argument is a pointer to a nonvararg function,
1915     // and if the return type is not a pointer to a function.
1916     //
1917     Out << ' ';
1918     if (!FTy->isVarArg() &&
1919         (!RetTy->isPointerTy() ||
1920          !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
1921       TypePrinter.print(RetTy, Out);
1922       Out << ' ';
1923       writeOperand(Operand, false);
1924     } else {
1925       writeOperand(Operand, true);
1926     }
1927     Out << '(';
1928     for (unsigned op = 0, Eop = I.getNumOperands() - 3; op < Eop; ++op) {
1929       if (op)
1930         Out << ", ";
1931       writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op + 1));
1932     }
1933
1934     Out << ')';
1935     if (PAL.getFnAttributes() != Attribute::None)
1936       Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1937
1938     Out << "\n          to ";
1939     writeOperand(II->getNormalDest(), true);
1940     Out << " unwind ";
1941     writeOperand(II->getUnwindDest(), true);
1942
1943   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
1944     Out << ' ';
1945     TypePrinter.print(AI->getType()->getElementType(), Out);
1946     if (!AI->getArraySize() || AI->isArrayAllocation()) {
1947       Out << ", ";
1948       writeOperand(AI->getArraySize(), true);
1949     }
1950     if (AI->getAlignment()) {
1951       Out << ", align " << AI->getAlignment();
1952     }
1953   } else if (isa<CastInst>(I)) {
1954     if (Operand) {
1955       Out << ' ';
1956       writeOperand(Operand, true);   // Work with broken code
1957     }
1958     Out << " to ";
1959     TypePrinter.print(I.getType(), Out);
1960   } else if (isa<VAArgInst>(I)) {
1961     if (Operand) {
1962       Out << ' ';
1963       writeOperand(Operand, true);   // Work with broken code
1964     }
1965     Out << ", ";
1966     TypePrinter.print(I.getType(), Out);
1967   } else if (Operand) {   // Print the normal way.
1968
1969     // PrintAllTypes - Instructions who have operands of all the same type
1970     // omit the type from all but the first operand.  If the instruction has
1971     // different type operands (for example br), then they are all printed.
1972     bool PrintAllTypes = false;
1973     const Type *TheType = Operand->getType();
1974
1975     // Select, Store and ShuffleVector always print all types.
1976     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1977         || isa<ReturnInst>(I)) {
1978       PrintAllTypes = true;
1979     } else {
1980       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1981         Operand = I.getOperand(i);
1982         // note that Operand shouldn't be null, but the test helps make dump()
1983         // more tolerant of malformed IR
1984         if (Operand && Operand->getType() != TheType) {
1985           PrintAllTypes = true;    // We have differing types!  Print them all!
1986           break;
1987         }
1988       }
1989     }
1990
1991     if (!PrintAllTypes) {
1992       Out << ' ';
1993       TypePrinter.print(TheType, Out);
1994     }
1995
1996     Out << ' ';
1997     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1998       if (i) Out << ", ";
1999       writeOperand(I.getOperand(i), PrintAllTypes);
2000     }
2001   }
2002
2003   // Print post operand alignment for load/store.
2004   if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
2005     Out << ", align " << cast<LoadInst>(I).getAlignment();
2006   } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
2007     Out << ", align " << cast<StoreInst>(I).getAlignment();
2008   }
2009
2010   // Print Metadata info.
2011   SmallVector<std::pair<unsigned, MDNode*>, 4> InstMD;
2012   I.getAllMetadata(InstMD);
2013   if (!InstMD.empty()) {
2014     SmallVector<StringRef, 8> MDNames;
2015     I.getType()->getContext().getMDKindNames(MDNames);
2016     for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2017       unsigned Kind = InstMD[i].first;
2018        if (Kind < MDNames.size()) {
2019          Out << ", !" << MDNames[Kind];
2020       } else {
2021         Out << ", !<unknown kind #" << Kind << ">";
2022       }
2023       Out << " !" << Machine.getMetadataSlot(InstMD[i].second);
2024     }
2025   }
2026   printInfoComment(I);
2027 }
2028
2029 static void WriteMDNodeComment(const MDNode *Node,
2030                                formatted_raw_ostream &Out) {
2031   if (Node->getNumOperands() < 1)
2032     return;
2033   ConstantInt *CI = dyn_cast_or_null<ConstantInt>(Node->getOperand(0));
2034   if (!CI) return;
2035   APInt Val = CI->getValue();
2036   APInt Tag = Val & ~APInt(Val.getBitWidth(), LLVMDebugVersionMask);
2037   if (Val.ult(LLVMDebugVersion))
2038     return;
2039
2040   Out.PadToColumn(50);
2041   if (Tag == dwarf::DW_TAG_auto_variable)
2042     Out << "; [ DW_TAG_auto_variable ]";
2043   else if (Tag == dwarf::DW_TAG_arg_variable)
2044     Out << "; [ DW_TAG_arg_variable ]";
2045   else if (Tag == dwarf::DW_TAG_return_variable)
2046     Out << "; [ DW_TAG_return_variable ]";
2047   else if (Tag == dwarf::DW_TAG_vector_type)
2048     Out << "; [ DW_TAG_vector_type ]";
2049   else if (Tag == dwarf::DW_TAG_user_base)
2050     Out << "; [ DW_TAG_user_base ]";
2051   else if (Tag.isIntN(32)) {
2052     if (const char *TagName = dwarf::TagString(Tag.getZExtValue()))
2053       Out << "; [ " << TagName << " ]";
2054   }
2055 }
2056
2057 void AssemblyWriter::writeAllMDNodes() {
2058   SmallVector<const MDNode *, 16> Nodes;
2059   Nodes.resize(Machine.mdn_size());
2060   for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2061        I != E; ++I)
2062     Nodes[I->second] = cast<MDNode>(I->first);
2063
2064   for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2065     Out << '!' << i << " = metadata ";
2066     printMDNodeBody(Nodes[i]);
2067   }
2068 }
2069
2070 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2071   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine);
2072   WriteMDNodeComment(Node, Out);
2073   Out << "\n";
2074 }
2075
2076 //===----------------------------------------------------------------------===//
2077 //                       External Interface declarations
2078 //===----------------------------------------------------------------------===//
2079
2080 void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2081   SlotTracker SlotTable(this);
2082   formatted_raw_ostream OS(ROS);
2083   AssemblyWriter W(OS, SlotTable, this, AAW);
2084   W.printModule(this);
2085 }
2086
2087 void Type::print(raw_ostream &OS) const {
2088   if (this == 0) {
2089     OS << "<null Type>";
2090     return;
2091   }
2092   TypePrinting().print(this, OS);
2093 }
2094
2095 void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2096   if (this == 0) {
2097     ROS << "printing a <null> value\n";
2098     return;
2099   }
2100   formatted_raw_ostream OS(ROS);
2101   if (const Instruction *I = dyn_cast<Instruction>(this)) {
2102     const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2103     SlotTracker SlotTable(F);
2104     AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), AAW);
2105     W.printInstruction(*I);
2106   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2107     SlotTracker SlotTable(BB->getParent());
2108     AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), AAW);
2109     W.printBasicBlock(BB);
2110   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2111     SlotTracker SlotTable(GV->getParent());
2112     AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
2113     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2114       W.printGlobal(V);
2115     else if (const Function *F = dyn_cast<Function>(GV))
2116       W.printFunction(F);
2117     else
2118       W.printAlias(cast<GlobalAlias>(GV));
2119   } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
2120     const Function *F = N->getFunction();
2121     SlotTracker SlotTable(F);
2122     AssemblyWriter W(OS, SlotTable, F ? getModuleFromVal(F) : 0, AAW);
2123     W.printMDNodeBody(N);
2124   } else if (const NamedMDNode *N = dyn_cast<NamedMDNode>(this)) {
2125     SlotTracker SlotTable(N->getParent());
2126     AssemblyWriter W(OS, SlotTable, N->getParent(), AAW);
2127     W.printNamedMDNode(N);
2128   } else if (const Constant *C = dyn_cast<Constant>(this)) {
2129     TypePrinting TypePrinter;
2130     TypePrinter.print(C->getType(), OS);
2131     OS << ' ';
2132     WriteConstantInt(OS, C, TypePrinter, 0);
2133   } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2134              isa<Argument>(this)) {
2135     WriteAsOperand(OS, this, true, 0);
2136   } else {
2137     // Otherwise we don't know what it is. Call the virtual function to
2138     // allow a subclass to print itself.
2139     printCustom(OS);
2140   }
2141 }
2142
2143 // Value::printCustom - subclasses should override this to implement printing.
2144 void Value::printCustom(raw_ostream &OS) const {
2145   llvm_unreachable("Unknown value to print out!");
2146 }
2147
2148 // Value::dump - allow easy printing of Values from the debugger.
2149 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
2150
2151 // Type::dump - allow easy printing of Types from the debugger.
2152 // This one uses type names from the given context module
2153 void Type::dump(const Module *Context) const {
2154   WriteTypeSymbolic(dbgs(), this, Context);
2155   dbgs() << '\n';
2156 }
2157
2158 // Type::dump - allow easy printing of Types from the debugger.
2159 void Type::dump() const { dump(0); }
2160
2161 // Module::dump() - Allow printing of Modules from the debugger.
2162 void Module::dump() const { print(dbgs(), 0); }