Print accurate run instructions for when testing LLC
[oota-llvm.git] / lib / VMCore / AsmWriter.cpp
index b3f8db7c423284a7f41d7c975268c320f1d720f4..2ebce7243bc96a5f03d287b1591a429318996f24 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 "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) {
-  if (const Argument *MA = dyn_cast<const Argument>(V))
+  if (const Argument *MA = dyn_cast<Argument>(V))
     return MA->getParent() ? MA->getParent()->getParent() : 0;
-  else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V))
+  else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
     return BB->getParent() ? BB->getParent()->getParent() : 0;
-  else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
+  else if (const Instruction *I = dyn_cast<Instruction>(V)) {
     const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
     return M ? M->getParent() : 0;
-  } else if (const GlobalValue *GV = dyn_cast<const GlobalValue>(V))
+  } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
     return GV->getParent();
   return 0;
 }
 
 static SlotCalculator *createSlotCalculator(const Value *V) {
   assert(!isa<Type>(V) && "Can't create an SC for a type!");
-  if (const Argument *FA = dyn_cast<const Argument>(V)) {
+  if (const Argument *FA = dyn_cast<Argument>(V)) {
     return new SlotCalculator(FA->getParent(), true);
-  } else if (const Instruction *I = dyn_cast<const Instruction>(V)) {
+  } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
     return new SlotCalculator(I->getParent()->getParent(), true);
-  } else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(V)) {
+  } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
     return new SlotCalculator(BB->getParent(), true);
-  } else if (const GlobalVariable *GV = dyn_cast<const GlobalVariable>(V)){
+  } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
     return new SlotCalculator(GV->getParent(), true);
-  } else if (const Function *Func = dyn_cast<const Function>(V)) {
+  } else if (const Function *Func = dyn_cast<Function>(V)) {
     return new SlotCalculator(Func, true);
   }
   return 0;
@@ -73,7 +69,7 @@ static SlotCalculator *createSlotCalculator(const Value *V) {
 // names into the TypeNames map.
 //
 static void fillTypeNameTable(const Module *M,
-                              map<const Type *, string> &TypeNames) {
+                              std::map<const Type *, std::string> &TypeNames) {
   if (!M) return;
   const SymbolTable &ST = M->getSymbolTable();
   SymbolTable::const_iterator PI = ST.find(Type::TypeTy);
@@ -83,7 +79,7 @@ static void fillTypeNameTable(const Module *M,
       // 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);
+      const Type *Ty = cast<Type>(I->second);
       if (!isa<PointerType>(Ty) ||
           !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
         TypeNames.insert(std::make_pair(Ty, "%"+I->first));
@@ -93,12 +89,13 @@ static void fillTypeNameTable(const Module *M,
 
 
 
-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,10 +111,10 @@ 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);
+    const FunctionType *FTy = cast<FunctionType>(Ty);
     Result = calcTypeName(FTy->getReturnType(), TypeStack, TypeNames) + " (";
     for (FunctionType::ParamTypes::const_iterator
            I = FTy->getParamTypes().begin(),
@@ -134,7 +131,7 @@ static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
     break;
   }
   case Type::StructTyID: {
-    const StructType *STy = cast<const StructType>(Ty);
+    const StructType *STy = cast<StructType>(Ty);
     Result = "{ ";
     for (StructType::ElementTypes::const_iterator
            I = STy->getElementTypes().begin(),
@@ -147,15 +144,18 @@ static string calcTypeName(const Type *Ty, vector<const Type *> &TypeStack,
     break;
   }
   case Type::PointerTyID:
-    Result = calcTypeName(cast<const PointerType>(Ty)->getElementType(), 
+    Result = calcTypeName(cast<PointerType>(Ty)->getElementType(), 
                           TypeStack, TypeNames) + "*";
     break;
   case Type::ArrayTyID: {
-    const ArrayType *ATy = cast<const ArrayType>(Ty);
+    const ArrayType *ATy = cast<ArrayType>(Ty);
     Result = "[" + utostr(ATy->getNumElements()) + " x ";
     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) {
-    map<const Type *, string> TypeNames;
+    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");
@@ -232,7 +234,7 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
     //
     if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
         ((StrVal[0] == '-' || StrVal[0] == '+') &&
-         (StrVal[0] >= '0' && StrVal[0] <= '9')))
+         (StrVal[1] >= '0' && StrVal[1] <= '9')))
       // Reparse stringized version!
       if (atof(StrVal.c_str()) == CFP->getValue()) {
         Out << StrVal; return;
@@ -251,6 +253,11 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
     Out << "0x" << utohexstr(*(uint64_t*)Ptr);
 
   } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
+    if (CA->getNumOperands() > 5 && CA->isNullValue()) {
+      Out << "zeroinitializer";
+      return;
+    }
+
     // As a special case, print the array as a string if it is an array of
     // ubytes or an array of sbytes with positive values.
     // 
@@ -267,9 +274,7 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
     if (isString) {
       Out << "c\"";
       for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
-        unsigned char C = (ETy == Type::SByteTy) ?
-          (unsigned char)cast<ConstantSInt>(CA->getOperand(i))->getValue() :
-          (unsigned char)cast<ConstantUInt>(CA->getOperand(i))->getValue();
+        unsigned char C = cast<ConstantInt>(CA->getOperand(i))->getRawValue();
         
         if (isprint(C) && C != '"' && C != '\\') {
           Out << C;
@@ -298,6 +303,11 @@ static void WriteConstantInt(ostream &Out, const Constant *CV, bool PrintName,
       Out << " ]";
     }
   } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
+    if (CS->getNumOperands() > 5 && CS->isNullValue()) {
+      Out << "zeroinitializer";
+      return;
+    }
+
     Out << "{";
     if (CS->getNumOperands()) {
       Out << " ";
@@ -359,21 +369,22 @@ 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()) {
     Out << "%" << V->getName();
   } else {
-    if (const Constant *CV = dyn_cast<const Constant>(V)) {
+    if (const Constant *CV = dyn_cast<Constant>(V)) {
       WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
     } else {
       int Slot;
       if (Table) {
        Slot = Table->getValSlot(V);
       } else {
-        if (const Type *Ty = dyn_cast<const Type>(V)) {
+        if (const Type *Ty = dyn_cast<Type>(V)) {
           Out << Ty->getDescription();
           return;
         }
@@ -397,9 +408,9 @@ 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)
@@ -415,12 +426,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
@@ -452,14 +463,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.
@@ -470,7 +481,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
@@ -501,7 +512,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>";
@@ -519,6 +530,9 @@ 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...
   printSymbolTable(M->getSymbolTable());
   
@@ -535,8 +549,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 << "external ";
+  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());
@@ -559,9 +580,9 @@ void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
     
     for (; I != End; ++I) {
       const Value *V = I->second;
-      if (const Constant *CPV = dyn_cast<const Constant>(V)) {
+      if (const Constant *CPV = dyn_cast<Constant>(V)) {
        printConstant(CPV);
-      } else if (const Type *Ty = dyn_cast<const Type>(V)) {
+      } else if (const Type *Ty = dyn_cast<Type>(V)) {
        Out << "\t%" << I->first << " = type ";
 
         // Make sure we print out at least one level of the type structure, so
@@ -594,8 +615,18 @@ 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);
 
@@ -653,7 +684,7 @@ void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
     int Slot = Table.getValSlot(BB);
     Out << "\n; <label>:";
     if (Slot >= 0) 
-      Out << Slot;         // Extra newline seperates out label's
+      Out << Slot;         // Extra newline separates out label's
     else 
       Out << "<badref>"; 
   }
@@ -793,9 +824,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 
@@ -804,20 +839,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) {
@@ -881,7 +918,7 @@ void Constant::print(std::ostream &o) const {
 
   o << " " << getType()->getDescription() << " ";
 
-  map<const Type *, string> TypeTable;
+  std::map<const Type *, std::string> TypeTable;
   WriteConstantInt(o, this, false, TypeTable, 0);
 }
 
@@ -922,7 +959,7 @@ CachedWriter &CachedWriter::operator<<(const Value *V) {
   switch (V->getValueType()) {
   case Value::ConstantVal:
   case Value::ArgumentVal:       AW->writeOperand(V, true, true); break;
-  case Value::TypeVal:           AW->write(cast<const Type>(V)); break;
+  case Value::TypeVal:           AW->write(cast<Type>(V)); break;
   case Value::InstructionVal:    AW->write(cast<Instruction>(V)); break;
   case Value::BasicBlockVal:     AW->write(cast<BasicBlock>(V)); break;
   case Value::FunctionVal:       AW->write(cast<Function>(V)); break;