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 RegisterOpt<PrintModulePass>
 166 X("printm", "Print module to stderr");
 167 static RegisterOpt<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 == ConstantBool::True ? "true" : "false");
 425   } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
 426     Out << CI->getValue();
 427   } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
 428     Out << CI->getValue();
 429   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 430     // We would like to output the FP constant value in exponential notation,
 431     // but we cannot do this if doing so will lose precision.  Check here to
 432     // make sure that we only output it in exponential format if we can parse
 433     // the value back and get the same value.
 434     //
 435     std::string StrVal = ftostr(CFP->getValue());
 436
 437     // Check to make sure that the stringized number is not some string like
 438     // "Inf" or NaN, that atof will accept, but the lexer will not.  Check that
 439     // the string matches the "[-+]?[0-9]" regex.
 440     //
 441     if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
 442         ((StrVal[0] == '-' || StrVal[0] == '+') &&
 443          (StrVal[1] >= '0' && StrVal[1] <= '9')))
 444       // Reparse stringized version!
 445       if (atof(StrVal.c_str()) == CFP->getValue()) {
 446         Out << StrVal;
 447         return;
 448       }
 449
 450     // Otherwise we could not reparse it to exactly the same value, so we must
 451     // output the string in hexadecimal format!
 452     assert(sizeof(double) == sizeof(uint64_t) &&
 453            "assuming that double is 64 bits!");
 454     Out << "0x" << utohexstr(DoubleToBits(CFP->getValue()));
 455
 456   } else if (isa<ConstantAggregateZero>(CV)) {
 457     Out << "zeroinitializer";
 458   } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 459     // As a special case, print the array as a string if it is an array of
 460     // ubytes or an array of sbytes with positive values.
 461     //
 462     const Type *ETy = CA->getType()->getElementType();
 463     if (CA->isString()) {
 464       Out << "c\"";
 465       PrintEscapedString(CA->getAsString(), Out);
 466       Out << "\"";
 467
 468     } else {                // Cannot output in string format...
 469       Out << '[';
 470       if (CA->getNumOperands()) {
 471         Out << ' ';
 472         printTypeInt(Out, ETy, TypeTable);
 473         WriteAsOperandInternal(Out, CA->getOperand(0),
 474                                PrintName, TypeTable, Machine);
 475         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
 476           Out << ", ";
 477           printTypeInt(Out, ETy, TypeTable);
 478           WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
 479                                  TypeTable, Machine);
 480         }
 481       }
 482       Out << " ]";
 483     }
 484   } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
 485     Out << '{';
 486     unsigned N = CS->getNumOperands();
 487     if (N) {
 488       if (N > 2) {
 489         Indent += std::string(IndentSize, ' ');
 490         Out << Indent;
 491       } else {
 492         Out << ' ';
 493       }
 494       printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
 495
 496       WriteAsOperandInternal(Out, CS->getOperand(0),
 497                              PrintName, TypeTable, Machine);
 498
 499       for (unsigned i = 1; i < N; i++) {
 500         Out << ", ";
 501         if (N > 2) Out << Indent;
 502         printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
 503
 504         WriteAsOperandInternal(Out, CS->getOperand(i),
 505                                PrintName, TypeTable, Machine);
 506       }
 507       if (N > 2) Indent.resize(Indent.size() - IndentSize);
 508     }
 509
 510     Out << " }";
 511   } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CV)) {
 512       const Type *ETy = CP->getType()->getElementType();
 513       assert(CP->getNumOperands() > 0 &&
 514              "Number of operands for a PackedConst must be > 0");
 515       Out << '<';
 516       Out << ' ';
 517       printTypeInt(Out, ETy, TypeTable);
 518       WriteAsOperandInternal(Out, CP->getOperand(0),
 519                              PrintName, TypeTable, Machine);
 520       for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
 521           Out << ", ";
 522           printTypeInt(Out, ETy, TypeTable);
 523           WriteAsOperandInternal(Out, CP->getOperand(i), PrintName,
 524                                  TypeTable, Machine);
 525       }
 526       Out << " >";
 527   } else if (isa<ConstantPointerNull>(CV)) {
 528     Out << "null";
 529
 530   } else if (isa<UndefValue>(CV)) {
 531     Out << "undef";
 532
 533   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 534     Out << CE->getOpcodeName() << " (";
 535
 536     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
 537       printTypeInt(Out, (*OI)->getType(), TypeTable);
 538       WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Machine);
 539       if (OI+1 != CE->op_end())
 540         Out << ", ";
 541     }
 542
 543     if (CE->getOpcode() == Instruction::Cast) {
 544       Out << " to ";
 545       printTypeInt(Out, CE->getType(), TypeTable);
 546     }
 547     Out << ')';
 548
 549   } else {
 550     Out << "<placeholder or erroneous Constant>";
 551   }
 552 }
 553
 554
 555 /// WriteAsOperand - Write the name of the specified value out to the specified
 556 /// ostream.  This can be useful when you just want to print int %reg126, not
 557 /// the whole instruction that generated it.
 558 ///
 559 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
 560                                    bool PrintName,
 561                                   std::map<const Type*, std::string> &TypeTable,
 562                                    SlotMachine *Machine) {
 563   Out << ' ';
 564   if ((PrintName || isa<GlobalValue>(V)) && V->hasName())
 565     Out << getLLVMName(V->getName());
 566   else {
 567     const Constant *CV = dyn_cast<Constant>(V);
 568     if (CV && !isa<GlobalValue>(CV)) {
 569       WriteConstantInt(Out, CV, PrintName, TypeTable, Machine);
 570     } else if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
 571       Out << "asm ";
 572       if (IA->hasSideEffects())
 573         Out << "sideeffect ";
 574       Out << '"';
 575       PrintEscapedString(IA->getAsmString(), Out);
 576       Out << "\", \"";
 577       PrintEscapedString(IA->getConstraintString(), Out);
 578       Out << '"';
 579     } else {
 580       int Slot;
 581       if (Machine) {
 582         Slot = Machine->getSlot(V);
 583       } else {
 584         Machine = createSlotMachine(V);
 585         if (Machine)
 586           Slot = Machine->getSlot(V);
 587         else
 588           Slot = -1;
 589         delete Machine;
 590       }
 591       if (Slot != -1)
 592         Out << '%' << Slot;
 593       else
 594         Out << "<badref>";
 595     }
 596   }
 597 }
 598
 599 /// WriteAsOperand - Write the name of the specified value out to the specified
 600 /// ostream.  This can be useful when you just want to print int %reg126, not
 601 /// the whole instruction that generated it.
 602 ///
 603 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
 604                                    bool PrintType, bool PrintName,
 605                                    const Module *Context) {
 606   std::map<const Type *, std::string> TypeNames;
 607   if (Context == 0) Context = getModuleFromVal(V);
 608
 609   if (Context)
 610     fillTypeNameTable(Context, TypeNames);
 611
 612   if (PrintType)
 613     printTypeInt(Out, V->getType(), TypeNames);
 614
 615   WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
 616   return Out;
 617 }
 618
 619 /// WriteAsOperandInternal - Write the name of the specified value out to
 620 /// the specified ostream.  This can be useful when you just want to print
 621 /// int %reg126, not the whole instruction that generated it.
 622 ///
 623 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
 624                                    bool PrintName,
 625                                   std::map<const Type*, std::string> &TypeTable,
 626                                    SlotMachine *Machine) {
 627   Out << ' ';
 628   int Slot;
 629   if (Machine) {
 630     Slot = Machine->getSlot(T);
 631     if (Slot != -1)
 632       Out << '%' << Slot;
 633     else
 634       Out << "<badref>";
 635   } else {
 636     Out << T->getDescription();
 637   }
 638 }
 639
 640 /// WriteAsOperand - Write the name of the specified value out to the specified
 641 /// ostream.  This can be useful when you just want to print int %reg126, not
 642 /// the whole instruction that generated it.
 643 ///
 644 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Type *Ty,
 645                                    bool PrintType, bool PrintName,
 646                                    const Module *Context) {
 647   std::map<const Type *, std::string> TypeNames;
 648   assert(Context != 0 && "Can't write types as operand without module context");
 649
 650   fillTypeNameTable(Context, TypeNames);
 651
 652   // if (PrintType)
 653     // printTypeInt(Out, V->getType(), TypeNames);
 654
 655   printTypeInt(Out, Ty, TypeNames);
 656
 657   WriteAsOperandInternal(Out, Ty, PrintName, TypeNames, 0);
 658   return Out;
 659 }
 660
 661 namespace llvm {
 662
 663 class AssemblyWriter {
 664   std::ostream &Out;
 665   SlotMachine &Machine;
 666   const Module *TheModule;
 667   std::map<const Type *, std::string> TypeNames;
 668   AssemblyAnnotationWriter *AnnotationWriter;
 669 public:
 670   inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
 671                         AssemblyAnnotationWriter *AAW)
 672     : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
 673
 674     // If the module has a symbol table, take all global types and stuff their
 675     // names into the TypeNames map.
 676     //
 677     fillTypeNameTable(M, TypeNames);
 678   }
 679
 680   inline void write(const Module *M)         { printModule(M);      }
 681   inline void write(const GlobalVariable *G) { printGlobal(G);      }
 682   inline void write(const Function *F)       { printFunction(F);    }
 683   inline void write(const BasicBlock *BB)    { printBasicBlock(BB); }
 684   inline void write(const Instruction *I)    { printInstruction(*I); }
 685   inline void write(const Constant *CPV)     { printConstant(CPV);  }
 686   inline void write(const Type *Ty)          { printType(Ty);       }
 687
 688   void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
 689
 690   const Module* getModule() { return TheModule; }
 691
 692 private:
 693   void printModule(const Module *M);
 694   void printSymbolTable(const SymbolTable &ST);
 695   void printConstant(const Constant *CPV);
 696   void printGlobal(const GlobalVariable *GV);
 697   void printFunction(const Function *F);
 698   void printArgument(const Argument *FA);
 699   void printBasicBlock(const BasicBlock *BB);
 700   void printInstruction(const Instruction &I);
 701
 702   // printType - Go to extreme measures to attempt to print out a short,
 703   // symbolic version of a type name.
 704   //
 705   std::ostream &printType(const Type *Ty) {
 706     return printTypeInt(Out, Ty, TypeNames);
 707   }
 708
 709   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 710   // without considering any symbolic types that we may have equal to it.
 711   //
 712   std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
 713
 714   // printInfoComment - Print a little comment after the instruction indicating
 715   // which slot it occupies.
 716   void printInfoComment(const Value &V);
 717 };
 718 }  // end of llvm namespace
 719
 720 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 721 /// without considering any symbolic types that we may have equal to it.
 722 ///
 723 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 724   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 725     printType(FTy->getReturnType()) << " (";
 726     for (FunctionType::param_iterator I = FTy->param_begin(),
 727            E = FTy->param_end(); I != E; ++I) {
 728       if (I != FTy->param_begin())
 729         Out << ", ";
 730       printType(*I);
 731     }
 732     if (FTy->isVarArg()) {
 733       if (FTy->getNumParams()) Out << ", ";
 734       Out << "...";
 735     }
 736     Out << ')';
 737   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 738     Out << "{ ";
 739     for (StructType::element_iterator I = STy->element_begin(),
 740            E = STy->element_end(); I != E; ++I) {
 741       if (I != STy->element_begin())
 742         Out << ", ";
 743       printType(*I);
 744     }
 745     Out << " }";
 746   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 747     printType(PTy->getElementType()) << '*';
 748   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 749     Out << '[' << ATy->getNumElements() << " x ";
 750     printType(ATy->getElementType()) << ']';
 751   } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
 752     Out << '<' << PTy->getNumElements() << " x ";
 753     printType(PTy->getElementType()) << '>';
 754   }
 755   else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
 756     Out << "opaque";
 757   } else {
 758     if (!Ty->isPrimitiveType())
 759       Out << "<unknown derived type>";
 760     printType(Ty);
 761   }
 762   return Out;
 763 }
 764
 765
 766 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
 767                                   bool PrintName) {
 768   if (Operand != 0) {
 769     if (PrintType) { Out << ' '; printType(Operand->getType()); }
 770     WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Machine);
 771   } else {
 772     Out << "<null operand!>";
 773   }
 774 }
 775
 776
 777 void AssemblyWriter::printModule(const Module *M) {
 778   if (!M->getModuleIdentifier().empty() &&
 779       // Don't print the ID if it will start a new line (which would
 780       // require a comment char before it).
 781       M->getModuleIdentifier().find('\n') == std::string::npos)
 782     Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
 783
 784   switch (M->getEndianness()) {
 785   case Module::LittleEndian: Out << "target endian = little\n"; break;
 786   case Module::BigEndian:    Out << "target endian = big\n";    break;
 787   case Module::AnyEndianness: break;
 788   }
 789   switch (M->getPointerSize()) {
 790   case Module::Pointer32:    Out << "target pointersize = 32\n"; break;
 791   case Module::Pointer64:    Out << "target pointersize = 64\n"; break;
 792   case Module::AnyPointerSize: break;
 793   }
 794   if (!M->getTargetTriple().empty())
 795     Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
 796
 797   if (!M->getModuleInlineAsm().empty()) {
 798     // Split the string into lines, to make it easier to read the .ll file.
 799     std::string Asm = M->getModuleInlineAsm();
 800     size_t CurPos = 0;
 801     size_t NewLine = Asm.find_first_of('\n', CurPos);
 802     while (NewLine != std::string::npos) {
 803       // We found a newline, print the portion of the asm string from the
 804       // last newline up to this newline.
 805       Out << "module asm \"";
 806       PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
 807                          Out);
 808       Out << "\"\n";
 809       CurPos = NewLine+1;
 810       NewLine = Asm.find_first_of('\n', CurPos);
 811     }
 812     Out << "module asm \"";
 813     PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
 814     Out << "\"\n";
 815   }
 816
 817   // Loop over the dependent libraries and emit them.
 818   Module::lib_iterator LI = M->lib_begin();
 819   Module::lib_iterator LE = M->lib_end();
 820   if (LI != LE) {
 821     Out << "deplibs = [ ";
 822     while (LI != LE) {
 823       Out << '"' << *LI << '"';
 824       ++LI;
 825       if (LI != LE)
 826         Out << ", ";
 827     }
 828     Out << " ]\n";
 829   }
 830
 831   // Loop over the symbol table, emitting all named constants.
 832   printSymbolTable(M->getSymbolTable());
 833
 834   for (Module::const_global_iterator I = M->global_begin(), E = M->global_end(); I != E; ++I)
 835     printGlobal(I);
 836
 837   Out << "\nimplementation   ; Functions:\n";
 838
 839   // Output all of the functions.
 840   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 841     printFunction(I);
 842 }
 843
 844 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 845   if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
 846
 847   if (!GV->hasInitializer())
 848     Out << "external ";
 849   else
 850     switch (GV->getLinkage()) {
 851     case GlobalValue::InternalLinkage:  Out << "internal "; break;
 852     case GlobalValue::LinkOnceLinkage:  Out << "linkonce "; break;
 853     case GlobalValue::WeakLinkage:      Out << "weak "; break;
 854     case GlobalValue::AppendingLinkage: Out << "appending "; break;
 855     case GlobalValue::ExternalLinkage: break;
 856     case GlobalValue::GhostLinkage:
 857       std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
 858       abort();
 859     }
 860
 861   Out << (GV->isConstant() ? "constant " : "global ");
 862   printType(GV->getType()->getElementType());
 863
 864   if (GV->hasInitializer()) {
 865     Constant* C = cast<Constant>(GV->getInitializer());
 866     assert(C &&  "GlobalVar initializer isn't constant?");
 867     writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
 868   }
 869
 870   if (GV->hasSection())
 871     Out << ", section \"" << GV->getSection() << '"';
 872   if (GV->getAlignment())
 873     Out << ", align " << GV->getAlignment();
 874
 875   printInfoComment(*GV);
 876   Out << "\n";
 877 }
 878
 879
 880 // printSymbolTable - Run through symbol table looking for constants
 881 // and types. Emit their declarations.
 882 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
 883
 884   // Print the types.
 885   for (SymbolTable::type_const_iterator TI = ST.type_begin();
 886        TI != ST.type_end(); ++TI ) {
 887     Out << "\t" << getLLVMName(TI->first) << " = type ";
 888
 889     // Make sure we print out at least one level of the type structure, so
 890     // that we do not get %FILE = type %FILE
 891     //
 892     printTypeAtLeastOneLevel(TI->second) << "\n";
 893   }
 894
 895   // Print the constants, in type plane order.
 896   for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
 897        PI != ST.plane_end(); ++PI ) {
 898     SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
 899     SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
 900
 901     for (; VI != VE; ++VI) {
 902       const Value* V = VI->second;
 903       const Constant *CPV = dyn_cast<Constant>(V) ;
 904       if (CPV && !isa<GlobalValue>(V)) {
 905         printConstant(CPV);
 906       }
 907     }
 908   }
 909 }
 910
 911
 912 /// printConstant - Print out a constant pool entry...
 913 ///
 914 void AssemblyWriter::printConstant(const Constant *CPV) {
 915   // Don't print out unnamed constants, they will be inlined
 916   if (!CPV->hasName()) return;
 917
 918   // Print out name...
 919   Out << "\t" << getLLVMName(CPV->getName()) << " =";
 920
 921   // Write the value out now...
 922   writeOperand(CPV, true, false);
 923
 924   printInfoComment(*CPV);
 925   Out << "\n";
 926 }
 927
 928 /// printFunction - Print all aspects of a function.
 929 ///
 930 void AssemblyWriter::printFunction(const Function *F) {
 931   // Print out the return type and name...
 932   Out << "\n";
 933
 934   // Ensure that no local symbols conflict with global symbols.
 935   const_cast<Function*>(F)->renameLocalSymbols();
 936
 937   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
 938
 939   if (F->isExternal())
 940     Out << "declare ";
 941   else
 942     switch (F->getLinkage()) {
 943     case GlobalValue::InternalLinkage:  Out << "internal "; break;
 944     case GlobalValue::LinkOnceLinkage:  Out << "linkonce "; break;
 945     case GlobalValue::WeakLinkage:      Out << "weak "; break;
 946     case GlobalValue::AppendingLinkage: Out << "appending "; break;
 947     case GlobalValue::ExternalLinkage: break;
 948     case GlobalValue::GhostLinkage:
 949       std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
 950       abort();
 951     }
 952
 953   // Print the calling convention.
 954   switch (F->getCallingConv()) {
 955   case CallingConv::C: break;   // default
 956   case CallingConv::CSRet: Out << "csretcc "; break;
 957   case CallingConv::Fast:  Out << "fastcc "; break;
 958   case CallingConv::Cold:  Out << "coldcc "; break;
 959   default: Out << "cc" << F->getCallingConv() << " "; break;
 960   }
 961
 962   printType(F->getReturnType()) << ' ';
 963   if (!F->getName().empty())
 964     Out << getLLVMName(F->getName());
 965   else
 966     Out << "\"\"";
 967   Out << '(';
 968   Machine.incorporateFunction(F);
 969
 970   // Loop over the arguments, printing them...
 971   const FunctionType *FT = F->getFunctionType();
 972
 973   for(Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
 974     printArgument(I);
 975
 976   // Finish printing arguments...
 977   if (FT->isVarArg()) {
 978     if (FT->getNumParams()) Out << ", ";
 979     Out << "...";  // Output varargs portion of signature!
 980   }
 981   Out << ')';
 982
 983   if (F->hasSection())
 984     Out << " section \"" << F->getSection() << '"';
 985   if (F->getAlignment())
 986     Out << " align " << F->getAlignment();
 987
 988   if (F->isExternal()) {
 989     Out << "\n";
 990   } else {
 991     Out << " {";
 992
 993     // Output all of its basic blocks... for the function
 994     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
 995       printBasicBlock(I);
 996
 997     Out << "}\n";
 998   }
 999
1000   Machine.purgeFunction();
1001 }
1002
1003 /// printArgument - This member is called for every argument that is passed into
1004 /// the function.  Simply print it out
1005 ///
1006 void AssemblyWriter::printArgument(const Argument *Arg) {
1007   // Insert commas as we go... the first arg doesn't get a comma
1008   if (Arg != Arg->getParent()->arg_begin()) Out << ", ";
1009
1010   // Output type...
1011   printType(Arg->getType());
1012
1013   // Output name, if available...
1014   if (Arg->hasName())
1015     Out << ' ' << getLLVMName(Arg->getName());
1016 }
1017
1018 /// printBasicBlock - This member is called for each basic block in a method.
1019 ///
1020 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1021   if (BB->hasName()) {              // Print out the label if it exists...
1022     Out << "\n" << getLLVMName(BB->getName(), false) << ':';
1023   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
1024     Out << "\n; <label>:";
1025     int Slot = Machine.getSlot(BB);
1026     if (Slot != -1)
1027       Out << Slot;
1028     else
1029       Out << "<badref>";
1030   }
1031
1032   if (BB->getParent() == 0)
1033     Out << "\t\t; Error: Block without parent!";
1034   else {
1035     if (BB != &BB->getParent()->front()) {  // Not the entry block?
1036       // Output predecessors for the block...
1037       Out << "\t\t;";
1038       pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1039
1040       if (PI == PE) {
1041         Out << " No predecessors!";
1042       } else {
1043         Out << " preds =";
1044         writeOperand(*PI, false, true);
1045         for (++PI; PI != PE; ++PI) {
1046           Out << ',';
1047           writeOperand(*PI, false, true);
1048         }
1049       }
1050     }
1051   }
1052
1053   Out << "\n";
1054
1055   if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1056
1057   // Output all of the instructions in the basic block...
1058   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1059     printInstruction(*I);
1060
1061   if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1062 }
1063
1064
1065 /// printInfoComment - Print a little comment after the instruction indicating
1066 /// which slot it occupies.
1067 ///
1068 void AssemblyWriter::printInfoComment(const Value &V) {
1069   if (V.getType() != Type::VoidTy) {
1070     Out << "\t\t; <";
1071     printType(V.getType()) << '>';
1072
1073     if (!V.hasName()) {
1074       int SlotNum = Machine.getSlot(&V);
1075       if (SlotNum == -1)
1076         Out << ":<badref>";
1077       else
1078         Out << ':' << SlotNum; // Print out the def slot taken.
1079     }
1080     Out << " [#uses=" << V.getNumUses() << ']';  // Output # uses
1081   }
1082 }
1083
1084 /// printInstruction - This member is called for each Instruction in a function..
1085 ///
1086 void AssemblyWriter::printInstruction(const Instruction &I) {
1087   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1088
1089   Out << "\t";
1090
1091   // Print out name if it exists...
1092   if (I.hasName())
1093     Out << getLLVMName(I.getName()) << " = ";
1094
1095   // If this is a volatile load or store, print out the volatile marker.
1096   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
1097       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1098       Out << "volatile ";
1099   } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1100     // If this is a call, check if it's a tail call.
1101     Out << "tail ";
1102   }
1103
1104   // Print out the opcode...
1105   Out << I.getOpcodeName();
1106
1107   // Print out the type of the operands...
1108   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1109
1110   // Special case conditional branches to swizzle the condition out to the front
1111   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1112     writeOperand(I.getOperand(2), true);
1113     Out << ',';
1114     writeOperand(Operand, true);
1115     Out << ',';
1116     writeOperand(I.getOperand(1), true);
1117
1118   } else if (isa<SwitchInst>(I)) {
1119     // Special case switch statement to get formatting nice and correct...
1120     writeOperand(Operand        , true); Out << ',';
1121     writeOperand(I.getOperand(1), true); Out << " [";
1122
1123     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1124       Out << "\n\t\t";
1125       writeOperand(I.getOperand(op  ), true); Out << ',';
1126       writeOperand(I.getOperand(op+1), true);
1127     }
1128     Out << "\n\t]";
1129   } else if (isa<PHINode>(I)) {
1130     Out << ' ';
1131     printType(I.getType());
1132     Out << ' ';
1133
1134     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1135       if (op) Out << ", ";
1136       Out << '[';
1137       writeOperand(I.getOperand(op  ), false); Out << ',';
1138       writeOperand(I.getOperand(op+1), false); Out << " ]";
1139     }
1140   } else if (isa<ReturnInst>(I) && !Operand) {
1141     Out << " void";
1142   } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1143     // Print the calling convention being used.
1144     switch (CI->getCallingConv()) {
1145     case CallingConv::C: break;   // default
1146     case CallingConv::CSRet: Out << " csretcc"; break;
1147     case CallingConv::Fast:  Out << " fastcc"; break;
1148     case CallingConv::Cold:  Out << " coldcc"; break;
1149     default: Out << " cc" << CI->getCallingConv(); break;
1150     }
1151
1152     const PointerType  *PTy = cast<PointerType>(Operand->getType());
1153     const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1154     const Type       *RetTy = FTy->getReturnType();
1155
1156     // If possible, print out the short form of the call instruction.  We can
1157     // only do this if the first argument is a pointer to a nonvararg function,
1158     // and if the return type is not a pointer to a function.
1159     //
1160     if (!FTy->isVarArg() &&
1161         (!isa<PointerType>(RetTy) ||
1162          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1163       Out << ' '; printType(RetTy);
1164       writeOperand(Operand, false);
1165     } else {
1166       writeOperand(Operand, true);
1167     }
1168     Out << '(';
1169     if (CI->getNumOperands() > 1) writeOperand(CI->getOperand(1), true);
1170     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1171       Out << ',';
1172       writeOperand(I.getOperand(op), true);
1173     }
1174
1175     Out << " )";
1176   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1177     const PointerType  *PTy = cast<PointerType>(Operand->getType());
1178     const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1179     const Type       *RetTy = FTy->getReturnType();
1180
1181     // Print the calling convention being used.
1182     switch (II->getCallingConv()) {
1183     case CallingConv::C: break;   // default
1184     case CallingConv::CSRet: Out << " csretcc"; break;
1185     case CallingConv::Fast:  Out << " fastcc"; break;
1186     case CallingConv::Cold:  Out << " coldcc"; break;
1187     default: Out << " cc" << II->getCallingConv(); break;
1188     }
1189
1190     // If possible, print out the short form of the invoke instruction. We can
1191     // only do this if the first argument is a pointer to a nonvararg function,
1192     // and if the return type is not a pointer to a function.
1193     //
1194     if (!FTy->isVarArg() &&
1195         (!isa<PointerType>(RetTy) ||
1196          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1197       Out << ' '; printType(RetTy);
1198       writeOperand(Operand, false);
1199     } else {
1200       writeOperand(Operand, true);
1201     }
1202
1203     Out << '(';
1204     if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1205     for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1206       Out << ',';
1207       writeOperand(I.getOperand(op), true);
1208     }
1209
1210     Out << " )\n\t\t\tto";
1211     writeOperand(II->getNormalDest(), true);
1212     Out << " unwind";
1213     writeOperand(II->getUnwindDest(), true);
1214
1215   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1216     Out << ' ';
1217     printType(AI->getType()->getElementType());
1218     if (AI->isArrayAllocation()) {
1219       Out << ',';
1220       writeOperand(AI->getArraySize(), true);
1221     }
1222     if (AI->getAlignment()) {
1223       Out << ", align " << AI->getAlignment();
1224     }
1225   } else if (isa<CastInst>(I)) {
1226     if (Operand) writeOperand(Operand, true);   // Work with broken code
1227     Out << " to ";
1228     printType(I.getType());
1229   } else if (isa<VAArgInst>(I)) {
1230     if (Operand) writeOperand(Operand, true);   // Work with broken code
1231     Out << ", ";
1232     printType(I.getType());
1233   } else if (Operand) {   // Print the normal way...
1234
1235     // PrintAllTypes - Instructions who have operands of all the same type
1236     // omit the type from all but the first operand.  If the instruction has
1237     // different type operands (for example br), then they are all printed.
1238     bool PrintAllTypes = false;
1239     const Type *TheType = Operand->getType();
1240
1241     // Shift Left & Right print both types even for Ubyte LHS, and select prints
1242     // types even if all operands are bools.
1243     if (isa<ShiftInst>(I) || isa<SelectInst>(I) || isa<StoreInst>(I) ||
1244         isa<ShuffleVectorInst>(I)) {
1245       PrintAllTypes = true;
1246     } else {
1247       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1248         Operand = I.getOperand(i);
1249         if (Operand->getType() != TheType) {
1250           PrintAllTypes = true;    // We have differing types!  Print them all!
1251           break;
1252         }
1253       }
1254     }
1255
1256     if (!PrintAllTypes) {
1257       Out << ' ';
1258       printType(TheType);
1259     }
1260
1261     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1262       if (i) Out << ',';
1263       writeOperand(I.getOperand(i), PrintAllTypes);
1264     }
1265   }
1266
1267   printInfoComment(I);
1268   Out << "\n";
1269 }
1270
1271
1272 //===----------------------------------------------------------------------===//
1273 //                       External Interface declarations
1274 //===----------------------------------------------------------------------===//
1275
1276 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1277   SlotMachine SlotTable(this);
1278   AssemblyWriter W(o, SlotTable, this, AAW);
1279   W.write(this);
1280 }
1281
1282 void GlobalVariable::print(std::ostream &o) const {
1283   SlotMachine SlotTable(getParent());
1284   AssemblyWriter W(o, SlotTable, getParent(), 0);
1285   W.write(this);
1286 }
1287
1288 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1289   SlotMachine SlotTable(getParent());
1290   AssemblyWriter W(o, SlotTable, getParent(), AAW);
1291
1292   W.write(this);
1293 }
1294
1295 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1296   WriteAsOperand(o, this, true, true, 0);
1297 }
1298
1299 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1300   SlotMachine SlotTable(getParent());
1301   AssemblyWriter W(o, SlotTable,
1302                    getParent() ? getParent()->getParent() : 0, AAW);
1303   W.write(this);
1304 }
1305
1306 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1307   const Function *F = getParent() ? getParent()->getParent() : 0;
1308   SlotMachine SlotTable(F);
1309   AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1310
1311   W.write(this);
1312 }
1313
1314 void Constant::print(std::ostream &o) const {
1315   if (this == 0) { o << "<null> constant value\n"; return; }
1316
1317   o << ' ' << getType()->getDescription() << ' ';
1318
1319   std::map<const Type *, std::string> TypeTable;
1320   WriteConstantInt(o, this, false, TypeTable, 0);
1321 }
1322
1323 void Type::print(std::ostream &o) const {
1324   if (this == 0)
1325     o << "<null Type>";
1326   else
1327     o << getDescription();
1328 }
1329
1330 void Argument::print(std::ostream &o) const {
1331   WriteAsOperand(o, this, true, true,
1332                  getParent() ? getParent()->getParent() : 0);
1333 }
1334
1335 // Value::dump - allow easy printing of  Values from the debugger.
1336 // Located here because so much of the needed functionality is here.
1337 void Value::dump() const { print(std::cerr); }
1338
1339 // Type::dump - allow easy printing of  Values from the debugger.
1340 // Located here because so much of the needed functionality is here.
1341 void Type::dump() const { print(std::cerr); }
1342
1343 //===----------------------------------------------------------------------===//
1344 //  CachedWriter Class Implementation
1345 //===----------------------------------------------------------------------===//
1346
1347 void CachedWriter::setModule(const Module *M) {
1348   delete SC; delete AW;
1349   if (M) {
1350     SC = new SlotMachine(M );
1351     AW = new AssemblyWriter(Out, *SC, M, 0);
1352   } else {
1353     SC = 0; AW = 0;
1354   }
1355 }
1356
1357 CachedWriter::~CachedWriter() {
1358   delete AW;
1359   delete SC;
1360 }
1361
1362 CachedWriter &CachedWriter::operator<<(const Value &V) {
1363   assert(AW && SC && "CachedWriter does not have a current module!");
1364   if (const Instruction *I = dyn_cast<Instruction>(&V))
1365     AW->write(I);
1366   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1367     AW->write(BB);
1368   else if (const Function *F = dyn_cast<Function>(&V))
1369     AW->write(F);
1370   else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1371     AW->write(GV);
1372   else
1373     AW->writeOperand(&V, true, true);
1374   return *this;
1375 }
1376
1377 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1378   if (SymbolicTypes) {
1379     const Module *M = AW->getModule();
1380     if (M) WriteTypeSymbolic(Out, &Ty, M);
1381   } else {
1382     AW->write(&Ty);
1383   }
1384   return *this;
1385 }
1386
1387 //===----------------------------------------------------------------------===//
1388 //===--                    SlotMachine Implementation
1389 //===----------------------------------------------------------------------===//
1390
1391 #if 0
1392 #define SC_DEBUG(X) std::cerr << X
1393 #else
1394 #define SC_DEBUG(X)
1395 #endif
1396
1397 // Module level constructor. Causes the contents of the Module (sans functions)
1398 // to be added to the slot table.
1399 SlotMachine::SlotMachine(const Module *M)
1400   : TheModule(M)    ///< Saved for lazy initialization.
1401   , TheFunction(0)
1402   , FunctionProcessed(false)
1403   , mMap()
1404   , mTypes()
1405   , fMap()
1406   , fTypes()
1407 {
1408 }
1409
1410 // Function level constructor. Causes the contents of the Module and the one
1411 // function provided to be added to the slot table.
1412 SlotMachine::SlotMachine(const Function *F )
1413   : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1414   , TheFunction(F) ///< Saved for lazy initialization
1415   , FunctionProcessed(false)
1416   , mMap()
1417   , mTypes()
1418   , fMap()
1419   , fTypes()
1420 {
1421 }
1422
1423 inline void SlotMachine::initialize(void) {
1424   if ( TheModule) {
1425     processModule();
1426     TheModule = 0; ///< Prevent re-processing next time we're called.
1427   }
1428   if ( TheFunction && ! FunctionProcessed) {
1429     processFunction();
1430   }
1431 }
1432
1433 // Iterate through all the global variables, functions, and global
1434 // variable initializers and create slots for them.
1435 void SlotMachine::processModule() {
1436   SC_DEBUG("begin processModule!\n");
1437
1438   // Add all of the global variables to the value table...
1439   for (Module::const_global_iterator I = TheModule->global_begin(), E = TheModule->global_end();
1440        I != E; ++I)
1441     createSlot(I);
1442
1443   // Add all the functions to the table
1444   for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1445        I != E; ++I)
1446     createSlot(I);
1447
1448   SC_DEBUG("end processModule!\n");
1449 }
1450
1451
1452 // Process the arguments, basic blocks, and instructions  of a function.
1453 void SlotMachine::processFunction() {
1454   SC_DEBUG("begin processFunction!\n");
1455
1456   // Add all the function arguments
1457   for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1458       AE = TheFunction->arg_end(); AI != AE; ++AI)
1459     createSlot(AI);
1460
1461   SC_DEBUG("Inserting Instructions:\n");
1462
1463   // Add all of the basic blocks and instructions
1464   for (Function::const_iterator BB = TheFunction->begin(),
1465        E = TheFunction->end(); BB != E; ++BB) {
1466     createSlot(BB);
1467     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1468       createSlot(I);
1469     }
1470   }
1471
1472   FunctionProcessed = true;
1473
1474   SC_DEBUG("end processFunction!\n");
1475 }
1476
1477 // Clean up after incorporating a function. This is the only way
1478 // to get out of the function incorporation state that affects the
1479 // getSlot/createSlot lock. Function incorporation state is indicated
1480 // by TheFunction != 0.
1481 void SlotMachine::purgeFunction() {
1482   SC_DEBUG("begin purgeFunction!\n");
1483   fMap.clear(); // Simply discard the function level map
1484   fTypes.clear();
1485   TheFunction = 0;
1486   FunctionProcessed = false;
1487   SC_DEBUG("end purgeFunction!\n");
1488 }
1489
1490 /// Get the slot number for a value. This function will assert if you
1491 /// ask for a Value that hasn't previously been inserted with createSlot.
1492 /// Types are forbidden because Type does not inherit from Value (any more).
1493 int SlotMachine::getSlot(const Value *V) {
1494   assert( V && "Can't get slot for null Value" );
1495   assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1496     "Can't insert a non-GlobalValue Constant into SlotMachine");
1497
1498   // Check for uninitialized state and do lazy initialization
1499   this->initialize();
1500
1501   // Get the type of the value
1502   const Type* VTy = V->getType();
1503
1504   // Find the type plane in the module map
1505   TypedPlanes::const_iterator MI = mMap.find(VTy);
1506
1507   if ( TheFunction ) {
1508     // Lookup the type in the function map too
1509     TypedPlanes::const_iterator FI = fMap.find(VTy);
1510     // If there is a corresponding type plane in the function map
1511     if ( FI != fMap.end() ) {
1512       // Lookup the Value in the function map
1513       ValueMap::const_iterator FVI = FI->second.map.find(V);
1514       // If the value doesn't exist in the function map
1515       if ( FVI == FI->second.map.end() ) {
1516         // Look up the value in the module map.
1517         if (MI == mMap.end()) return -1;
1518         ValueMap::const_iterator MVI = MI->second.map.find(V);
1519         // If we didn't find it, it wasn't inserted
1520         if (MVI == MI->second.map.end()) return -1;
1521         assert( MVI != MI->second.map.end() && "Value not found");
1522         // We found it only at the module level
1523         return MVI->second;
1524
1525       // else the value exists in the function map
1526       } else {
1527         // Return the slot number as the module's contribution to
1528         // the type plane plus the index in the function's contribution
1529         // to the type plane.
1530         if (MI != mMap.end())
1531           return MI->second.next_slot + FVI->second;
1532         else
1533           return FVI->second;
1534       }
1535     }
1536   }
1537
1538   // N.B. Can get here only if either !TheFunction or the function doesn't
1539   // have a corresponding type plane for the Value
1540
1541   // Make sure the type plane exists
1542   if (MI == mMap.end()) return -1;
1543   // Lookup the value in the module's map
1544   ValueMap::const_iterator MVI = MI->second.map.find(V);
1545   // Make sure we found it.
1546   if (MVI == MI->second.map.end()) return -1;
1547   // Return it.
1548   return MVI->second;
1549 }
1550
1551 /// Get the slot number for a value. This function will assert if you
1552 /// ask for a Value that hasn't previously been inserted with createSlot.
1553 /// Types are forbidden because Type does not inherit from Value (any more).
1554 int SlotMachine::getSlot(const Type *Ty) {
1555   assert( Ty && "Can't get slot for null Type" );
1556
1557   // Check for uninitialized state and do lazy initialization
1558   this->initialize();
1559
1560   if ( TheFunction ) {
1561     // Lookup the Type in the function map
1562     TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1563     // If the Type doesn't exist in the function map
1564     if ( FTI == fTypes.map.end() ) {
1565       TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1566       // If we didn't find it, it wasn't inserted
1567       if (MTI == mTypes.map.end())
1568         return -1;
1569       // We found it only at the module level
1570       return MTI->second;
1571
1572     // else the value exists in the function map
1573     } else {
1574       // Return the slot number as the module's contribution to
1575       // the type plane plus the index in the function's contribution
1576       // to the type plane.
1577       return mTypes.next_slot + FTI->second;
1578     }
1579   }
1580
1581   // N.B. Can get here only if either !TheFunction
1582
1583   // Lookup the value in the module's map
1584   TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1585   // Make sure we found it.
1586   if (MTI == mTypes.map.end()) return -1;
1587   // Return it.
1588   return MTI->second;
1589 }
1590
1591 // Create a new slot, or return the existing slot if it is already
1592 // inserted. Note that the logic here parallels getSlot but instead
1593 // of asserting when the Value* isn't found, it inserts the value.
1594 unsigned SlotMachine::createSlot(const Value *V) {
1595   assert( V && "Can't insert a null Value to SlotMachine");
1596   assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1597     "Can't insert a non-GlobalValue Constant into SlotMachine");
1598
1599   const Type* VTy = V->getType();
1600
1601   // Just ignore void typed things
1602   if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1603
1604   // Look up the type plane for the Value's type from the module map
1605   TypedPlanes::const_iterator MI = mMap.find(VTy);
1606
1607   if ( TheFunction ) {
1608     // Get the type plane for the Value's type from the function map
1609     TypedPlanes::const_iterator FI = fMap.find(VTy);
1610     // If there is a corresponding type plane in the function map
1611     if ( FI != fMap.end() ) {
1612       // Lookup the Value in the function map
1613       ValueMap::const_iterator FVI = FI->second.map.find(V);
1614       // If the value doesn't exist in the function map
1615       if ( FVI == FI->second.map.end() ) {
1616         // If there is no corresponding type plane in the module map
1617         if ( MI == mMap.end() )
1618           return insertValue(V);
1619         // Look up the value in the module map
1620         ValueMap::const_iterator MVI = MI->second.map.find(V);
1621         // If we didn't find it, it wasn't inserted
1622         if ( MVI == MI->second.map.end() )
1623           return insertValue(V);
1624         else
1625           // We found it only at the module level
1626           return MVI->second;
1627
1628       // else the value exists in the function map
1629       } else {
1630         if ( MI == mMap.end() )
1631           return FVI->second;
1632         else
1633           // Return the slot number as the module's contribution to
1634           // the type plane plus the index in the function's contribution
1635           // to the type plane.
1636           return MI->second.next_slot + FVI->second;
1637       }
1638
1639     // else there is not a corresponding type plane in the function map
1640     } else {
1641       // If the type plane doesn't exists at the module level
1642       if ( MI == mMap.end() ) {
1643         return insertValue(V);
1644       // else type plane exists at the module level, examine it
1645       } else {
1646         // Look up the value in the module's map
1647         ValueMap::const_iterator MVI = MI->second.map.find(V);
1648         // If we didn't find it there either
1649         if ( MVI == MI->second.map.end() )
1650           // Return the slot number as the module's contribution to
1651           // the type plane plus the index of the function map insertion.
1652           return MI->second.next_slot + insertValue(V);
1653         else
1654           return MVI->second;
1655       }
1656     }
1657   }
1658
1659   // N.B. Can only get here if !TheFunction
1660
1661   // If the module map's type plane is not for the Value's type
1662   if ( MI != mMap.end() ) {
1663     // Lookup the value in the module's map
1664     ValueMap::const_iterator MVI = MI->second.map.find(V);
1665     if ( MVI != MI->second.map.end() )
1666       return MVI->second;
1667   }
1668
1669   return insertValue(V);
1670 }
1671
1672 // Create a new slot, or return the existing slot if it is already
1673 // inserted. Note that the logic here parallels getSlot but instead
1674 // of asserting when the Value* isn't found, it inserts the value.
1675 unsigned SlotMachine::createSlot(const Type *Ty) {
1676   assert( Ty && "Can't insert a null Type to SlotMachine");
1677
1678   if ( TheFunction ) {
1679     // Lookup the Type in the function map
1680     TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1681     // If the type doesn't exist in the function map
1682     if ( FTI == fTypes.map.end() ) {
1683       // Look up the type in the module map
1684       TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1685       // If we didn't find it, it wasn't inserted
1686       if ( MTI == mTypes.map.end() )
1687         return insertValue(Ty);
1688       else
1689         // We found it only at the module level
1690         return MTI->second;
1691
1692     // else the value exists in the function map
1693     } else {
1694       // Return the slot number as the module's contribution to
1695       // the type plane plus the index in the function's contribution
1696       // to the type plane.
1697       return mTypes.next_slot + FTI->second;
1698     }
1699   }
1700
1701   // N.B. Can only get here if !TheFunction
1702
1703   // Lookup the type in the module's map
1704   TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1705   if ( MTI != mTypes.map.end() )
1706     return MTI->second;
1707
1708   return insertValue(Ty);
1709 }
1710
1711 // Low level insert function. Minimal checking is done. This
1712 // function is just for the convenience of createSlot (above).
1713 unsigned SlotMachine::insertValue(const Value *V ) {
1714   assert(V && "Can't insert a null Value into SlotMachine!");
1715   assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1716     "Can't insert a non-GlobalValue Constant into SlotMachine");
1717
1718   // If this value does not contribute to a plane (is void)
1719   // or if the value already has a name then ignore it.
1720   if (V->getType() == Type::VoidTy || V->hasName() ) {
1721       SC_DEBUG("ignored value " << *V << "\n");
1722       return 0;   // FIXME: Wrong return value
1723   }
1724
1725   const Type *VTy = V->getType();
1726   unsigned DestSlot = 0;
1727
1728   if ( TheFunction ) {
1729     TypedPlanes::iterator I = fMap.find( VTy );
1730     if ( I == fMap.end() )
1731       I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1732     DestSlot = I->second.map[V] = I->second.next_slot++;
1733   } else {
1734     TypedPlanes::iterator I = mMap.find( VTy );
1735     if ( I == mMap.end() )
1736       I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1737     DestSlot = I->second.map[V] = I->second.next_slot++;
1738   }
1739
1740   SC_DEBUG("  Inserting value [" << VTy << "] = " << V << " slot=" <<
1741            DestSlot << " [");
1742   // G = Global, C = Constant, T = Type, F = Function, o = other
1743   SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1744            (isa<Constant>(V) ? 'C' : 'o'))));
1745   SC_DEBUG("]\n");
1746   return DestSlot;
1747 }
1748
1749 // Low level insert function. Minimal checking is done. This
1750 // function is just for the convenience of createSlot (above).
1751 unsigned SlotMachine::insertValue(const Type *Ty ) {
1752   assert(Ty && "Can't insert a null Type into SlotMachine!");
1753
1754   unsigned DestSlot = 0;
1755
1756   if ( TheFunction ) {
1757     DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1758   } else {
1759     DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1760   }
1761   SC_DEBUG("  Inserting type [" << DestSlot << "] = " << Ty << "\n");
1762   return DestSlot;
1763 }
1764
1765 // vim: sw=2