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