// 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;
}
+// getLLVMName - Turn the specified string into an 'LLVM name', which is either
+// prefixed with % (if the string only contains simple characters) or is
+// surrounded with ""'s (if it has special chars in it).
+static std::string getLLVMName(const std::string &Name) {
+ assert(!Name.empty() && "Cannot get empty name!");
+
+ // First character cannot start with a number...
+ if (Name[0] >= '0' && Name[0] <= '9')
+ return "\"" + Name + "\"";
+
+ // Scan to see if we have any characters that are not on the "white list"
+ for (unsigned i = 0, e = Name.size(); i != e; ++i) {
+ char C = Name[i];
+ assert(C != '"' && "Illegal character in LLVM value name!");
+ if ((C < 'a' || C > 'z') && (C < 'A' || C > 'Z') && (C < '0' || C > '9') &&
+ C != '-' && C != '.' && C != '_')
+ return "\"" + Name + "\"";
+ }
+
+ // If we get here, then the identifier is legal to use as a "VarID".
+ return "%"+Name;
+}
+
// If the module has a symbol table, take all global types and stuff their
// 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);
// 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));
+ TypeNames.insert(std::make_pair(Ty, getLLVMName(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...
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(),
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(),
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>";
}
// 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;
}
// 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);
}
}
-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");
//
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;
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.
//
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;
Out << " ]";
}
} else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
+ if (CS->getNumOperands() > 5 && CS->isNullValue()) {
+ Out << "zeroinitializer";
+ return;
+ }
+
Out << "{";
if (CS->getNumOperands()) {
Out << " ";
} else if (const ConstantPointerRef *PR = dyn_cast<ConstantPointerRef>(CV)) {
const GlobalValue *V = PR->getValue();
if (V->hasName()) {
- Out << "%" << V->getName();
+ Out << getLLVMName(V->getName());
} else if (Table) {
int Slot = Table->getValSlot(V);
if (Slot >= 0)
// 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();
+ Out << getLLVMName(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;
}
// 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)
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
// 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.
// 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
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>";
void AssemblyWriter::printModule(const Module *M) {
+ switch (M->getEndianness()) {
+ case Module::LittleEndian: Out << "target endian = little\n"; break;
+ case Module::BigEndian: Out << "target endian = big\n"; break;
+ case Module::AnyEndianness: break;
+ }
+ switch (M->getPointerSize()) {
+ case Module::Pointer32: Out << "target pointersize = 32\n"; break;
+ case Module::Pointer64: Out << "target pointersize = 64\n"; break;
+ case Module::AnyPointerSize: break;
+ }
+
// Loop over the symbol table, emitting all named constants...
printSymbolTable(M->getSymbolTable());
}
void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
- if (GV->hasName()) Out << "%" << GV->getName() << " = ";
+ if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
if (!GV->hasInitializer())
Out << "external ";
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)) {
- Out << "\t%" << I->first << " = type ";
+ } else if (const Type *Ty = dyn_cast<Type>(V)) {
+ Out << "\t" << getLLVMName(I->first) << " = type ";
// Make sure we print out at least one level of the type structure, so
// that we do not get %FILE = type %FILE
if (!CPV->hasName()) return;
// Print out name...
- Out << "\t%" << CPV->getName() << " =";
+ Out << "\t" << getLLVMName(CPV->getName()) << " =";
// Write the value out now...
writeOperand(CPV, true, false);
case GlobalValue::ExternalLinkage: break;
}
- printType(F->getReturnType()) << " %" << F->getName() << "(";
+ printType(F->getReturnType()) << " " << getLLVMName(F->getName()) << "(";
Table.incorporateFunction(F);
// Loop over the arguments, printing them...
// Output name, if available...
if (Arg->hasName())
- Out << " %" << Arg->getName();
+ Out << " " << getLLVMName(Arg->getName());
else if (Table.getValSlot(Arg) < 0)
Out << "<badref>";
}
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>";
}
// Print out name if it exists...
if (I.hasName())
- Out << "%" << I.getName() << " = ";
+ Out << getLLVMName(I.getName()) << " = ";
// Print out the opcode...
Out << I.getOpcodeName();
} else if (isa<ReturnInst>(I) && !Operand) {
Out << " void";
} else if (isa<CallInst>(I)) {
- const PointerType *PTy = dyn_cast<PointerType>(Operand->getType());
- const FunctionType*MTy = PTy ? dyn_cast<FunctionType>(PTy->getElementType()):0;
- const Type *RetTy = MTy ? MTy->getReturnType() : 0;
+ const PointerType *PTy = cast<PointerType>(Operand->getType());
+ const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
+ const Type *RetTy = FTy->getReturnType();
- // If possible, print out the short form of the call instruction, but we can
+ // If possible, print out the short form of the call instruction. We can
// only do this if the first argument is a pointer to a nonvararg function,
- // and if the value returned is not a pointer to a function.
+ // and if the return type is not a pointer to a function.
//
- if (RetTy && MTy && !MTy->isVarArg() &&
+ if (!FTy->isVarArg() &&
(!isa<PointerType>(RetTy) ||
!isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Out << " "; printType(RetTy);
Out << " )";
} else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
- // TODO: Should try to print out short form of the Invoke instruction
- writeOperand(Operand, true);
+ const PointerType *PTy = cast<PointerType>(Operand->getType());
+ const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
+ const Type *RetTy = FTy->getReturnType();
+
+ // If possible, print out the short form of the invoke instruction. We can
+ // only do this if the first argument is a pointer to a nonvararg function,
+ // and if the return type is not a pointer to a function.
+ //
+ if (!FTy->isVarArg() &&
+ (!isa<PointerType>(RetTy) ||
+ !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
+ Out << " "; printType(RetTy);
+ writeOperand(Operand, false);
+ } else {
+ writeOperand(Operand, true);
+ }
+
Out << "(";
if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
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
o << " " << getType()->getDescription() << " ";
- map<const Type *, string> TypeTable;
+ std::map<const Type *, std::string> TypeTable;
WriteConstantInt(o, this, false, TypeTable, 0);
}
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;