Updated for the new projects Makefile.
[oota-llvm.git] / lib / VMCore / AsmWriter.cpp
index aeca6f7e21eacc883b2fe0a020bcef58feacbadd..7695fcb7500b7f4152e004fbaafe9ff2561044e0 100644 (file)
@@ -3,8 +3,7 @@
 // This library implements the functionality defined in llvm/Assembly/Writer.h
 //
 // Note that these routines must be extremely tolerant of various errors in the
-// LLVM code, because of of the primary uses of it is for debugging
-// transformations.
+// LLVM code, because it can be used for debugging transformations.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/iPHINode.h"
 #include "llvm/iOther.h"
 #include "llvm/SymbolTable.h"
+#include "llvm/Support/CFG.h"
 #include "Support/StringExtras.h"
 #include "Support/STLExtras.h"
 #include <algorithm>
-using std::string;
-using std::map;
-using std::vector;
-using std::ostream;
 
 static RegisterPass<PrintModulePass>
 X("printm", "Print module to stderr",PassInfo::Analysis|PassInfo::Optimization);
 static RegisterPass<PrintFunctionPass>
 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
 
-static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
-                                   map<const Type *, string> &TypeTable,
+static void WriteAsOperandInternal(std::ostream &Out, const Value *V, 
+                                   bool PrintName,
+                                 std::map<const Type *, std::string> &TypeTable,
                                    SlotCalculator *Table);
 
 static const Module *getModuleFromVal(const Value *V) {
@@ -72,33 +69,33 @@ static SlotCalculator *createSlotCalculator(const Value *V) {
 // names into the TypeNames map.
 //
 static void fillTypeNameTable(const Module *M,
-                              map<const Type *, string> &TypeNames) {
-  if (M && M->hasSymbolTable()) {
-    const SymbolTable *ST = M->getSymbolTable();
-    SymbolTable::const_iterator PI = ST->find(Type::TypeTy);
-    if (PI != ST->end()) {
-      SymbolTable::type_const_iterator I = PI->second.begin();
-      for (; I != PI->second.end(); ++I) {
-        // As a heuristic, don't insert pointer to primitive types, because
-        // they are used too often to have a single useful name.
-        //
-        const Type *Ty = cast<const Type>(I->second);
-        if (!isa<PointerType>(Ty) ||
-            !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
-          TypeNames.insert(std::make_pair(Ty, "%"+I->first));
-      }
+                              std::map<const Type *, std::string> &TypeNames) {
+  if (!M) return;
+  const SymbolTable &ST = M->getSymbolTable();
+  SymbolTable::const_iterator PI = ST.find(Type::TypeTy);
+  if (PI != ST.end()) {
+    SymbolTable::type_const_iterator I = PI->second.begin();
+    for (; I != PI->second.end(); ++I) {
+      // As a heuristic, don't insert pointer to primitive types, because
+      // they are used too often to have a single useful name.
+      //
+      const Type *Ty = cast<const Type>(I->second);
+      if (!isa<PointerType>(Ty) ||
+          !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
+        TypeNames.insert(std::make_pair(Ty, "%"+I->first));
     }
   }
 }
 
 
 
-static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
-                           map<const Type *, string> &TypeNames) {
+static std::string calcTypeName(const Type *Ty, 
+                                std::vector<const Type *> &TypeStack,
+                                std::map<const Type *, std::string> &TypeNames){
   if (Ty->isPrimitiveType()) return Ty->getDescription();  // Base case
 
   // Check to see if the type is named.
-  map<const Type *, string>::iterator I = TypeNames.find(Ty);
+  std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
   if (I != TypeNames.end()) return I->second;
 
   // Check to see if the Type is already on the stack...
@@ -114,7 +111,7 @@ static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
 
   TypeStack.push_back(Ty);    // Recursive case: Add us to the stack..
   
-  string Result;
+  std::string Result;
   switch (Ty->getPrimitiveID()) {
   case Type::FunctionTyID: {
     const FunctionType *FTy = cast<const FunctionType>(Ty);
@@ -156,6 +153,9 @@ static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
     Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
     break;
   }
+  case Type::OpaqueTyID:
+    Result = "opaque";
+    break;
   default:
     Result = "<unrecognized-type>";
   }
@@ -168,23 +168,23 @@ static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
 // printTypeInt - The internal guts of printing out a type that has a
 // potentially named portion.
 //
-static ostream &printTypeInt(ostream &Out, const Type *Ty,
-                             map<const Type *, string> &TypeNames) {
+static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
+                              std::map<const Type *, std::string> &TypeNames) {
   // Primitive types always print out their description, regardless of whether
   // they have been named or not.
   //
   if (Ty->isPrimitiveType()) return Out << Ty->getDescription();
 
   // Check to see if the type is named.
-  map<const Type *, string>::iterator I = TypeNames.find(Ty);
+  std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
   if (I != TypeNames.end()) return Out << I->second;
 
   // Otherwise we have a type that has not been named but is a derived type.
   // Carefully recurse the type hierarchy to print out any contained symbolic
   // names.
   //
-  vector<const Type *> TypeStack;
-  string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
+  std::vector<const Type *> TypeStack;
+  std::string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
   TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
   return Out << TypeName;
 }
@@ -194,13 +194,14 @@ static ostream &printTypeInt(ostream &Out, const Type *Ty,
 // type, iff there is an entry in the modules symbol table for the specified
 // type or one of it's component types.  This is slower than a simple x << Type;
 //
-ostream &WriteTypeSymbolic(ostream &Out, const Type *Ty, const Module *M) {
+std::ostream &WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
+                                const Module *M) {
   Out << " "; 
 
   // If they want us to print out a type, attempt to make it symbolic if there
   // is a symbol table in the module...
-  if (M && M->hasSymbolTable()) {
-    map<const Type *, string> TypeNames;
+  if (M) {
+    std::map<const Type *, std::string> TypeNames;
     fillTypeNameTable(M, TypeNames);
     
     return printTypeInt(Out, Ty, TypeNames);
@@ -209,8 +210,9 @@ ostream &WriteTypeSymbolic(ostream &Out, const Type *Ty, const Module *M) {
   }
 }
 
-static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
-                             map<const Type *, string> &TypeTable,
+static void WriteConstantInt(std::ostream &Out, const Constant *CV, 
+                             bool PrintName,
+                             std::map<const Type *, std::string> &TypeTable,
                              SlotCalculator *Table) {
   if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
     Out << (CB == ConstantBool::True ? "true" : "false");
@@ -334,10 +336,7 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
     }
 
   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
-    Out << CE->getOpcodeName();
-
-    bool isGEP = CE->getOpcode() == Instruction::GetElementPtr;
-    Out << (isGEP? " (" : " ");
+    Out << CE->getOpcodeName() << " (";
     
     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
       printTypeInt(Out, (*OI)->getType(), TypeTable);
@@ -346,8 +345,12 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
         Out << ", ";
     }
     
-    if (isGEP)
-      Out << ")";
+    if (CE->getOpcode() == Instruction::Cast) {
+      Out << " to ";
+      printTypeInt(Out, CE->getType(), TypeTable);
+    }
+    Out << ")";
+
   } else {
     Out << "<placeholder or erroneous Constant>";
   }
@@ -358,8 +361,9 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
 // ostream.  This can be useful when you just want to print int %reg126, not the
 // whole instruction that generated it.
 //
-static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
-                                   map<const Type *, string> &TypeTable,
+static void WriteAsOperandInternal(std::ostream &Out, const Value *V, 
+                                   bool PrintName,
+                                  std::map<const Type*, std::string> &TypeTable,
                                    SlotCalculator *Table) {
   Out << " ";
   if (PrintName && V->hasName()) {
@@ -396,12 +400,12 @@ static void WriteAsOperandInternal(ostream &Out, const Value *V, bool PrintName,
 // ostream.  This can be useful when you just want to print int %reg126, not the
 // whole instruction that generated it.
 //
-ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType, 
-                       bool PrintName, const Module *Context) {
-  map<const Type *, string> TypeNames;
+std::ostream &WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType, 
+                             bool PrintName, const Module *Context) {
+  std::map<const Type *, std::string> TypeNames;
   if (Context == 0) Context = getModuleFromVal(V);
 
-  if (Context && Context->hasSymbolTable())
+  if (Context)
     fillTypeNameTable(Context, TypeNames);
 
   if (PrintType)
@@ -414,12 +418,12 @@ ostream &WriteAsOperand(ostream &Out, const Value *V, bool PrintType,
 
 
 class AssemblyWriter {
-  ostream &Out;
+  std::ostream &Out;
   SlotCalculator &Table;
   const Module *TheModule;
-  map<const Type *, string> TypeNames;
+  std::map<const Type *, std::string> TypeNames;
 public:
-  inline AssemblyWriter(ostream &o, SlotCalculator &Tab, const Module *M)
+  inline AssemblyWriter(std::ostream &o, SlotCalculator &Tab, const Module *M)
     : Out(o), Table(Tab), TheModule(M) {
 
     // If the module has a symbol table, take all global types and stuff their
@@ -451,14 +455,14 @@ private :
   // printType - Go to extreme measures to attempt to print out a short,
   // symbolic version of a type name.
   //
-  ostream &printType(const Type *Ty) {
+  std::ostream &printType(const Type *Ty) {
     return printTypeInt(Out, Ty, TypeNames);
   }
 
   // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
   // without considering any symbolic types that we may have equal to it.
   //
-  ostream &printTypeAtLeastOneLevel(const Type *Ty);
+  std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
 
   // printInfoComment - Print a little comment after the instruction indicating
   // which slot it occupies.
@@ -469,7 +473,7 @@ private :
 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
 // without considering any symbolic types that we may have equal to it.
 //
-ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
+std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
   if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
     printType(FTy->getReturnType()) << " (";
     for (FunctionType::ParamTypes::const_iterator
@@ -500,7 +504,7 @@ ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
     Out << "[" << ATy->getNumElements() << " x ";
     printType(ATy->getElementType()) << "]";
   } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
-    Out << OTy->getDescription();
+    Out << "opaque";
   } else {
     if (!Ty->isPrimitiveType())
       Out << "<unknown derived type>";
@@ -518,9 +522,11 @@ void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
 
 
 void AssemblyWriter::printModule(const Module *M) {
+  Out << "target endian = " << (M->isLittleEndian() ? "little" : "big") << "\n";
+  Out << "target pointersize = " << (M->has32BitPointers() ? 32 : 64) << "\n";
+
   // Loop over the symbol table, emitting all named constants...
-  if (M->hasSymbolTable())
-    printSymbolTable(*M->getSymbolTable());
+  printSymbolTable(M->getSymbolTable());
   
   for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
     printGlobal(I);
@@ -535,8 +541,15 @@ void AssemblyWriter::printModule(const Module *M) {
 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
   if (GV->hasName()) Out << "%" << GV->getName() << " = ";
 
-  if (GV->hasInternalLinkage()) Out << "internal ";
-  if (!GV->hasInitializer()) Out << "uninitialized ";
+  if (!GV->hasInitializer()) 
+    Out << "external ";
+  else
+    switch (GV->getLinkage()) {
+    case GlobalValue::InternalLinkage: Out << "internal "; break;
+    case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
+    case GlobalValue::AppendingLinkage: Out << "appending "; break;
+    case GlobalValue::ExternalLinkage: break;
+    }
 
   Out << (GV->isConstant() ? "constant " : "global ");
   printType(GV->getType()->getElementType());
@@ -594,25 +607,26 @@ void AssemblyWriter::printConstant(const Constant *CPV) {
 //
 void AssemblyWriter::printFunction(const Function *F) {
   // Print out the return type and name...
-  Out << "\n" << (F->isExternal() ? "declare " : "")
-      << (F->hasInternalLinkage() ? "internal " : "");
+  Out << "\n";
+
+  if (F->isExternal())
+    Out << "declare ";
+  else
+    switch (F->getLinkage()) {
+    case GlobalValue::InternalLinkage: Out << "internal "; break;
+    case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
+    case GlobalValue::AppendingLinkage: Out << "appending "; break;
+    case GlobalValue::ExternalLinkage: break;
+    }
+
   printType(F->getReturnType()) << " %" << F->getName() << "(";
   Table.incorporateFunction(F);
 
   // Loop over the arguments, printing them...
   const FunctionType *FT = F->getFunctionType();
 
-  if (!F->isExternal()) {
-    for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
-      printArgument(I);
-  } else {
-    // Loop over the arguments, printing them...
-    for (FunctionType::ParamTypes::const_iterator I = FT->getParamTypes().begin(),
-          E = FT->getParamTypes().end(); I != E; ++I) {
-      if (I != FT->getParamTypes().begin()) Out << ", ";
-      printType(*I);
-    }
-  }
+  for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
+    printArgument(I);
 
   // Finish printing arguments...
   if (FT->isVarArg()) {
@@ -657,8 +671,7 @@ void AssemblyWriter::printArgument(const Argument *Arg) {
 //
 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
   if (BB->hasName()) {              // Print out the label if it exists...
-    Out << "\n" << BB->getName() << ":\t\t\t\t\t;[#uses="
-        << BB->use_size() << "]";  // Output # uses
+    Out << "\n" << BB->getName() << ":";
   } else if (!BB->use_empty()) {      // Don't print block # of no uses...
     int Slot = Table.getValSlot(BB);
     Out << "\n; <label>:";
@@ -666,7 +679,21 @@ void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
       Out << Slot;         // Extra newline seperates out label's
     else 
       Out << "<badref>"; 
-    Out << "\t\t\t\t\t;[#uses=" << BB->use_size() << "]";  // Output # uses
+  }
+  
+  // Output predecessors for the block...
+  Out << "\t\t;";
+  pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
+
+  if (PI == PE) {
+    Out << " No predecessors!";
+  } else {
+    Out << " preds =";
+    writeOperand(*PI, false, true);
+    for (++PI; PI != PE; ++PI) {
+      Out << ",";
+      writeOperand(*PI, false, true);
+    }
   }
   
   Out << "\n";
@@ -789,9 +816,13 @@ void AssemblyWriter::printInstruction(const Instruction &I) {
       writeOperand(AI->getArraySize(), true);
     }
   } else if (isa<CastInst>(I)) {
-    if (Operand) writeOperand(Operand, true);
+    writeOperand(Operand, true);
     Out << " to ";
     printType(I.getType());
+  } else if (isa<VarArgInst>(I)) {
+    writeOperand(Operand, true);
+    Out << ", ";
+    printType(I.getType());
   } else if (Operand) {   // Print the normal way...
 
     // PrintAllTypes - Instructions who have operands of all the same type 
@@ -800,20 +831,22 @@ void AssemblyWriter::printInstruction(const Instruction &I) {
     bool PrintAllTypes = false;
     const Type *TheType = Operand->getType();
 
-    for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
-      Operand = I.getOperand(i);
-      if (Operand->getType() != TheType) {
-       PrintAllTypes = true;       // We have differing types!  Print them all!
-       break;
+    // Shift Left & Right print both types even for Ubyte LHS
+    if (isa<ShiftInst>(I)) {
+      PrintAllTypes = true;
+    } else {
+      for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
+        Operand = I.getOperand(i);
+        if (Operand->getType() != TheType) {
+          PrintAllTypes = true;    // We have differing types!  Print them all!
+          break;
+        }
       }
     }
-
-    // Shift Left & Right print both types even for Ubyte LHS
-    if (isa<ShiftInst>(I)) PrintAllTypes = true;
-
+    
     if (!PrintAllTypes) {
       Out << " ";
-      printType(I.getOperand(0)->getType());
+      printType(TheType);
     }
 
     for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
@@ -868,9 +901,16 @@ void Instruction::print(std::ostream &o) const {
 
 void Constant::print(std::ostream &o) const {
   if (this == 0) { o << "<null> constant value\n"; return; }
+
+  // Handle CPR's special, because they have context information...
+  if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
+    CPR->getValue()->print(o);  // Print as a global value, with context info.
+    return;
+  }
+
   o << " " << getType()->getDescription() << " ";
 
-  map<const Type *, string> TypeTable;
+  std::map<const Type *, std::string> TypeTable;
   WriteConstantInt(o, this, false, TypeTable, 0);
 }