lib/VMCore/AsmWriter.cpp

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