lib/VMCore/AsmWriter.cpp

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