lib/VMCore/AsmWriter.cpp

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