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