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