1 //===-- Writer.cpp - Library for converting LLVM code to C ----------------===//
3 // This library converts LLVM code to C code, compilable by GCC.
5 //===-----------------------------------------------------------------------==//
7 #include "llvm/Assembly/CWriter.h"
8 #include "llvm/Constants.h"
9 #include "llvm/DerivedTypes.h"
10 #include "llvm/Module.h"
11 #include "llvm/iMemory.h"
12 #include "llvm/iTerminators.h"
13 #include "llvm/iPHINode.h"
14 #include "llvm/iOther.h"
15 #include "llvm/iOperators.h"
16 #include "llvm/Pass.h"
17 #include "llvm/SymbolTable.h"
18 #include "llvm/SlotCalculator.h"
19 #include "llvm/Analysis/FindUsedTypes.h"
20 #include "llvm/Analysis/ConstantsScanner.h"
21 #include "llvm/Support/InstVisitor.h"
22 #include "llvm/Support/InstIterator.h"
23 #include "Support/StringExtras.h"
24 #include "Support/STLExtras.h"
32 class CWriter : public Pass, public InstVisitor<CWriter> {
34 SlotCalculator *Table;
35 const Module *TheModule;
36 map<const Type *, string> TypeNames;
37 std::set<const Value*> MangledGlobals;
39 map<const ConstantFP *, unsigned> FPConstantMap;
41 CWriter(ostream &o) : Out(o) {}
43 void getAnalysisUsage(AnalysisUsage &AU) const {
45 AU.addRequired<FindUsedTypes>();
48 virtual bool run(Module &M) {
50 Table = new SlotCalculator(&M, false);
53 // Ensure that all structure types have names...
54 bool Changed = nameAllUsedStructureTypes(M);
62 MangledGlobals.clear();
66 ostream &printType(const Type *Ty, const string &VariableName = "",
67 bool IgnoreName = false, bool namedContext = true);
69 void writeOperand(Value *Operand);
70 void writeOperandInternal(Value *Operand);
72 string getValueName(const Value *V);
75 bool nameAllUsedStructureTypes(Module &M);
76 void printModule(Module *M);
77 void printSymbolTable(const SymbolTable &ST);
78 void printContainedStructs(const Type *Ty, std::set<const StructType *> &);
79 void printGlobal(const GlobalVariable *GV);
80 void printFunctionSignature(const Function *F, bool Prototype);
82 void printFunction(Function *);
84 void printConstant(Constant *CPV);
85 void printConstantArray(ConstantArray *CPA);
87 // isInlinableInst - Attempt to inline instructions into their uses to build
88 // trees as much as possible. To do this, we have to consistently decide
89 // what is acceptable to inline, so that variable declarations don't get
90 // printed and an extra copy of the expr is not emitted.
92 static bool isInlinableInst(const Instruction &I) {
93 // Must be an expression, must be used exactly once. If it is dead, we
94 // emit it inline where it would go.
95 if (I.getType() == Type::VoidTy || I.use_size() != 1 ||
96 isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I))
99 // Only inline instruction it it's use is in the same BB as the inst.
100 return I.getParent() == cast<Instruction>(I.use_back())->getParent();
103 // Instruction visitation functions
104 friend class InstVisitor<CWriter>;
106 void visitReturnInst(ReturnInst &I);
107 void visitBranchInst(BranchInst &I);
109 void visitPHINode(PHINode &I) {}
110 void visitBinaryOperator(Instruction &I);
112 void visitCastInst (CastInst &I);
113 void visitCallInst (CallInst &I);
114 void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
116 void visitMallocInst(MallocInst &I);
117 void visitAllocaInst(AllocaInst &I);
118 void visitFreeInst (FreeInst &I);
119 void visitLoadInst (LoadInst &I);
120 void visitStoreInst (StoreInst &I);
121 void visitGetElementPtrInst(GetElementPtrInst &I);
123 void visitInstruction(Instruction &I) {
124 std::cerr << "C Writer does not know about " << I;
128 void outputLValue(Instruction *I) {
129 Out << " " << getValueName(I) << " = ";
131 void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
133 void printIndexingExpression(Value *Ptr, User::op_iterator I,
134 User::op_iterator E);
138 // We dont want identifier names with ., space, - in them.
139 // So we replace them with _
140 static string makeNameProper(string x) {
142 for (string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
144 case '.': tmp += "d_"; break;
145 case ' ': tmp += "s_"; break;
146 case '-': tmp += "D_"; break;
153 string CWriter::getValueName(const Value *V) {
154 if (V->hasName()) { // Print out the label if it exists...
155 if (isa<GlobalValue>(V) && // Do not mangle globals...
156 cast<GlobalValue>(V)->hasExternalLinkage() && // Unless it's internal or
157 !MangledGlobals.count(V)) // Unless the name would collide if we don't
158 return makeNameProper(V->getName());
160 return "l" + utostr(V->getType()->getUniqueID()) + "_" +
161 makeNameProper(V->getName());
164 int Slot = Table->getValSlot(V);
165 assert(Slot >= 0 && "Invalid value!");
166 return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
169 // A pointer type should not use parens around *'s alone, e.g., (**)
170 inline bool ptrTypeNameNeedsParens(const string &NameSoFar) {
171 return (NameSoFar.find_last_not_of('*') != std::string::npos);
174 // Pass the Type* and the variable name and this prints out the variable
177 ostream &CWriter::printType(const Type *Ty, const string &NameSoFar,
178 bool IgnoreName, bool namedContext) {
179 if (Ty->isPrimitiveType())
180 switch (Ty->getPrimitiveID()) {
181 case Type::VoidTyID: return Out << "void " << NameSoFar;
182 case Type::BoolTyID: return Out << "bool " << NameSoFar;
183 case Type::UByteTyID: return Out << "unsigned char " << NameSoFar;
184 case Type::SByteTyID: return Out << "signed char " << NameSoFar;
185 case Type::UShortTyID: return Out << "unsigned short " << NameSoFar;
186 case Type::ShortTyID: return Out << "short " << NameSoFar;
187 case Type::UIntTyID: return Out << "unsigned " << NameSoFar;
188 case Type::IntTyID: return Out << "int " << NameSoFar;
189 case Type::ULongTyID: return Out << "unsigned long long " << NameSoFar;
190 case Type::LongTyID: return Out << "signed long long " << NameSoFar;
191 case Type::FloatTyID: return Out << "float " << NameSoFar;
192 case Type::DoubleTyID: return Out << "double " << NameSoFar;
194 std::cerr << "Unknown primitive type: " << Ty << "\n";
198 // Check to see if the type is named.
200 map<const Type *, string>::iterator I = TypeNames.find(Ty);
201 if (I != TypeNames.end()) {
202 return Out << I->second << " " << NameSoFar;
206 switch (Ty->getPrimitiveID()) {
207 case Type::FunctionTyID: {
208 const FunctionType *MTy = cast<FunctionType>(Ty);
209 printType(MTy->getReturnType(), "");
210 Out << " " << NameSoFar << " (";
212 for (FunctionType::ParamTypes::const_iterator
213 I = MTy->getParamTypes().begin(),
214 E = MTy->getParamTypes().end(); I != E; ++I) {
215 if (I != MTy->getParamTypes().begin())
219 if (MTy->isVarArg()) {
220 if (!MTy->getParamTypes().empty())
226 case Type::StructTyID: {
227 const StructType *STy = cast<StructType>(Ty);
228 Out << NameSoFar + " {\n";
230 for (StructType::ElementTypes::const_iterator
231 I = STy->getElementTypes().begin(),
232 E = STy->getElementTypes().end(); I != E; ++I) {
234 printType(*I, "field" + utostr(Idx++));
240 case Type::PointerTyID: {
241 const PointerType *PTy = cast<PointerType>(Ty);
242 std::string ptrName = "*" + NameSoFar;
244 // Do not need parens around "* NameSoFar" if NameSoFar consists only
245 // of zero or more '*' chars *and* this is not an unnamed pointer type
246 // such as the result type in a cast statement. Otherwise, enclose in ( ).
247 if (ptrTypeNameNeedsParens(NameSoFar) || !namedContext ||
248 PTy->getElementType()->getPrimitiveID() == Type::ArrayTyID)
249 ptrName = "(" + ptrName + ")"; //
251 return printType(PTy->getElementType(), ptrName);
254 case Type::ArrayTyID: {
255 const ArrayType *ATy = cast<ArrayType>(Ty);
256 unsigned NumElements = ATy->getNumElements();
257 return printType(ATy->getElementType(),
258 NameSoFar + "[" + utostr(NumElements) + "]");
261 assert(0 && "Unhandled case in getTypeProps!");
268 void CWriter::printConstantArray(ConstantArray *CPA) {
270 // As a special case, print the array as a string if it is an array of
271 // ubytes or an array of sbytes with positive values.
273 const Type *ETy = CPA->getType()->getElementType();
274 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
276 // Make sure the last character is a null char, as automatically added by C
277 if (CPA->getNumOperands() == 0 ||
278 !cast<Constant>(*(CPA->op_end()-1))->isNullValue())
283 // Do not include the last character, which we know is null
284 for (unsigned i = 0, e = CPA->getNumOperands()-1; i != e; ++i) {
285 unsigned char C = (ETy == Type::SByteTy) ?
286 (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
287 (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
296 case '\n': Out << "\\n"; break;
297 case '\t': Out << "\\t"; break;
298 case '\r': Out << "\\r"; break;
299 case '\v': Out << "\\v"; break;
300 case '\a': Out << "\\a"; break;
301 case '\"': Out << "\\\""; break;
302 case '\'': Out << "\\\'"; break;
305 Out << ( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A');
306 Out << ((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A');
314 if (CPA->getNumOperands()) {
316 printConstant(cast<Constant>(CPA->getOperand(0)));
317 for (unsigned i = 1, e = CPA->getNumOperands(); i != e; ++i) {
319 printConstant(cast<Constant>(CPA->getOperand(i)));
327 // printConstant - The LLVM Constant to C Constant converter.
328 void CWriter::printConstant(Constant *CPV) {
329 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
330 switch (CE->getOpcode()) {
331 case Instruction::Cast:
333 printType(CPV->getType());
335 printConstant(cast<Constant>(CPV->getOperand(0)));
339 case Instruction::GetElementPtr:
341 printIndexingExpression(CPV->getOperand(0),
342 CPV->op_begin()+1, CPV->op_end());
345 case Instruction::Add:
347 printConstant(cast<Constant>(CPV->getOperand(0)));
349 printConstant(cast<Constant>(CPV->getOperand(1)));
352 case Instruction::Sub:
354 printConstant(cast<Constant>(CPV->getOperand(0)));
356 printConstant(cast<Constant>(CPV->getOperand(1)));
361 std::cerr << "CWriter Error: Unhandled constant expression: "
367 switch (CPV->getType()->getPrimitiveID()) {
369 Out << (CPV == ConstantBool::False ? "0" : "1"); break;
370 case Type::SByteTyID:
371 case Type::ShortTyID:
373 Out << cast<ConstantSInt>(CPV)->getValue(); break;
375 Out << cast<ConstantSInt>(CPV)->getValue() << "ll"; break;
377 case Type::UByteTyID:
378 case Type::UShortTyID:
379 Out << cast<ConstantUInt>(CPV)->getValue(); break;
381 Out << cast<ConstantUInt>(CPV)->getValue() << "u"; break;
382 case Type::ULongTyID:
383 Out << cast<ConstantUInt>(CPV)->getValue() << "ull"; break;
385 case Type::FloatTyID:
386 case Type::DoubleTyID: {
387 ConstantFP *FPC = cast<ConstantFP>(CPV);
388 map<const ConstantFP *, unsigned>::iterator I = FPConstantMap.find(FPC);
389 if (I != FPConstantMap.end()) {
390 // Because of FP precision problems we must load from a stack allocated
391 // value that holds the value in hex.
392 Out << "(*(" << (FPC->getType() == Type::FloatTy ? "float" : "double")
393 << "*)&FloatConstant" << I->second << ")";
395 Out << FPC->getValue();
400 case Type::ArrayTyID:
401 printConstantArray(cast<ConstantArray>(CPV));
404 case Type::StructTyID: {
406 if (CPV->getNumOperands()) {
408 printConstant(cast<Constant>(CPV->getOperand(0)));
409 for (unsigned i = 1, e = CPV->getNumOperands(); i != e; ++i) {
411 printConstant(cast<Constant>(CPV->getOperand(i)));
418 case Type::PointerTyID:
419 if (isa<ConstantPointerNull>(CPV)) {
421 printType(CPV->getType(), "");
424 } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CPV)) {
425 writeOperand(CPR->getValue());
430 std::cerr << "Unknown constant type: " << CPV << "\n";
435 void CWriter::writeOperandInternal(Value *Operand) {
436 if (Instruction *I = dyn_cast<Instruction>(Operand))
437 if (isInlinableInst(*I)) {
438 // Should we inline this instruction to build a tree?
445 if (Operand->hasName()) {
446 Out << getValueName(Operand);
447 } else if (Constant *CPV = dyn_cast<Constant>(Operand)) {
450 int Slot = Table->getValSlot(Operand);
451 assert(Slot >= 0 && "Malformed LLVM!");
452 Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
456 void CWriter::writeOperand(Value *Operand) {
457 if (isa<GlobalVariable>(Operand))
458 Out << "(&"; // Global variables are references as their addresses by llvm
460 writeOperandInternal(Operand);
462 if (isa<GlobalVariable>(Operand))
466 // nameAllUsedStructureTypes - If there are structure types in the module that
467 // are used but do not have names assigned to them in the symbol table yet then
468 // we assign them names now.
470 bool CWriter::nameAllUsedStructureTypes(Module &M) {
471 // Get a set of types that are used by the program...
472 std::set<const Type *> UT = getAnalysis<FindUsedTypes>().getTypes();
474 // Loop over the module symbol table, removing types from UT that are already
477 SymbolTable *MST = M.getSymbolTableSure();
478 if (MST->find(Type::TypeTy) != MST->end())
479 for (SymbolTable::type_iterator I = MST->type_begin(Type::TypeTy),
480 E = MST->type_end(Type::TypeTy); I != E; ++I)
481 UT.erase(cast<Type>(I->second));
483 // UT now contains types that are not named. Loop over it, naming structure
486 bool Changed = false;
487 for (std::set<const Type *>::const_iterator I = UT.begin(), E = UT.end();
489 if (const StructType *ST = dyn_cast<StructType>(*I)) {
490 ((Value*)ST)->setName("unnamed", MST);
496 void CWriter::printModule(Module *M) {
497 // Calculate which global values have names that will collide when we throw
498 // away type information.
499 { // Scope to delete the FoundNames set when we are done with it...
500 std::set<string> FoundNames;
501 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
502 if (I->hasName()) // If the global has a name...
503 if (FoundNames.count(I->getName())) // And the name is already used
504 MangledGlobals.insert(I); // Mangle the name
506 FoundNames.insert(I->getName()); // Otherwise, keep track of name
508 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
509 if (I->hasName()) // If the global has a name...
510 if (FoundNames.count(I->getName())) // And the name is already used
511 MangledGlobals.insert(I); // Mangle the name
513 FoundNames.insert(I->getName()); // Otherwise, keep track of name
516 // printing stdlib inclusion
517 //Out << "#include <stdlib.h>\n";
519 // get declaration for alloca
520 Out << "/* Provide Declarations */\n"
521 << "#include <alloca.h>\n\n"
523 // Provide a definition for null if one does not already exist,
524 // and for `bool' if not compiling with a C++ compiler.
525 << "#ifndef NULL\n#define NULL 0\n#endif\n\n"
526 << "#ifndef __cplusplus\ntypedef unsigned char bool;\n#endif\n"
528 << "\n\n/* Support for floating point constants */\n"
529 << "typedef unsigned long long ConstantDoubleTy;\n"
531 << "\n\n/* Global Declarations */\n";
533 // First output all the declarations for the program, because C requires
534 // Functions & globals to be declared before they are used.
537 // Loop over the symbol table, emitting all named constants...
538 if (M->hasSymbolTable())
539 printSymbolTable(*M->getSymbolTable());
541 // Global variable declarations...
543 Out << "\n/* External Global Variable Declarations */\n";
544 // Needed for malloc to work on sun.
545 Out << "extern void * malloc(size_t);\n";
546 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
547 if (I->hasExternalLinkage()) {
549 printType(I->getType()->getElementType(), getValueName(I));
555 // Function declarations
557 Out << "\n/* Function Declarations */\n";
558 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) {
559 printFunctionSignature(I, true);
564 // Output the global variable definitions and contents...
566 Out << "\n\n/* Global Variable Definitions and Initialization */\n";
567 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
568 if (I->hasInternalLinkage())
570 printType(I->getType()->getElementType(), getValueName(I));
572 if (I->hasInitializer()) {
574 writeOperand(I->getInitializer());
580 // Output all of the functions...
582 Out << "\n\n/* Function Bodies */\n";
583 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
589 /// printSymbolTable - Run through symbol table looking for type names. If a
590 /// type name is found, emit it's declaration...
592 void CWriter::printSymbolTable(const SymbolTable &ST) {
593 // If there are no type names, exit early.
594 if (ST.find(Type::TypeTy) == ST.end())
597 // We are only interested in the type plane of the symbol table...
598 SymbolTable::type_const_iterator I = ST.type_begin(Type::TypeTy);
599 SymbolTable::type_const_iterator End = ST.type_end(Type::TypeTy);
601 // Print out forward declarations for structure types before anything else!
602 Out << "/* Structure forward decls */\n";
603 for (; I != End; ++I)
604 if (const Type *STy = dyn_cast<StructType>(I->second)) {
605 string Name = "struct l_" + makeNameProper(I->first);
606 Out << Name << ";\n";
607 TypeNames.insert(std::make_pair(STy, Name));
612 // Now we can print out typedefs...
613 Out << "/* Typedefs */\n";
614 for (I = ST.type_begin(Type::TypeTy); I != End; ++I) {
615 const Type *Ty = cast<Type>(I->second);
616 string Name = "l_" + makeNameProper(I->first);
624 // Keep track of which structures have been printed so far...
625 std::set<const StructType *> StructPrinted;
627 // Loop over all structures then push them into the stack so they are
628 // printed in the correct order.
630 Out << "/* Structure contents */\n";
631 for (I = ST.type_begin(Type::TypeTy); I != End; ++I)
632 if (const StructType *STy = dyn_cast<StructType>(I->second))
633 printContainedStructs(STy, StructPrinted);
636 // Push the struct onto the stack and recursively push all structs
637 // this one depends on.
638 void CWriter::printContainedStructs(const Type *Ty,
639 std::set<const StructType*> &StructPrinted){
640 if (const StructType *STy = dyn_cast<StructType>(Ty)){
641 //Check to see if we have already printed this struct
642 if (StructPrinted.count(STy) == 0) {
643 // Print all contained types first...
644 for (StructType::ElementTypes::const_iterator
645 I = STy->getElementTypes().begin(),
646 E = STy->getElementTypes().end(); I != E; ++I) {
647 const Type *Ty1 = I->get();
648 if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
649 printContainedStructs(Ty1, StructPrinted);
652 //Print structure type out..
653 StructPrinted.insert(STy);
654 string Name = TypeNames[STy];
655 printType(STy, Name, true);
659 // If it is an array, check contained types and continue
660 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)){
661 const Type *Ty1 = ATy->getElementType();
662 if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
663 printContainedStructs(Ty1, StructPrinted);
668 void CWriter::printFunctionSignature(const Function *F, bool Prototype) {
669 if (F->hasInternalLinkage()) Out << "static ";
671 // Loop over the arguments, printing them...
672 const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
674 // Print out the return type and name...
675 printType(F->getReturnType());
676 Out << getValueName(F) << "(";
678 if (!F->isExternal()) {
681 if (F->abegin()->hasName() || !Prototype)
682 ArgName = getValueName(F->abegin());
684 printType(F->afront().getType(), ArgName);
686 for (Function::const_aiterator I = ++F->abegin(), E = F->aend();
689 if (I->hasName() || !Prototype)
690 ArgName = getValueName(I);
693 printType(I->getType(), ArgName);
697 // Loop over the arguments, printing them...
698 for (FunctionType::ParamTypes::const_iterator I =
699 FT->getParamTypes().begin(),
700 E = FT->getParamTypes().end(); I != E; ++I) {
701 if (I != FT->getParamTypes().begin()) Out << ", ";
706 // Finish printing arguments... if this is a vararg function, print the ...,
707 // unless there are no known types, in which case, we just emit ().
709 if (FT->isVarArg() && !FT->getParamTypes().empty()) {
710 if (FT->getParamTypes().size()) Out << ", ";
711 Out << "..."; // Output varargs portion of signature!
717 void CWriter::printFunction(Function *F) {
718 if (F->isExternal()) return;
720 Table->incorporateFunction(F);
722 printFunctionSignature(F, false);
725 // print local variable information for the function
726 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
727 if ((*I)->getType() != Type::VoidTy && !isInlinableInst(**I)) {
729 printType((*I)->getType(), getValueName(*I));
735 // Scan the function for floating point constants. If any FP constant is used
736 // in the function, we want to redirect it here so that we do not depend on
737 // the precision of the printed form.
739 unsigned FPCounter = 0;
740 for (constant_iterator I = constant_begin(F), E = constant_end(F); I != E;++I)
741 if (const ConstantFP *FPC = dyn_cast<ConstantFP>(*I))
742 if (FPConstantMap.find(FPC) == FPConstantMap.end()) {
743 double Val = FPC->getValue();
745 FPConstantMap[FPC] = FPCounter; // Number the FP constants
746 Out << " const ConstantDoubleTy FloatConstant" << FPCounter++
747 << " = 0x" << std::hex << *(unsigned long long*)&Val << std::dec
748 << "; /* " << Val << " */\n";
753 // print the basic blocks
754 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
755 BasicBlock *Prev = BB->getPrev();
757 // Don't print the label for the basic block if there are no uses, or if the
758 // only terminator use is the precessor basic block's terminator. We have
759 // to scan the use list because PHI nodes use basic blocks too but do not
760 // require a label to be generated.
762 bool NeedsLabel = false;
763 for (Value::use_iterator UI = BB->use_begin(), UE = BB->use_end();
765 if (TerminatorInst *TI = dyn_cast<TerminatorInst>(*UI))
766 if (TI != Prev->getTerminator()) {
771 if (NeedsLabel) Out << getValueName(BB) << ":\n";
773 // Output all of the instructions in the basic block...
774 for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E; ++II){
775 if (!isInlinableInst(*II) && !isa<PHINode>(*II)) {
776 if (II->getType() != Type::VoidTy)
785 // Don't emit prefix or suffix for the terminator...
786 visit(*BB->getTerminator());
790 Table->purgeFunction();
791 FPConstantMap.clear();
794 // Specific Instruction type classes... note that all of the casts are
795 // neccesary because we use the instruction classes as opaque types...
797 void CWriter::visitReturnInst(ReturnInst &I) {
798 // Don't output a void return if this is the last basic block in the function
799 if (I.getNumOperands() == 0 &&
800 &*--I.getParent()->getParent()->end() == I.getParent() &&
801 !I.getParent()->size() == 1) {
806 if (I.getNumOperands()) {
808 writeOperand(I.getOperand(0));
813 static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
814 // If PHI nodes need copies, we need the copy code...
815 if (isa<PHINode>(To->front()) ||
816 From->getNext() != To) // Not directly successor, need goto
819 // Otherwise we don't need the code.
823 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
825 for (BasicBlock::iterator I = Succ->begin();
826 PHINode *PN = dyn_cast<PHINode>(&*I); ++I) {
827 // now we have to do the printing
828 Out << string(Indent, ' ');
830 writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
831 Out << "; /* for PHI node */\n";
834 if (CurBB->getNext() != Succ) {
835 Out << string(Indent, ' ') << " goto ";
841 // Brach instruction printing - Avoid printing out a brach to a basic block that
842 // immediately succeeds the current one.
844 void CWriter::visitBranchInst(BranchInst &I) {
845 if (I.isConditional()) {
846 if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(0))) {
848 writeOperand(I.getCondition());
851 printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
853 if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(1))) {
854 Out << " } else {\n";
855 printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
858 // First goto not neccesary, assume second one is...
860 writeOperand(I.getCondition());
863 printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
868 printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
874 void CWriter::visitBinaryOperator(Instruction &I) {
875 // binary instructions, shift instructions, setCond instructions.
876 if (isa<PointerType>(I.getType())) {
878 printType(I.getType());
882 if (isa<PointerType>(I.getType())) Out << "(long long)";
883 writeOperand(I.getOperand(0));
885 switch (I.getOpcode()) {
886 case Instruction::Add: Out << " + "; break;
887 case Instruction::Sub: Out << " - "; break;
888 case Instruction::Mul: Out << "*"; break;
889 case Instruction::Div: Out << "/"; break;
890 case Instruction::Rem: Out << "%"; break;
891 case Instruction::And: Out << " & "; break;
892 case Instruction::Or: Out << " | "; break;
893 case Instruction::Xor: Out << " ^ "; break;
894 case Instruction::SetEQ: Out << " == "; break;
895 case Instruction::SetNE: Out << " != "; break;
896 case Instruction::SetLE: Out << " <= "; break;
897 case Instruction::SetGE: Out << " >= "; break;
898 case Instruction::SetLT: Out << " < "; break;
899 case Instruction::SetGT: Out << " > "; break;
900 case Instruction::Shl : Out << " << "; break;
901 case Instruction::Shr : Out << " >> "; break;
902 default: std::cerr << "Invalid operator type!" << I; abort();
905 if (isa<PointerType>(I.getType())) Out << "(long long)";
906 writeOperand(I.getOperand(1));
909 void CWriter::visitCastInst(CastInst &I) {
911 printType(I.getType(), string(""),/*ignoreName*/false, /*namedContext*/false);
913 writeOperand(I.getOperand(0));
916 void CWriter::visitCallInst(CallInst &I) {
917 const PointerType *PTy = cast<PointerType>(I.getCalledValue()->getType());
918 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
919 const Type *RetTy = FTy->getReturnType();
921 writeOperand(I.getOperand(0));
924 if (I.getNumOperands() > 1) {
925 writeOperand(I.getOperand(1));
927 for (unsigned op = 2, Eop = I.getNumOperands(); op != Eop; ++op) {
929 writeOperand(I.getOperand(op));
935 void CWriter::visitMallocInst(MallocInst &I) {
937 printType(I.getType());
938 Out << ")malloc(sizeof(";
939 printType(I.getType()->getElementType());
942 if (I.isArrayAllocation()) {
944 writeOperand(I.getOperand(0));
949 void CWriter::visitAllocaInst(AllocaInst &I) {
951 printType(I.getType());
952 Out << ") alloca(sizeof(";
953 printType(I.getType()->getElementType());
955 if (I.isArrayAllocation()) {
957 writeOperand(I.getOperand(0));
962 void CWriter::visitFreeInst(FreeInst &I) {
964 writeOperand(I.getOperand(0));
968 void CWriter::printIndexingExpression(Value *Ptr, User::op_iterator I,
969 User::op_iterator E) {
970 bool HasImplicitAddress = false;
971 // If accessing a global value with no indexing, avoid *(&GV) syndrome
972 if (GlobalValue *V = dyn_cast<GlobalValue>(Ptr)) {
973 HasImplicitAddress = true;
974 } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Ptr)) {
975 HasImplicitAddress = true;
976 Ptr = CPR->getValue(); // Get to the global...
980 if (!HasImplicitAddress)
981 Out << "*"; // Implicit zero first argument: '*x' is equivalent to 'x[0]'
983 writeOperandInternal(Ptr);
987 const Constant *CI = dyn_cast<Constant>(I->get());
988 if (HasImplicitAddress && (!CI || !CI->isNullValue()))
991 writeOperandInternal(Ptr);
993 if (HasImplicitAddress && (!CI || !CI->isNullValue())) {
995 HasImplicitAddress = false; // HIA is only true if we haven't addressed yet
998 assert(!HasImplicitAddress || (CI && CI->isNullValue()) &&
999 "Can only have implicit address with direct accessing");
1001 if (HasImplicitAddress) {
1003 } else if (CI && CI->isNullValue() && I+1 != E) {
1004 // Print out the -> operator if possible...
1005 if ((*(I+1))->getType() == Type::UByteTy) {
1006 Out << (HasImplicitAddress ? "." : "->");
1007 Out << "field" << cast<ConstantUInt>(*(I+1))->getValue();
1013 if ((*I)->getType() == Type::LongTy) {
1018 Out << ".field" << cast<ConstantUInt>(*I)->getValue();
1022 void CWriter::visitLoadInst(LoadInst &I) {
1024 writeOperand(I.getOperand(0));
1027 void CWriter::visitStoreInst(StoreInst &I) {
1029 writeOperand(I.getPointerOperand());
1031 writeOperand(I.getOperand(0));
1034 void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
1036 printIndexingExpression(I.getPointerOperand(), I.idx_begin(), I.idx_end());
1039 //===----------------------------------------------------------------------===//
1040 // External Interface declaration
1041 //===----------------------------------------------------------------------===//
1043 Pass *createWriteToCPass(std::ostream &o) { return new CWriter(o); }