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