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