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