lib/VMCore/AsmWriter.cpp

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