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 ignored;
 644       bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
 645       double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
 646                               CFP->getValueAPF().convertToFloat();
 647       std::string StrVal = ftostr(CFP->getValueAPF());
 648
 649       // Check to make sure that the stringized number is not some string like
 650       // "Inf" or NaN, that atof will accept, but the lexer will not.  Check
 651       // that the string matches the "[-+]?[0-9]" regex.
 652       //
 653       if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
 654           ((StrVal[0] == '-' || StrVal[0] == '+') &&
 655            (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
 656         // Reparse stringized version!
 657         if (atof(StrVal.c_str()) == Val) {
 658           Out << StrVal;
 659           return;
 660         }
 661       }
 662       // Otherwise we could not reparse it to exactly the same value, so we must
 663       // output the string in hexadecimal format!  Note that loading and storing
 664       // floating point types changes the bits of NaNs on some hosts, notably
 665       // x86, so we must not use these types.
 666       assert(sizeof(double) == sizeof(uint64_t) &&
 667              "assuming that double is 64 bits!");
 668       char Buffer[40];
 669       APFloat apf = CFP->getValueAPF();
 670       // Floats are represented in ASCII IR as double, convert.
 671       if (!isDouble)
 672         apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
 673                           &ignored);
 674       Out << "0x" <<
 675               utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
 676                             Buffer+40);
 677       return;
 678     }
 679
 680     // Some form of long double.  These appear as a magic letter identifying
 681     // the type, then a fixed number of hex digits.
 682     Out << "0x";
 683     if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended)
 684       Out << 'K';
 685     else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
 686       Out << 'L';
 687     else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
 688       Out << 'M';
 689     else
 690       assert(0 && "Unsupported floating point type");
 691     // api needed to prevent premature destruction
 692     APInt api = CFP->getValueAPF().bitcastToAPInt();
 693     const uint64_t* p = api.getRawData();
 694     uint64_t word = *p;
 695     int shiftcount=60;
 696     int width = api.getBitWidth();
 697     for (int j=0; j<width; j+=4, shiftcount-=4) {
 698       unsigned int nibble = (word>>shiftcount) & 15;
 699       if (nibble < 10)
 700         Out << (unsigned char)(nibble + '0');
 701       else
 702         Out << (unsigned char)(nibble - 10 + 'A');
 703       if (shiftcount == 0 && j+4 < width) {
 704         word = *(++p);
 705         shiftcount = 64;
 706         if (width-j-4 < 64)
 707           shiftcount = width-j-4;
 708       }
 709     }
 710     return;
 711   }
 712
 713   if (isa<ConstantAggregateZero>(CV)) {
 714     Out << "zeroinitializer";
 715     return;
 716   }
 717
 718   if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 719     // As a special case, print the array as a string if it is an array of
 720     // i8 with ConstantInt values.
 721     //
 722     const Type *ETy = CA->getType()->getElementType();
 723     if (CA->isString()) {
 724       Out << "c\"";
 725       PrintEscapedString(CA->getAsString(), Out);
 726       Out << '"';
 727     } else {                // Cannot output in string format...
 728       Out << '[';
 729       if (CA->getNumOperands()) {
 730         Out << ' ';
 731         printTypeInt(Out, ETy, TypeTable);
 732         Out << ' ';
 733         WriteAsOperandInternal(Out, CA->getOperand(0),
 734                                TypeTable, Machine);
 735         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
 736           Out << ", ";
 737           printTypeInt(Out, ETy, TypeTable);
 738           Out << ' ';
 739           WriteAsOperandInternal(Out, CA->getOperand(i), TypeTable, Machine);
 740         }
 741         Out << ' ';
 742       }
 743       Out << ']';
 744     }
 745     return;
 746   }
 747
 748   if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
 749     if (CS->getType()->isPacked())
 750       Out << '<';
 751     Out << '{';
 752     unsigned N = CS->getNumOperands();
 753     if (N) {
 754       Out << ' ';
 755       printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
 756       Out << ' ';
 757
 758       WriteAsOperandInternal(Out, CS->getOperand(0), TypeTable, Machine);
 759
 760       for (unsigned i = 1; i < N; i++) {
 761         Out << ", ";
 762         printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
 763         Out << ' ';
 764
 765         WriteAsOperandInternal(Out, CS->getOperand(i), TypeTable, Machine);
 766       }
 767       Out << ' ';
 768     }
 769
 770     Out << '}';
 771     if (CS->getType()->isPacked())
 772       Out << '>';
 773     return;
 774   }
 775
 776   if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
 777     const Type *ETy = CP->getType()->getElementType();
 778     assert(CP->getNumOperands() > 0 &&
 779            "Number of operands for a PackedConst must be > 0");
 780     Out << "< ";
 781     printTypeInt(Out, ETy, TypeTable);
 782     Out << ' ';
 783     WriteAsOperandInternal(Out, CP->getOperand(0), TypeTable, Machine);
 784     for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
 785       Out << ", ";
 786       printTypeInt(Out, ETy, TypeTable);
 787       Out << ' ';
 788       WriteAsOperandInternal(Out, CP->getOperand(i), TypeTable, Machine);
 789     }
 790     Out << " >";
 791     return;
 792   }
 793
 794   if (isa<ConstantPointerNull>(CV)) {
 795     Out << "null";
 796     return;
 797   }
 798
 799   if (isa<UndefValue>(CV)) {
 800     Out << "undef";
 801     return;
 802   }
 803
 804   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 805     Out << CE->getOpcodeName();
 806     if (CE->isCompare())
 807       Out << ' ' << getPredicateText(CE->getPredicate());
 808     Out << " (";
 809
 810     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
 811       printTypeInt(Out, (*OI)->getType(), TypeTable);
 812       Out << ' ';
 813       WriteAsOperandInternal(Out, *OI, TypeTable, Machine);
 814       if (OI+1 != CE->op_end())
 815         Out << ", ";
 816     }
 817
 818     if (CE->hasIndices()) {
 819       const SmallVector<unsigned, 4> &Indices = CE->getIndices();
 820       for (unsigned i = 0, e = Indices.size(); i != e; ++i)
 821         Out << ", " << Indices[i];
 822     }
 823
 824     if (CE->isCast()) {
 825       Out << " to ";
 826       printTypeInt(Out, CE->getType(), TypeTable);
 827     }
 828
 829     Out << ')';
 830     return;
 831   }
 832
 833   Out << "<placeholder or erroneous Constant>";
 834 }
 835
 836
 837 /// WriteAsOperand - Write the name of the specified value out to the specified
 838 /// ostream.  This can be useful when you just want to print int %reg126, not
 839 /// the whole instruction that generated it.
 840 ///
 841 static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
 842                                   std::map<const Type*, std::string> &TypeTable,
 843                                    SlotTracker *Machine) {
 844   if (V->hasName()) {
 845     PrintLLVMName(Out, V);
 846     return;
 847   }
 848
 849   const Constant *CV = dyn_cast<Constant>(V);
 850   if (CV && !isa<GlobalValue>(CV)) {
 851     WriteConstantInt(Out, CV, TypeTable, Machine);
 852     return;
 853   }
 854
 855   if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
 856     Out << "asm ";
 857     if (IA->hasSideEffects())
 858       Out << "sideeffect ";
 859     Out << '"';
 860     PrintEscapedString(IA->getAsmString(), Out);
 861     Out << "\", \"";
 862     PrintEscapedString(IA->getConstraintString(), Out);
 863     Out << '"';
 864     return;
 865   }
 866
 867   char Prefix = '%';
 868   int Slot;
 869   if (Machine) {
 870     if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 871       Slot = Machine->getGlobalSlot(GV);
 872       Prefix = '@';
 873     } else {
 874       Slot = Machine->getLocalSlot(V);
 875     }
 876   } else {
 877     Machine = createSlotTracker(V);
 878     if (Machine) {
 879       if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 880         Slot = Machine->getGlobalSlot(GV);
 881         Prefix = '@';
 882       } else {
 883         Slot = Machine->getLocalSlot(V);
 884       }
 885     } else {
 886       Slot = -1;
 887     }
 888     delete Machine;
 889   }
 890
 891   if (Slot != -1)
 892     Out << Prefix << Slot;
 893   else
 894     Out << "<badref>";
 895 }
 896
 897 /// WriteAsOperand - Write the name of the specified value out to the specified
 898 /// ostream.  This can be useful when you just want to print int %reg126, not
 899 /// the whole instruction that generated it.
 900 ///
 901 void llvm::WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
 902                           const Module *Context) {
 903   raw_os_ostream OS(Out);
 904   WriteAsOperand(OS, V, PrintType, Context);
 905 }
 906
 907 void llvm::WriteAsOperand(raw_ostream &Out, const Value *V, bool PrintType,
 908                           const Module *Context) {
 909   std::map<const Type *, std::string> TypeNames;
 910   if (Context == 0) Context = getModuleFromVal(V);
 911
 912   if (Context)
 913     fillTypeNameTable(Context, TypeNames);
 914
 915   if (PrintType) {
 916     printTypeInt(Out, V->getType(), TypeNames);
 917     Out << ' ';
 918   }
 919
 920   WriteAsOperandInternal(Out, V, TypeNames, 0);
 921 }
 922
 923
 924 namespace {
 925
 926 class AssemblyWriter {
 927   raw_ostream &Out;
 928   SlotTracker &Machine;
 929   const Module *TheModule;
 930   std::map<const Type *, std::string> TypeNames;
 931   AssemblyAnnotationWriter *AnnotationWriter;
 932 public:
 933   inline AssemblyWriter(raw_ostream &o, SlotTracker &Mac, const Module *M,
 934                         AssemblyAnnotationWriter *AAW)
 935     : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
 936
 937     // If the module has a symbol table, take all global types and stuff their
 938     // names into the TypeNames map.
 939     //
 940     fillTypeNameTable(M, TypeNames);
 941   }
 942
 943   void write(const Module *M) { printModule(M);       }
 944
 945   void write(const GlobalValue *G) {
 946     if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
 947       printGlobal(GV);
 948     else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
 949       printAlias(GA);
 950     else if (const Function *F = dyn_cast<Function>(G))
 951       printFunction(F);
 952     else
 953       assert(0 && "Unknown global");
 954   }
 955
 956   void write(const BasicBlock *BB)    { printBasicBlock(BB);  }
 957   void write(const Instruction *I)    { printInstruction(*I); }
 958   void write(const Type *Ty)          { printType(Ty);        }
 959
 960   void writeOperand(const Value *Op, bool PrintType);
 961   void writeParamOperand(const Value *Operand, Attributes Attrs);
 962
 963   const Module* getModule() { return TheModule; }
 964
 965 private:
 966   void printModule(const Module *M);
 967   void printTypeSymbolTable(const TypeSymbolTable &ST);
 968   void printGlobal(const GlobalVariable *GV);
 969   void printAlias(const GlobalAlias *GV);
 970   void printFunction(const Function *F);
 971   void printArgument(const Argument *FA, Attributes Attrs);
 972   void printBasicBlock(const BasicBlock *BB);
 973   void printInstruction(const Instruction &I);
 974
 975   // printType - Go to extreme measures to attempt to print out a short,
 976   // symbolic version of a type name.
 977   //
 978   void printType(const Type *Ty) {
 979     printTypeInt(Out, Ty, TypeNames);
 980   }
 981
 982   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 983   // without considering any symbolic types that we may have equal to it.
 984   //
 985   void printTypeAtLeastOneLevel(const Type *Ty);
 986
 987   // printInfoComment - Print a little comment after the instruction indicating
 988   // which slot it occupies.
 989   void printInfoComment(const Value &V);
 990 };
 991 }  // end of llvm namespace
 992
 993 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 994 /// without considering any symbolic types that we may have equal to it.
 995 ///
 996 void AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 997   if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty)) {
 998     Out << "i" << utostr(ITy->getBitWidth());
 999     return;
1000   }
1001
1002   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
1003     printType(FTy->getReturnType());
1004     Out << " (";
1005     for (FunctionType::param_iterator I = FTy->param_begin(),
1006            E = FTy->param_end(); I != E; ++I) {
1007       if (I != FTy->param_begin())
1008         Out << ", ";
1009       printType(*I);
1010     }
1011     if (FTy->isVarArg()) {
1012       if (FTy->getNumParams()) Out << ", ";
1013       Out << "...";
1014     }
1015     Out << ')';
1016     return;
1017   }
1018
1019   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
1020     if (STy->isPacked())
1021       Out << '<';
1022     Out << "{ ";
1023     for (StructType::element_iterator I = STy->element_begin(),
1024            E = STy->element_end(); I != E; ++I) {
1025       if (I != STy->element_begin())
1026         Out << ", ";
1027       printType(*I);
1028     }
1029     Out << " }";
1030     if (STy->isPacked())
1031       Out << '>';
1032     return;
1033   }
1034
1035   if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1036     printType(PTy->getElementType());
1037     if (unsigned AddressSpace = PTy->getAddressSpace())
1038       Out << " addrspace(" << AddressSpace << ")";
1039     Out << '*';
1040     return;
1041   }
1042
1043   if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
1044     Out << '[' << ATy->getNumElements() << " x ";
1045     printType(ATy->getElementType());
1046     Out << ']';
1047     return;
1048   }
1049
1050   if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
1051     Out << '<' << PTy->getNumElements() << " x ";
1052     printType(PTy->getElementType());
1053     Out << '>';
1054     return;
1055   }
1056
1057   if (isa<OpaqueType>(Ty)) {
1058     Out << "opaque";
1059     return;
1060   }
1061
1062   if (!Ty->isPrimitiveType())
1063     Out << "<unknown derived type>";
1064   printType(Ty);
1065 }
1066
1067
1068 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1069   if (Operand == 0) {
1070     Out << "<null operand!>";
1071   } else {
1072     if (PrintType) {
1073       printType(Operand->getType());
1074       Out << ' ';
1075     }
1076     WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
1077   }
1078 }
1079
1080 void AssemblyWriter::writeParamOperand(const Value *Operand,
1081                                        Attributes Attrs) {
1082   if (Operand == 0) {
1083     Out << "<null operand!>";
1084   } else {
1085     // Print the type
1086     printType(Operand->getType());
1087     // Print parameter attributes list
1088     if (Attrs != Attribute::None)
1089       Out << ' ' << Attribute::getAsString(Attrs);
1090     Out << ' ';
1091     // Print the operand
1092     WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
1093   }
1094 }
1095
1096 void AssemblyWriter::printModule(const Module *M) {
1097   if (!M->getModuleIdentifier().empty() &&
1098       // Don't print the ID if it will start a new line (which would
1099       // require a comment char before it).
1100       M->getModuleIdentifier().find('\n') == std::string::npos)
1101     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1102
1103   if (!M->getDataLayout().empty())
1104     Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
1105   if (!M->getTargetTriple().empty())
1106     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
1107
1108   if (!M->getModuleInlineAsm().empty()) {
1109     // Split the string into lines, to make it easier to read the .ll file.
1110     std::string Asm = M->getModuleInlineAsm();
1111     size_t CurPos = 0;
1112     size_t NewLine = Asm.find_first_of('\n', CurPos);
1113     while (NewLine != std::string::npos) {
1114       // We found a newline, print the portion of the asm string from the
1115       // last newline up to this newline.
1116       Out << "module asm \"";
1117       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1118                          Out);
1119       Out << "\"\n";
1120       CurPos = NewLine+1;
1121       NewLine = Asm.find_first_of('\n', CurPos);
1122     }
1123     Out << "module asm \"";
1124     PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1125     Out << "\"\n";
1126   }
1127
1128   // Loop over the dependent libraries and emit them.
1129   Module::lib_iterator LI = M->lib_begin();
1130   Module::lib_iterator LE = M->lib_end();
1131   if (LI != LE) {
1132     Out << "deplibs = [ ";
1133     while (LI != LE) {
1134       Out << '"' << *LI << '"';
1135       ++LI;
1136       if (LI != LE)
1137         Out << ", ";
1138     }
1139     Out << " ]\n";
1140   }
1141
1142   // Loop over the symbol table, emitting all named constants.
1143   printTypeSymbolTable(M->getTypeSymbolTable());
1144
1145   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1146        I != E; ++I)
1147     printGlobal(I);
1148
1149   // Output all aliases.
1150   if (!M->alias_empty()) Out << "\n";
1151   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1152        I != E; ++I)
1153     printAlias(I);
1154
1155   // Output all of the functions.
1156   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1157     printFunction(I);
1158 }
1159
1160 static void PrintLinkage(GlobalValue::LinkageTypes LT, raw_ostream &Out) {
1161   switch (LT) {
1162   case GlobalValue::PrivateLinkage:      Out << "private "; break;
1163   case GlobalValue::InternalLinkage:     Out << "internal "; break;
1164   case GlobalValue::LinkOnceLinkage:     Out << "linkonce "; break;
1165   case GlobalValue::WeakLinkage:         Out << "weak "; break;
1166   case GlobalValue::CommonLinkage:       Out << "common "; break;
1167   case GlobalValue::AppendingLinkage:    Out << "appending "; break;
1168   case GlobalValue::DLLImportLinkage:    Out << "dllimport "; break;
1169   case GlobalValue::DLLExportLinkage:    Out << "dllexport "; break;
1170   case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1171   case GlobalValue::ExternalLinkage: break;
1172   case GlobalValue::GhostLinkage:
1173     Out << "GhostLinkage not allowed in AsmWriter!\n";
1174     abort();
1175   }
1176 }
1177
1178
1179 static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
1180                             raw_ostream &Out) {
1181   switch (Vis) {
1182   default: assert(0 && "Invalid visibility style!");
1183   case GlobalValue::DefaultVisibility: break;
1184   case GlobalValue::HiddenVisibility:    Out << "hidden "; break;
1185   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1186   }
1187 }
1188
1189 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
1190   if (GV->hasName()) {
1191     PrintLLVMName(Out, GV);
1192     Out << " = ";
1193   }
1194
1195   if (!GV->hasInitializer() && GV->hasExternalLinkage())
1196     Out << "external ";
1197
1198   PrintLinkage(GV->getLinkage(), Out);
1199   PrintVisibility(GV->getVisibility(), Out);
1200
1201   if (GV->isThreadLocal()) Out << "thread_local ";
1202   if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1203     Out << "addrspace(" << AddressSpace << ") ";
1204   Out << (GV->isConstant() ? "constant " : "global ");
1205   printType(GV->getType()->getElementType());
1206
1207   if (GV->hasInitializer()) {
1208     Out << ' ';
1209     writeOperand(GV->getInitializer(), false);
1210   }
1211
1212   if (GV->hasSection())
1213     Out << ", section \"" << GV->getSection() << '"';
1214   if (GV->getAlignment())
1215     Out << ", align " << GV->getAlignment();
1216
1217   printInfoComment(*GV);
1218   Out << '\n';
1219 }
1220
1221 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
1222   // Don't crash when dumping partially built GA
1223   if (!GA->hasName())
1224     Out << "<<nameless>> = ";
1225   else {
1226     PrintLLVMName(Out, GA);
1227     Out << " = ";
1228   }
1229   PrintVisibility(GA->getVisibility(), Out);
1230
1231   Out << "alias ";
1232
1233   PrintLinkage(GA->getLinkage(), Out);
1234
1235   const Constant *Aliasee = GA->getAliasee();
1236
1237   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1238     printType(GV->getType());
1239     Out << ' ';
1240     PrintLLVMName(Out, GV);
1241   } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1242     printType(F->getFunctionType());
1243     Out << "* ";
1244
1245     if (F->hasName())
1246       PrintLLVMName(Out, F);
1247     else
1248       Out << "@\"\"";
1249   } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1250     printType(GA->getType());
1251     Out << " ";
1252     PrintLLVMName(Out, GA);
1253   } else {
1254     const ConstantExpr *CE = 0;
1255     if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1256         (CE->getOpcode() == Instruction::BitCast)) {
1257       writeOperand(CE, false);
1258     } else
1259       assert(0 && "Unsupported aliasee");
1260   }
1261
1262   printInfoComment(*GA);
1263   Out << '\n';
1264 }
1265
1266 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1267   // Print the types.
1268   for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1269        TI != TE; ++TI) {
1270     Out << '\t';
1271     PrintLLVMName(Out, &TI->first[0], TI->first.size(), LocalPrefix);
1272     Out << " = type ";
1273
1274     // Make sure we print out at least one level of the type structure, so
1275     // that we do not get %FILE = type %FILE
1276     //
1277     printTypeAtLeastOneLevel(TI->second);
1278     Out << '\n';
1279   }
1280 }
1281
1282 /// printFunction - Print all aspects of a function.
1283 ///
1284 void AssemblyWriter::printFunction(const Function *F) {
1285   // Print out the return type and name.
1286   Out << '\n';
1287
1288   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1289
1290   if (F->isDeclaration())
1291     Out << "declare ";
1292   else
1293     Out << "define ";
1294
1295   PrintLinkage(F->getLinkage(), Out);
1296   PrintVisibility(F->getVisibility(), Out);
1297
1298   // Print the calling convention.
1299   switch (F->getCallingConv()) {
1300   case CallingConv::C: break;   // default
1301   case CallingConv::Fast:         Out << "fastcc "; break;
1302   case CallingConv::Cold:         Out << "coldcc "; break;
1303   case CallingConv::X86_StdCall:  Out << "x86_stdcallcc "; break;
1304   case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1305   default: Out << "cc" << F->getCallingConv() << " "; break;
1306   }
1307
1308   const FunctionType *FT = F->getFunctionType();
1309   const AttrListPtr &Attrs = F->getAttributes();
1310   Attributes RetAttrs = Attrs.getRetAttributes();
1311   if (RetAttrs != Attribute::None)
1312     Out <<  Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
1313   printType(F->getReturnType());
1314   Out << ' ';
1315   if (F->hasName())
1316     PrintLLVMName(Out, F);
1317   else
1318     Out << "@\"\"";
1319   Out << '(';
1320   Machine.incorporateFunction(F);
1321
1322   // Loop over the arguments, printing them...
1323
1324   unsigned Idx = 1;
1325   if (!F->isDeclaration()) {
1326     // If this isn't a declaration, print the argument names as well.
1327     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1328          I != E; ++I) {
1329       // Insert commas as we go... the first arg doesn't get a comma
1330       if (I != F->arg_begin()) Out << ", ";
1331       printArgument(I, Attrs.getParamAttributes(Idx));
1332       Idx++;
1333     }
1334   } else {
1335     // Otherwise, print the types from the function type.
1336     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1337       // Insert commas as we go... the first arg doesn't get a comma
1338       if (i) Out << ", ";
1339
1340       // Output type...
1341       printType(FT->getParamType(i));
1342
1343       Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
1344       if (ArgAttrs != Attribute::None)
1345         Out << ' ' << Attribute::getAsString(ArgAttrs);
1346     }
1347   }
1348
1349   // Finish printing arguments...
1350   if (FT->isVarArg()) {
1351     if (FT->getNumParams()) Out << ", ";
1352     Out << "...";  // Output varargs portion of signature!
1353   }
1354   Out << ')';
1355   Attributes FnAttrs = Attrs.getFnAttributes();
1356   if (FnAttrs != Attribute::None)
1357     Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
1358   if (F->hasSection())
1359     Out << " section \"" << F->getSection() << '"';
1360   if (F->getAlignment())
1361     Out << " align " << F->getAlignment();
1362   if (F->hasGC())
1363     Out << " gc \"" << F->getGC() << '"';
1364   if (F->isDeclaration()) {
1365     Out << "\n";
1366   } else {
1367     Out << " {";
1368
1369     // Output all of its basic blocks... for the function
1370     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1371       printBasicBlock(I);
1372
1373     Out << "}\n";
1374   }
1375
1376   Machine.purgeFunction();
1377 }
1378
1379 /// printArgument - This member is called for every argument that is passed into
1380 /// the function.  Simply print it out
1381 ///
1382 void AssemblyWriter::printArgument(const Argument *Arg,
1383                                    Attributes Attrs) {
1384   // Output type...
1385   printType(Arg->getType());
1386
1387   // Output parameter attributes list
1388   if (Attrs != Attribute::None)
1389     Out << ' ' << Attribute::getAsString(Attrs);
1390
1391   // Output name, if available...
1392   if (Arg->hasName()) {
1393     Out << ' ';
1394     PrintLLVMName(Out, Arg);
1395   }
1396 }
1397
1398 /// printBasicBlock - This member is called for each basic block in a method.
1399 ///
1400 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1401   if (BB->hasName()) {              // Print out the label if it exists...
1402     Out << "\n";
1403     PrintLLVMName(Out, BB->getNameStart(), BB->getNameLen(), LabelPrefix);
1404     Out << ':';
1405   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
1406     Out << "\n; <label>:";
1407     int Slot = Machine.getLocalSlot(BB);
1408     if (Slot != -1)
1409       Out << Slot;
1410     else
1411       Out << "<badref>";
1412   }
1413
1414   if (BB->getParent() == 0)
1415     Out << "\t\t; Error: Block without parent!";
1416   else if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
1417     // Output predecessors for the block...
1418     Out << "\t\t;";
1419     pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1420
1421     if (PI == PE) {
1422       Out << " No predecessors!";
1423     } else {
1424       Out << " preds = ";
1425       writeOperand(*PI, false);
1426       for (++PI; PI != PE; ++PI) {
1427         Out << ", ";
1428         writeOperand(*PI, false);
1429       }
1430     }
1431   }
1432
1433   Out << "\n";
1434
1435   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1436
1437   // Output all of the instructions in the basic block...
1438   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1439     printInstruction(*I);
1440
1441   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1442 }
1443
1444
1445 /// printInfoComment - Print a little comment after the instruction indicating
1446 /// which slot it occupies.
1447 ///
1448 void AssemblyWriter::printInfoComment(const Value &V) {
1449   if (V.getType() != Type::VoidTy) {
1450     Out << "\t\t; <";
1451     printType(V.getType());
1452     Out << '>';
1453
1454     if (!V.hasName() && !isa<Instruction>(V)) {
1455       int SlotNum;
1456       if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1457         SlotNum = Machine.getGlobalSlot(GV);
1458       else
1459         SlotNum = Machine.getLocalSlot(&V);
1460       if (SlotNum == -1)
1461         Out << ":<badref>";
1462       else
1463         Out << ':' << SlotNum; // Print out the def slot taken.
1464     }
1465     Out << " [#uses=" << V.getNumUses() << ']';  // Output # uses
1466   }
1467 }
1468
1469 // This member is called for each Instruction in a function..
1470 void AssemblyWriter::printInstruction(const Instruction &I) {
1471   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1472
1473   Out << '\t';
1474
1475   // Print out name if it exists...
1476   if (I.hasName()) {
1477     PrintLLVMName(Out, &I);
1478     Out << " = ";
1479   } else if (I.getType() != Type::VoidTy) {
1480     // Print out the def slot taken.
1481     int SlotNum = Machine.getLocalSlot(&I);
1482     if (SlotNum == -1)
1483       Out << "<badref> = ";
1484     else
1485       Out << '%' << SlotNum << " = ";
1486   }
1487
1488   // If this is a volatile load or store, print out the volatile marker.
1489   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
1490       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1491       Out << "volatile ";
1492   } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1493     // If this is a call, check if it's a tail call.
1494     Out << "tail ";
1495   }
1496
1497   // Print out the opcode...
1498   Out << I.getOpcodeName();
1499
1500   // Print out the compare instruction predicates
1501   if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1502     Out << ' ' << getPredicateText(CI->getPredicate());
1503
1504   // Print out the type of the operands...
1505   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1506
1507   // Special case conditional branches to swizzle the condition out to the front
1508   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1509     Out << ' ';
1510     writeOperand(I.getOperand(2), true);
1511     Out << ", ";
1512     writeOperand(Operand, true);
1513     Out << ", ";
1514     writeOperand(I.getOperand(1), true);
1515
1516   } else if (isa<SwitchInst>(I)) {
1517     // Special case switch statement to get formatting nice and correct...
1518     Out << ' ';
1519     writeOperand(Operand        , true);
1520     Out << ", ";
1521     writeOperand(I.getOperand(1), true);
1522     Out << " [";
1523
1524     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1525       Out << "\n\t\t";
1526       writeOperand(I.getOperand(op  ), true);
1527       Out << ", ";
1528       writeOperand(I.getOperand(op+1), true);
1529     }
1530     Out << "\n\t]";
1531   } else if (isa<PHINode>(I)) {
1532     Out << ' ';
1533     printType(I.getType());
1534     Out << ' ';
1535
1536     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1537       if (op) Out << ", ";
1538       Out << "[ ";
1539       writeOperand(I.getOperand(op  ), false); Out << ", ";
1540       writeOperand(I.getOperand(op+1), false); Out << " ]";
1541     }
1542   } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1543     Out << ' ';
1544     writeOperand(I.getOperand(0), true);
1545     for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1546       Out << ", " << *i;
1547   } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1548     Out << ' ';
1549     writeOperand(I.getOperand(0), true); Out << ", ";
1550     writeOperand(I.getOperand(1), true);
1551     for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1552       Out << ", " << *i;
1553   } else if (isa<ReturnInst>(I) && !Operand) {
1554     Out << " void";
1555   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1556     // Print the calling convention being used.
1557     switch (CI->getCallingConv()) {
1558     case CallingConv::C: break;   // default
1559     case CallingConv::Fast:  Out << " fastcc"; break;
1560     case CallingConv::Cold:  Out << " coldcc"; break;
1561     case CallingConv::X86_StdCall:  Out << " x86_stdcallcc"; break;
1562     case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1563     default: Out << " cc" << CI->getCallingConv(); break;
1564     }
1565
1566     const PointerType    *PTy = cast<PointerType>(Operand->getType());
1567     const FunctionType   *FTy = cast<FunctionType>(PTy->getElementType());
1568     const Type         *RetTy = FTy->getReturnType();
1569     const AttrListPtr &PAL = CI->getAttributes();
1570
1571     if (PAL.getRetAttributes() != Attribute::None)
1572       Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1573
1574     // If possible, print out the short form of the call instruction.  We can
1575     // only do this if the first argument is a pointer to a nonvararg function,
1576     // and if the return type is not a pointer to a function.
1577     //
1578     Out << ' ';
1579     if (!FTy->isVarArg() &&
1580         (!isa<PointerType>(RetTy) ||
1581          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1582       printType(RetTy);
1583       Out << ' ';
1584       writeOperand(Operand, false);
1585     } else {
1586       writeOperand(Operand, true);
1587     }
1588     Out << '(';
1589     for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1590       if (op > 1)
1591         Out << ", ";
1592       writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
1593     }
1594     Out << ')';
1595     if (PAL.getFnAttributes() != Attribute::None)
1596       Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1597   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1598     const PointerType    *PTy = cast<PointerType>(Operand->getType());
1599     const FunctionType   *FTy = cast<FunctionType>(PTy->getElementType());
1600     const Type         *RetTy = FTy->getReturnType();
1601     const AttrListPtr &PAL = II->getAttributes();
1602
1603     // Print the calling convention being used.
1604     switch (II->getCallingConv()) {
1605     case CallingConv::C: break;   // default
1606     case CallingConv::Fast:  Out << " fastcc"; break;
1607     case CallingConv::Cold:  Out << " coldcc"; break;
1608     case CallingConv::X86_StdCall:  Out << " x86_stdcallcc"; break;
1609     case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1610     default: Out << " cc" << II->getCallingConv(); break;
1611     }
1612
1613     if (PAL.getRetAttributes() != Attribute::None)
1614       Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1615
1616     // If possible, print out the short form of the invoke instruction. We can
1617     // only do this if the first argument is a pointer to a nonvararg function,
1618     // and if the return type is not a pointer to a function.
1619     //
1620     Out << ' ';
1621     if (!FTy->isVarArg() &&
1622         (!isa<PointerType>(RetTy) ||
1623          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1624       printType(RetTy);
1625       Out << ' ';
1626       writeOperand(Operand, false);
1627     } else {
1628       writeOperand(Operand, true);
1629     }
1630     Out << '(';
1631     for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1632       if (op > 3)
1633         Out << ", ";
1634       writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
1635     }
1636
1637     Out << ')';
1638     if (PAL.getFnAttributes() != Attribute::None)
1639       Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1640
1641     Out << "\n\t\t\tto ";
1642     writeOperand(II->getNormalDest(), true);
1643     Out << " unwind ";
1644     writeOperand(II->getUnwindDest(), true);
1645
1646   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1647     Out << ' ';
1648     printType(AI->getType()->getElementType());
1649     if (AI->isArrayAllocation()) {
1650       Out << ", ";
1651       writeOperand(AI->getArraySize(), true);
1652     }
1653     if (AI->getAlignment()) {
1654       Out << ", align " << AI->getAlignment();
1655     }
1656   } else if (isa<CastInst>(I)) {
1657     if (Operand) {
1658       Out << ' ';
1659       writeOperand(Operand, true);   // Work with broken code
1660     }
1661     Out << " to ";
1662     printType(I.getType());
1663   } else if (isa<VAArgInst>(I)) {
1664     if (Operand) {
1665       Out << ' ';
1666       writeOperand(Operand, true);   // Work with broken code
1667     }
1668     Out << ", ";
1669     printType(I.getType());
1670   } else if (Operand) {   // Print the normal way...
1671
1672     // PrintAllTypes - Instructions who have operands of all the same type
1673     // omit the type from all but the first operand.  If the instruction has
1674     // different type operands (for example br), then they are all printed.
1675     bool PrintAllTypes = false;
1676     const Type *TheType = Operand->getType();
1677
1678     // Select, Store and ShuffleVector always print all types.
1679     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1680         || isa<ReturnInst>(I)) {
1681       PrintAllTypes = true;
1682     } else {
1683       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1684         Operand = I.getOperand(i);
1685         // note that Operand shouldn't be null, but the test helps make dump()
1686         // more tolerant of malformed IR
1687         if (Operand && Operand->getType() != TheType) {
1688           PrintAllTypes = true;    // We have differing types!  Print them all!
1689           break;
1690         }
1691       }
1692     }
1693
1694     if (!PrintAllTypes) {
1695       Out << ' ';
1696       printType(TheType);
1697     }
1698
1699     Out << ' ';
1700     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1701       if (i) Out << ", ";
1702       writeOperand(I.getOperand(i), PrintAllTypes);
1703     }
1704   }
1705
1706   // Print post operand alignment for load/store
1707   if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1708     Out << ", align " << cast<LoadInst>(I).getAlignment();
1709   } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1710     Out << ", align " << cast<StoreInst>(I).getAlignment();
1711   }
1712
1713   printInfoComment(I);
1714   Out << '\n';
1715 }
1716
1717
1718 //===----------------------------------------------------------------------===//
1719 //                       External Interface declarations
1720 //===----------------------------------------------------------------------===//
1721
1722 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1723   raw_os_ostream OS(o);
1724   print(OS, AAW);
1725 }
1726 void Module::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1727   SlotTracker SlotTable(this);
1728   AssemblyWriter W(OS, SlotTable, this, AAW);
1729   W.write(this);
1730 }
1731
1732 void Type::print(std::ostream &o) const {
1733   raw_os_ostream OS(o);
1734   print(OS);
1735 }
1736
1737 void Type::print(raw_ostream &o) const {
1738   if (this == 0)
1739     o << "<null Type>";
1740   else
1741     o << getDescription();
1742 }
1743
1744 void Value::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1745   if (this == 0) {
1746     OS << "printing a <null> value\n";
1747     return;
1748   }
1749
1750   if (const Instruction *I = dyn_cast<Instruction>(this)) {
1751     const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
1752     SlotTracker SlotTable(F);
1753     AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
1754     W.write(I);
1755   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
1756     SlotTracker SlotTable(BB->getParent());
1757     AssemblyWriter W(OS, SlotTable,
1758                      BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
1759     W.write(BB);
1760   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
1761     SlotTracker SlotTable(GV->getParent());
1762     AssemblyWriter W(OS, SlotTable, GV->getParent(), 0);
1763     W.write(GV);
1764   } else if (const Constant *C = dyn_cast<Constant>(this)) {
1765     OS << C->getType()->getDescription() << ' ';
1766     std::map<const Type *, std::string> TypeTable;
1767     WriteConstantInt(OS, C, TypeTable, 0);
1768   } else if (const Argument *A = dyn_cast<Argument>(this)) {
1769     WriteAsOperand(OS, this, true,
1770                    A->getParent() ? A->getParent()->getParent() : 0);
1771   } else if (isa<InlineAsm>(this)) {
1772     WriteAsOperand(OS, this, true, 0);
1773   } else {
1774     assert(0 && "Unknown value to print out!");
1775   }
1776 }
1777
1778 void Value::print(std::ostream &O, AssemblyAnnotationWriter *AAW) const {
1779   raw_os_ostream OS(O);
1780   print(OS, AAW);
1781 }
1782
1783 // Value::dump - allow easy printing of Values from the debugger.
1784 void Value::dump() const { print(errs()); errs() << '\n'; errs().flush(); }
1785
1786 // Type::dump - allow easy printing of Types from the debugger.
1787 void Type::dump() const { print(errs()); errs() << '\n'; errs().flush(); }
1788
1789 // Type::dump - allow easy printing of Types from the debugger.
1790 // This one uses type names from the given context module
1791 void Type::dump(const Module *Context) const {
1792   WriteTypeSymbolic(errs(), this, Context);
1793   errs() << '\n';
1794   errs().flush();
1795 }
1796
1797 // Module::dump() - Allow printing of Modules from the debugger.
1798 void Module::dump() const { print(errs(), 0); errs().flush(); }
1799
1800