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