-//===-- Writer.cpp - Library for writing C files --------------------------===//
+//===-- Writer.cpp - Library for converting LLVM code to C ----------------===//
//
// This library implements the functionality defined in llvm/Assembly/CWriter.h
-// and CLocalVars.h
//
// TODO : Recursive types.
//
//===-----------------------------------------------------------------------==//
#include "llvm/Assembly/CWriter.h"
-#include "llvm/SlotCalculator.h"
#include "llvm/Constants.h"
#include "llvm/DerivedTypes.h"
#include "llvm/Module.h"
-#include "llvm/GlobalVariable.h"
-#include "llvm/Function.h"
-#include "llvm/Argument.h"
-#include "llvm/BasicBlock.h"
#include "llvm/iMemory.h"
#include "llvm/iTerminators.h"
#include "llvm/iPHINode.h"
#include "llvm/iOther.h"
#include "llvm/iOperators.h"
#include "llvm/SymbolTable.h"
+#include "llvm/SlotCalculator.h"
#include "llvm/Support/InstVisitor.h"
#include "llvm/Support/InstIterator.h"
#include "Support/StringExtras.h"
#include "Support/STLExtras.h"
-
#include <algorithm>
-#include <strstream>
+#include <set>
using std::string;
using std::map;
using std::ostream;
-static std::string getConstStrValue(const Constant* CPV);
+namespace {
+ class CWriter : public InstVisitor<CWriter> {
+ ostream& Out;
+ SlotCalculator &Table;
+ const Module *TheModule;
+ map<const Type *, string> TypeNames;
+ std::set<const Value*> MangledGlobals;
+ public:
+ inline CWriter(ostream &o, SlotCalculator &Tab, const Module *M)
+ : Out(o), Table(Tab), TheModule(M) {
+ }
+
+ inline void write(Module *M) { printModule(M); }
+ ostream &printType(const Type *Ty, const string &VariableName = "",
+ bool IgnoreName = false);
-static std::string getConstArrayStrValue(const Constant* CPV) {
- std::string Result;
-
- // 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.
- //
- const Type *ETy = cast<ArrayType>(CPV->getType())->getElementType();
- bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
+ void writeOperand(Value *Operand);
+ void writeOperandInternal(Value *Operand);
- if (ETy == Type::SByteTy) {
- for (unsigned i = 0; i < CPV->getNumOperands(); ++i)
- if (ETy == Type::SByteTy &&
- cast<ConstantSInt>(CPV->getOperand(i))->getValue() < 0) {
- isString = false;
- break;
- }
- }
- if (isString) {
- // Make sure the last character is a null char, as automatically added by C
- if (CPV->getNumOperands() == 0 ||
- !cast<Constant>(*(CPV->op_end()-1))->isNullValue())
- isString = false;
- }
-
- if (isString) {
- Result = "\"";
- // Do not include the last character, which we know is null
- for (unsigned i = 0, e = CPV->getNumOperands()-1; i != e; ++i) {
- unsigned char C = (ETy == Type::SByteTy) ?
- (unsigned char)cast<ConstantSInt>(CPV->getOperand(i))->getValue() :
- (unsigned char)cast<ConstantUInt>(CPV->getOperand(i))->getValue();
-
- if (isprint(C)) {
- Result += C;
- } else {
- switch (C) {
- case '\n': Result += "\\n"; break;
- case '\t': Result += "\\t"; break;
- case '\r': Result += "\\r"; break;
- case '\v': Result += "\\v"; break;
- case '\a': Result += "\\a"; break;
- default:
- Result += "\\x";
- Result += ( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A');
- Result += ((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A');
- break;
- }
- }
- }
- Result += "\"";
- } else {
- Result = "{";
- if (CPV->getNumOperands()) {
- Result += " " + getConstStrValue(cast<Constant>(CPV->getOperand(0)));
- for (unsigned i = 1; i < CPV->getNumOperands(); i++)
- Result += ", " + getConstStrValue(cast<Constant>(CPV->getOperand(i)));
+ string getValueName(const Value *V);
+
+ private :
+ void printModule(Module *M);
+ void printSymbolTable(const SymbolTable &ST);
+ void printGlobal(const GlobalVariable *GV);
+ void printFunctionSignature(const Function *F);
+ void printFunctionDecl(const Function *F); // Print just the forward decl
+
+ void printFunction(Function *);
+
+ void printConstant(Constant *CPV);
+ void printConstantArray(ConstantArray *CPA);
+
+ // isInlinableInst - Attempt to inline instructions into their uses to build
+ // trees as much as possible. To do this, we have to consistently decide
+ // what is acceptable to inline, so that variable declarations don't get
+ // printed and an extra copy of the expr is not emitted.
+ //
+ static bool isInlinableInst(const Instruction &I) {
+ // Must be an expression, must be used exactly once. If it is dead, we
+ // emit it inline where it would go.
+ if (I.getType() == Type::VoidTy || I.use_size() != 1 ||
+ isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I))
+ return false;
+
+ // Only inline instruction it it's use is in the same BB as the inst.
+ return I.getParent() == cast<Instruction>(I.use_back())->getParent();
}
- Result += " }";
- }
-
- return Result;
-}
-static std::string getConstStrValue(const Constant* CPV) {
- switch (CPV->getType()->getPrimitiveID()) {
- case Type::BoolTyID:
- return CPV == ConstantBool::False ? "0" : "1";
- case Type::SByteTyID:
- case Type::ShortTyID:
- case Type::IntTyID:
- return itostr(cast<ConstantSInt>(CPV)->getValue());
- case Type::LongTyID:
- return itostr(cast<ConstantSInt>(CPV)->getValue()) + "ll";
+ // Instruction visitation functions
+ friend class InstVisitor<CWriter>;
- case Type::UByteTyID:
- return utostr(cast<ConstantUInt>(CPV)->getValue());
- case Type::UShortTyID:
- return utostr(cast<ConstantUInt>(CPV)->getValue());
- case Type::UIntTyID:
- return utostr(cast<ConstantUInt>(CPV)->getValue())+"u";
- case Type::ULongTyID:
- return utostr(cast<ConstantUInt>(CPV)->getValue())+"ull";
+ void visitReturnInst(ReturnInst &I);
+ void visitBranchInst(BranchInst &I);
- case Type::FloatTyID:
- case Type::DoubleTyID:
- return ftostr(cast<ConstantFP>(CPV)->getValue());
+ void visitPHINode(PHINode &I) {}
+ void visitBinaryOperator(Instruction &I);
- case Type::ArrayTyID:
- return getConstArrayStrValue(CPV);
+ void visitCastInst (CastInst &I);
+ void visitCallInst (CallInst &I);
+ void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
- case Type::StructTyID: {
- std::string Result = "{";
- if (CPV->getNumOperands()) {
- Result += " " + getConstStrValue(cast<Constant>(CPV->getOperand(0)));
- for (unsigned i = 1; i < CPV->getNumOperands(); i++)
- Result += ", " + getConstStrValue(cast<Constant>(CPV->getOperand(i)));
+ void visitMallocInst(MallocInst &I);
+ void visitAllocaInst(AllocaInst &I);
+ void visitFreeInst (FreeInst &I);
+ void visitLoadInst (LoadInst &I);
+ void visitStoreInst (StoreInst &I);
+ void visitGetElementPtrInst(GetElementPtrInst &I);
+
+ void visitInstruction(Instruction &I) {
+ std::cerr << "C Writer does not know about " << I;
+ abort();
}
- return Result + " }";
- }
- default:
- cerr << "Unknown constant type: " << CPV << "\n";
- abort();
+ void outputLValue(Instruction *I) {
+ Out << " " << getValueName(I) << " = ";
+ }
+ void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
+ unsigned Indent);
+ void printIndexingExpression(Value *Ptr, User::op_iterator I,
+ User::op_iterator E);
+ };
+}
+
+// We dont want identifier names with ., space, - in them.
+// So we replace them with _
+static string makeNameProper(string x) {
+ string tmp;
+ for (string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
+ switch (*sI) {
+ case '.': tmp += "d_"; break;
+ case ' ': tmp += "s_"; break;
+ case '-': tmp += "D_"; break;
+ default: tmp += *sI;
+ }
+
+ return tmp;
+}
+
+string CWriter::getValueName(const Value *V) {
+ if (V->hasName()) { // Print out the label if it exists...
+ if (isa<GlobalValue>(V) && // Do not mangle globals...
+ cast<GlobalValue>(V)->hasExternalLinkage() && // Unless it's internal or
+ !MangledGlobals.count(V)) // Unless the name would collide if we don't
+ return makeNameProper(V->getName());
+
+ return "l" + utostr(V->getType()->getUniqueID()) + "_" +
+ makeNameProper(V->getName());
}
+
+ int Slot = Table.getValSlot(V);
+ assert(Slot >= 0 && "Invalid value!");
+ return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
}
-// Pass the Type* variable and and the variable name and this prints out the
-// variable declaration.
+// Pass the Type* and the variable name and this prints out the variable
+// declaration.
//
-static string calcTypeNameVar(const Type *Ty,
- map<const Type *, string> &TypeNames,
- const string &NameSoFar, bool ignoreName = false){
+ostream &CWriter::printType(const Type *Ty, const string &NameSoFar,
+ bool IgnoreName = false) {
if (Ty->isPrimitiveType())
switch (Ty->getPrimitiveID()) {
- case Type::VoidTyID: return "void " + NameSoFar;
- case Type::BoolTyID: return "bool " + NameSoFar;
- case Type::UByteTyID: return "unsigned char " + NameSoFar;
- case Type::SByteTyID: return "signed char " + NameSoFar;
- case Type::UShortTyID: return "unsigned short " + NameSoFar;
- case Type::ShortTyID: return "short " + NameSoFar;
- case Type::UIntTyID: return "unsigned " + NameSoFar;
- case Type::IntTyID: return "int " + NameSoFar;
- case Type::ULongTyID: return "unsigned long long " + NameSoFar;
- case Type::LongTyID: return "signed long long " + NameSoFar;
- case Type::FloatTyID: return "float " + NameSoFar;
- case Type::DoubleTyID: return "double " + NameSoFar;
+ case Type::VoidTyID: return Out << "void " << NameSoFar;
+ case Type::BoolTyID: return Out << "bool " << NameSoFar;
+ case Type::UByteTyID: return Out << "unsigned char " << NameSoFar;
+ case Type::SByteTyID: return Out << "signed char " << NameSoFar;
+ case Type::UShortTyID: return Out << "unsigned short " << NameSoFar;
+ case Type::ShortTyID: return Out << "short " << NameSoFar;
+ case Type::UIntTyID: return Out << "unsigned " << NameSoFar;
+ case Type::IntTyID: return Out << "int " << NameSoFar;
+ case Type::ULongTyID: return Out << "unsigned long long " << NameSoFar;
+ case Type::LongTyID: return Out << "signed long long " << NameSoFar;
+ case Type::FloatTyID: return Out << "float " << NameSoFar;
+ case Type::DoubleTyID: return Out << "double " << NameSoFar;
default :
- cerr << "Unknown primitive type: " << Ty << "\n";
+ std::cerr << "Unknown primitive type: " << Ty << "\n";
abort();
}
// Check to see if the type is named.
- if (!ignoreName) {
+ if (!IgnoreName) {
map<const Type *, string>::iterator I = TypeNames.find(Ty);
- if (I != TypeNames.end())
- return I->second + " " + NameSoFar;
+ if (I != TypeNames.end()) {
+ return Out << I->second << " " << NameSoFar;
+ }
}
- string Result;
switch (Ty->getPrimitiveID()) {
case Type::FunctionTyID: {
const FunctionType *MTy = cast<FunctionType>(Ty);
- Result += calcTypeNameVar(MTy->getReturnType(), TypeNames, "");
- Result += " " + NameSoFar + " (";
+ printType(MTy->getReturnType(), "");
+ Out << " " << NameSoFar << " (";
+
for (FunctionType::ParamTypes::const_iterator
I = MTy->getParamTypes().begin(),
E = MTy->getParamTypes().end(); I != E; ++I) {
if (I != MTy->getParamTypes().begin())
- Result += ", ";
- Result += calcTypeNameVar(*I, TypeNames, "");
+ Out << ", ";
+ printType(*I, "");
}
if (MTy->isVarArg()) {
if (!MTy->getParamTypes().empty())
- Result += ", ";
- Result += "...";
+ Out << ", ";
+ Out << "...";
}
- Result += ")";
- break;
+ return Out << ")";
}
case Type::StructTyID: {
- const StructType *STy = cast<const StructType>(Ty);
- Result = NameSoFar + " {\n";
- unsigned indx = 0;
+ const StructType *STy = cast<StructType>(Ty);
+ Out << NameSoFar + " {\n";
+ unsigned Idx = 0;
for (StructType::ElementTypes::const_iterator
I = STy->getElementTypes().begin(),
E = STy->getElementTypes().end(); I != E; ++I) {
- Result += " " +calcTypeNameVar(*I, TypeNames, "field" + utostr(indx++));
- Result += ";\n";
+ Out << " ";
+ printType(*I, "field" + utostr(Idx++));
+ Out << ";\n";
}
- Result += "}";
- break;
+ return Out << "}";
}
case Type::PointerTyID: {
- Result = calcTypeNameVar(cast<const PointerType>(Ty)->getElementType(),
- TypeNames, "*" + NameSoFar);
- break;
+ const PointerType *PTy = cast<PointerType>(Ty);
+ return printType(PTy->getElementType(), "(*" + NameSoFar + ")");
}
-
+
case Type::ArrayTyID: {
- const ArrayType *ATy = cast<const ArrayType>(Ty);
- int NumElements = ATy->getNumElements();
- Result = calcTypeNameVar(ATy->getElementType(), TypeNames,
- NameSoFar + "[" + itostr(NumElements) + "]");
- break;
+ const ArrayType *ATy = cast<ArrayType>(Ty);
+ unsigned NumElements = ATy->getNumElements();
+ return printType(ATy->getElementType(),
+ NameSoFar + "[" + utostr(NumElements) + "]");
}
default:
assert(0 && "Unhandled case in getTypeProps!");
- Result = "<error>";
+ abort();
}
- return Result;
+ return Out;
}
-namespace {
- class CWriter {
- ostream& Out;
- SlotCalculator &Table;
- const Module *TheModule;
- map<const Type *, string> TypeNames;
- public:
- inline CWriter(ostream &o, SlotCalculator &Tab, const Module *M)
- : Out(o), Table(Tab), TheModule(M) {
- }
-
- inline void write(Module *M) { printModule(M); }
-
- ostream& printTypeVar(const Type *Ty, const string &VariableName) {
- return Out << calcTypeNameVar(Ty, TypeNames, VariableName);
- }
-
- ostream& printType(const Type *Ty) {
- return Out << calcTypeNameVar(Ty, TypeNames, "");
- }
-
- void writeOperand(const Value *Operand);
-
- string getValueName(const Value *V);
- private :
+void CWriter::printConstantArray(ConstantArray *CPA) {
- void printModule(Module *M);
- void printSymbolTable(const SymbolTable &ST);
- void printGlobal(const GlobalVariable *GV);
- void printFunctionSignature(const Function *F);
- void printFunctionDecl(const Function *F); // Print just the forward decl
-
- void printFunction(Function *);
- };
- /* END class CWriter */
-}
-
-namespace {
- /* CLASS CInstPrintVisitor */
-
- class CInstPrintVisitor: public InstVisitor<CInstPrintVisitor> {
- CWriter& CW;
- SlotCalculator& Table;
- ostream &Out;
-
- void outputLValue(Instruction *);
- void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
- unsigned Indent);
- void printIndexingExpr(MemAccessInst *MAI);
-
- public:
- CInstPrintVisitor (CWriter &cw, SlotCalculator& table, ostream& o)
- : CW(cw), Table(table), Out(o) {}
-
- void visitCastInst(CastInst *I);
- void visitCallInst(CallInst *I);
- void visitShiftInst(ShiftInst *I) { visitBinaryOperator(I); }
- void visitReturnInst(ReturnInst *I);
- void visitBranchInst(BranchInst *I);
- void visitSwitchInst(SwitchInst *I);
- void visitInvokeInst(InvokeInst *I) ;
- void visitMallocInst(MallocInst *I);
- void visitAllocaInst(AllocaInst *I);
- void visitFreeInst(FreeInst *I);
- void visitLoadInst(LoadInst *I);
- void visitStoreInst(StoreInst *I);
- void visitGetElementPtrInst(GetElementPtrInst *I);
- void visitPHINode(PHINode *I) {}
-
- void visitNot(GenericUnaryInst *I);
- void visitBinaryOperator(Instruction *I);
- };
-}
-
-void CInstPrintVisitor::outputLValue(Instruction *I) {
- Out << " " << CW.getValueName(I) << " = ";
-}
-
-// Implement all "other" instructions, except for PHINode
-void CInstPrintVisitor::visitCastInst(CastInst *I) {
- outputLValue(I);
- Out << "(";
- CW.printType(I->getType());
- Out << ")";
- CW.writeOperand(I->getOperand(0));
- Out << ";\n";
-}
-
-void CInstPrintVisitor::visitCallInst(CallInst *I) {
- if (I->getType() != Type::VoidTy)
- outputLValue(I);
- else
- Out << " ";
+ // 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.
+ //
+ const Type *ETy = CPA->getType()->getElementType();
+ bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
- const PointerType *PTy = cast<PointerType>(I->getCalledValue()->getType());
- const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
- const Type *RetTy = FTy->getReturnType();
+ // Make sure the last character is a null char, as automatically added by C
+ if (CPA->getNumOperands() == 0 ||
+ !cast<Constant>(*(CPA->op_end()-1))->isNullValue())
+ isString = false;
- Out << CW.getValueName(I->getOperand(0)) << "(";
-
- if (I->getNumOperands() > 1) {
- CW.writeOperand(I->getOperand(1));
-
- for (unsigned op = 2, Eop = I->getNumOperands(); op != Eop; ++op) {
- Out << ", ";
- CW.writeOperand(I->getOperand(op));
- }
- }
- Out << ");\n";
-}
-
-// Specific Instruction type classes... note that all of the casts are
-// neccesary because we use the instruction classes as opaque types...
-//
-void CInstPrintVisitor::visitReturnInst(ReturnInst *I) {
- // Don't output a void return if this is the last basic block in the function
- if (I->getNumOperands() == 0 &&
- *(I->getParent()->getParent()->end()-1) == I->getParent())
- return;
-
- Out << " return";
- if (I->getNumOperands()) {
- Out << " ";
- CW.writeOperand(I->getOperand(0));
- }
- Out << ";\n";
-}
-
-// Return true if BB1 immediately preceeds BB2.
-static bool BBFollowsBB(BasicBlock *BB1, BasicBlock *BB2) {
- Function *F = BB1->getParent();
- Function::iterator I = find(F->begin(), F->end(), BB1);
- assert(I != F->end() && "BB not in function!");
- return *(I+1) == BB2;
-}
-
-static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
- // If PHI nodes need copies, we need the copy code...
- if (isa<PHINode>(To->front()) ||
- !BBFollowsBB(From, To)) // Not directly successor, need goto
- return true;
-
- // Otherwise we don't need the code.
- return false;
-}
-
-void CInstPrintVisitor::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
- unsigned Indent) {
- for (BasicBlock::iterator I = Succ->begin();
- PHINode *PN = dyn_cast<PHINode>(*I); ++I) {
- // now we have to do the printing
- Out << string(Indent, ' ');
- outputLValue(PN);
- CW.writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
- Out << "; /* for PHI node */\n";
- }
-
- if (!BBFollowsBB(CurBB, Succ)) {
- Out << string(Indent, ' ') << " goto ";
- CW.writeOperand(Succ);
- Out << ";\n";
- }
-}
-
-// Brach instruction printing - Avoid printing out a brach to a basic block that
-// immediately succeeds the current one.
-//
-void CInstPrintVisitor::visitBranchInst(BranchInst *I) {
- if (I->isConditional()) {
- if (isGotoCodeNeccessary(I->getParent(), I->getSuccessor(0))) {
- Out << " if (";
- CW.writeOperand(I->getCondition());
- Out << ") {\n";
-
- printBranchToBlock(I->getParent(), I->getSuccessor(0), 2);
+ if (isString) {
+ Out << "\"";
+ // Do not include the last character, which we know is null
+ for (unsigned i = 0, e = CPA->getNumOperands()-1; i != e; ++i) {
+ unsigned char C = (ETy == Type::SByteTy) ?
+ (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
+ (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
- if (isGotoCodeNeccessary(I->getParent(), I->getSuccessor(1))) {
- Out << " } else {\n";
- printBranchToBlock(I->getParent(), I->getSuccessor(1), 2);
+ if (isprint(C)) {
+ Out << C;
+ } else {
+ switch (C) {
+ case '\n': Out << "\\n"; break;
+ case '\t': Out << "\\t"; break;
+ case '\r': Out << "\\r"; break;
+ case '\v': Out << "\\v"; break;
+ case '\a': Out << "\\a"; break;
+ default:
+ Out << "\\x";
+ Out << ( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A');
+ Out << ((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A');
+ break;
+ }
}
- } else {
- // First goto not neccesary, assume second one is...
- Out << " if (!";
- CW.writeOperand(I->getCondition());
- Out << ") {\n";
-
- printBranchToBlock(I->getParent(), I->getSuccessor(1), 2);
}
-
- Out << " }\n";
+ Out << "\"";
} else {
- printBranchToBlock(I->getParent(), I->getSuccessor(0), 0);
- }
- Out << "\n";
-}
-
-void CInstPrintVisitor::visitSwitchInst(SwitchInst *I) {
- assert(0 && "Switch not implemented!");
-}
-
-void CInstPrintVisitor::visitInvokeInst(InvokeInst *I) {
- assert(0 && "Invoke not implemented!");
-}
-
-void CInstPrintVisitor::visitMallocInst(MallocInst *I) {
- outputLValue(I);
- Out << "(";
- CW.printType(I->getType());
- Out << ")malloc(sizeof(";
- CW.printType(I->getType()->getElementType());
- Out << ")";
-
- if (I->isArrayAllocation()) {
- Out << " * " ;
- CW.writeOperand(I->getOperand(0));
- }
- Out << ");\n";
-}
-
-void CInstPrintVisitor::visitAllocaInst(AllocaInst *I) {
- outputLValue(I);
- Out << "(";
- CW.printType(I->getType());
- Out << ") alloca(sizeof(";
- CW.printType(I->getType()->getElementType());
- Out << ")";
- if (I->isArrayAllocation()) {
- Out << " * " ;
- CW.writeOperand(I->getOperand(0));
+ Out << "{";
+ if (CPA->getNumOperands()) {
+ Out << " ";
+ printConstant(cast<Constant>(CPA->getOperand(0)));
+ for (unsigned i = 1, e = CPA->getNumOperands(); i != e; ++i) {
+ Out << ", ";
+ printConstant(cast<Constant>(CPA->getOperand(i)));
+ }
+ }
+ Out << " }";
}
- Out << ");\n";
-}
-
-void CInstPrintVisitor::visitFreeInst(FreeInst *I) {
- Out << " free(";
- CW.writeOperand(I->getOperand(0));
- Out << ");\n";
}
-void CInstPrintVisitor::printIndexingExpr(MemAccessInst *MAI) {
- MemAccessInst::op_iterator I = MAI->idx_begin(), E = MAI->idx_end();
- if (I == E)
- Out << "*"; // Implicit zero first argument: '*x' is equivalent to 'x[0]'
- CW.writeOperand(MAI->getPointerOperand());
-
- if (I == E) return;
-
- // Print out the -> operator if possible...
- Constant *CI = dyn_cast<Constant>(*I);
- if (CI && CI->isNullValue() && I+1 != E &&
- (*(I+1))->getType() == Type::UByteTy) {
- ++I;
- Out << "->field" << cast<ConstantUInt>(*I)->getValue();
- ++I;
- }
-
- for (; I != E; ++I)
- if ((*I)->getType() == Type::UIntTy) {
- Out << "[";
- CW.writeOperand(*I);
- Out << "]";
- } else {
- Out << ".field" << cast<ConstantUInt>(*I)->getValue();
+// printConstant - The LLVM Constant to C Constant converter.
+void CWriter::printConstant(Constant *CPV) {
+ if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
+ switch (CE->getOpcode()) {
+ case Instruction::Cast:
+ Out << "((";
+ printType(CPV->getType());
+ Out << ")";
+ printConstant(cast<Constant>(CPV->getOperand(0)));
+ Out << ")";
+ return;
+
+ case Instruction::GetElementPtr:
+ Out << "&(";
+ printIndexingExpression(CPV->getOperand(0),
+ CPV->op_begin()+1, CPV->op_end());
+ Out << ")";
+ return;
+ case Instruction::Add:
+ Out << "(";
+ printConstant(cast<Constant>(CPV->getOperand(0)));
+ Out << " + ";
+ printConstant(cast<Constant>(CPV->getOperand(1)));
+ Out << ")";
+ return;
+ case Instruction::Sub:
+ Out << "(";
+ printConstant(cast<Constant>(CPV->getOperand(0)));
+ Out << " - ";
+ printConstant(cast<Constant>(CPV->getOperand(1)));
+ Out << ")";
+ return;
+
+ default:
+ std::cerr << "CWriter Error: Unhandled constant expression: "
+ << CE << "\n";
+ abort();
}
-}
+ }
-void CInstPrintVisitor::visitLoadInst(LoadInst *I) {
- outputLValue(I);
- printIndexingExpr(I);
- Out << ";\n";
-}
+ switch (CPV->getType()->getPrimitiveID()) {
+ case Type::BoolTyID:
+ Out << (CPV == ConstantBool::False ? "0" : "1"); break;
+ case Type::SByteTyID:
+ case Type::ShortTyID:
+ case Type::IntTyID:
+ Out << cast<ConstantSInt>(CPV)->getValue(); break;
+ case Type::LongTyID:
+ Out << cast<ConstantSInt>(CPV)->getValue() << "ll"; break;
-void CInstPrintVisitor::visitStoreInst(StoreInst *I) {
- Out << " ";
- printIndexingExpr(I);
- Out << " = ";
- CW.writeOperand(I->getOperand(0));
- Out << ";\n";
-}
+ case Type::UByteTyID:
+ case Type::UShortTyID:
+ Out << cast<ConstantUInt>(CPV)->getValue(); break;
+ case Type::UIntTyID:
+ Out << cast<ConstantUInt>(CPV)->getValue() << "u"; break;
+ case Type::ULongTyID:
+ Out << cast<ConstantUInt>(CPV)->getValue() << "ull"; break;
-void CInstPrintVisitor::visitGetElementPtrInst(GetElementPtrInst *I) {
- outputLValue(I);
- Out << "&";
- printIndexingExpr(I);
- Out << ";\n";
-}
+ case Type::FloatTyID:
+ case Type::DoubleTyID:
+ Out << cast<ConstantFP>(CPV)->getValue(); break;
-void CInstPrintVisitor::visitNot(GenericUnaryInst *I) {
- outputLValue(I);
- Out << "~";
- CW.writeOperand(I->getOperand(0));
- Out << ";\n";
-}
+ case Type::ArrayTyID:
+ printConstantArray(cast<ConstantArray>(CPV));
+ break;
-void CInstPrintVisitor::visitBinaryOperator(Instruction *I) {
- // binary instructions, shift instructions, setCond instructions.
- outputLValue(I);
- if (isa<PointerType>(I->getType())) {
- Out << "(";
- CW.printType(I->getType());
- Out << ")";
+ case Type::StructTyID: {
+ Out << "{";
+ if (CPV->getNumOperands()) {
+ Out << " ";
+ printConstant(cast<Constant>(CPV->getOperand(0)));
+ for (unsigned i = 1, e = CPV->getNumOperands(); i != e; ++i) {
+ Out << ", ";
+ printConstant(cast<Constant>(CPV->getOperand(i)));
+ }
+ }
+ Out << " }";
+ break;
}
-
- if (isa<PointerType>(I->getType())) Out << "(long long)";
- CW.writeOperand(I->getOperand(0));
- switch (I->getOpcode()) {
- case Instruction::Add: Out << " + "; break;
- case Instruction::Sub: Out << " - "; break;
- case Instruction::Mul: Out << "*"; break;
- case Instruction::Div: Out << "/"; break;
- case Instruction::Rem: Out << "%"; break;
- case Instruction::And: Out << " & "; break;
- case Instruction::Or: Out << " | "; break;
- case Instruction::Xor: Out << " ^ "; break;
- case Instruction::SetEQ: Out << " == "; break;
- case Instruction::SetNE: Out << " != "; break;
- case Instruction::SetLE: Out << " <= "; break;
- case Instruction::SetGE: Out << " >= "; break;
- case Instruction::SetLT: Out << " < "; break;
- case Instruction::SetGT: Out << " > "; break;
- case Instruction::Shl : Out << " << "; break;
- case Instruction::Shr : Out << " >> "; break;
- default: cerr << "Invalid operator type!" << I; abort();
+ case Type::PointerTyID:
+ if (isa<ConstantPointerNull>(CPV)) {
+ Out << "((";
+ printType(CPV->getType(), "");
+ Out << ")NULL)";
+ break;
+ } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CPV)) {
+ writeOperand(CPR->getValue());
+ break;
+ }
+ // FALL THROUGH
+ default:
+ std::cerr << "Unknown constant type: " << CPV << "\n";
+ abort();
}
+}
- if (isa<PointerType>(I->getType())) Out << "(long long)";
- CW.writeOperand(I->getOperand(1));
- Out << ";\n";
+void CWriter::writeOperandInternal(Value *Operand) {
+ if (Instruction *I = dyn_cast<Instruction>(Operand))
+ if (isInlinableInst(*I)) {
+ // Should we inline this instruction to build a tree?
+ Out << "(";
+ visit(*I);
+ Out << ")";
+ return;
+ }
+
+ if (Operand->hasName()) {
+ Out << getValueName(Operand);
+ } else if (Constant *CPV = dyn_cast<Constant>(Operand)) {
+ printConstant(CPV);
+ } else {
+ int Slot = Table.getValSlot(Operand);
+ assert(Slot >= 0 && "Malformed LLVM!");
+ Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
+ }
}
-/* END : CInstPrintVisitor implementation */
+void CWriter::writeOperand(Value *Operand) {
+ if (isa<GlobalVariable>(Operand))
+ Out << "(&"; // Global variables are references as their addresses by llvm
-// We dont want identifier names with ., space, - in them.
-// So we replace them with _
-static string makeNameProper(string x) {
- string tmp;
- for (string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
- switch (*sI) {
- case '.': tmp += "d_"; break;
- case ' ': tmp += "s_"; break;
- case '-': tmp += "D_"; break;
- case '_': tmp += "__"; break;
- default: tmp += *sI;
- }
+ writeOperandInternal(Operand);
- return tmp;
+ if (isa<GlobalVariable>(Operand))
+ Out << ")";
}
-string CWriter::getValueName(const Value *V) {
- if (V->hasName()) { // Print out the label if it exists...
- if (isa<GlobalValue>(V)) // Do not mangle globals...
- return makeNameProper(V->getName());
+void CWriter::printModule(Module *M) {
+ // Calculate which global values have names that will collide when we throw
+ // away type information.
+ { // Scope to delete the FoundNames set when we are done with it...
+ std::set<string> FoundNames;
+ for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
+ if (I->hasName()) // If the global has a name...
+ if (FoundNames.count(I->getName())) // And the name is already used
+ MangledGlobals.insert(I); // Mangle the name
+ else
+ FoundNames.insert(I->getName()); // Otherwise, keep track of name
- return "l" + utostr(V->getType()->getUniqueID()) + "_" +
- makeNameProper(V->getName());
+ for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
+ if (I->hasName()) // If the global has a name...
+ if (FoundNames.count(I->getName())) // And the name is already used
+ MangledGlobals.insert(I); // Mangle the name
+ else
+ FoundNames.insert(I->getName()); // Otherwise, keep track of name
}
- int Slot = Table.getValSlot(V);
- assert(Slot >= 0 && "Invalid value!");
- return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
-}
-void CWriter::printModule(Module *M) {
// printing stdlib inclusion
// Out << "#include <stdlib.h>\n";
// get declaration for alloca
Out << "/* Provide Declarations */\n"
+ << "#include <malloc.h>\n"
<< "#include <alloca.h>\n\n"
// Provide a definition for null if one does not already exist.
<< "#ifndef NULL\n#define NULL 0\n#endif\n\n"
<< "typedef unsigned char bool;\n"
- << "\n\n/* Global Symbols */\n";
+ << "\n\n/* Global Declarations */\n";
+
+ // First output all the declarations for the program, because C requires
+ // Functions & globals to be declared before they are used.
+ //
// Loop over the symbol table, emitting all named constants...
if (M->hasSymbolTable())
printSymbolTable(*M->getSymbolTable());
- Out << "\n\n/* Global Data */\n";
- for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
- GlobalVariable *GV = *I;
- if (GV->hasInternalLinkage()) Out << "static ";
- printTypeVar(GV->getType()->getElementType(), getValueName(GV));
+ // Global variable declarations...
+ if (!M->gempty()) {
+ Out << "\n/* Global Variable Declarations */\n";
+ for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
+ Out << (I->hasExternalLinkage() ? "extern " : "static ");
+ printType(I->getType()->getElementType(), getValueName(I));
+ Out << ";\n";
+ }
+ }
+
+ // Function declarations
+ if (!M->empty()) {
+ Out << "\n/* Function Declarations */\n";
+ for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
+ printFunctionDecl(I);
+ }
- if (GV->hasInitializer()) {
- Out << " = " ;
- writeOperand(GV->getInitializer());
+ // Output the global variable contents...
+ if (!M->gempty()) {
+ Out << "\n\n/* Global Data */\n";
+ for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
+ if (I->hasInternalLinkage()) Out << "static ";
+ printType(I->getType()->getElementType(), getValueName(I));
+
+ if (I->hasInitializer()) {
+ Out << " = " ;
+ writeOperand(I->getInitializer());
+ }
+ Out << ";\n";
}
- Out << ";\n";
}
- // First output all the declarations of the functions as C requires Functions
- // be declared before they are used.
- //
- Out << "\n\n/* Function Declarations */\n";
- for_each(M->begin(), M->end(), bind_obj(this, &CWriter::printFunctionDecl));
-
// Output all of the functions...
- Out << "\n\n/* Function Bodies */\n";
- for_each(M->begin(), M->end(), bind_obj(this, &CWriter::printFunction));
+ if (!M->empty()) {
+ Out << "\n\n/* Function Bodies */\n";
+ for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
+ printFunction(I);
+ }
}
SymbolTable::type_const_iterator End = ST.type_end(TI->first);
for (; I != End; ++I)
- if (const Type *Ty = dyn_cast<const StructType>(I->second)) {
- string Name = "struct l_" + I->first;
+ if (const Type *Ty = dyn_cast<StructType>(I->second)) {
+ string Name = "struct l_" + makeNameProper(I->first);
Out << Name << ";\n";
-
TypeNames.insert(std::make_pair(Ty, Name));
}
}
for (; I != End; ++I) {
const Value *V = I->second;
- if (const Type *Ty = dyn_cast<const Type>(V)) {
- string Name = "l_" + I->first;
+ if (const Type *Ty = dyn_cast<Type>(V)) {
+ string Name = "l_" + makeNameProper(I->first);
if (isa<StructType>(Ty))
- Name = "struct " + Name;
+ Name = "struct " + makeNameProper(Name);
else
Out << "typedef ";
- Out << calcTypeNameVar(Ty, TypeNames, Name, true) << ";\n";
+ printType(Ty, Name, true);
+ Out << ";\n";
}
}
}
Out << getValueName(F) << "(";
if (!F->isExternal()) {
- if (!F->getArgumentList().empty()) {
- printTypeVar(F->getArgumentList().front()->getType(),
- getValueName(F->getArgumentList().front()));
+ if (!F->aempty()) {
+ printType(F->afront().getType(), getValueName(F->abegin()));
- for (Function::ArgumentListType::const_iterator
- I = F->getArgumentList().begin()+1,
- E = F->getArgumentList().end(); I != E; ++I) {
+ for (Function::const_aiterator I = ++F->abegin(), E = F->aend();
+ I != E; ++I) {
Out << ", ";
- printTypeVar((*I)->getType(), getValueName(*I));
+ printType(I->getType(), getValueName(I));
}
}
} else {
// print local variable information for the function
for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
- if ((*I)->getType() != Type::VoidTy) {
+ if ((*I)->getType() != Type::VoidTy && !isInlinableInst(**I)) {
Out << " ";
- printTypeVar((*I)->getType(), getValueName(*I));
+ printType((*I)->getType(), getValueName(*I));
Out << ";\n";
}
// print the basic blocks
- for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
- BasicBlock *BB = *I, *Prev = I != F->begin() ? *(I-1) : 0;
+ for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
+ BasicBlock *Prev = BB->getPrev();
// Don't print the label for the basic block if there are no uses, or if the
// only terminator use is the precessor basic block's terminator. We have
if (NeedsLabel) Out << getValueName(BB) << ":\n";
// Output all of the instructions in the basic block...
- // print the basic blocks
- CInstPrintVisitor CIPV(*this, Table, Out);
- CIPV.visit(BB);
+ for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E; ++II){
+ if (!isInlinableInst(*II) && !isa<PHINode>(*II)) {
+ if (II->getType() != Type::VoidTy)
+ outputLValue(II);
+ else
+ Out << " ";
+ visit(*II);
+ Out << ";\n";
+ }
+ }
+
+ // Don't emit prefix or suffix for the terminator...
+ visit(*BB->getTerminator());
}
Out << "}\n\n";
Table.purgeFunction();
}
-void CWriter::writeOperand(const Value *Operand) {
- if (isa<GlobalVariable>(Operand))
- Out << "(&"; // Global variables are references as their addresses by llvm
+// Specific Instruction type classes... note that all of the casts are
+// neccesary because we use the instruction classes as opaque types...
+//
+void CWriter::visitReturnInst(ReturnInst &I) {
+ // Don't output a void return if this is the last basic block in the function
+ if (I.getNumOperands() == 0 &&
+ &*--I.getParent()->getParent()->end() == I.getParent() &&
+ !I.getParent()->size() == 1) {
+ return;
+ }
- if (Operand->hasName()) {
- Out << getValueName(Operand);
- } else if (const Constant *CPV = dyn_cast<const Constant>(Operand)) {
- if (isa<ConstantPointerNull>(CPV)) {
- Out << "((";
- printTypeVar(CPV->getType(), "");
- Out << ")NULL)";
- } else
- Out << getConstStrValue(CPV);
+ Out << " return";
+ if (I.getNumOperands()) {
+ Out << " ";
+ writeOperand(I.getOperand(0));
+ }
+ Out << ";\n";
+}
+
+static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
+ // If PHI nodes need copies, we need the copy code...
+ if (isa<PHINode>(To->front()) ||
+ From->getNext() != To) // Not directly successor, need goto
+ return true;
+
+ // Otherwise we don't need the code.
+ return false;
+}
+
+void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
+ unsigned Indent) {
+ for (BasicBlock::iterator I = Succ->begin();
+ PHINode *PN = dyn_cast<PHINode>(&*I); ++I) {
+ // now we have to do the printing
+ Out << string(Indent, ' ');
+ outputLValue(PN);
+ writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
+ Out << "; /* for PHI node */\n";
+ }
+
+ if (CurBB->getNext() != Succ) {
+ Out << string(Indent, ' ') << " goto ";
+ writeOperand(Succ);
+ Out << ";\n";
+ }
+}
+
+// Brach instruction printing - Avoid printing out a brach to a basic block that
+// immediately succeeds the current one.
+//
+void CWriter::visitBranchInst(BranchInst &I) {
+ if (I.isConditional()) {
+ if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(0))) {
+ Out << " if (";
+ writeOperand(I.getCondition());
+ Out << ") {\n";
+
+ printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
+
+ if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(1))) {
+ Out << " } else {\n";
+ printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
+ }
+ } else {
+ // First goto not neccesary, assume second one is...
+ Out << " if (!";
+ writeOperand(I.getCondition());
+ Out << ") {\n";
+
+ printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
+ }
+
+ Out << " }\n";
} else {
- int Slot = Table.getValSlot(Operand);
- assert(Slot >= 0 && "Malformed LLVM!");
- Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
+ printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
}
+ Out << "\n";
+}
- if (isa<GlobalVariable>(Operand))
+
+void CWriter::visitBinaryOperator(Instruction &I) {
+ // binary instructions, shift instructions, setCond instructions.
+ if (isa<PointerType>(I.getType())) {
+ Out << "(";
+ printType(I.getType());
+ Out << ")";
+ }
+
+ if (isa<PointerType>(I.getType())) Out << "(long long)";
+ writeOperand(I.getOperand(0));
+
+ switch (I.getOpcode()) {
+ case Instruction::Add: Out << " + "; break;
+ case Instruction::Sub: Out << " - "; break;
+ case Instruction::Mul: Out << "*"; break;
+ case Instruction::Div: Out << "/"; break;
+ case Instruction::Rem: Out << "%"; break;
+ case Instruction::And: Out << " & "; break;
+ case Instruction::Or: Out << " | "; break;
+ case Instruction::Xor: Out << " ^ "; break;
+ case Instruction::SetEQ: Out << " == "; break;
+ case Instruction::SetNE: Out << " != "; break;
+ case Instruction::SetLE: Out << " <= "; break;
+ case Instruction::SetGE: Out << " >= "; break;
+ case Instruction::SetLT: Out << " < "; break;
+ case Instruction::SetGT: Out << " > "; break;
+ case Instruction::Shl : Out << " << "; break;
+ case Instruction::Shr : Out << " >> "; break;
+ default: std::cerr << "Invalid operator type!" << I; abort();
+ }
+
+ if (isa<PointerType>(I.getType())) Out << "(long long)";
+ writeOperand(I.getOperand(1));
+}
+
+void CWriter::visitCastInst(CastInst &I) {
+ Out << "(";
+ printType(I.getType());
+ Out << ")";
+ writeOperand(I.getOperand(0));
+}
+
+void CWriter::visitCallInst(CallInst &I) {
+ const PointerType *PTy = cast<PointerType>(I.getCalledValue()->getType());
+ const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
+ const Type *RetTy = FTy->getReturnType();
+
+ Out << getValueName(I.getOperand(0)) << "(";
+
+ if (I.getNumOperands() > 1) {
+ writeOperand(I.getOperand(1));
+
+ for (unsigned op = 2, Eop = I.getNumOperands(); op != Eop; ++op) {
+ Out << ", ";
+ writeOperand(I.getOperand(op));
+ }
+ }
+ Out << ")";
+}
+
+void CWriter::visitMallocInst(MallocInst &I) {
+ Out << "(";
+ printType(I.getType());
+ Out << ")malloc(sizeof(";
+ printType(I.getType()->getElementType());
+ Out << ")";
+
+ if (I.isArrayAllocation()) {
+ Out << " * " ;
+ writeOperand(I.getOperand(0));
+ }
+ Out << ")";
+}
+
+void CWriter::visitAllocaInst(AllocaInst &I) {
+ Out << "(";
+ printType(I.getType());
+ Out << ") alloca(sizeof(";
+ printType(I.getType()->getElementType());
+ Out << ")";
+ if (I.isArrayAllocation()) {
+ Out << " * " ;
+ writeOperand(I.getOperand(0));
+ }
+ Out << ")";
+}
+
+void CWriter::visitFreeInst(FreeInst &I) {
+ Out << "free(";
+ writeOperand(I.getOperand(0));
+ Out << ")";
+}
+
+void CWriter::printIndexingExpression(Value *Ptr, User::op_iterator I,
+ User::op_iterator E) {
+ bool HasImplicitAddress = false;
+ // If accessing a global value with no indexing, avoid *(&GV) syndrome
+ if (GlobalValue *V = dyn_cast<GlobalValue>(Ptr)) {
+ HasImplicitAddress = true;
+ } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Ptr)) {
+ HasImplicitAddress = true;
+ Ptr = CPR->getValue(); // Get to the global...
+ }
+
+ if (I == E) {
+ if (!HasImplicitAddress)
+ Out << "*"; // Implicit zero first argument: '*x' is equivalent to 'x[0]'
+
+ writeOperandInternal(Ptr);
+ return;
+ }
+
+ const Constant *CI = dyn_cast<Constant>(I->get());
+ if (HasImplicitAddress && (!CI || !CI->isNullValue()))
+ Out << "(&";
+
+ writeOperandInternal(Ptr);
+
+ if (HasImplicitAddress && (!CI || !CI->isNullValue()))
Out << ")";
+
+ // Print out the -> operator if possible...
+ if (CI && CI->isNullValue() && I+1 != E) {
+ if ((*(I+1))->getType() == Type::UByteTy) {
+ Out << (HasImplicitAddress ? "." : "->");
+ Out << "field" << cast<ConstantUInt>(*(I+1))->getValue();
+ I += 2;
+ } else { // Performing array indexing. Just skip the 0
+ ++I;
+ }
+ } else if (HasImplicitAddress) {
+
+ }
+
+ for (; I != E; ++I)
+ if ((*I)->getType() == Type::UIntTy) {
+ Out << "[";
+ writeOperand(*I);
+ Out << "]";
+ } else {
+ Out << ".field" << cast<ConstantUInt>(*I)->getValue();
+ }
+}
+
+void CWriter::visitLoadInst(LoadInst &I) {
+ printIndexingExpression(I.getPointerOperand(), I.idx_begin(), I.idx_end());
+}
+
+void CWriter::visitStoreInst(StoreInst &I) {
+ printIndexingExpression(I.getPointerOperand(), I.idx_begin(), I.idx_end());
+ Out << " = ";
+ writeOperand(I.getOperand(0));
}
+void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
+ Out << "&";
+ printIndexingExpression(I.getPointerOperand(), I.idx_begin(), I.idx_end());
+}
//===----------------------------------------------------------------------===//
// External Interface declaration