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