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