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