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/Instructions.h"
12 #include "llvm/Pass.h"
13 #include "llvm/SymbolTable.h"
14 #include "llvm/Intrinsics.h"
15 #include "llvm/SlotCalculator.h"
16 #include "llvm/Analysis/FindUsedTypes.h"
17 #include "llvm/Analysis/ConstantsScanner.h"
18 #include "llvm/Support/InstVisitor.h"
19 #include "llvm/Support/InstIterator.h"
20 #include "llvm/Support/CallSite.h"
21 #include "Support/StringExtras.h"
22 #include "Support/STLExtras.h"
28 class CWriter : public Pass, public InstVisitor<CWriter> {
30 SlotCalculator *Table;
31 const Module *TheModule;
32 std::map<const Type *, std::string> TypeNames;
33 std::set<const Value*> MangledGlobals;
34 bool needsMalloc, emittedInvoke;
36 std::map<const ConstantFP *, unsigned> FPConstantMap;
38 CWriter(std::ostream &o) : Out(o) {}
40 void getAnalysisUsage(AnalysisUsage &AU) const {
42 AU.addRequired<FindUsedTypes>();
45 virtual bool run(Module &M) {
47 Table = new SlotCalculator(&M, false);
50 // Ensure that all structure types have names...
51 bool Changed = nameAllUsedStructureTypes(M);
59 MangledGlobals.clear();
63 std::ostream &printType(std::ostream &Out, const Type *Ty,
64 const std::string &VariableName = "",
65 bool IgnoreName = false, bool namedContext = true);
67 void writeOperand(Value *Operand);
68 void writeOperandInternal(Value *Operand);
70 std::string getValueName(const Value *V);
73 bool nameAllUsedStructureTypes(Module &M);
74 void printModule(Module *M);
75 void printSymbolTable(const SymbolTable &ST);
76 void printContainedStructs(const Type *Ty, std::set<const StructType *> &);
77 void printFunctionSignature(const Function *F, bool Prototype);
79 void printFunction(Function *);
81 void printConstant(Constant *CPV);
82 void printConstantArray(ConstantArray *CPA);
84 // isInlinableInst - Attempt to inline instructions into their uses to build
85 // trees as much as possible. To do this, we have to consistently decide
86 // what is acceptable to inline, so that variable declarations don't get
87 // printed and an extra copy of the expr is not emitted.
89 static bool isInlinableInst(const Instruction &I) {
90 // Must be an expression, must be used exactly once. If it is dead, we
91 // emit it inline where it would go.
92 if (I.getType() == Type::VoidTy || I.use_size() != 1 ||
93 isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I) ||
94 isa<LoadInst>(I)) // Don't inline a load across a store!
97 // Only inline instruction it it's use is in the same BB as the inst.
98 return I.getParent() == cast<Instruction>(I.use_back())->getParent();
101 // isDirectAlloca - Define fixed sized allocas in the entry block as direct
102 // variables which are accessed with the & operator. This causes GCC to
103 // generate significantly better code than to emit alloca calls directly.
105 static const AllocaInst *isDirectAlloca(const Value *V) {
106 const AllocaInst *AI = dyn_cast<AllocaInst>(V);
107 if (!AI) return false;
108 if (AI->isArrayAllocation())
109 return 0; // FIXME: we can also inline fixed size array allocas!
110 if (AI->getParent() != &AI->getParent()->getParent()->getEntryNode())
115 // Instruction visitation functions
116 friend class InstVisitor<CWriter>;
118 void visitReturnInst(ReturnInst &I);
119 void visitBranchInst(BranchInst &I);
120 void visitSwitchInst(SwitchInst &I);
121 void visitInvokeInst(InvokeInst &I);
123 void visitPHINode(PHINode &I);
124 void visitBinaryOperator(Instruction &I);
126 void visitCastInst (CastInst &I);
127 void visitCallInst (CallInst &I);
128 void visitCallSite (CallSite CS);
129 void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
131 void visitMallocInst(MallocInst &I);
132 void visitAllocaInst(AllocaInst &I);
133 void visitFreeInst (FreeInst &I);
134 void visitLoadInst (LoadInst &I);
135 void visitStoreInst (StoreInst &I);
136 void visitGetElementPtrInst(GetElementPtrInst &I);
137 void visitVarArgInst(VarArgInst &I);
139 void visitInstruction(Instruction &I) {
140 std::cerr << "C Writer does not know about " << I;
144 void outputLValue(Instruction *I) {
145 Out << " " << getValueName(I) << " = ";
147 void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
149 void printIndexingExpression(Value *Ptr, User::op_iterator I,
150 User::op_iterator E);
154 // We dont want identifier names with ., space, - in them.
155 // So we replace them with _
156 static std::string makeNameProper(std::string x) {
158 for (std::string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
160 case '.': tmp += "d_"; break;
161 case ' ': tmp += "s_"; break;
162 case '-': tmp += "D_"; break;
169 std::string CWriter::getValueName(const Value *V) {
170 if (V->hasName()) { // Print out the label if it exists...
172 // Name mangling occurs as follows:
173 // - If V is not a global, mangling always occurs.
174 // - Otherwise, mangling occurs when any of the following are true:
175 // 1) V has internal linkage
176 // 2) V's name would collide if it is not mangled.
179 if(const GlobalValue* gv = dyn_cast<GlobalValue>(V)) {
180 if(!gv->hasInternalLinkage() && !MangledGlobals.count(gv)) {
181 // No internal linkage, name will not collide -> no mangling.
182 return makeNameProper(gv->getName());
186 // Non-global, or global with internal linkage / colliding name -> mangle.
187 return "l" + utostr(V->getType()->getUniqueID()) + "_" +
188 makeNameProper(V->getName());
191 int Slot = Table->getValSlot(V);
192 assert(Slot >= 0 && "Invalid value!");
193 return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
196 // A pointer type should not use parens around *'s alone, e.g., (**)
197 inline bool ptrTypeNameNeedsParens(const std::string &NameSoFar) {
198 return (NameSoFar.find_last_not_of('*') != std::string::npos);
201 // Pass the Type* and the variable name and this prints out the variable
204 std::ostream &CWriter::printType(std::ostream &Out, const Type *Ty,
205 const std::string &NameSoFar,
206 bool IgnoreName, bool namedContext) {
207 if (Ty->isPrimitiveType())
208 switch (Ty->getPrimitiveID()) {
209 case Type::VoidTyID: return Out << "void " << NameSoFar;
210 case Type::BoolTyID: return Out << "bool " << NameSoFar;
211 case Type::UByteTyID: return Out << "unsigned char " << NameSoFar;
212 case Type::SByteTyID: return Out << "signed char " << NameSoFar;
213 case Type::UShortTyID: return Out << "unsigned short " << NameSoFar;
214 case Type::ShortTyID: return Out << "short " << NameSoFar;
215 case Type::UIntTyID: return Out << "unsigned " << NameSoFar;
216 case Type::IntTyID: return Out << "int " << NameSoFar;
217 case Type::ULongTyID: return Out << "unsigned long long " << NameSoFar;
218 case Type::LongTyID: return Out << "signed long long " << NameSoFar;
219 case Type::FloatTyID: return Out << "float " << NameSoFar;
220 case Type::DoubleTyID: return Out << "double " << NameSoFar;
222 std::cerr << "Unknown primitive type: " << Ty << "\n";
226 // Check to see if the type is named.
227 if (!IgnoreName || isa<OpaqueType>(Ty)) {
228 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
229 if (I != TypeNames.end()) {
230 return Out << I->second << " " << NameSoFar;
234 switch (Ty->getPrimitiveID()) {
235 case Type::FunctionTyID: {
236 const FunctionType *MTy = cast<FunctionType>(Ty);
237 std::stringstream FunctionInnards;
238 FunctionInnards << " (" << NameSoFar << ") (";
239 for (FunctionType::ParamTypes::const_iterator
240 I = MTy->getParamTypes().begin(),
241 E = MTy->getParamTypes().end(); I != E; ++I) {
242 if (I != MTy->getParamTypes().begin())
243 FunctionInnards << ", ";
244 printType(FunctionInnards, *I, "");
246 if (MTy->isVarArg()) {
247 if (!MTy->getParamTypes().empty())
248 FunctionInnards << ", ...";
249 } else if (MTy->getParamTypes().empty()) {
250 FunctionInnards << "void";
252 FunctionInnards << ")";
253 std::string tstr = FunctionInnards.str();
254 printType(Out, MTy->getReturnType(), tstr);
257 case Type::StructTyID: {
258 const StructType *STy = cast<StructType>(Ty);
259 Out << NameSoFar + " {\n";
261 for (StructType::ElementTypes::const_iterator
262 I = STy->getElementTypes().begin(),
263 E = STy->getElementTypes().end(); I != E; ++I) {
265 printType(Out, *I, "field" + utostr(Idx++));
271 case Type::PointerTyID: {
272 const PointerType *PTy = cast<PointerType>(Ty);
273 std::string ptrName = "*" + NameSoFar;
275 // Do not need parens around "* NameSoFar" if NameSoFar consists only
276 // of zero or more '*' chars *and* this is not an unnamed pointer type
277 // such as the result type in a cast statement. Otherwise, enclose in ( ).
278 if (ptrTypeNameNeedsParens(NameSoFar) || !namedContext ||
279 PTy->getElementType()->getPrimitiveID() == Type::ArrayTyID)
280 ptrName = "(" + ptrName + ")"; //
282 return printType(Out, PTy->getElementType(), ptrName);
285 case Type::ArrayTyID: {
286 const ArrayType *ATy = cast<ArrayType>(Ty);
287 unsigned NumElements = ATy->getNumElements();
288 return printType(Out, ATy->getElementType(),
289 NameSoFar + "[" + utostr(NumElements) + "]");
292 case Type::OpaqueTyID: {
293 static int Count = 0;
294 std::string TyName = "struct opaque_" + itostr(Count++);
295 assert(TypeNames.find(Ty) == TypeNames.end());
296 TypeNames[Ty] = TyName;
297 return Out << TyName << " " << NameSoFar;
300 assert(0 && "Unhandled case in getTypeProps!");
307 void CWriter::printConstantArray(ConstantArray *CPA) {
309 // As a special case, print the array as a string if it is an array of
310 // ubytes or an array of sbytes with positive values.
312 const Type *ETy = CPA->getType()->getElementType();
313 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
315 // Make sure the last character is a null char, as automatically added by C
316 if (isString && (CPA->getNumOperands() == 0 ||
317 !cast<Constant>(*(CPA->op_end()-1))->isNullValue()))
322 // Keep track of whether the last number was a hexadecimal escape
323 bool LastWasHex = false;
325 // Do not include the last character, which we know is null
326 for (unsigned i = 0, e = CPA->getNumOperands()-1; i != e; ++i) {
327 unsigned char C = cast<ConstantInt>(CPA->getOperand(i))->getRawValue();
329 // Print it out literally if it is a printable character. The only thing
330 // to be careful about is when the last letter output was a hex escape
331 // code, in which case we have to be careful not to print out hex digits
332 // explicitly (the C compiler thinks it is a continuation of the previous
333 // character, sheesh...)
335 if (isprint(C) && (!LastWasHex || !isxdigit(C))) {
337 if (C == '"' || C == '\\')
344 case '\n': Out << "\\n"; break;
345 case '\t': Out << "\\t"; break;
346 case '\r': Out << "\\r"; break;
347 case '\v': Out << "\\v"; break;
348 case '\a': Out << "\\a"; break;
349 case '\"': Out << "\\\""; break;
350 case '\'': Out << "\\\'"; break;
353 Out << (char)(( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'));
354 Out << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
363 if (CPA->getNumOperands()) {
365 printConstant(cast<Constant>(CPA->getOperand(0)));
366 for (unsigned i = 1, e = CPA->getNumOperands(); i != e; ++i) {
368 printConstant(cast<Constant>(CPA->getOperand(i)));
375 /// FPCSafeToPrint - Returns true if we may assume that CFP may be
376 /// written out textually as a double (rather than as a reference to a
377 /// stack-allocated variable). We decide this by converting CFP to a
378 /// string and back into a double, and then checking whether the
379 /// conversion results in a bit-equal double to the original value of
380 /// CFP. This depends on us and the target C compiler agreeing on the
381 /// conversion process (which is pretty likely since we only deal in
382 /// IEEE FP.) This is adapted from similar code in
383 /// lib/VMCore/AsmWriter.cpp:WriteConstantInt().
384 static bool FPCSafeToPrint (const ConstantFP *CFP) {
385 std::string StrVal = ftostr(CFP->getValue());
386 // Check to make sure that the stringized number is not some string like
387 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
388 // the string matches the "[-+]?[0-9]" regex.
389 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
390 ((StrVal[0] == '-' || StrVal[0] == '+') &&
391 (StrVal[1] >= '0' && StrVal[1] <= '9')))
392 // Reparse stringized version!
393 return (atof(StrVal.c_str()) == CFP->getValue());
397 // printConstant - The LLVM Constant to C Constant converter.
398 void CWriter::printConstant(Constant *CPV) {
399 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
400 switch (CE->getOpcode()) {
401 case Instruction::Cast:
403 printType(Out, CPV->getType());
405 printConstant(CE->getOperand(0));
409 case Instruction::GetElementPtr:
411 printIndexingExpression(CE->getOperand(0),
412 CPV->op_begin()+1, CPV->op_end());
415 case Instruction::Add:
417 printConstant(CE->getOperand(0));
419 printConstant(CE->getOperand(1));
422 case Instruction::Sub:
424 printConstant(CE->getOperand(0));
426 printConstant(CE->getOperand(1));
431 std::cerr << "CWriter Error: Unhandled constant expression: "
437 switch (CPV->getType()->getPrimitiveID()) {
439 Out << (CPV == ConstantBool::False ? "0" : "1"); break;
440 case Type::SByteTyID:
441 case Type::ShortTyID:
442 Out << cast<ConstantSInt>(CPV)->getValue(); break;
444 if ((int)cast<ConstantSInt>(CPV)->getValue() == (int)0x80000000)
445 Out << "((int)0x80000000)"; // Handle MININT specially to avoid warning
447 Out << cast<ConstantSInt>(CPV)->getValue();
451 Out << cast<ConstantSInt>(CPV)->getValue() << "ll"; break;
453 case Type::UByteTyID:
454 case Type::UShortTyID:
455 Out << cast<ConstantUInt>(CPV)->getValue(); break;
457 Out << cast<ConstantUInt>(CPV)->getValue() << "u"; break;
458 case Type::ULongTyID:
459 Out << cast<ConstantUInt>(CPV)->getValue() << "ull"; break;
461 case Type::FloatTyID:
462 case Type::DoubleTyID: {
463 ConstantFP *FPC = cast<ConstantFP>(CPV);
464 std::map<const ConstantFP*, unsigned>::iterator I = FPConstantMap.find(FPC);
465 if (I != FPConstantMap.end()) {
466 // Because of FP precision problems we must load from a stack allocated
467 // value that holds the value in hex.
468 Out << "(*(" << (FPC->getType() == Type::FloatTy ? "float" : "double")
469 << "*)&FloatConstant" << I->second << ")";
471 if (FPCSafeToPrint (FPC)) {
472 Out << ftostr (FPC->getValue ());
474 Out << FPC->getValue(); // Who knows? Give it our best shot...
480 case Type::ArrayTyID:
481 printConstantArray(cast<ConstantArray>(CPV));
484 case Type::StructTyID: {
486 if (CPV->getNumOperands()) {
488 printConstant(cast<Constant>(CPV->getOperand(0)));
489 for (unsigned i = 1, e = CPV->getNumOperands(); i != e; ++i) {
491 printConstant(cast<Constant>(CPV->getOperand(i)));
498 case Type::PointerTyID:
499 if (isa<ConstantPointerNull>(CPV)) {
501 printType(Out, CPV->getType());
502 Out << ")/*NULL*/0)";
504 } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CPV)) {
505 writeOperand(CPR->getValue());
510 std::cerr << "Unknown constant type: " << CPV << "\n";
515 void CWriter::writeOperandInternal(Value *Operand) {
516 if (Instruction *I = dyn_cast<Instruction>(Operand))
517 if (isInlinableInst(*I) && !isDirectAlloca(I)) {
518 // Should we inline this instruction to build a tree?
525 if (Operand->hasName()) {
526 Out << getValueName(Operand);
527 } else if (Constant *CPV = dyn_cast<Constant>(Operand)) {
530 int Slot = Table->getValSlot(Operand);
531 assert(Slot >= 0 && "Malformed LLVM!");
532 Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
536 void CWriter::writeOperand(Value *Operand) {
537 if (isa<GlobalVariable>(Operand) || isDirectAlloca(Operand))
538 Out << "(&"; // Global variables are references as their addresses by llvm
540 writeOperandInternal(Operand);
542 if (isa<GlobalVariable>(Operand) || isDirectAlloca(Operand))
546 // nameAllUsedStructureTypes - If there are structure types in the module that
547 // are used but do not have names assigned to them in the symbol table yet then
548 // we assign them names now.
550 bool CWriter::nameAllUsedStructureTypes(Module &M) {
551 // Get a set of types that are used by the program...
552 std::set<const Type *> UT = getAnalysis<FindUsedTypes>().getTypes();
554 // Loop over the module symbol table, removing types from UT that are already
557 SymbolTable &MST = M.getSymbolTable();
558 if (MST.find(Type::TypeTy) != MST.end())
559 for (SymbolTable::type_iterator I = MST.type_begin(Type::TypeTy),
560 E = MST.type_end(Type::TypeTy); I != E; ++I)
561 UT.erase(cast<Type>(I->second));
563 // UT now contains types that are not named. Loop over it, naming structure
566 bool Changed = false;
567 for (std::set<const Type *>::const_iterator I = UT.begin(), E = UT.end();
569 if (const StructType *ST = dyn_cast<StructType>(*I)) {
570 ((Value*)ST)->setName("unnamed", &MST);
576 // generateCompilerSpecificCode - This is where we add conditional compilation
577 // directives to cater to specific compilers as need be.
579 static void generateCompilerSpecificCode(std::ostream& Out) {
580 // Alloca is hard to get, and we don't want to include stdlib.h here...
581 Out << "/* get a declaration for alloca */\n"
583 << "extern void *__builtin_alloca(unsigned long);\n"
584 << "#define alloca(x) __builtin_alloca(x)\n"
586 << "#ifndef __FreeBSD__\n"
587 << "#include <alloca.h>\n"
591 // We output GCC specific attributes to preserve 'linkonce'ness on globals.
592 // If we aren't being compiled with GCC, just drop these attributes.
593 Out << "#ifndef __GNUC__ /* Can only support \"linkonce\" vars with GCC */\n"
594 << "#define __attribute__(X)\n"
598 void CWriter::printModule(Module *M) {
599 // Calculate which global values have names that will collide when we throw
600 // away type information.
601 { // Scope to delete the FoundNames set when we are done with it...
602 std::set<std::string> FoundNames;
603 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
604 if (I->hasName()) // If the global has a name...
605 if (FoundNames.count(I->getName())) // And the name is already used
606 MangledGlobals.insert(I); // Mangle the name
608 FoundNames.insert(I->getName()); // Otherwise, keep track of name
610 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
611 if (I->hasName()) // If the global has a name...
612 if (FoundNames.count(I->getName())) // And the name is already used
613 MangledGlobals.insert(I); // Mangle the name
615 FoundNames.insert(I->getName()); // Otherwise, keep track of name
618 // get declaration for alloca
619 Out << "/* Provide Declarations */\n";
620 Out << "#include <stdarg.h>\n";
621 Out << "#include <setjmp.h>\n";
622 generateCompilerSpecificCode(Out);
624 // Provide a definition for `bool' if not compiling with a C++ compiler.
626 << "#ifndef __cplusplus\ntypedef unsigned char bool;\n#endif\n"
628 << "\n\n/* Support for floating point constants */\n"
629 << "typedef unsigned long long ConstantDoubleTy;\n"
630 << "typedef unsigned int ConstantFloatTy;\n"
632 << "\n\n/* Support for the invoke instruction */\n"
633 << "extern struct __llvm_jmpbuf_list_t {\n"
634 << " jmp_buf buf; struct __llvm_jmpbuf_list_t *next;\n"
635 << "} *__llvm_jmpbuf_list;\n"
637 << "\n\n/* Global Declarations */\n";
639 // First output all the declarations for the program, because C requires
640 // Functions & globals to be declared before they are used.
643 // Loop over the symbol table, emitting all named constants...
644 printSymbolTable(M->getSymbolTable());
646 // Global variable declarations...
648 Out << "\n/* External Global Variable Declarations */\n";
649 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
650 if (I->hasExternalLinkage()) {
652 printType(Out, I->getType()->getElementType(), getValueName(I));
658 // Function declarations
660 Out << "\n/* Function Declarations */\n";
662 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) {
663 // If the function is external and the name collides don't print it.
664 // Sometimes the bytecode likes to have multiple "declarations" for
665 // external functions
666 if ((I->hasInternalLinkage() || !MangledGlobals.count(I)) &&
667 !I->getIntrinsicID()) {
668 printFunctionSignature(I, true);
674 // Print Malloc prototype if needed
676 Out << "\n/* Malloc to make sun happy */\n";
677 Out << "extern void * malloc();\n\n";
680 // Output the global variable declarations
682 Out << "\n\n/* Global Variable Declarations */\n";
683 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
684 if (!I->isExternal()) {
686 printType(Out, I->getType()->getElementType(), getValueName(I));
692 // Output the global variable definitions and contents...
694 Out << "\n\n/* Global Variable Definitions and Initialization */\n";
695 for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
696 if (!I->isExternal()) {
697 if (I->hasInternalLinkage())
699 printType(Out, I->getType()->getElementType(), getValueName(I));
700 if (I->hasLinkOnceLinkage())
701 Out << " __attribute__((common))";
702 if (!I->getInitializer()->isNullValue()) {
704 writeOperand(I->getInitializer());
710 // Output all of the functions...
711 emittedInvoke = false;
713 Out << "\n\n/* Function Bodies */\n";
714 for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
718 // If the program included an invoke instruction, we need to output the
719 // support code for it here!
721 Out << "\n/* More support for the invoke instruction */\n"
722 << "struct __llvm_jmpbuf_list_t *__llvm_jmpbuf_list "
723 << "__attribute__((common)) = 0;\n";
728 /// printSymbolTable - Run through symbol table looking for type names. If a
729 /// type name is found, emit it's declaration...
731 void CWriter::printSymbolTable(const SymbolTable &ST) {
732 // If there are no type names, exit early.
733 if (ST.find(Type::TypeTy) == ST.end())
736 // We are only interested in the type plane of the symbol table...
737 SymbolTable::type_const_iterator I = ST.type_begin(Type::TypeTy);
738 SymbolTable::type_const_iterator End = ST.type_end(Type::TypeTy);
740 // Print out forward declarations for structure types before anything else!
741 Out << "/* Structure forward decls */\n";
742 for (; I != End; ++I)
743 if (const Type *STy = dyn_cast<StructType>(I->second)) {
744 std::string Name = "struct l_" + makeNameProper(I->first);
745 Out << Name << ";\n";
746 TypeNames.insert(std::make_pair(STy, Name));
751 // Now we can print out typedefs...
752 Out << "/* Typedefs */\n";
753 for (I = ST.type_begin(Type::TypeTy); I != End; ++I) {
754 const Type *Ty = cast<Type>(I->second);
755 std::string Name = "l_" + makeNameProper(I->first);
757 printType(Out, Ty, Name);
763 // Keep track of which structures have been printed so far...
764 std::set<const StructType *> StructPrinted;
766 // Loop over all structures then push them into the stack so they are
767 // printed in the correct order.
769 Out << "/* Structure contents */\n";
770 for (I = ST.type_begin(Type::TypeTy); I != End; ++I)
771 if (const StructType *STy = dyn_cast<StructType>(I->second))
772 printContainedStructs(STy, StructPrinted);
775 // Push the struct onto the stack and recursively push all structs
776 // this one depends on.
777 void CWriter::printContainedStructs(const Type *Ty,
778 std::set<const StructType*> &StructPrinted){
779 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
780 //Check to see if we have already printed this struct
781 if (StructPrinted.count(STy) == 0) {
782 // Print all contained types first...
783 for (StructType::ElementTypes::const_iterator
784 I = STy->getElementTypes().begin(),
785 E = STy->getElementTypes().end(); I != E; ++I) {
786 const Type *Ty1 = I->get();
787 if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
788 printContainedStructs(*I, StructPrinted);
791 //Print structure type out..
792 StructPrinted.insert(STy);
793 std::string Name = TypeNames[STy];
794 printType(Out, STy, Name, true);
798 // If it is an array, check contained types and continue
799 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)){
800 const Type *Ty1 = ATy->getElementType();
801 if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
802 printContainedStructs(Ty1, StructPrinted);
807 void CWriter::printFunctionSignature(const Function *F, bool Prototype) {
808 // If the program provides its own malloc prototype we don't need
809 // to include the general one.
810 if (getValueName(F) == "malloc")
813 if (F->hasInternalLinkage()) Out << "static ";
814 if (F->hasLinkOnceLinkage()) Out << "inline ";
816 // Loop over the arguments, printing them...
817 const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
819 std::stringstream FunctionInnards;
821 // Print out the name...
822 FunctionInnards << getValueName(F) << "(";
824 if (!F->isExternal()) {
827 if (F->abegin()->hasName() || !Prototype)
828 ArgName = getValueName(F->abegin());
829 printType(FunctionInnards, F->afront().getType(), ArgName);
830 for (Function::const_aiterator I = ++F->abegin(), E = F->aend();
832 FunctionInnards << ", ";
833 if (I->hasName() || !Prototype)
834 ArgName = getValueName(I);
837 printType(FunctionInnards, I->getType(), ArgName);
841 // Loop over the arguments, printing them...
842 for (FunctionType::ParamTypes::const_iterator I =
843 FT->getParamTypes().begin(),
844 E = FT->getParamTypes().end(); I != E; ++I) {
845 if (I != FT->getParamTypes().begin()) FunctionInnards << ", ";
846 printType(FunctionInnards, *I);
850 // Finish printing arguments... if this is a vararg function, print the ...,
851 // unless there are no known types, in which case, we just emit ().
853 if (FT->isVarArg() && !FT->getParamTypes().empty()) {
854 if (FT->getParamTypes().size()) FunctionInnards << ", ";
855 FunctionInnards << "..."; // Output varargs portion of signature!
857 FunctionInnards << ")";
858 // Print out the return type and the entire signature for that matter
859 printType(Out, F->getReturnType(), FunctionInnards.str());
862 void CWriter::printFunction(Function *F) {
863 if (F->isExternal()) return;
865 Table->incorporateFunction(F);
867 printFunctionSignature(F, false);
870 // print local variable information for the function
871 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
872 if (const AllocaInst *AI = isDirectAlloca(*I)) {
874 printType(Out, AI->getAllocatedType(), getValueName(AI));
875 Out << "; /* Address exposed local */\n";
876 } else if ((*I)->getType() != Type::VoidTy && !isInlinableInst(**I)) {
878 printType(Out, (*I)->getType(), getValueName(*I));
881 if (isa<PHINode>(*I)) { // Print out PHI node temporaries as well...
883 printType(Out, (*I)->getType(), getValueName(*I)+"__PHI_TEMPORARY");
890 // Scan the function for floating point constants. If any FP constant is used
891 // in the function, we want to redirect it here so that we do not depend on
892 // the precision of the printed form, unless the printed form preserves
895 unsigned FPCounter = 0;
896 for (constant_iterator I = constant_begin(F), E = constant_end(F); I != E;++I)
897 if (const ConstantFP *FPC = dyn_cast<ConstantFP>(*I))
898 if ((!FPCSafeToPrint(FPC)) // Do not put in FPConstantMap if safe.
899 && (FPConstantMap.find(FPC) == FPConstantMap.end())) {
900 double Val = FPC->getValue();
902 FPConstantMap[FPC] = FPCounter; // Number the FP constants
904 if (FPC->getType() == Type::DoubleTy)
905 Out << " const ConstantDoubleTy FloatConstant" << FPCounter++
906 << " = 0x" << std::hex << *(unsigned long long*)&Val << std::dec
907 << "; /* " << Val << " */\n";
908 else if (FPC->getType() == Type::FloatTy) {
910 Out << " const ConstantFloatTy FloatConstant" << FPCounter++
911 << " = 0x" << std::hex << *(unsigned*)&fVal << std::dec
912 << "; /* " << Val << " */\n";
914 assert(0 && "Unknown float type!");
919 // print the basic blocks
920 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
921 BasicBlock *Prev = BB->getPrev();
923 // Don't print the label for the basic block if there are no uses, or if the
924 // only terminator use is the precessor basic block's terminator. We have
925 // to scan the use list because PHI nodes use basic blocks too but do not
926 // require a label to be generated.
928 bool NeedsLabel = false;
929 for (Value::use_iterator UI = BB->use_begin(), UE = BB->use_end();
931 if (TerminatorInst *TI = dyn_cast<TerminatorInst>(*UI))
932 if (TI != Prev->getTerminator() ||
933 isa<SwitchInst>(Prev->getTerminator())) {
938 if (NeedsLabel) Out << getValueName(BB) << ":\n";
940 // Output all of the instructions in the basic block...
941 for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E; ++II){
942 if (!isInlinableInst(*II) && !isDirectAlloca(II)) {
943 if (II->getType() != Type::VoidTy)
952 // Don't emit prefix or suffix for the terminator...
953 visit(*BB->getTerminator());
957 Table->purgeFunction();
958 FPConstantMap.clear();
961 // Specific Instruction type classes... note that all of the casts are
962 // neccesary because we use the instruction classes as opaque types...
964 void CWriter::visitReturnInst(ReturnInst &I) {
965 // Don't output a void return if this is the last basic block in the function
966 if (I.getNumOperands() == 0 &&
967 &*--I.getParent()->getParent()->end() == I.getParent() &&
968 !I.getParent()->size() == 1) {
973 if (I.getNumOperands()) {
975 writeOperand(I.getOperand(0));
980 void CWriter::visitSwitchInst(SwitchInst &SI) {
982 writeOperand(SI.getOperand(0));
983 Out << ") {\n default:\n";
984 printBranchToBlock(SI.getParent(), SI.getDefaultDest(), 2);
986 for (unsigned i = 2, e = SI.getNumOperands(); i != e; i += 2) {
988 writeOperand(SI.getOperand(i));
990 BasicBlock *Succ = cast<BasicBlock>(SI.getOperand(i+1));
991 printBranchToBlock(SI.getParent(), Succ, 2);
992 if (Succ == SI.getParent()->getNext())
998 void CWriter::visitInvokeInst(InvokeInst &II) {
1000 << " struct __llvm_jmpbuf_list_t Entry;\n"
1001 << " Entry.next = __llvm_jmpbuf_list;\n"
1002 << " if (setjmp(Entry.buf)) {\n"
1003 << " __llvm_jmpbuf_list = Entry.next;\n";
1004 printBranchToBlock(II.getParent(), II.getExceptionalDest(), 4);
1006 << " __llvm_jmpbuf_list = &Entry;\n"
1010 << " __llvm_jmpbuf_list = Entry.next;\n"
1012 printBranchToBlock(II.getParent(), II.getNormalDest(), 0);
1013 emittedInvoke = true;
1017 static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
1018 // If PHI nodes need copies, we need the copy code...
1019 if (isa<PHINode>(To->front()) ||
1020 From->getNext() != To) // Not directly successor, need goto
1023 // Otherwise we don't need the code.
1027 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
1029 for (BasicBlock::iterator I = Succ->begin();
1030 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1031 // now we have to do the printing
1032 Out << std::string(Indent, ' ');
1033 Out << " " << getValueName(I) << "__PHI_TEMPORARY = ";
1034 writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
1035 Out << "; /* for PHI node */\n";
1038 if (CurBB->getNext() != Succ) {
1039 Out << std::string(Indent, ' ') << " goto ";
1045 // Brach instruction printing - Avoid printing out a brach to a basic block that
1046 // immediately succeeds the current one.
1048 void CWriter::visitBranchInst(BranchInst &I) {
1049 if (I.isConditional()) {
1050 if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(0))) {
1052 writeOperand(I.getCondition());
1055 printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
1057 if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(1))) {
1058 Out << " } else {\n";
1059 printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
1062 // First goto not neccesary, assume second one is...
1064 writeOperand(I.getCondition());
1067 printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
1072 printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
1077 // PHI nodes get copied into temporary values at the end of predecessor basic
1078 // blocks. We now need to copy these temporary values into the REAL value for
1080 void CWriter::visitPHINode(PHINode &I) {
1082 Out << "__PHI_TEMPORARY";
1086 void CWriter::visitBinaryOperator(Instruction &I) {
1087 // binary instructions, shift instructions, setCond instructions.
1088 assert(!isa<PointerType>(I.getType()));
1090 // We must cast the results of binary operations which might be promoted.
1091 bool needsCast = false;
1092 if ((I.getType() == Type::UByteTy) || (I.getType() == Type::SByteTy)
1093 || (I.getType() == Type::UShortTy) || (I.getType() == Type::ShortTy)
1094 || (I.getType() == Type::FloatTy)) {
1097 printType(Out, I.getType(), "", false, false);
1101 writeOperand(I.getOperand(0));
1103 switch (I.getOpcode()) {
1104 case Instruction::Add: Out << " + "; break;
1105 case Instruction::Sub: Out << " - "; break;
1106 case Instruction::Mul: Out << "*"; break;
1107 case Instruction::Div: Out << "/"; break;
1108 case Instruction::Rem: Out << "%"; break;
1109 case Instruction::And: Out << " & "; break;
1110 case Instruction::Or: Out << " | "; break;
1111 case Instruction::Xor: Out << " ^ "; break;
1112 case Instruction::SetEQ: Out << " == "; break;
1113 case Instruction::SetNE: Out << " != "; break;
1114 case Instruction::SetLE: Out << " <= "; break;
1115 case Instruction::SetGE: Out << " >= "; break;
1116 case Instruction::SetLT: Out << " < "; break;
1117 case Instruction::SetGT: Out << " > "; break;
1118 case Instruction::Shl : Out << " << "; break;
1119 case Instruction::Shr : Out << " >> "; break;
1120 default: std::cerr << "Invalid operator type!" << I; abort();
1123 writeOperand(I.getOperand(1));
1130 void CWriter::visitCastInst(CastInst &I) {
1131 if (I.getType() == Type::BoolTy) {
1133 writeOperand(I.getOperand(0));
1138 printType(Out, I.getType(), "", /*ignoreName*/false, /*namedContext*/false);
1140 if (isa<PointerType>(I.getType())&&I.getOperand(0)->getType()->isIntegral() ||
1141 isa<PointerType>(I.getOperand(0)->getType())&&I.getType()->isIntegral()) {
1142 // Avoid "cast to pointer from integer of different size" warnings
1146 writeOperand(I.getOperand(0));
1149 void CWriter::visitCallInst(CallInst &I) {
1150 // Handle intrinsic function calls first...
1151 if (Function *F = I.getCalledFunction())
1152 if (LLVMIntrinsic::ID ID = (LLVMIntrinsic::ID)F->getIntrinsicID()) {
1154 default: assert(0 && "Unknown LLVM intrinsic!");
1155 case LLVMIntrinsic::va_start:
1156 Out << "va_start((va_list)*";
1157 writeOperand(I.getOperand(1));
1159 // Output the last argument to the enclosing function...
1160 writeOperand(&I.getParent()->getParent()->aback());
1163 case LLVMIntrinsic::va_end:
1164 Out << "va_end((va_list)*";
1165 writeOperand(I.getOperand(1));
1168 case LLVMIntrinsic::va_copy:
1169 Out << "va_copy((va_list)*";
1170 writeOperand(I.getOperand(1));
1171 Out << ", (va_list)";
1172 writeOperand(I.getOperand(2));
1176 case LLVMIntrinsic::setjmp:
1177 Out << "setjmp(*(jmp_buf*)";
1178 writeOperand(I.getOperand(1));
1181 case LLVMIntrinsic::longjmp:
1182 Out << "longjmp(*(jmp_buf*)";
1183 writeOperand(I.getOperand(1));
1185 writeOperand(I.getOperand(2));
1193 void CWriter::visitCallSite(CallSite CS) {
1194 const PointerType *PTy = cast<PointerType>(CS.getCalledValue()->getType());
1195 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1196 const Type *RetTy = FTy->getReturnType();
1198 writeOperand(CS.getCalledValue());
1201 if (CS.arg_begin() != CS.arg_end()) {
1202 CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
1205 for (++AI; AI != AE; ++AI) {
1213 void CWriter::visitMallocInst(MallocInst &I) {
1215 printType(Out, I.getType());
1216 Out << ")malloc(sizeof(";
1217 printType(Out, I.getType()->getElementType());
1220 if (I.isArrayAllocation()) {
1222 writeOperand(I.getOperand(0));
1227 void CWriter::visitAllocaInst(AllocaInst &I) {
1229 printType(Out, I.getType());
1230 Out << ") alloca(sizeof(";
1231 printType(Out, I.getType()->getElementType());
1233 if (I.isArrayAllocation()) {
1235 writeOperand(I.getOperand(0));
1240 void CWriter::visitFreeInst(FreeInst &I) {
1242 writeOperand(I.getOperand(0));
1246 void CWriter::printIndexingExpression(Value *Ptr, User::op_iterator I,
1247 User::op_iterator E) {
1248 bool HasImplicitAddress = false;
1249 // If accessing a global value with no indexing, avoid *(&GV) syndrome
1250 if (GlobalValue *V = dyn_cast<GlobalValue>(Ptr)) {
1251 HasImplicitAddress = true;
1252 } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Ptr)) {
1253 HasImplicitAddress = true;
1254 Ptr = CPR->getValue(); // Get to the global...
1255 } else if (isDirectAlloca(Ptr)) {
1256 HasImplicitAddress = true;
1260 if (!HasImplicitAddress)
1261 Out << "*"; // Implicit zero first argument: '*x' is equivalent to 'x[0]'
1263 writeOperandInternal(Ptr);
1267 const Constant *CI = dyn_cast<Constant>(I);
1268 if (HasImplicitAddress && (!CI || !CI->isNullValue()))
1271 writeOperandInternal(Ptr);
1273 if (HasImplicitAddress && (!CI || !CI->isNullValue())) {
1275 HasImplicitAddress = false; // HIA is only true if we haven't addressed yet
1278 assert(!HasImplicitAddress || (CI && CI->isNullValue()) &&
1279 "Can only have implicit address with direct accessing");
1281 if (HasImplicitAddress) {
1283 } else if (CI && CI->isNullValue() && I+1 != E) {
1284 // Print out the -> operator if possible...
1285 if ((*(I+1))->getType() == Type::UByteTy) {
1286 Out << (HasImplicitAddress ? "." : "->");
1287 Out << "field" << cast<ConstantUInt>(*(I+1))->getValue();
1293 if ((*I)->getType() == Type::LongTy) {
1298 Out << ".field" << cast<ConstantUInt>(*I)->getValue();
1302 void CWriter::visitLoadInst(LoadInst &I) {
1304 writeOperand(I.getOperand(0));
1307 void CWriter::visitStoreInst(StoreInst &I) {
1309 writeOperand(I.getPointerOperand());
1311 writeOperand(I.getOperand(0));
1314 void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
1316 printIndexingExpression(I.getPointerOperand(), I.idx_begin(), I.idx_end());
1319 void CWriter::visitVarArgInst(VarArgInst &I) {
1320 Out << "va_arg((va_list)*";
1321 writeOperand(I.getOperand(0));
1323 printType(Out, I.getType(), "", /*ignoreName*/false, /*namedContext*/false);
1328 //===----------------------------------------------------------------------===//
1329 // External Interface declaration
1330 //===----------------------------------------------------------------------===//
1332 Pass *createWriteToCPass(std::ostream &o) { return new CWriter(o); }