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