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       const uint64_t* p = CFP->getValueAPF().convertToAPInt().getRawData();
 525       uint64_t word = *p;
 526       int shiftcount=60;
 527       int width = CFP->getValueAPF().convertToAPInt().getBitWidth();
 528       for (int j=0; j<width; j+=4, shiftcount-=4) {
 529         unsigned int nibble = (word>>shiftcount) & 15;
 530         if (nibble < 10)
 531           Out << (unsigned char)(nibble + '0');
 532         else
 533           Out << (unsigned char)(nibble - 10 + 'A');
 534         if (shiftcount == 0) {
 535           word = *(++p);
 536           shiftcount = 60;
 537           if (width-j-4 < 64)
 538             shiftcount = width-j-4;
 539         }
 540       }
 541     }
 542   } else if (isa<ConstantAggregateZero>(CV)) {
 543     Out << "zeroinitializer";
 544   } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 545     // As a special case, print the array as a string if it is an array of
 546     // ubytes or an array of sbytes with positive values.
 547     //
 548     const Type *ETy = CA->getType()->getElementType();
 549     if (CA->isString()) {
 550       Out << "c\"";
 551       PrintEscapedString(CA->getAsString(), Out);
 552       Out << "\"";
 553
 554     } else {                // Cannot output in string format...
 555       Out << '[';
 556       if (CA->getNumOperands()) {
 557         Out << ' ';
 558         printTypeInt(Out, ETy, TypeTable);
 559         WriteAsOperandInternal(Out, CA->getOperand(0),
 560                                TypeTable, Machine);
 561         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
 562           Out << ", ";
 563           printTypeInt(Out, ETy, TypeTable);
 564           WriteAsOperandInternal(Out, CA->getOperand(i), TypeTable, Machine);
 565         }
 566       }
 567       Out << " ]";
 568     }
 569   } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
 570     if (CS->getType()->isPacked())
 571       Out << '<';
 572     Out << '{';
 573     unsigned N = CS->getNumOperands();
 574     if (N) {
 575       if (N > 2) {
 576         Indent += std::string(IndentSize, ' ');
 577         Out << Indent;
 578       } else {
 579         Out << ' ';
 580       }
 581       printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
 582
 583       WriteAsOperandInternal(Out, CS->getOperand(0), TypeTable, Machine);
 584
 585       for (unsigned i = 1; i < N; i++) {
 586         Out << ", ";
 587         if (N > 2) Out << Indent;
 588         printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
 589
 590         WriteAsOperandInternal(Out, CS->getOperand(i), TypeTable, Machine);
 591       }
 592       if (N > 2) Indent.resize(Indent.size() - IndentSize);
 593     }
 594
 595     Out << " }";
 596     if (CS->getType()->isPacked())
 597       Out << '>';
 598   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
 599       const Type *ETy = CP->getType()->getElementType();
 600       assert(CP->getNumOperands() > 0 &&
 601              "Number of operands for a PackedConst must be > 0");
 602       Out << '<';
 603       Out << ' ';
 604       printTypeInt(Out, ETy, TypeTable);
 605       WriteAsOperandInternal(Out, CP->getOperand(0), TypeTable, Machine);
 606       for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
 607           Out << ", ";
 608           printTypeInt(Out, ETy, TypeTable);
 609           WriteAsOperandInternal(Out, CP->getOperand(i), TypeTable, Machine);
 610       }
 611       Out << " >";
 612   } else if (isa<ConstantPointerNull>(CV)) {
 613     Out << "null";
 614
 615   } else if (isa<UndefValue>(CV)) {
 616     Out << "undef";
 617
 618   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 619     Out << CE->getOpcodeName();
 620     if (CE->isCompare())
 621       Out << " " << getPredicateText(CE->getPredicate());
 622     Out << " (";
 623
 624     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
 625       printTypeInt(Out, (*OI)->getType(), TypeTable);
 626       WriteAsOperandInternal(Out, *OI, TypeTable, Machine);
 627       if (OI+1 != CE->op_end())
 628         Out << ", ";
 629     }
 630
 631     if (CE->isCast()) {
 632       Out << " to ";
 633       printTypeInt(Out, CE->getType(), TypeTable);
 634     }
 635
 636     Out << ')';
 637
 638   } else {
 639     Out << "<placeholder or erroneous Constant>";
 640   }
 641 }
 642
 643
 644 /// WriteAsOperand - Write the name of the specified value out to the specified
 645 /// ostream.  This can be useful when you just want to print int %reg126, not
 646 /// the whole instruction that generated it.
 647 ///
 648 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
 649                                   std::map<const Type*, std::string> &TypeTable,
 650                                    SlotMachine *Machine) {
 651   Out << ' ';
 652   if (V->hasName())
 653     Out << getLLVMName(V->getName(),
 654                        isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
 655   else {
 656     const Constant *CV = dyn_cast<Constant>(V);
 657     if (CV && !isa<GlobalValue>(CV)) {
 658       WriteConstantInt(Out, CV, TypeTable, Machine);
 659     } else if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
 660       Out << "asm ";
 661       if (IA->hasSideEffects())
 662         Out << "sideeffect ";
 663       Out << '"';
 664       PrintEscapedString(IA->getAsmString(), Out);
 665       Out << "\", \"";
 666       PrintEscapedString(IA->getConstraintString(), Out);
 667       Out << '"';
 668     } else {
 669       char Prefix = '%';
 670       int Slot;
 671       if (Machine) {
 672         if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 673           Slot = Machine->getGlobalSlot(GV);
 674           Prefix = '@';
 675         } else {
 676           Slot = Machine->getLocalSlot(V);
 677         }
 678       } else {
 679         Machine = createSlotMachine(V);
 680         if (Machine) {
 681           if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 682             Slot = Machine->getGlobalSlot(GV);
 683             Prefix = '@';
 684           } else {
 685             Slot = Machine->getLocalSlot(V);
 686           }
 687         } else {
 688           Slot = -1;
 689         }
 690         delete Machine;
 691       }
 692       if (Slot != -1)
 693         Out << Prefix << Slot;
 694       else
 695         Out << "<badref>";
 696     }
 697   }
 698 }
 699
 700 /// WriteAsOperand - Write the name of the specified value out to the specified
 701 /// ostream.  This can be useful when you just want to print int %reg126, not
 702 /// the whole instruction that generated it.
 703 ///
 704 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
 705                                    bool PrintType, const Module *Context) {
 706   std::map<const Type *, std::string> TypeNames;
 707   if (Context == 0) Context = getModuleFromVal(V);
 708
 709   if (Context)
 710     fillTypeNameTable(Context, TypeNames);
 711
 712   if (PrintType)
 713     printTypeInt(Out, V->getType(), TypeNames);
 714
 715   WriteAsOperandInternal(Out, V, TypeNames, 0);
 716   return Out;
 717 }
 718
 719
 720 namespace llvm {
 721
 722 class AssemblyWriter {
 723   std::ostream &Out;
 724   SlotMachine &Machine;
 725   const Module *TheModule;
 726   std::map<const Type *, std::string> TypeNames;
 727   AssemblyAnnotationWriter *AnnotationWriter;
 728 public:
 729   inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
 730                         AssemblyAnnotationWriter *AAW)
 731     : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
 732
 733     // If the module has a symbol table, take all global types and stuff their
 734     // names into the TypeNames map.
 735     //
 736     fillTypeNameTable(M, TypeNames);
 737   }
 738
 739   inline void write(const Module *M)         { printModule(M);       }
 740   inline void write(const GlobalVariable *G) { printGlobal(G);       }
 741   inline void write(const GlobalAlias *G)    { printAlias(G);        }
 742   inline void write(const Function *F)       { printFunction(F);     }
 743   inline void write(const BasicBlock *BB)    { printBasicBlock(BB);  }
 744   inline void write(const Instruction *I)    { printInstruction(*I); }
 745   inline void write(const Type *Ty)          { printType(Ty);        }
 746
 747   void writeOperand(const Value *Op, bool PrintType);
 748
 749   const Module* getModule() { return TheModule; }
 750
 751 private:
 752   void printModule(const Module *M);
 753   void printTypeSymbolTable(const TypeSymbolTable &ST);
 754   void printGlobal(const GlobalVariable *GV);
 755   void printAlias(const GlobalAlias *GV);
 756   void printFunction(const Function *F);
 757   void printArgument(const Argument *FA, uint16_t ParamAttrs);
 758   void printBasicBlock(const BasicBlock *BB);
 759   void printInstruction(const Instruction &I);
 760
 761   // printType - Go to extreme measures to attempt to print out a short,
 762   // symbolic version of a type name.
 763   //
 764   std::ostream &printType(const Type *Ty) {
 765     return printTypeInt(Out, Ty, TypeNames);
 766   }
 767
 768   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 769   // without considering any symbolic types that we may have equal to it.
 770   //
 771   std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
 772
 773   // printInfoComment - Print a little comment after the instruction indicating
 774   // which slot it occupies.
 775   void printInfoComment(const Value &V);
 776 };
 777 }  // end of llvm namespace
 778
 779 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 780 /// without considering any symbolic types that we may have equal to it.
 781 ///
 782 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 783   if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty))
 784     Out << "i" << utostr(ITy->getBitWidth());
 785   else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 786     printType(FTy->getReturnType());
 787     Out << " (";
 788     unsigned Idx = 1;
 789     const ParamAttrsList *Attrs = FTy->getParamAttrs();
 790     for (FunctionType::param_iterator I = FTy->param_begin(),
 791            E = FTy->param_end(); I != E; ++I) {
 792       if (I != FTy->param_begin())
 793         Out << ", ";
 794       printType(*I);
 795       if (Attrs && Attrs->getParamAttrs(Idx) != ParamAttr::None) {
 796         Out << " " << Attrs->getParamAttrsTextByIndex(Idx);
 797       }
 798       Idx++;
 799     }
 800     if (FTy->isVarArg()) {
 801       if (FTy->getNumParams()) Out << ", ";
 802       Out << "...";
 803     }
 804     Out << ')';
 805     if (Attrs && Attrs->getParamAttrs(0) != ParamAttr::None)
 806       Out << ' ' << Attrs->getParamAttrsTextByIndex(0);
 807   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 808     if (STy->isPacked())
 809       Out << '<';
 810     Out << "{ ";
 811     for (StructType::element_iterator I = STy->element_begin(),
 812            E = STy->element_end(); I != E; ++I) {
 813       if (I != STy->element_begin())
 814         Out << ", ";
 815       printType(*I);
 816     }
 817     Out << " }";
 818     if (STy->isPacked())
 819       Out << '>';
 820   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 821     printType(PTy->getElementType()) << '*';
 822   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 823     Out << '[' << ATy->getNumElements() << " x ";
 824     printType(ATy->getElementType()) << ']';
 825   } else if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
 826     Out << '<' << PTy->getNumElements() << " x ";
 827     printType(PTy->getElementType()) << '>';
 828   }
 829   else if (isa<OpaqueType>(Ty)) {
 830     Out << "opaque";
 831   } else {
 832     if (!Ty->isPrimitiveType())
 833       Out << "<unknown derived type>";
 834     printType(Ty);
 835   }
 836   return Out;
 837 }
 838
 839
 840 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
 841   if (Operand == 0) {
 842     Out << "<null operand!>";
 843   } else {
 844     if (PrintType) { Out << ' '; printType(Operand->getType()); }
 845     WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
 846   }
 847 }
 848
 849
 850 void AssemblyWriter::printModule(const Module *M) {
 851   if (!M->getModuleIdentifier().empty() &&
 852       // Don't print the ID if it will start a new line (which would
 853       // require a comment char before it).
 854       M->getModuleIdentifier().find('\n') == std::string::npos)
 855     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
 856
 857   if (!M->getDataLayout().empty())
 858     Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
 859   if (!M->getTargetTriple().empty())
 860     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
 861
 862   if (!M->getModuleInlineAsm().empty()) {
 863     // Split the string into lines, to make it easier to read the .ll file.
 864     std::string Asm = M->getModuleInlineAsm();
 865     size_t CurPos = 0;
 866     size_t NewLine = Asm.find_first_of('\n', CurPos);
 867     while (NewLine != std::string::npos) {
 868       // We found a newline, print the portion of the asm string from the
 869       // last newline up to this newline.
 870       Out << "module asm \"";
 871       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
 872                          Out);
 873       Out << "\"\n";
 874       CurPos = NewLine+1;
 875       NewLine = Asm.find_first_of('\n', CurPos);
 876     }
 877     Out << "module asm \"";
 878     PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
 879     Out << "\"\n";
 880   }
 881
 882   // Loop over the dependent libraries and emit them.
 883   Module::lib_iterator LI = M->lib_begin();
 884   Module::lib_iterator LE = M->lib_end();
 885   if (LI != LE) {
 886     Out << "deplibs = [ ";
 887     while (LI != LE) {
 888       Out << '"' << *LI << '"';
 889       ++LI;
 890       if (LI != LE)
 891         Out << ", ";
 892     }
 893     Out << " ]\n";
 894   }
 895
 896   // Loop over the symbol table, emitting all named constants.
 897   printTypeSymbolTable(M->getTypeSymbolTable());
 898
 899   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
 900        I != E; ++I)
 901     printGlobal(I);
 902
 903   // Output all aliases.
 904   if (!M->alias_empty()) Out << "\n";
 905   for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
 906        I != E; ++I)
 907     printAlias(I);
 908
 909   // Output all of the functions.
 910   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 911     printFunction(I);
 912 }
 913
 914 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 915   if (GV->hasName()) Out << getLLVMName(GV->getName(), GlobalPrefix) << " = ";
 916
 917   if (!GV->hasInitializer())
 918     switch (GV->getLinkage()) {
 919      case GlobalValue::DLLImportLinkage:   Out << "dllimport "; break;
 920      case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
 921      default: Out << "external "; break;
 922     } else {
 923     switch (GV->getLinkage()) {
 924     case GlobalValue::InternalLinkage:     Out << "internal "; break;
 925     case GlobalValue::LinkOnceLinkage:     Out << "linkonce "; break;
 926     case GlobalValue::WeakLinkage:         Out << "weak "; break;
 927     case GlobalValue::AppendingLinkage:    Out << "appending "; break;
 928     case GlobalValue::DLLImportLinkage:    Out << "dllimport "; break;
 929     case GlobalValue::DLLExportLinkage:    Out << "dllexport "; break;
 930     case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
 931     case GlobalValue::ExternalLinkage:     break;
 932     case GlobalValue::GhostLinkage:
 933       cerr << "GhostLinkage not allowed in AsmWriter!\n";
 934       abort();
 935     }
 936     switch (GV->getVisibility()) {
 937     default: assert(0 && "Invalid visibility style!");
 938     case GlobalValue::DefaultVisibility: break;
 939     case GlobalValue::HiddenVisibility: Out << "hidden "; break;
 940     case GlobalValue::ProtectedVisibility: Out << "protected "; break;
 941     }
 942   }
 943
 944   if (GV->isThreadLocal()) Out << "thread_local ";
 945   Out << (GV->isConstant() ? "constant " : "global ");
 946   printType(GV->getType()->getElementType());
 947
 948   if (GV->hasInitializer()) {
 949     Constant* C = cast<Constant>(GV->getInitializer());
 950     assert(C &&  "GlobalVar initializer isn't constant?");
 951     writeOperand(GV->getInitializer(), false);
 952   }
 953
 954   if (GV->hasSection())
 955     Out << ", section \"" << GV->getSection() << '"';
 956   if (GV->getAlignment())
 957     Out << ", align " << GV->getAlignment();
 958
 959   printInfoComment(*GV);
 960   Out << "\n";
 961 }
 962
 963 void AssemblyWriter::printAlias(const GlobalAlias *GA) {
 964   Out << getLLVMName(GA->getName(), GlobalPrefix) << " = ";
 965   switch (GA->getVisibility()) {
 966   default: assert(0 && "Invalid visibility style!");
 967   case GlobalValue::DefaultVisibility: break;
 968   case GlobalValue::HiddenVisibility: Out << "hidden "; break;
 969   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
 970   }
 971
 972   Out << "alias ";
 973
 974   switch (GA->getLinkage()) {
 975   case GlobalValue::WeakLinkage: Out << "weak "; break;
 976   case GlobalValue::InternalLinkage: Out << "internal "; break;
 977   case GlobalValue::ExternalLinkage: break;
 978   default:
 979    assert(0 && "Invalid alias linkage");
 980   }
 981
 982   const Constant *Aliasee = GA->getAliasee();
 983
 984   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
 985     printType(GV->getType());
 986     Out << " " << getLLVMName(GV->getName(), GlobalPrefix);
 987   } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
 988     printType(F->getFunctionType());
 989     Out << "* ";
 990
 991     if (!F->getName().empty())
 992       Out << getLLVMName(F->getName(), GlobalPrefix);
 993     else
 994       Out << "@\"\"";
 995   } else {
 996     const ConstantExpr *CE = 0;
 997     if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
 998         (CE->getOpcode() == Instruction::BitCast)) {
 999       writeOperand(CE, false);
1000     } else
1001       assert(0 && "Unsupported aliasee");
1002   }
1003
1004   printInfoComment(*GA);
1005   Out << "\n";
1006 }
1007
1008 void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
1009   // Print the types.
1010   for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1011        TI != TE; ++TI) {
1012     Out << "\t" << getLLVMName(TI->first, LocalPrefix) << " = type ";
1013
1014     // Make sure we print out at least one level of the type structure, so
1015     // that we do not get %FILE = type %FILE
1016     //
1017     printTypeAtLeastOneLevel(TI->second) << "\n";
1018   }
1019 }
1020
1021 /// printFunction - Print all aspects of a function.
1022 ///
1023 void AssemblyWriter::printFunction(const Function *F) {
1024   // Print out the return type and name...
1025   Out << "\n";
1026
1027   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
1028
1029   if (F->isDeclaration())
1030     Out << "declare ";
1031   else
1032     Out << "define ";
1033
1034   switch (F->getLinkage()) {
1035   case GlobalValue::InternalLinkage:     Out << "internal "; break;
1036   case GlobalValue::LinkOnceLinkage:     Out << "linkonce "; break;
1037   case GlobalValue::WeakLinkage:         Out << "weak "; break;
1038   case GlobalValue::AppendingLinkage:    Out << "appending "; break;
1039   case GlobalValue::DLLImportLinkage:    Out << "dllimport "; break;
1040   case GlobalValue::DLLExportLinkage:    Out << "dllexport "; break;
1041   case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1042   case GlobalValue::ExternalLinkage: break;
1043   case GlobalValue::GhostLinkage:
1044     cerr << "GhostLinkage not allowed in AsmWriter!\n";
1045     abort();
1046   }
1047   switch (F->getVisibility()) {
1048   default: assert(0 && "Invalid visibility style!");
1049   case GlobalValue::DefaultVisibility: break;
1050   case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1051   case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1052   }
1053
1054   // Print the calling convention.
1055   switch (F->getCallingConv()) {
1056   case CallingConv::C: break;   // default
1057   case CallingConv::Fast:         Out << "fastcc "; break;
1058   case CallingConv::Cold:         Out << "coldcc "; break;
1059   case CallingConv::X86_StdCall:  Out << "x86_stdcallcc "; break;
1060   case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1061   default: Out << "cc" << F->getCallingConv() << " "; break;
1062   }
1063
1064   const FunctionType *FT = F->getFunctionType();
1065   const ParamAttrsList *Attrs = FT->getParamAttrs();
1066   printType(F->getReturnType()) << ' ';
1067   if (!F->getName().empty())
1068     Out << getLLVMName(F->getName(), GlobalPrefix);
1069   else
1070     Out << "@\"\"";
1071   Out << '(';
1072   Machine.incorporateFunction(F);
1073
1074   // Loop over the arguments, printing them...
1075
1076   unsigned Idx = 1;
1077   if (!F->isDeclaration()) {
1078     // If this isn't a declaration, print the argument names as well.
1079     for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1080          I != E; ++I) {
1081       // Insert commas as we go... the first arg doesn't get a comma
1082       if (I != F->arg_begin()) Out << ", ";
1083       printArgument(I, (Attrs ? Attrs->getParamAttrs(Idx)
1084                               : uint16_t(ParamAttr::None)));
1085       Idx++;
1086     }
1087   } else {
1088     // Otherwise, print the types from the function type.
1089     for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1090       // Insert commas as we go... the first arg doesn't get a comma
1091       if (i) Out << ", ";
1092
1093       // Output type...
1094       printType(FT->getParamType(i));
1095
1096       unsigned ArgAttrs = ParamAttr::None;
1097       if (Attrs) ArgAttrs = Attrs->getParamAttrs(i+1);
1098       if (ArgAttrs != ParamAttr::None)
1099         Out << ' ' << ParamAttrsList::getParamAttrsText(ArgAttrs);
1100     }
1101   }
1102
1103   // Finish printing arguments...
1104   if (FT->isVarArg()) {
1105     if (FT->getNumParams()) Out << ", ";
1106     Out << "...";  // Output varargs portion of signature!
1107   }
1108   Out << ')';
1109   if (Attrs && Attrs->getParamAttrs(0) != ParamAttr::None)
1110     Out << ' ' << Attrs->getParamAttrsTextByIndex(0);
1111   if (F->hasSection())
1112     Out << " section \"" << F->getSection() << '"';
1113   if (F->getAlignment())
1114     Out << " align " << F->getAlignment();
1115
1116   if (F->isDeclaration()) {
1117     Out << "\n";
1118   } else {
1119     Out << " {";
1120
1121     // Output all of its basic blocks... for the function
1122     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1123       printBasicBlock(I);
1124
1125     Out << "}\n";
1126   }
1127
1128   Machine.purgeFunction();
1129 }
1130
1131 /// printArgument - This member is called for every argument that is passed into
1132 /// the function.  Simply print it out
1133 ///
1134 void AssemblyWriter::printArgument(const Argument *Arg, uint16_t Attrs) {
1135   // Output type...
1136   printType(Arg->getType());
1137
1138   if (Attrs != ParamAttr::None)
1139     Out << ' ' << ParamAttrsList::getParamAttrsText(Attrs);
1140
1141   // Output name, if available...
1142   if (Arg->hasName())
1143     Out << ' ' << getLLVMName(Arg->getName(), LocalPrefix);
1144 }
1145
1146 /// printBasicBlock - This member is called for each basic block in a method.
1147 ///
1148 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1149   if (BB->hasName()) {              // Print out the label if it exists...
1150     Out << "\n" << getLLVMName(BB->getName(), LabelPrefix) << ':';
1151   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
1152     Out << "\n; <label>:";
1153     int Slot = Machine.getLocalSlot(BB);
1154     if (Slot != -1)
1155       Out << Slot;
1156     else
1157       Out << "<badref>";
1158   }
1159
1160   if (BB->getParent() == 0)
1161     Out << "\t\t; Error: Block without parent!";
1162   else {
1163     if (BB != &BB->getParent()->getEntryBlock()) {  // Not the entry block?
1164       // Output predecessors for the block...
1165       Out << "\t\t;";
1166       pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1167
1168       if (PI == PE) {
1169         Out << " No predecessors!";
1170       } else {
1171         Out << " preds =";
1172         writeOperand(*PI, false);
1173         for (++PI; PI != PE; ++PI) {
1174           Out << ',';
1175           writeOperand(*PI, false);
1176         }
1177       }
1178     }
1179   }
1180
1181   Out << "\n";
1182
1183   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1184
1185   // Output all of the instructions in the basic block...
1186   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1187     printInstruction(*I);
1188
1189   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1190 }
1191
1192
1193 /// printInfoComment - Print a little comment after the instruction indicating
1194 /// which slot it occupies.
1195 ///
1196 void AssemblyWriter::printInfoComment(const Value &V) {
1197   if (V.getType() != Type::VoidTy) {
1198     Out << "\t\t; <";
1199     printType(V.getType()) << '>';
1200
1201     if (!V.hasName()) {
1202       int SlotNum;
1203       if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1204         SlotNum = Machine.getGlobalSlot(GV);
1205       else
1206         SlotNum = Machine.getLocalSlot(&V);
1207       if (SlotNum == -1)
1208         Out << ":<badref>";
1209       else
1210         Out << ':' << SlotNum; // Print out the def slot taken.
1211     }
1212     Out << " [#uses=" << V.getNumUses() << ']';  // Output # uses
1213   }
1214 }
1215
1216 // This member is called for each Instruction in a function..
1217 void AssemblyWriter::printInstruction(const Instruction &I) {
1218   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1219
1220   Out << "\t";
1221
1222   // Print out name if it exists...
1223   if (I.hasName())
1224     Out << getLLVMName(I.getName(), LocalPrefix) << " = ";
1225
1226   // If this is a volatile load or store, print out the volatile marker.
1227   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
1228       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1229       Out << "volatile ";
1230   } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1231     // If this is a call, check if it's a tail call.
1232     Out << "tail ";
1233   }
1234
1235   // Print out the opcode...
1236   Out << I.getOpcodeName();
1237
1238   // Print out the compare instruction predicates
1239   if (const FCmpInst *FCI = dyn_cast<FCmpInst>(&I)) {
1240     Out << " " << getPredicateText(FCI->getPredicate());
1241   } else if (const ICmpInst *ICI = dyn_cast<ICmpInst>(&I)) {
1242     Out << " " << getPredicateText(ICI->getPredicate());
1243   }
1244
1245   // Print out the type of the operands...
1246   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1247
1248   // Special case conditional branches to swizzle the condition out to the front
1249   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1250     writeOperand(I.getOperand(2), true);
1251     Out << ',';
1252     writeOperand(Operand, true);
1253     Out << ',';
1254     writeOperand(I.getOperand(1), true);
1255
1256   } else if (isa<SwitchInst>(I)) {
1257     // Special case switch statement to get formatting nice and correct...
1258     writeOperand(Operand        , true); Out << ',';
1259     writeOperand(I.getOperand(1), true); Out << " [";
1260
1261     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1262       Out << "\n\t\t";
1263       writeOperand(I.getOperand(op  ), true); Out << ',';
1264       writeOperand(I.getOperand(op+1), true);
1265     }
1266     Out << "\n\t]";
1267   } else if (isa<PHINode>(I)) {
1268     Out << ' ';
1269     printType(I.getType());
1270     Out << ' ';
1271
1272     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1273       if (op) Out << ", ";
1274       Out << '[';
1275       writeOperand(I.getOperand(op  ), false); Out << ',';
1276       writeOperand(I.getOperand(op+1), false); Out << " ]";
1277     }
1278   } else if (isa<ReturnInst>(I) && !Operand) {
1279     Out << " void";
1280   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1281     // Print the calling convention being used.
1282     switch (CI->getCallingConv()) {
1283     case CallingConv::C: break;   // default
1284     case CallingConv::Fast:  Out << " fastcc"; break;
1285     case CallingConv::Cold:  Out << " coldcc"; break;
1286     case CallingConv::X86_StdCall:  Out << "x86_stdcallcc "; break;
1287     case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1288     default: Out << " cc" << CI->getCallingConv(); break;
1289     }
1290
1291     const PointerType    *PTy = cast<PointerType>(Operand->getType());
1292     const FunctionType   *FTy = cast<FunctionType>(PTy->getElementType());
1293     const Type         *RetTy = FTy->getReturnType();
1294     const ParamAttrsList *PAL = FTy->getParamAttrs();
1295
1296     // If possible, print out the short form of the call instruction.  We can
1297     // only do this if the first argument is a pointer to a nonvararg function,
1298     // and if the return type is not a pointer to a function.
1299     //
1300     if (!FTy->isVarArg() &&
1301         (!isa<PointerType>(RetTy) ||
1302          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1303       Out << ' '; printType(RetTy);
1304       writeOperand(Operand, false);
1305     } else {
1306       writeOperand(Operand, true);
1307     }
1308     Out << '(';
1309     for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1310       if (op > 1)
1311         Out << ',';
1312       writeOperand(I.getOperand(op), true);
1313       if (PAL && PAL->getParamAttrs(op) != ParamAttr::None)
1314         Out << " " << PAL->getParamAttrsTextByIndex(op);
1315     }
1316     Out << " )";
1317     if (PAL && PAL->getParamAttrs(0) != ParamAttr::None)
1318       Out << ' ' << PAL->getParamAttrsTextByIndex(0);
1319   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1320     const PointerType    *PTy = cast<PointerType>(Operand->getType());
1321     const FunctionType   *FTy = cast<FunctionType>(PTy->getElementType());
1322     const Type         *RetTy = FTy->getReturnType();
1323     const ParamAttrsList *PAL = FTy->getParamAttrs();
1324
1325     // Print the calling convention being used.
1326     switch (II->getCallingConv()) {
1327     case CallingConv::C: break;   // default
1328     case CallingConv::Fast:  Out << " fastcc"; break;
1329     case CallingConv::Cold:  Out << " coldcc"; break;
1330     case CallingConv::X86_StdCall:  Out << "x86_stdcallcc "; break;
1331     case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1332     default: Out << " cc" << II->getCallingConv(); break;
1333     }
1334
1335     // If possible, print out the short form of the invoke instruction. We can
1336     // only do this if the first argument is a pointer to a nonvararg function,
1337     // and if the return type is not a pointer to a function.
1338     //
1339     if (!FTy->isVarArg() &&
1340         (!isa<PointerType>(RetTy) ||
1341          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1342       Out << ' '; printType(RetTy);
1343       writeOperand(Operand, false);
1344     } else {
1345       writeOperand(Operand, true);
1346     }
1347
1348     Out << '(';
1349     for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1350       if (op > 3)
1351         Out << ',';
1352       writeOperand(I.getOperand(op), true);
1353       if (PAL && PAL->getParamAttrs(op-2) != ParamAttr::None)
1354         Out << " " << PAL->getParamAttrsTextByIndex(op-2);
1355     }
1356
1357     Out << " )";
1358     if (PAL && PAL->getParamAttrs(0) != ParamAttr::None)
1359       Out << " " << PAL->getParamAttrsTextByIndex(0);
1360     Out << "\n\t\t\tto";
1361     writeOperand(II->getNormalDest(), true);
1362     Out << " unwind";
1363     writeOperand(II->getUnwindDest(), true);
1364
1365   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1366     Out << ' ';
1367     printType(AI->getType()->getElementType());
1368     if (AI->isArrayAllocation()) {
1369       Out << ',';
1370       writeOperand(AI->getArraySize(), true);
1371     }
1372     if (AI->getAlignment()) {
1373       Out << ", align " << AI->getAlignment();
1374     }
1375   } else if (isa<CastInst>(I)) {
1376     if (Operand) writeOperand(Operand, true);   // Work with broken code
1377     Out << " to ";
1378     printType(I.getType());
1379   } else if (isa<VAArgInst>(I)) {
1380     if (Operand) writeOperand(Operand, true);   // Work with broken code
1381     Out << ", ";
1382     printType(I.getType());
1383   } else if (Operand) {   // Print the normal way...
1384
1385     // PrintAllTypes - Instructions who have operands of all the same type
1386     // omit the type from all but the first operand.  If the instruction has
1387     // different type operands (for example br), then they are all printed.
1388     bool PrintAllTypes = false;
1389     const Type *TheType = Operand->getType();
1390
1391     // Select, Store and ShuffleVector always print all types.
1392     if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)) {
1393       PrintAllTypes = true;
1394     } else {
1395       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1396         Operand = I.getOperand(i);
1397         if (Operand->getType() != TheType) {
1398           PrintAllTypes = true;    // We have differing types!  Print them all!
1399           break;
1400         }
1401       }
1402     }
1403
1404     if (!PrintAllTypes) {
1405       Out << ' ';
1406       printType(TheType);
1407     }
1408
1409     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1410       if (i) Out << ',';
1411       writeOperand(I.getOperand(i), PrintAllTypes);
1412     }
1413   }
1414
1415   // Print post operand alignment for load/store
1416   if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1417     Out << ", align " << cast<LoadInst>(I).getAlignment();
1418   } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1419     Out << ", align " << cast<StoreInst>(I).getAlignment();
1420   }
1421
1422   printInfoComment(I);
1423   Out << "\n";
1424 }
1425
1426
1427 //===----------------------------------------------------------------------===//
1428 //                       External Interface declarations
1429 //===----------------------------------------------------------------------===//
1430
1431 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1432   SlotMachine SlotTable(this);
1433   AssemblyWriter W(o, SlotTable, this, AAW);
1434   W.write(this);
1435 }
1436
1437 void GlobalVariable::print(std::ostream &o) const {
1438   SlotMachine SlotTable(getParent());
1439   AssemblyWriter W(o, SlotTable, getParent(), 0);
1440   W.write(this);
1441 }
1442
1443 void GlobalAlias::print(std::ostream &o) const {
1444   SlotMachine SlotTable(getParent());
1445   AssemblyWriter W(o, SlotTable, getParent(), 0);
1446   W.write(this);
1447 }
1448
1449 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1450   SlotMachine SlotTable(getParent());
1451   AssemblyWriter W(o, SlotTable, getParent(), AAW);
1452
1453   W.write(this);
1454 }
1455
1456 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1457   WriteAsOperand(o, this, true, 0);
1458 }
1459
1460 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1461   SlotMachine SlotTable(getParent());
1462   AssemblyWriter W(o, SlotTable,
1463                    getParent() ? getParent()->getParent() : 0, AAW);
1464   W.write(this);
1465 }
1466
1467 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1468   const Function *F = getParent() ? getParent()->getParent() : 0;
1469   SlotMachine SlotTable(F);
1470   AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1471
1472   W.write(this);
1473 }
1474
1475 void Constant::print(std::ostream &o) const {
1476   if (this == 0) { o << "<null> constant value\n"; return; }
1477
1478   o << ' ' << getType()->getDescription() << ' ';
1479
1480   std::map<const Type *, std::string> TypeTable;
1481   WriteConstantInt(o, this, TypeTable, 0);
1482 }
1483
1484 void Type::print(std::ostream &o) const {
1485   if (this == 0)
1486     o << "<null Type>";
1487   else
1488     o << getDescription();
1489 }
1490
1491 void Argument::print(std::ostream &o) const {
1492   WriteAsOperand(o, this, true, getParent() ? getParent()->getParent() : 0);
1493 }
1494
1495 // Value::dump - allow easy printing of  Values from the debugger.
1496 // Located here because so much of the needed functionality is here.
1497 void Value::dump() const { print(*cerr.stream()); cerr << '\n'; }
1498
1499 // Type::dump - allow easy printing of  Values from the debugger.
1500 // Located here because so much of the needed functionality is here.
1501 void Type::dump() const { print(*cerr.stream()); cerr << '\n'; }
1502
1503 void
1504 ParamAttrsList::dump() const {
1505   cerr << "PAL[ ";
1506   for (unsigned i = 0; i < attrs.size(); ++i) {
1507     uint16_t index = getParamIndex(i);
1508     uint16_t attrs = getParamAttrs(index);
1509     cerr << "{" << index << "," << attrs << "} ";
1510   }
1511   cerr << "]\n";
1512 }
1513
1514 //===----------------------------------------------------------------------===//
1515 //                         SlotMachine Implementation
1516 //===----------------------------------------------------------------------===//
1517
1518 #if 0
1519 #define SC_DEBUG(X) cerr << X
1520 #else
1521 #define SC_DEBUG(X)
1522 #endif
1523
1524 // Module level constructor. Causes the contents of the Module (sans functions)
1525 // to be added to the slot table.
1526 SlotMachine::SlotMachine(const Module *M)
1527   : TheModule(M)    ///< Saved for lazy initialization.
1528   , TheFunction(0)
1529   , FunctionProcessed(false)
1530   , mMap(), mNext(0), fMap(), fNext(0)
1531 {
1532 }
1533
1534 // Function level constructor. Causes the contents of the Module and the one
1535 // function provided to be added to the slot table.
1536 SlotMachine::SlotMachine(const Function *F)
1537   : TheModule(F ? F->getParent() : 0) ///< Saved for lazy initialization
1538   , TheFunction(F) ///< Saved for lazy initialization
1539   , FunctionProcessed(false)
1540   , mMap(), mNext(0), fMap(), fNext(0)
1541 {
1542 }
1543
1544 inline void SlotMachine::initialize() {
1545   if (TheModule) {
1546     processModule();
1547     TheModule = 0; ///< Prevent re-processing next time we're called.
1548   }
1549   if (TheFunction && !FunctionProcessed)
1550     processFunction();
1551 }
1552
1553 // Iterate through all the global variables, functions, and global
1554 // variable initializers and create slots for them.
1555 void SlotMachine::processModule() {
1556   SC_DEBUG("begin processModule!\n");
1557
1558   // Add all of the unnamed global variables to the value table.
1559   for (Module::const_global_iterator I = TheModule->global_begin(),
1560        E = TheModule->global_end(); I != E; ++I)
1561     if (!I->hasName())
1562       CreateModuleSlot(I);
1563
1564   // Add all the unnamed functions to the table.
1565   for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1566        I != E; ++I)
1567     if (!I->hasName())
1568       CreateModuleSlot(I);
1569
1570   SC_DEBUG("end processModule!\n");
1571 }
1572
1573
1574 // Process the arguments, basic blocks, and instructions  of a function.
1575 void SlotMachine::processFunction() {
1576   SC_DEBUG("begin processFunction!\n");
1577   fNext = 0;
1578
1579   // Add all the function arguments with no names.
1580   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1581       AE = TheFunction->arg_end(); AI != AE; ++AI)
1582     if (!AI->hasName())
1583       CreateFunctionSlot(AI);
1584
1585   SC_DEBUG("Inserting Instructions:\n");
1586
1587   // Add all of the basic blocks and instructions with no names.
1588   for (Function::const_iterator BB = TheFunction->begin(),
1589        E = TheFunction->end(); BB != E; ++BB) {
1590     if (!BB->hasName())
1591       CreateFunctionSlot(BB);
1592     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1593       if (I->getType() != Type::VoidTy && !I->hasName())
1594         CreateFunctionSlot(I);
1595   }
1596
1597   FunctionProcessed = true;
1598
1599   SC_DEBUG("end processFunction!\n");
1600 }
1601
1602 /// Clean up after incorporating a function. This is the only way to get out of
1603 /// the function incorporation state that affects get*Slot/Create*Slot. Function
1604 /// incorporation state is indicated by TheFunction != 0.
1605 void SlotMachine::purgeFunction() {
1606   SC_DEBUG("begin purgeFunction!\n");
1607   fMap.clear(); // Simply discard the function level map
1608   TheFunction = 0;
1609   FunctionProcessed = false;
1610   SC_DEBUG("end purgeFunction!\n");
1611 }
1612
1613 /// getGlobalSlot - Get the slot number of a global value.
1614 int SlotMachine::getGlobalSlot(const GlobalValue *V) {
1615   // Check for uninitialized state and do lazy initialization.
1616   initialize();
1617
1618   // Find the type plane in the module map
1619   ValueMap::const_iterator MI = mMap.find(V);
1620   if (MI == mMap.end()) return -1;
1621
1622   return MI->second;
1623 }
1624
1625
1626 /// getLocalSlot - Get the slot number for a value that is local to a function.
1627 int SlotMachine::getLocalSlot(const Value *V) {
1628   assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
1629
1630   // Check for uninitialized state and do lazy initialization.
1631   initialize();
1632
1633   ValueMap::const_iterator FI = fMap.find(V);
1634   if (FI == fMap.end()) return -1;
1635
1636   return FI->second;
1637 }
1638
1639
1640 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
1641 void SlotMachine::CreateModuleSlot(const GlobalValue *V) {
1642   assert(V && "Can't insert a null Value into SlotMachine!");
1643   assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
1644   assert(!V->hasName() && "Doesn't need a slot!");
1645
1646   unsigned DestSlot = mNext++;
1647   mMap[V] = DestSlot;
1648
1649   SC_DEBUG("  Inserting value [" << V->getType() << "] = " << V << " slot=" <<
1650            DestSlot << " [");
1651   // G = Global, F = Function, A = Alias, o = other
1652   SC_DEBUG((isa<GlobalVariable>(V) ? 'G' :
1653             (isa<Function> ? 'F' :
1654              (isa<GlobalAlias> ? 'A' : 'o'))) << "]\n");
1655 }
1656
1657
1658 /// CreateSlot - Create a new slot for the specified value if it has no name.
1659 void SlotMachine::CreateFunctionSlot(const Value *V) {
1660   const Type *VTy = V->getType();
1661   assert(VTy != Type::VoidTy && !V->hasName() && "Doesn't need a slot!");
1662
1663   unsigned DestSlot = fNext++;
1664   fMap[V] = DestSlot;
1665
1666   // G = Global, F = Function, o = other
1667   SC_DEBUG("  Inserting value [" << VTy << "] = " << V << " slot=" <<
1668            DestSlot << " [o]\n");
1669 }