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