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