1 //===-- Writer.cpp - Library for writing C files --------------------------===//
3 // This library implements the functionality defined in llvm/Assembly/CWriter.h
6 // TODO : Recursive types.
8 //===-----------------------------------------------------------------------==//
10 #include "llvm/Assembly/CWriter.h"
11 #include "llvm/SlotCalculator.h"
12 #include "llvm/Constants.h"
13 #include "llvm/DerivedTypes.h"
14 #include "llvm/Module.h"
15 #include "llvm/GlobalVariable.h"
16 #include "llvm/Function.h"
17 #include "llvm/Argument.h"
18 #include "llvm/BasicBlock.h"
19 #include "llvm/iMemory.h"
20 #include "llvm/iTerminators.h"
21 #include "llvm/iPHINode.h"
22 #include "llvm/iOther.h"
23 #include "llvm/iOperators.h"
24 #include "llvm/SymbolTable.h"
25 #include "llvm/Support/InstVisitor.h"
26 #include "llvm/Support/InstIterator.h"
27 #include "Support/StringExtras.h"
28 #include "Support/STLExtras.h"
36 static std::string getConstStrValue(const Constant* CPV);
39 static std::string getConstArrayStrValue(const Constant* CPV) {
42 // As a special case, print the array as a string if it is an array of
43 // ubytes or an array of sbytes with positive values.
45 const Type *ETy = cast<ArrayType>(CPV->getType())->getElementType();
46 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
48 // Make sure the last character is a null char, as automatically added by C
49 if (CPV->getNumOperands() == 0 ||
50 !cast<Constant>(*(CPV->op_end()-1))->isNullValue())
55 // Do not include the last character, which we know is null
56 for (unsigned i = 0, e = CPV->getNumOperands()-1; i != e; ++i) {
57 unsigned char C = (ETy == Type::SByteTy) ?
58 (unsigned char)cast<ConstantSInt>(CPV->getOperand(i))->getValue() :
59 (unsigned char)cast<ConstantUInt>(CPV->getOperand(i))->getValue();
65 case '\n': Result += "\\n"; break;
66 case '\t': Result += "\\t"; break;
67 case '\r': Result += "\\r"; break;
68 case '\v': Result += "\\v"; break;
69 case '\a': Result += "\\a"; break;
72 Result += ( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A');
73 Result += ((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A');
81 if (CPV->getNumOperands()) {
82 Result += " " + getConstStrValue(cast<Constant>(CPV->getOperand(0)));
83 for (unsigned i = 1; i < CPV->getNumOperands(); i++)
84 Result += ", " + getConstStrValue(cast<Constant>(CPV->getOperand(i)));
92 static std::string getConstStrValue(const Constant* CPV) {
93 switch (CPV->getType()->getPrimitiveID()) {
94 case Type::BoolTyID: return CPV == ConstantBool::False ? "0" : "1";
97 case Type::IntTyID: return itostr(cast<ConstantSInt>(CPV)->getValue());
98 case Type::LongTyID: return itostr(cast<ConstantSInt>(CPV)->getValue())+"ll";
100 case Type::UByteTyID:
101 case Type::UShortTyID:return utostr(cast<ConstantUInt>(CPV)->getValue());
102 case Type::UIntTyID: return utostr(cast<ConstantUInt>(CPV)->getValue())+"u";
103 case Type::ULongTyID:return utostr(cast<ConstantUInt>(CPV)->getValue())+"ull";
105 case Type::FloatTyID:
106 case Type::DoubleTyID: return ftostr(cast<ConstantFP>(CPV)->getValue());
108 case Type::ArrayTyID: return getConstArrayStrValue(CPV);
110 case Type::StructTyID: {
111 std::string Result = "{";
112 if (CPV->getNumOperands()) {
113 Result += " " + getConstStrValue(cast<Constant>(CPV->getOperand(0)));
114 for (unsigned i = 1; i < CPV->getNumOperands(); i++)
115 Result += ", " + getConstStrValue(cast<Constant>(CPV->getOperand(i)));
117 return Result + " }";
121 cerr << "Unknown constant type: " << CPV << "\n";
126 // Pass the Type* variable and and the variable name and this prints out the
127 // variable declaration.
129 static string calcTypeNameVar(const Type *Ty,
130 map<const Type *, string> &TypeNames,
131 const string &NameSoFar, bool ignoreName = false){
132 if (Ty->isPrimitiveType())
133 switch (Ty->getPrimitiveID()) {
134 case Type::VoidTyID: return "void " + NameSoFar;
135 case Type::BoolTyID: return "bool " + NameSoFar;
136 case Type::UByteTyID: return "unsigned char " + NameSoFar;
137 case Type::SByteTyID: return "signed char " + NameSoFar;
138 case Type::UShortTyID: return "unsigned short " + NameSoFar;
139 case Type::ShortTyID: return "short " + NameSoFar;
140 case Type::UIntTyID: return "unsigned " + NameSoFar;
141 case Type::IntTyID: return "int " + NameSoFar;
142 case Type::ULongTyID: return "unsigned long long " + NameSoFar;
143 case Type::LongTyID: return "signed long long " + NameSoFar;
144 case Type::FloatTyID: return "float " + NameSoFar;
145 case Type::DoubleTyID: return "double " + NameSoFar;
147 cerr << "Unknown primitive type: " << Ty << "\n";
151 // Check to see if the type is named.
153 map<const Type *, string>::iterator I = TypeNames.find(Ty);
154 if (I != TypeNames.end())
155 return I->second + " " + NameSoFar;
159 switch (Ty->getPrimitiveID()) {
160 case Type::FunctionTyID: {
161 const FunctionType *MTy = cast<FunctionType>(Ty);
162 Result += calcTypeNameVar(MTy->getReturnType(), TypeNames, "");
163 Result += " " + NameSoFar + " (";
164 for (FunctionType::ParamTypes::const_iterator
165 I = MTy->getParamTypes().begin(),
166 E = MTy->getParamTypes().end(); I != E; ++I) {
167 if (I != MTy->getParamTypes().begin())
169 Result += calcTypeNameVar(*I, TypeNames, "");
171 if (MTy->isVarArg()) {
172 if (!MTy->getParamTypes().empty())
178 case Type::StructTyID: {
179 const StructType *STy = cast<const StructType>(Ty);
180 Result = NameSoFar + " {\n";
182 for (StructType::ElementTypes::const_iterator
183 I = STy->getElementTypes().begin(),
184 E = STy->getElementTypes().end(); I != E; ++I) {
185 Result += " " +calcTypeNameVar(*I, TypeNames, "field" + utostr(indx++));
191 case Type::PointerTyID: {
192 return calcTypeNameVar(cast<const PointerType>(Ty)->getElementType(),
193 TypeNames, "*" + NameSoFar);
196 case Type::ArrayTyID: {
197 const ArrayType *ATy = cast<const ArrayType>(Ty);
198 int NumElements = ATy->getNumElements();
199 return calcTypeNameVar(ATy->getElementType(), TypeNames,
200 NameSoFar + "[" + itostr(NumElements) + "]");
203 assert(0 && "Unhandled case in getTypeProps!");
211 class CWriter : public InstVisitor<CWriter> {
213 SlotCalculator &Table;
214 const Module *TheModule;
215 map<const Type *, string> TypeNames;
217 inline CWriter(ostream &o, SlotCalculator &Tab, const Module *M)
218 : Out(o), Table(Tab), TheModule(M) {
221 inline void write(Module *M) { printModule(M); }
223 ostream& printTypeVar(const Type *Ty, const string &VariableName) {
224 return Out << calcTypeNameVar(Ty, TypeNames, VariableName);
227 ostream& printType(const Type *Ty) {
228 return Out << calcTypeNameVar(Ty, TypeNames, "");
231 void writeOperand(const Value *Operand);
233 string getValueName(const Value *V);
236 void printModule(Module *M);
237 void printSymbolTable(const SymbolTable &ST);
238 void printGlobal(const GlobalVariable *GV);
239 void printFunctionSignature(const Function *F);
240 void printFunctionDecl(const Function *F); // Print just the forward decl
242 void printFunction(Function *);
244 // Instruction visitation functions
245 friend class InstVisitor<CWriter>;
247 void visitReturnInst(ReturnInst *I);
248 void visitBranchInst(BranchInst *I);
250 void visitPHINode(PHINode *I) {}
251 void visitNot(GenericUnaryInst *I);
252 void visitBinaryOperator(Instruction *I);
254 void visitCastInst(CastInst *I);
255 void visitCallInst(CallInst *I);
256 void visitShiftInst(ShiftInst *I) { visitBinaryOperator(I); }
258 void visitMallocInst(MallocInst *I);
259 void visitAllocaInst(AllocaInst *I);
260 void visitFreeInst(FreeInst *I);
261 void visitLoadInst(LoadInst *I);
262 void visitStoreInst(StoreInst *I);
263 void visitGetElementPtrInst(GetElementPtrInst *I);
265 void visitInstruction(Instruction *I) {
266 cerr << "C Writer does not know about " << I;
270 void outputLValue(Instruction *I) {
271 Out << " " << getValueName(I) << " = ";
273 void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
275 void printIndexingExpr(MemAccessInst *MAI);
279 // We dont want identifier names with ., space, - in them.
280 // So we replace them with _
281 static string makeNameProper(string x) {
283 for (string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
285 case '.': tmp += "d_"; break;
286 case ' ': tmp += "s_"; break;
287 case '-': tmp += "D_"; break;
288 case '_': tmp += "__"; break;
295 string CWriter::getValueName(const Value *V) {
296 if (V->hasName()) { // Print out the label if it exists...
297 if (isa<GlobalValue>(V)) // Do not mangle globals...
298 return makeNameProper(V->getName());
300 return "l" + utostr(V->getType()->getUniqueID()) + "_" +
301 makeNameProper(V->getName());
304 int Slot = Table.getValSlot(V);
305 assert(Slot >= 0 && "Invalid value!");
306 return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
309 void CWriter::writeOperand(const Value *Operand) {
310 if (isa<GlobalVariable>(Operand))
311 Out << "(&"; // Global variables are references as their addresses by llvm
313 if (Operand->hasName()) {
314 Out << getValueName(Operand);
315 } else if (const Constant *CPV = dyn_cast<const Constant>(Operand)) {
316 if (isa<ConstantPointerNull>(CPV)) {
318 printTypeVar(CPV->getType(), "");
321 Out << getConstStrValue(CPV);
323 int Slot = Table.getValSlot(Operand);
324 assert(Slot >= 0 && "Malformed LLVM!");
325 Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
328 if (isa<GlobalVariable>(Operand))
332 void CWriter::printModule(Module *M) {
333 // printing stdlib inclusion
334 // Out << "#include <stdlib.h>\n";
336 // get declaration for alloca
337 Out << "/* Provide Declarations */\n"
338 << "#include <alloca.h>\n\n"
340 // Provide a definition for null if one does not already exist.
341 << "#ifndef NULL\n#define NULL 0\n#endif\n\n"
342 << "typedef unsigned char bool;\n"
344 << "\n\n/* Global Symbols */\n";
346 // Loop over the symbol table, emitting all named constants...
347 if (M->hasSymbolTable())
348 printSymbolTable(*M->getSymbolTable());
350 Out << "\n\n/* Global Data */\n";
351 for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
352 GlobalVariable *GV = *I;
353 if (GV->hasInternalLinkage()) Out << "static ";
354 printTypeVar(GV->getType()->getElementType(), getValueName(GV));
356 if (GV->hasInitializer()) {
358 writeOperand(GV->getInitializer());
363 // First output all the declarations of the functions as C requires Functions
364 // be declared before they are used.
366 Out << "\n\n/* Function Declarations */\n";
367 for_each(M->begin(), M->end(), bind_obj(this, &CWriter::printFunctionDecl));
369 // Output all of the functions...
370 Out << "\n\n/* Function Bodies */\n";
371 for_each(M->begin(), M->end(), bind_obj(this, &CWriter::printFunction));
375 // printSymbolTable - Run through symbol table looking for named constants
376 // if a named constant is found, emit it's declaration...
377 // Assuming that symbol table has only types and constants.
378 void CWriter::printSymbolTable(const SymbolTable &ST) {
379 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
380 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
381 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
383 for (; I != End; ++I)
384 if (const Type *Ty = dyn_cast<const StructType>(I->second)) {
385 string Name = "struct l_" + I->first;
386 Out << Name << ";\n";
388 TypeNames.insert(std::make_pair(Ty, Name));
394 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
395 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
396 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
398 for (; I != End; ++I) {
399 const Value *V = I->second;
400 if (const Type *Ty = dyn_cast<const Type>(V)) {
401 string Name = "l_" + I->first;
402 if (isa<StructType>(Ty))
403 Name = "struct " + Name;
407 Out << calcTypeNameVar(Ty, TypeNames, Name, true) << ";\n";
414 // printFunctionDecl - Print function declaration
416 void CWriter::printFunctionDecl(const Function *F) {
417 printFunctionSignature(F);
421 void CWriter::printFunctionSignature(const Function *F) {
422 if (F->hasInternalLinkage()) Out << "static ";
424 // Loop over the arguments, printing them...
425 const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
427 // Print out the return type and name...
428 printType(F->getReturnType());
429 Out << getValueName(F) << "(";
431 if (!F->isExternal()) {
432 if (!F->getArgumentList().empty()) {
433 printTypeVar(F->getArgumentList().front()->getType(),
434 getValueName(F->getArgumentList().front()));
436 for (Function::ArgumentListType::const_iterator
437 I = F->getArgumentList().begin()+1,
438 E = F->getArgumentList().end(); I != E; ++I) {
440 printTypeVar((*I)->getType(), getValueName(*I));
444 // Loop over the arguments, printing them...
445 for (FunctionType::ParamTypes::const_iterator I =
446 FT->getParamTypes().begin(),
447 E = FT->getParamTypes().end(); I != E; ++I) {
448 if (I != FT->getParamTypes().begin()) Out << ", ";
453 // Finish printing arguments...
454 if (FT->isVarArg()) {
455 if (FT->getParamTypes().size()) Out << ", ";
456 Out << "..."; // Output varargs portion of signature!
462 void CWriter::printFunction(Function *F) {
463 if (F->isExternal()) return;
465 Table.incorporateFunction(F);
467 printFunctionSignature(F);
470 // print local variable information for the function
471 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
472 if ((*I)->getType() != Type::VoidTy) {
474 printTypeVar((*I)->getType(), getValueName(*I));
478 // print the basic blocks
479 for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
480 BasicBlock *BB = *I, *Prev = I != F->begin() ? *(I-1) : 0;
482 // Don't print the label for the basic block if there are no uses, or if the
483 // only terminator use is the precessor basic block's terminator. We have
484 // to scan the use list because PHI nodes use basic blocks too but do not
485 // require a label to be generated.
487 bool NeedsLabel = false;
488 for (Value::use_iterator UI = BB->use_begin(), UE = BB->use_end();
490 if (TerminatorInst *TI = dyn_cast<TerminatorInst>(*UI))
491 if (TI != Prev->getTerminator()) {
496 if (NeedsLabel) Out << getValueName(BB) << ":\n";
498 // Output all of the instructions in the basic block...
499 // print the basic blocks
504 Table.purgeFunction();
507 // Specific Instruction type classes... note that all of the casts are
508 // neccesary because we use the instruction classes as opaque types...
510 void CWriter::visitReturnInst(ReturnInst *I) {
511 // Don't output a void return if this is the last basic block in the function
512 if (I->getNumOperands() == 0 &&
513 *(I->getParent()->getParent()->end()-1) == I->getParent())
517 if (I->getNumOperands()) {
519 writeOperand(I->getOperand(0));
524 // Return true if BB1 immediately preceeds BB2.
525 static bool BBFollowsBB(BasicBlock *BB1, BasicBlock *BB2) {
526 Function *F = BB1->getParent();
527 Function::iterator I = find(F->begin(), F->end(), BB1);
528 assert(I != F->end() && "BB not in function!");
529 return *(I+1) == BB2;
532 static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
533 // If PHI nodes need copies, we need the copy code...
534 if (isa<PHINode>(To->front()) ||
535 !BBFollowsBB(From, To)) // Not directly successor, need goto
538 // Otherwise we don't need the code.
542 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
544 for (BasicBlock::iterator I = Succ->begin();
545 PHINode *PN = dyn_cast<PHINode>(*I); ++I) {
546 // now we have to do the printing
547 Out << string(Indent, ' ');
549 writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
550 Out << "; /* for PHI node */\n";
553 if (!BBFollowsBB(CurBB, Succ)) {
554 Out << string(Indent, ' ') << " goto ";
560 // Brach instruction printing - Avoid printing out a brach to a basic block that
561 // immediately succeeds the current one.
563 void CWriter::visitBranchInst(BranchInst *I) {
564 if (I->isConditional()) {
565 if (isGotoCodeNeccessary(I->getParent(), I->getSuccessor(0))) {
567 writeOperand(I->getCondition());
570 printBranchToBlock(I->getParent(), I->getSuccessor(0), 2);
572 if (isGotoCodeNeccessary(I->getParent(), I->getSuccessor(1))) {
573 Out << " } else {\n";
574 printBranchToBlock(I->getParent(), I->getSuccessor(1), 2);
577 // First goto not neccesary, assume second one is...
579 writeOperand(I->getCondition());
582 printBranchToBlock(I->getParent(), I->getSuccessor(1), 2);
587 printBranchToBlock(I->getParent(), I->getSuccessor(0), 0);
593 void CWriter::visitNot(GenericUnaryInst *I) {
596 writeOperand(I->getOperand(0));
600 void CWriter::visitBinaryOperator(Instruction *I) {
601 // binary instructions, shift instructions, setCond instructions.
603 if (isa<PointerType>(I->getType())) {
605 printType(I->getType());
609 if (isa<PointerType>(I->getType())) Out << "(long long)";
610 writeOperand(I->getOperand(0));
612 switch (I->getOpcode()) {
613 case Instruction::Add: Out << " + "; break;
614 case Instruction::Sub: Out << " - "; break;
615 case Instruction::Mul: Out << "*"; break;
616 case Instruction::Div: Out << "/"; break;
617 case Instruction::Rem: Out << "%"; break;
618 case Instruction::And: Out << " & "; break;
619 case Instruction::Or: Out << " | "; break;
620 case Instruction::Xor: Out << " ^ "; break;
621 case Instruction::SetEQ: Out << " == "; break;
622 case Instruction::SetNE: Out << " != "; break;
623 case Instruction::SetLE: Out << " <= "; break;
624 case Instruction::SetGE: Out << " >= "; break;
625 case Instruction::SetLT: Out << " < "; break;
626 case Instruction::SetGT: Out << " > "; break;
627 case Instruction::Shl : Out << " << "; break;
628 case Instruction::Shr : Out << " >> "; break;
629 default: cerr << "Invalid operator type!" << I; abort();
632 if (isa<PointerType>(I->getType())) Out << "(long long)";
633 writeOperand(I->getOperand(1));
637 void CWriter::visitCastInst(CastInst *I) {
640 printType(I->getType());
642 writeOperand(I->getOperand(0));
646 void CWriter::visitCallInst(CallInst *I) {
647 if (I->getType() != Type::VoidTy)
652 const PointerType *PTy = cast<PointerType>(I->getCalledValue()->getType());
653 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
654 const Type *RetTy = FTy->getReturnType();
656 Out << getValueName(I->getOperand(0)) << "(";
658 if (I->getNumOperands() > 1) {
659 writeOperand(I->getOperand(1));
661 for (unsigned op = 2, Eop = I->getNumOperands(); op != Eop; ++op) {
663 writeOperand(I->getOperand(op));
669 void CWriter::visitMallocInst(MallocInst *I) {
672 printType(I->getType());
673 Out << ")malloc(sizeof(";
674 printType(I->getType()->getElementType());
677 if (I->isArrayAllocation()) {
679 writeOperand(I->getOperand(0));
684 void CWriter::visitAllocaInst(AllocaInst *I) {
687 printType(I->getType());
688 Out << ") alloca(sizeof(";
689 printType(I->getType()->getElementType());
691 if (I->isArrayAllocation()) {
693 writeOperand(I->getOperand(0));
698 void CWriter::visitFreeInst(FreeInst *I) {
700 writeOperand(I->getOperand(0));
704 void CWriter::printIndexingExpr(MemAccessInst *MAI) {
705 MemAccessInst::op_iterator I = MAI->idx_begin(), E = MAI->idx_end();
707 Out << "*"; // Implicit zero first argument: '*x' is equivalent to 'x[0]'
709 writeOperand(MAI->getPointerOperand());
713 // Print out the -> operator if possible...
714 Constant *CI = dyn_cast<Constant>(*I);
715 if (CI && CI->isNullValue() && I+1 != E &&
716 (*(I+1))->getType() == Type::UByteTy) {
718 Out << "->field" << cast<ConstantUInt>(*I)->getValue();
723 if ((*I)->getType() == Type::UIntTy) {
728 Out << ".field" << cast<ConstantUInt>(*I)->getValue();
732 void CWriter::visitLoadInst(LoadInst *I) {
734 printIndexingExpr(I);
738 void CWriter::visitStoreInst(StoreInst *I) {
740 printIndexingExpr(I);
742 writeOperand(I->getOperand(0));
746 void CWriter::visitGetElementPtrInst(GetElementPtrInst *I) {
749 printIndexingExpr(I);
753 //===----------------------------------------------------------------------===//
754 // External Interface declaration
755 //===----------------------------------------------------------------------===//
757 void WriteToC(const Module *M, ostream &Out) {
758 assert(M && "You can't write a null module!!");
759 SlotCalculator SlotTable(M, false);
760 CWriter W(Out, SlotTable, M);