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/SlotCalculator.h"
  22 #include "llvm/DerivedTypes.h"
  23 #include "llvm/Instruction.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/Constants.h"
  26 #include "llvm/iMemory.h"
  27 #include "llvm/iTerminators.h"
  28 #include "llvm/iPHINode.h"
  29 #include "llvm/iOther.h"
  30 #include "llvm/SymbolTable.h"
  31 #include "llvm/Support/CFG.h"
  32 #include "Support/StringExtras.h"
  33 #include "Support/STLExtras.h"
  34 #include <algorithm>
  35
  36 namespace llvm {
  37
  38 static RegisterPass<PrintModulePass>
  39 X("printm", "Print module to stderr",PassInfo::Analysis|PassInfo::Optimization);
  40 static RegisterPass<PrintFunctionPass>
  41 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
  42
  43 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
  44                                    bool PrintName,
  45                                  std::map<const Type *, std::string> &TypeTable,
  46                                    SlotCalculator *Table);
  47
  48 static const Module *getModuleFromVal(const Value *V) {
  49   if (const Argument *MA = dyn_cast<Argument>(V))
  50     return MA->getParent() ? MA->getParent()->getParent() : 0;
  51   else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
  52     return BB->getParent() ? BB->getParent()->getParent() : 0;
  53   else if (const Instruction *I = dyn_cast<Instruction>(V)) {
  54     const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
  55     return M ? M->getParent() : 0;
  56   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
  57     return GV->getParent();
  58   return 0;
  59 }
  60
  61 static SlotCalculator *createSlotCalculator(const Value *V) {
  62   assert(!isa<Type>(V) && "Can't create an SC for a type!");
  63   if (const Argument *FA = dyn_cast<Argument>(V)) {
  64     return new SlotCalculator(FA->getParent(), true);
  65   } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
  66     return new SlotCalculator(I->getParent()->getParent(), true);
  67   } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
  68     return new SlotCalculator(BB->getParent(), true);
  69   } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
  70     return new SlotCalculator(GV->getParent(), true);
  71   } else if (const Function *Func = dyn_cast<Function>(V)) {
  72     return new SlotCalculator(Func, true);
  73   }
  74   return 0;
  75 }
  76
  77 // getLLVMName - Turn the specified string into an 'LLVM name', which is either
  78 // prefixed with % (if the string only contains simple characters) or is
  79 // surrounded with ""'s (if it has special chars in it).
  80 static std::string getLLVMName(const std::string &Name) {
  81   assert(!Name.empty() && "Cannot get empty name!");
  82
  83   // First character cannot start with a number...
  84   if (Name[0] >= '0' && Name[0] <= '9')
  85     return "\"" + Name + "\"";
  86
  87   // Scan to see if we have any characters that are not on the "white list"
  88   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
  89     char C = Name[i];
  90     assert(C != '"' && "Illegal character in LLVM value name!");
  91     if ((C < 'a' || C > 'z') && (C < 'A' || C > 'Z') && (C < '0' || C > '9') &&
  92         C != '-' && C != '.' && C != '_')
  93       return "\"" + Name + "\"";
  94   }
  95
  96   // If we get here, then the identifier is legal to use as a "VarID".
  97   return "%"+Name;
  98 }
  99
 100
 101 // If the module has a symbol table, take all global types and stuff their
 102 // names into the TypeNames map.
 103 //
 104 static void fillTypeNameTable(const Module *M,
 105                               std::map<const Type *, std::string> &TypeNames) {
 106   if (!M) return;
 107   const SymbolTable &ST = M->getSymbolTable();
 108   SymbolTable::const_iterator PI = ST.find(Type::TypeTy);
 109   if (PI != ST.end()) {
 110     SymbolTable::type_const_iterator I = PI->second.begin();
 111     for (; I != PI->second.end(); ++I) {
 112       // As a heuristic, don't insert pointer to primitive types, because
 113       // they are used too often to have a single useful name.
 114       //
 115       const Type *Ty = cast<Type>(I->second);
 116       if (!isa<PointerType>(Ty) ||
 117           !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
 118           isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
 119         TypeNames.insert(std::make_pair(Ty, getLLVMName(I->first)));
 120     }
 121   }
 122 }
 123
 124
 125
 126 static std::string calcTypeName(const Type *Ty,
 127                                 std::vector<const Type *> &TypeStack,
 128                                 std::map<const Type *, std::string> &TypeNames){
 129   if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))
 130     return Ty->getDescription();  // Base case
 131
 132   // Check to see if the type is named.
 133   std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
 134   if (I != TypeNames.end()) return I->second;
 135
 136   if (isa<OpaqueType>(Ty))
 137     return "opaque";
 138
 139   // Check to see if the Type is already on the stack...
 140   unsigned Slot = 0, CurSize = TypeStack.size();
 141   while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
 142
 143   // This is another base case for the recursion.  In this case, we know
 144   // that we have looped back to a type that we have previously visited.
 145   // Generate the appropriate upreference to handle this.
 146   //
 147   if (Slot < CurSize)
 148     return "\\" + utostr(CurSize-Slot);       // Here's the upreference
 149
 150   TypeStack.push_back(Ty);    // Recursive case: Add us to the stack..
 151
 152   std::string Result;
 153   switch (Ty->getPrimitiveID()) {
 154   case Type::FunctionTyID: {
 155     const FunctionType *FTy = cast<FunctionType>(Ty);
 156     Result = calcTypeName(FTy->getReturnType(), TypeStack, TypeNames) + " (";
 157     for (FunctionType::ParamTypes::const_iterator
 158            I = FTy->getParamTypes().begin(),
 159            E = FTy->getParamTypes().end(); I != E; ++I) {
 160       if (I != FTy->getParamTypes().begin())
 161         Result += ", ";
 162       Result += calcTypeName(*I, TypeStack, TypeNames);
 163     }
 164     if (FTy->isVarArg()) {
 165       if (!FTy->getParamTypes().empty()) Result += ", ";
 166       Result += "...";
 167     }
 168     Result += ")";
 169     break;
 170   }
 171   case Type::StructTyID: {
 172     const StructType *STy = cast<StructType>(Ty);
 173     Result = "{ ";
 174     for (StructType::ElementTypes::const_iterator
 175            I = STy->getElementTypes().begin(),
 176            E = STy->getElementTypes().end(); I != E; ++I) {
 177       if (I != STy->getElementTypes().begin())
 178         Result += ", ";
 179       Result += calcTypeName(*I, TypeStack, TypeNames);
 180     }
 181     Result += " }";
 182     break;
 183   }
 184   case Type::PointerTyID:
 185     Result = calcTypeName(cast<PointerType>(Ty)->getElementType(),
 186                           TypeStack, TypeNames) + "*";
 187     break;
 188   case Type::ArrayTyID: {
 189     const ArrayType *ATy = cast<ArrayType>(Ty);
 190     Result = "[" + utostr(ATy->getNumElements()) + " x ";
 191     Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
 192     break;
 193   }
 194   case Type::OpaqueTyID:
 195     Result = "opaque";
 196     break;
 197   default:
 198     Result = "<unrecognized-type>";
 199   }
 200
 201   TypeStack.pop_back();       // Remove self from stack...
 202   return Result;
 203 }
 204
 205
 206 // printTypeInt - The internal guts of printing out a type that has a
 207 // potentially named portion.
 208 //
 209 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
 210                               std::map<const Type *, std::string> &TypeNames) {
 211   // Primitive types always print out their description, regardless of whether
 212   // they have been named or not.
 213   //
 214   if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))
 215     return Out << Ty->getDescription();
 216
 217   // Check to see if the type is named.
 218   std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
 219   if (I != TypeNames.end()) return Out << I->second;
 220
 221   // Otherwise we have a type that has not been named but is a derived type.
 222   // Carefully recurse the type hierarchy to print out any contained symbolic
 223   // names.
 224   //
 225   std::vector<const Type *> TypeStack;
 226   std::string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
 227   TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
 228   return Out << TypeName;
 229 }
 230
 231
 232 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
 233 // type, iff there is an entry in the modules symbol table for the specified
 234 // type or one of it's component types.  This is slower than a simple x << Type;
 235 //
 236 std::ostream &WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
 237                                 const Module *M) {
 238   Out << " ";
 239
 240   // If they want us to print out a type, attempt to make it symbolic if there
 241   // is a symbol table in the module...
 242   if (M) {
 243     std::map<const Type *, std::string> TypeNames;
 244     fillTypeNameTable(M, TypeNames);
 245
 246     return printTypeInt(Out, Ty, TypeNames);
 247   } else {
 248     return Out << Ty->getDescription();
 249   }
 250 }
 251
 252 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
 253                              bool PrintName,
 254                              std::map<const Type *, std::string> &TypeTable,
 255                              SlotCalculator *Table) {
 256   if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
 257     Out << (CB == ConstantBool::True ? "true" : "false");
 258   } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
 259     Out << CI->getValue();
 260   } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
 261     Out << CI->getValue();
 262   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 263     // We would like to output the FP constant value in exponential notation,
 264     // but we cannot do this if doing so will lose precision.  Check here to
 265     // make sure that we only output it in exponential format if we can parse
 266     // the value back and get the same value.
 267     //
 268     std::string StrVal = ftostr(CFP->getValue());
 269
 270     // Check to make sure that the stringized number is not some string like
 271     // "Inf" or NaN, that atof will accept, but the lexer will not.  Check that
 272     // the string matches the "[-+]?[0-9]" regex.
 273     //
 274     if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
 275         ((StrVal[0] == '-' || StrVal[0] == '+') &&
 276          (StrVal[1] >= '0' && StrVal[1] <= '9')))
 277       // Reparse stringized version!
 278       if (atof(StrVal.c_str()) == CFP->getValue()) {
 279         Out << StrVal; return;
 280       }
 281
 282     // Otherwise we could not reparse it to exactly the same value, so we must
 283     // output the string in hexadecimal format!
 284     //
 285     // Behave nicely in the face of C TBAA rules... see:
 286     // http://www.nullstone.com/htmls/category/aliastyp.htm
 287     //
 288     double Val = CFP->getValue();
 289     char *Ptr = (char*)&Val;
 290     assert(sizeof(double) == sizeof(uint64_t) && sizeof(double) == 8 &&
 291            "assuming that double is 64 bits!");
 292     Out << "0x" << utohexstr(*(uint64_t*)Ptr);
 293
 294   } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
 295     if (CA->getNumOperands() > 5 && CA->isNullValue()) {
 296       Out << "zeroinitializer";
 297       return;
 298     }
 299
 300     // As a special case, print the array as a string if it is an array of
 301     // ubytes or an array of sbytes with positive values.
 302     //
 303     const Type *ETy = CA->getType()->getElementType();
 304     bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
 305
 306     if (ETy == Type::SByteTy)
 307       for (unsigned i = 0; i < CA->getNumOperands(); ++i)
 308         if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
 309           isString = false;
 310           break;
 311         }
 312
 313     if (isString) {
 314       Out << "c\"";
 315       for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
 316         unsigned char C = cast<ConstantInt>(CA->getOperand(i))->getRawValue();
 317
 318         if (isprint(C) && C != '"' && C != '\\') {
 319           Out << C;
 320         } else {
 321           Out << '\\'
 322               << (char) ((C/16  < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
 323               << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
 324         }
 325       }
 326       Out << "\"";
 327
 328     } else {                // Cannot output in string format...
 329       Out << "[";
 330       if (CA->getNumOperands()) {
 331         Out << " ";
 332         printTypeInt(Out, ETy, TypeTable);
 333         WriteAsOperandInternal(Out, CA->getOperand(0),
 334                                PrintName, TypeTable, Table);
 335         for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
 336           Out << ", ";
 337           printTypeInt(Out, ETy, TypeTable);
 338           WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
 339                                  TypeTable, Table);
 340         }
 341       }
 342       Out << " ]";
 343     }
 344   } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
 345     if (CS->getNumOperands() > 5 && CS->isNullValue()) {
 346       Out << "zeroinitializer";
 347       return;
 348     }
 349
 350     Out << "{";
 351     if (CS->getNumOperands()) {
 352       Out << " ";
 353       printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
 354
 355       WriteAsOperandInternal(Out, CS->getOperand(0),
 356                              PrintName, TypeTable, Table);
 357
 358       for (unsigned i = 1; i < CS->getNumOperands(); i++) {
 359         Out << ", ";
 360         printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
 361
 362         WriteAsOperandInternal(Out, CS->getOperand(i),
 363                                PrintName, TypeTable, Table);
 364       }
 365     }
 366
 367     Out << " }";
 368   } else if (isa<ConstantPointerNull>(CV)) {
 369     Out << "null";
 370
 371   } else if (const ConstantPointerRef *PR = dyn_cast<ConstantPointerRef>(CV)) {
 372     const GlobalValue *V = PR->getValue();
 373     if (V->hasName()) {
 374       Out << getLLVMName(V->getName());
 375     } else if (Table) {
 376       int Slot = Table->getSlot(V);
 377       if (Slot >= 0)
 378         Out << "%" << Slot;
 379       else
 380         Out << "<pointer reference badref>";
 381     } else {
 382       Out << "<pointer reference without context info>";
 383     }
 384
 385   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 386     Out << CE->getOpcodeName() << " (";
 387
 388     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
 389       printTypeInt(Out, (*OI)->getType(), TypeTable);
 390       WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Table);
 391       if (OI+1 != CE->op_end())
 392         Out << ", ";
 393     }
 394
 395     if (CE->getOpcode() == Instruction::Cast) {
 396       Out << " to ";
 397       printTypeInt(Out, CE->getType(), TypeTable);
 398     }
 399     Out << ")";
 400
 401   } else {
 402     Out << "<placeholder or erroneous Constant>";
 403   }
 404 }
 405
 406
 407 // WriteAsOperand - Write the name of the specified value out to the specified
 408 // ostream.  This can be useful when you just want to print int %reg126, not the
 409 // whole instruction that generated it.
 410 //
 411 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
 412                                    bool PrintName,
 413                                   std::map<const Type*, std::string> &TypeTable,
 414                                    SlotCalculator *Table) {
 415   Out << " ";
 416   if (PrintName && V->hasName()) {
 417     Out << getLLVMName(V->getName());
 418   } else {
 419     if (const Constant *CV = dyn_cast<Constant>(V)) {
 420       WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
 421     } else {
 422       int Slot;
 423       if (Table) {
 424         Slot = Table->getSlot(V);
 425       } else {
 426         if (const Type *Ty = dyn_cast<Type>(V)) {
 427           Out << Ty->getDescription();
 428           return;
 429         }
 430
 431         Table = createSlotCalculator(V);
 432         if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
 433
 434         Slot = Table->getSlot(V);
 435         delete Table;
 436       }
 437       if (Slot >= 0)  Out << "%" << Slot;
 438       else if (PrintName)
 439         Out << "<badref>";     // Not embedded into a location?
 440     }
 441   }
 442 }
 443
 444
 445
 446 // WriteAsOperand - Write the name of the specified value out to the specified
 447 // ostream.  This can be useful when you just want to print int %reg126, not the
 448 // whole instruction that generated it.
 449 //
 450 std::ostream &WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
 451                              bool PrintName, const Module *Context) {
 452   std::map<const Type *, std::string> TypeNames;
 453   if (Context == 0) Context = getModuleFromVal(V);
 454
 455   if (Context)
 456     fillTypeNameTable(Context, TypeNames);
 457
 458   if (PrintType)
 459     printTypeInt(Out, V->getType(), TypeNames);
 460
 461   if (const Type *Ty = dyn_cast<Type> (V))
 462     printTypeInt(Out, Ty, TypeNames);
 463
 464   WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
 465   return Out;
 466 }
 467
 468
 469
 470 class AssemblyWriter {
 471   std::ostream &Out;
 472   SlotCalculator &Table;
 473   const Module *TheModule;
 474   std::map<const Type *, std::string> TypeNames;
 475   AssemblyAnnotationWriter *AnnotationWriter;
 476 public:
 477   inline AssemblyWriter(std::ostream &o, SlotCalculator &Tab, const Module *M,
 478                         AssemblyAnnotationWriter *AAW)
 479     : Out(o), Table(Tab), TheModule(M), AnnotationWriter(AAW) {
 480
 481     // If the module has a symbol table, take all global types and stuff their
 482     // names into the TypeNames map.
 483     //
 484     fillTypeNameTable(M, TypeNames);
 485   }
 486
 487   inline void write(const Module *M)         { printModule(M);      }
 488   inline void write(const GlobalVariable *G) { printGlobal(G);      }
 489   inline void write(const Function *F)       { printFunction(F);    }
 490   inline void write(const BasicBlock *BB)    { printBasicBlock(BB); }
 491   inline void write(const Instruction *I)    { printInstruction(*I); }
 492   inline void write(const Constant *CPV)     { printConstant(CPV);  }
 493   inline void write(const Type *Ty)          { printType(Ty);       }
 494
 495   void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
 496
 497 private :
 498   void printModule(const Module *M);
 499   void printSymbolTable(const SymbolTable &ST);
 500   void printConstant(const Constant *CPV);
 501   void printGlobal(const GlobalVariable *GV);
 502   void printFunction(const Function *F);
 503   void printArgument(const Argument *FA);
 504   void printBasicBlock(const BasicBlock *BB);
 505   void printInstruction(const Instruction &I);
 506
 507   // printType - Go to extreme measures to attempt to print out a short,
 508   // symbolic version of a type name.
 509   //
 510   std::ostream &printType(const Type *Ty) {
 511     return printTypeInt(Out, Ty, TypeNames);
 512   }
 513
 514   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 515   // without considering any symbolic types that we may have equal to it.
 516   //
 517   std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
 518
 519   // printInfoComment - Print a little comment after the instruction indicating
 520   // which slot it occupies.
 521   void printInfoComment(const Value &V);
 522 };
 523
 524
 525 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 526 // without considering any symbolic types that we may have equal to it.
 527 //
 528 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
 529   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
 530     printType(FTy->getReturnType()) << " (";
 531     for (FunctionType::ParamTypes::const_iterator
 532            I = FTy->getParamTypes().begin(),
 533            E = FTy->getParamTypes().end(); I != E; ++I) {
 534       if (I != FTy->getParamTypes().begin())
 535         Out << ", ";
 536       printType(*I);
 537     }
 538     if (FTy->isVarArg()) {
 539       if (!FTy->getParamTypes().empty()) Out << ", ";
 540       Out << "...";
 541     }
 542     Out << ")";
 543   } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 544     Out << "{ ";
 545     for (StructType::ElementTypes::const_iterator
 546            I = STy->getElementTypes().begin(),
 547            E = STy->getElementTypes().end(); I != E; ++I) {
 548       if (I != STy->getElementTypes().begin())
 549         Out << ", ";
 550       printType(*I);
 551     }
 552     Out << " }";
 553   } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
 554     printType(PTy->getElementType()) << "*";
 555   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
 556     Out << "[" << ATy->getNumElements() << " x ";
 557     printType(ATy->getElementType()) << "]";
 558   } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
 559     Out << "opaque";
 560   } else {
 561     if (!Ty->isPrimitiveType())
 562       Out << "<unknown derived type>";
 563     printType(Ty);
 564   }
 565   return Out;
 566 }
 567
 568
 569 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
 570                                   bool PrintName) {
 571   if (PrintType) { Out << " "; printType(Operand->getType()); }
 572   WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Table);
 573 }
 574
 575
 576 void AssemblyWriter::printModule(const Module *M) {
 577   switch (M->getEndianness()) {
 578   case Module::LittleEndian: Out << "target endian = little\n"; break;
 579   case Module::BigEndian:    Out << "target endian = big\n";    break;
 580   case Module::AnyEndianness: break;
 581   }
 582   switch (M->getPointerSize()) {
 583   case Module::Pointer32:    Out << "target pointersize = 32\n"; break;
 584   case Module::Pointer64:    Out << "target pointersize = 64\n"; break;
 585   case Module::AnyPointerSize: break;
 586   }
 587
 588   // Loop over the symbol table, emitting all named constants...
 589   printSymbolTable(M->getSymbolTable());
 590
 591   for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 592     printGlobal(I);
 593
 594   Out << "\nimplementation   ; Functions:\n";
 595
 596   // Output all of the functions...
 597   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 598     printFunction(I);
 599 }
 600
 601 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 602   if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
 603
 604   if (!GV->hasInitializer())
 605     Out << "external ";
 606   else
 607     switch (GV->getLinkage()) {
 608     case GlobalValue::InternalLinkage:  Out << "internal "; break;
 609     case GlobalValue::LinkOnceLinkage:  Out << "linkonce "; break;
 610     case GlobalValue::WeakLinkage:      Out << "weak "; break;
 611     case GlobalValue::AppendingLinkage: Out << "appending "; break;
 612     case GlobalValue::ExternalLinkage: break;
 613     }
 614
 615   Out << (GV->isConstant() ? "constant " : "global ");
 616   printType(GV->getType()->getElementType());
 617
 618   if (GV->hasInitializer())
 619     writeOperand(GV->getInitializer(), false, false);
 620
 621   printInfoComment(*GV);
 622   Out << "\n";
 623 }
 624
 625
 626 // printSymbolTable - Run through symbol table looking for named constants
 627 // if a named constant is found, emit it's declaration...
 628 //
 629 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
 630   for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
 631     SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
 632     SymbolTable::type_const_iterator End = ST.type_end(TI->first);
 633
 634     for (; I != End; ++I) {
 635       const Value *V = I->second;
 636       if (const Constant *CPV = dyn_cast<Constant>(V)) {
 637         printConstant(CPV);
 638       } else if (const Type *Ty = dyn_cast<Type>(V)) {
 639         assert(Ty->getType() == Type::TypeTy && TI->first == Type::TypeTy);
 640         Out << "\t" << getLLVMName(I->first) << " = type ";
 641
 642         // Make sure we print out at least one level of the type structure, so
 643         // that we do not get %FILE = type %FILE
 644         //
 645         printTypeAtLeastOneLevel(Ty) << "\n";
 646       }
 647     }
 648   }
 649 }
 650
 651
 652 // printConstant - Print out a constant pool entry...
 653 //
 654 void AssemblyWriter::printConstant(const Constant *CPV) {
 655   // Don't print out unnamed constants, they will be inlined
 656   if (!CPV->hasName()) return;
 657
 658   // Print out name...
 659   Out << "\t" << getLLVMName(CPV->getName()) << " =";
 660
 661   // Write the value out now...
 662   writeOperand(CPV, true, false);
 663
 664   printInfoComment(*CPV);
 665   Out << "\n";
 666 }
 667
 668 // printFunction - Print all aspects of a function.
 669 //
 670 void AssemblyWriter::printFunction(const Function *F) {
 671   // Print out the return type and name...
 672   Out << "\n";
 673
 674   if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
 675
 676   if (F->isExternal())
 677     Out << "declare ";
 678   else
 679     switch (F->getLinkage()) {
 680     case GlobalValue::InternalLinkage:  Out << "internal "; break;
 681     case GlobalValue::LinkOnceLinkage:  Out << "linkonce "; break;
 682     case GlobalValue::WeakLinkage:      Out << "weak "; break;
 683     case GlobalValue::AppendingLinkage: Out << "appending "; break;
 684     case GlobalValue::ExternalLinkage: break;
 685     }
 686
 687   printType(F->getReturnType()) << " ";
 688   if (!F->getName().empty())
 689     Out << getLLVMName(F->getName());
 690   else
 691     Out << "\"\"";
 692   Out << "(";
 693   Table.incorporateFunction(F);
 694
 695   // Loop over the arguments, printing them...
 696   const FunctionType *FT = F->getFunctionType();
 697
 698   for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
 699     printArgument(I);
 700
 701   // Finish printing arguments...
 702   if (FT->isVarArg()) {
 703     if (FT->getParamTypes().size()) Out << ", ";
 704     Out << "...";  // Output varargs portion of signature!
 705   }
 706   Out << ")";
 707
 708   if (F->isExternal()) {
 709     Out << "\n";
 710   } else {
 711     Out << " {";
 712
 713     // Output all of its basic blocks... for the function
 714     for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
 715       printBasicBlock(I);
 716
 717     Out << "}\n";
 718   }
 719
 720   Table.purgeFunction();
 721 }
 722
 723 // printArgument - This member is called for every argument that
 724 // is passed into the function.  Simply print it out
 725 //
 726 void AssemblyWriter::printArgument(const Argument *Arg) {
 727   // Insert commas as we go... the first arg doesn't get a comma
 728   if (Arg != &Arg->getParent()->afront()) Out << ", ";
 729
 730   // Output type...
 731   printType(Arg->getType());
 732
 733   // Output name, if available...
 734   if (Arg->hasName())
 735     Out << " " << getLLVMName(Arg->getName());
 736   else if (Table.getSlot(Arg) < 0)
 737     Out << "<badref>";
 738 }
 739
 740 // printBasicBlock - This member is called for each basic block in a method.
 741 //
 742 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
 743   if (BB->hasName()) {              // Print out the label if it exists...
 744     Out << "\n" << BB->getName() << ":";
 745   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
 746     int Slot = Table.getSlot(BB);
 747     Out << "\n; <label>:";
 748     if (Slot >= 0)
 749       Out << Slot;         // Extra newline separates out label's
 750     else
 751       Out << "<badref>";
 752   }
 753
 754   if (BB != &BB->getParent()->front()) {  // Not the entry block?
 755     // Output predecessors for the block...
 756     Out << "\t\t;";
 757     pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
 758
 759     if (PI == PE) {
 760       Out << " No predecessors!";
 761     } else {
 762       Out << " preds =";
 763       writeOperand(*PI, false, true);
 764       for (++PI; PI != PE; ++PI) {
 765         Out << ",";
 766         writeOperand(*PI, false, true);
 767       }
 768     }
 769   }
 770
 771   Out << "\n";
 772
 773   if (AnnotationWriter) AnnotationWriter->emitBasicBlockAnnot(BB, Out);
 774
 775   // Output all of the instructions in the basic block...
 776   for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 777     printInstruction(*I);
 778 }
 779
 780
 781 // printInfoComment - Print a little comment after the instruction indicating
 782 // which slot it occupies.
 783 //
 784 void AssemblyWriter::printInfoComment(const Value &V) {
 785   if (V.getType() != Type::VoidTy) {
 786     Out << "\t\t; <";
 787     printType(V.getType()) << ">";
 788
 789     if (!V.hasName()) {
 790       int Slot = Table.getSlot(&V); // Print out the def slot taken...
 791       if (Slot >= 0) Out << ":" << Slot;
 792       else Out << ":<badref>";
 793     }
 794     Out << " [#uses=" << V.use_size() << "]";  // Output # uses
 795   }
 796 }
 797
 798 // printInstruction - This member is called for each Instruction in a method.
 799 //
 800 void AssemblyWriter::printInstruction(const Instruction &I) {
 801   if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
 802
 803   Out << "\t";
 804
 805   // Print out name if it exists...
 806   if (I.hasName())
 807     Out << getLLVMName(I.getName()) << " = ";
 808
 809   // If this is a volatile load or store, print out the volatile marker
 810   if ((isa<LoadInst>(I)  && cast<LoadInst>(I).isVolatile()) ||
 811       (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()))
 812       Out << "volatile ";
 813
 814   // Print out the opcode...
 815   Out << I.getOpcodeName();
 816
 817   // Print out the type of the operands...
 818   const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
 819
 820   // Special case conditional branches to swizzle the condition out to the front
 821   if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
 822     writeOperand(I.getOperand(2), true);
 823     Out << ",";
 824     writeOperand(Operand, true);
 825     Out << ",";
 826     writeOperand(I.getOperand(1), true);
 827
 828   } else if (isa<SwitchInst>(I)) {
 829     // Special case switch statement to get formatting nice and correct...
 830     writeOperand(Operand        , true); Out << ",";
 831     writeOperand(I.getOperand(1), true); Out << " [";
 832
 833     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
 834       Out << "\n\t\t";
 835       writeOperand(I.getOperand(op  ), true); Out << ",";
 836       writeOperand(I.getOperand(op+1), true);
 837     }
 838     Out << "\n\t]";
 839   } else if (isa<PHINode>(I)) {
 840     Out << " ";
 841     printType(I.getType());
 842     Out << " ";
 843
 844     for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
 845       if (op) Out << ", ";
 846       Out << "[";
 847       writeOperand(I.getOperand(op  ), false); Out << ",";
 848       writeOperand(I.getOperand(op+1), false); Out << " ]";
 849     }
 850   } else if (isa<ReturnInst>(I) && !Operand) {
 851     Out << " void";
 852   } else if (isa<CallInst>(I)) {
 853     const PointerType  *PTy = cast<PointerType>(Operand->getType());
 854     const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
 855     const Type       *RetTy = FTy->getReturnType();
 856
 857     // If possible, print out the short form of the call instruction.  We can
 858     // only do this if the first argument is a pointer to a nonvararg function,
 859     // and if the return type is not a pointer to a function.
 860     //
 861     if (!FTy->isVarArg() &&
 862         (!isa<PointerType>(RetTy) ||
 863          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
 864       Out << " "; printType(RetTy);
 865       writeOperand(Operand, false);
 866     } else {
 867       writeOperand(Operand, true);
 868     }
 869     Out << "(";
 870     if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
 871     for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
 872       Out << ",";
 873       writeOperand(I.getOperand(op), true);
 874     }
 875
 876     Out << " )";
 877   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 878     const PointerType  *PTy = cast<PointerType>(Operand->getType());
 879     const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
 880     const Type       *RetTy = FTy->getReturnType();
 881
 882     // If possible, print out the short form of the invoke instruction. We can
 883     // only do this if the first argument is a pointer to a nonvararg function,
 884     // and if the return type is not a pointer to a function.
 885     //
 886     if (!FTy->isVarArg() &&
 887         (!isa<PointerType>(RetTy) ||
 888          !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
 889       Out << " "; printType(RetTy);
 890       writeOperand(Operand, false);
 891     } else {
 892       writeOperand(Operand, true);
 893     }
 894
 895     Out << "(";
 896     if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
 897     for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
 898       Out << ",";
 899       writeOperand(I.getOperand(op), true);
 900     }
 901
 902     Out << " )\n\t\t\tto";
 903     writeOperand(II->getNormalDest(), true);
 904     Out << " except";
 905     writeOperand(II->getExceptionalDest(), true);
 906
 907   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
 908     Out << " ";
 909     printType(AI->getType()->getElementType());
 910     if (AI->isArrayAllocation()) {
 911       Out << ",";
 912       writeOperand(AI->getArraySize(), true);
 913     }
 914   } else if (isa<CastInst>(I)) {
 915     if (Operand) writeOperand(Operand, true);   // Work with broken code
 916     Out << " to ";
 917     printType(I.getType());
 918   } else if (isa<VAArgInst>(I)) {
 919     if (Operand) writeOperand(Operand, true);   // Work with broken code
 920     Out << ", ";
 921     printType(I.getType());
 922   } else if (const VANextInst *VAN = dyn_cast<VANextInst>(&I)) {
 923     if (Operand) writeOperand(Operand, true);   // Work with broken code
 924     Out << ", ";
 925     printType(VAN->getArgType());
 926   } else if (Operand) {   // Print the normal way...
 927
 928     // PrintAllTypes - Instructions who have operands of all the same type
 929     // omit the type from all but the first operand.  If the instruction has
 930     // different type operands (for example br), then they are all printed.
 931     bool PrintAllTypes = false;
 932     const Type *TheType = Operand->getType();
 933
 934     // Shift Left & Right print both types even for Ubyte LHS
 935     if (isa<ShiftInst>(I)) {
 936       PrintAllTypes = true;
 937     } else {
 938       for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
 939         Operand = I.getOperand(i);
 940         if (Operand->getType() != TheType) {
 941           PrintAllTypes = true;    // We have differing types!  Print them all!
 942           break;
 943         }
 944       }
 945     }
 946
 947     if (!PrintAllTypes) {
 948       Out << " ";
 949       printType(TheType);
 950     }
 951
 952     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
 953       if (i) Out << ",";
 954       writeOperand(I.getOperand(i), PrintAllTypes);
 955     }
 956   }
 957
 958   printInfoComment(I);
 959   Out << "\n";
 960 }
 961
 962
 963 //===----------------------------------------------------------------------===//
 964 //                       External Interface declarations
 965 //===----------------------------------------------------------------------===//
 966
 967 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
 968   SlotCalculator SlotTable(this, true);
 969   AssemblyWriter W(o, SlotTable, this, AAW);
 970   W.write(this);
 971 }
 972
 973 void GlobalVariable::print(std::ostream &o) const {
 974   SlotCalculator SlotTable(getParent(), true);
 975   AssemblyWriter W(o, SlotTable, getParent(), 0);
 976   W.write(this);
 977 }
 978
 979 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
 980   SlotCalculator SlotTable(getParent(), true);
 981   AssemblyWriter W(o, SlotTable, getParent(), AAW);
 982
 983   W.write(this);
 984 }
 985
 986 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
 987   SlotCalculator SlotTable(getParent(), true);
 988   AssemblyWriter W(o, SlotTable,
 989                    getParent() ? getParent()->getParent() : 0, AAW);
 990   W.write(this);
 991 }
 992
 993 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
 994   const Function *F = getParent() ? getParent()->getParent() : 0;
 995   SlotCalculator SlotTable(F, true);
 996   AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
 997
 998   W.write(this);
 999 }
1000
1001 void Constant::print(std::ostream &o) const {
1002   if (this == 0) { o << "<null> constant value\n"; return; }
1003
1004   // Handle CPR's special, because they have context information...
1005   if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
1006     CPR->getValue()->print(o);  // Print as a global value, with context info.
1007     return;
1008   }
1009
1010   o << " " << getType()->getDescription() << " ";
1011
1012   std::map<const Type *, std::string> TypeTable;
1013   WriteConstantInt(o, this, false, TypeTable, 0);
1014 }
1015
1016 void Type::print(std::ostream &o) const {
1017   if (this == 0)
1018     o << "<null Type>";
1019   else
1020     o << getDescription();
1021 }
1022
1023 void Argument::print(std::ostream &o) const {
1024   o << getType() << " " << getName();
1025 }
1026
1027 void Value::dump() const { print(std::cerr); }
1028
1029 //===----------------------------------------------------------------------===//
1030 //  CachedWriter Class Implementation
1031 //===----------------------------------------------------------------------===//
1032
1033 void CachedWriter::setModule(const Module *M) {
1034   delete SC; delete AW;
1035   if (M) {
1036     SC = new SlotCalculator(M, true);
1037     AW = new AssemblyWriter(Out, *SC, M, 0);
1038   } else {
1039     SC = 0; AW = 0;
1040   }
1041 }
1042
1043 CachedWriter::~CachedWriter() {
1044   delete AW;
1045   delete SC;
1046 }
1047
1048 CachedWriter &CachedWriter::operator<<(const Value *V) {
1049   assert(AW && SC && "CachedWriter does not have a current module!");
1050   switch (V->getValueType()) {
1051   case Value::ConstantVal:
1052   case Value::ArgumentVal:       AW->writeOperand(V, true, true); break;
1053   case Value::TypeVal:           AW->write(cast<Type>(V)); break;
1054   case Value::InstructionVal:    AW->write(cast<Instruction>(V)); break;
1055   case Value::BasicBlockVal:     AW->write(cast<BasicBlock>(V)); break;
1056   case Value::FunctionVal:       AW->write(cast<Function>(V)); break;
1057   case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
1058   default: Out << "<unknown value type: " << V->getValueType() << ">"; break;
1059   }
1060   return *this;
1061 }
1062
1063 } // End llvm namespace