blob: 39cdff49adc0e845a75b9c0c0cc2f6bb7886d7ef [file] [log] [blame]
Chris Lattner16c7bb22002-05-09 02:28:59 +00001//===-- Writer.cpp - Library for writing C files --------------------------===//
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +00002//
3// This library implements the functionality defined in llvm/Assembly/CWriter.h
4// and CLocalVars.h
5//
6// TODO : Recursive types.
Chris Lattner16c7bb22002-05-09 02:28:59 +00007//
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +00008//===-----------------------------------------------------------------------==//
Chris Lattner16c7bb22002-05-09 02:28:59 +00009
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000010#include "llvm/Assembly/CWriter.h"
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000011#include "llvm/SlotCalculator.h"
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000012#include "llvm/Constants.h"
Chris Lattner2f5f51a2002-05-09 03:28:37 +000013#include "llvm/DerivedTypes.h"
14#include "llvm/Module.h"
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000015#include "llvm/GlobalVariable.h"
Chris Lattner2f5f51a2002-05-09 03:28:37 +000016#include "llvm/Function.h"
17#include "llvm/Argument.h"
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000018#include "llvm/BasicBlock.h"
19#include "llvm/iMemory.h"
20#include "llvm/iTerminators.h"
21#include "llvm/iPHINode.h"
22#include "llvm/iOther.h"
Chris Lattner2f5f51a2002-05-09 03:28:37 +000023#include "llvm/iOperators.h"
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000024#include "llvm/SymbolTable.h"
25#include "llvm/Support/InstVisitor.h"
Chris Lattner7683a122002-05-09 20:33:35 +000026#include "llvm/Support/InstIterator.h"
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000027#include "Support/StringExtras.h"
28#include "Support/STLExtras.h"
29
30#include <algorithm>
31#include <strstream>
32using std::string;
33using std::map;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000034using std::ostream;
35
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000036static std::string getConstStrValue(const Constant* CPV);
37
38
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000039static std::string getConstArrayStrValue(const Constant* CPV) {
40 std::string Result;
41
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.
44 //
45 const Type *ETy = cast<ArrayType>(CPV->getType())->getElementType();
46 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
47
Chris Lattner4fbf26d2002-05-09 20:53:56 +000048 // 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())
51 isString = false;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000052
53 if (isString) {
54 Result = "\"";
Chris Lattner2f5eb4e2002-05-09 03:56:52 +000055 // Do not include the last character, which we know is null
56 for (unsigned i = 0, e = CPV->getNumOperands()-1; i != e; ++i) {
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000057 unsigned char C = (ETy == Type::SByteTy) ?
58 (unsigned char)cast<ConstantSInt>(CPV->getOperand(i))->getValue() :
59 (unsigned char)cast<ConstantUInt>(CPV->getOperand(i))->getValue();
60
61 if (isprint(C)) {
62 Result += C;
63 } else {
Chris Lattner2f5eb4e2002-05-09 03:56:52 +000064 switch (C) {
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;
70 default:
71 Result += "\\x";
72 Result += ( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A');
73 Result += ((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A');
74 break;
75 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000076 }
77 }
78 Result += "\"";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000079 } else {
80 Result = "{";
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)));
85 }
86 Result += " }";
87 }
88
89 return Result;
90}
91
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000092static std::string getConstStrValue(const Constant* CPV) {
Chris Lattner3ef6dc72002-05-09 14:40:11 +000093 switch (CPV->getType()->getPrimitiveID()) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +000094 case Type::BoolTyID: return CPV == ConstantBool::False ? "0" : "1";
Chris Lattner3ef6dc72002-05-09 14:40:11 +000095 case Type::SByteTyID:
96 case Type::ShortTyID:
Chris Lattner4fbf26d2002-05-09 20:53:56 +000097 case Type::IntTyID: return itostr(cast<ConstantSInt>(CPV)->getValue());
98 case Type::LongTyID: return itostr(cast<ConstantSInt>(CPV)->getValue())+"ll";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +000099
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000100 case Type::UByteTyID:
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000101 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";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000104
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000105 case Type::FloatTyID:
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000106 case Type::DoubleTyID: return ftostr(cast<ConstantFP>(CPV)->getValue());
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000107
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000108 case Type::ArrayTyID: return getConstArrayStrValue(CPV);
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000109
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000110 case Type::StructTyID: {
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000111 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)));
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000116 }
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000117 return Result + " }";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000118 }
119
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000120 default:
121 cerr << "Unknown constant type: " << CPV << "\n";
122 abort();
123 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000124}
125
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000126// Pass the Type* variable and and the variable name and this prints out the
127// variable declaration.
Chris Lattnerdeed7a52002-05-09 15:18:52 +0000128//
Chris Lattner16c7bb22002-05-09 02:28:59 +0000129static string calcTypeNameVar(const Type *Ty,
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000130 map<const Type *, string> &TypeNames,
131 const string &NameSoFar, bool ignoreName = false){
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000132 if (Ty->isPrimitiveType())
133 switch (Ty->getPrimitiveID()) {
Chris Lattnerdeed7a52002-05-09 15:18:52 +0000134 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;
Chris Lattner1f02c892002-05-09 20:14:10 +0000144 case Type::FloatTyID: return "float " + NameSoFar;
145 case Type::DoubleTyID: return "double " + NameSoFar;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000146 default :
Chris Lattnerdeed7a52002-05-09 15:18:52 +0000147 cerr << "Unknown primitive type: " << Ty << "\n";
148 abort();
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000149 }
150
151 // Check to see if the type is named.
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000152 if (!ignoreName) {
153 map<const Type *, string>::iterator I = TypeNames.find(Ty);
154 if (I != TypeNames.end())
155 return I->second + " " + NameSoFar;
156 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000157
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000158 string Result;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000159 switch (Ty->getPrimitiveID()) {
160 case Type::FunctionTyID: {
Chris Lattner7683a122002-05-09 20:33:35 +0000161 const FunctionType *MTy = cast<FunctionType>(Ty);
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000162 Result += calcTypeNameVar(MTy->getReturnType(), TypeNames, "");
Chris Lattner7683a122002-05-09 20:33:35 +0000163 Result += " " + NameSoFar + " (";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000164 for (FunctionType::ParamTypes::const_iterator
165 I = MTy->getParamTypes().begin(),
166 E = MTy->getParamTypes().end(); I != E; ++I) {
167 if (I != MTy->getParamTypes().begin())
168 Result += ", ";
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000169 Result += calcTypeNameVar(*I, TypeNames, "");
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000170 }
171 if (MTy->isVarArg()) {
172 if (!MTy->getParamTypes().empty())
173 Result += ", ";
174 Result += "...";
175 }
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000176 return Result + ")";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000177 }
178 case Type::StructTyID: {
179 const StructType *STy = cast<const StructType>(Ty);
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000180 Result = NameSoFar + " {\n";
181 unsigned indx = 0;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000182 for (StructType::ElementTypes::const_iterator
183 I = STy->getElementTypes().begin(),
184 E = STy->getElementTypes().end(); I != E; ++I) {
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000185 Result += " " +calcTypeNameVar(*I, TypeNames, "field" + utostr(indx++));
186 Result += ";\n";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000187 }
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000188 return Result + "}";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000189 }
190
191 case Type::PointerTyID: {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000192 return calcTypeNameVar(cast<const PointerType>(Ty)->getElementType(),
193 TypeNames, "*" + NameSoFar);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000194 }
195
196 case Type::ArrayTyID: {
197 const ArrayType *ATy = cast<const ArrayType>(Ty);
198 int NumElements = ATy->getNumElements();
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000199 return calcTypeNameVar(ATy->getElementType(), TypeNames,
200 NameSoFar + "[" + itostr(NumElements) + "]");
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000201 }
202 default:
203 assert(0 && "Unhandled case in getTypeProps!");
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000204 abort();
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000205 }
206
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000207 return Result;
208}
209
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000210namespace {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000211 class CWriter : public InstVisitor<CWriter> {
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000212 ostream& Out;
213 SlotCalculator &Table;
214 const Module *TheModule;
215 map<const Type *, string> TypeNames;
216 public:
217 inline CWriter(ostream &o, SlotCalculator &Tab, const Module *M)
218 : Out(o), Table(Tab), TheModule(M) {
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000219 }
220
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000221 inline void write(Module *M) { printModule(M); }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000222
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000223 ostream& printTypeVar(const Type *Ty, const string &VariableName) {
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000224 return Out << calcTypeNameVar(Ty, TypeNames, VariableName);
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000225 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000226
Chris Lattner2a7ab2e2002-05-09 04:39:00 +0000227 ostream& printType(const Type *Ty) {
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000228 return Out << calcTypeNameVar(Ty, TypeNames, "");
Chris Lattner2a7ab2e2002-05-09 04:39:00 +0000229 }
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000230
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000231 void writeOperand(const Value *Operand);
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000232 void writeOperandInternal(const Value *Operand);
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000233
234 string getValueName(const Value *V);
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000235
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000236 private :
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000237 void printModule(Module *M);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000238 void printSymbolTable(const SymbolTable &ST);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000239 void printGlobal(const GlobalVariable *GV);
Chris Lattner16c7bb22002-05-09 02:28:59 +0000240 void printFunctionSignature(const Function *F);
241 void printFunctionDecl(const Function *F); // Print just the forward decl
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000242
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000243 void printFunction(Function *);
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000244
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000245 // isInlinableInst - Attempt to inline instructions into their uses to build
246 // trees as much as possible. To do this, we have to consistently decide
247 // what is acceptable to inline, so that variable declarations don't get
248 // printed and an extra copy of the expr is not emitted.
249 //
250 static bool isInlinableInst(Instruction *I) {
251 // Must be an expression, must be used exactly once. If it is dead, we
252 // emit it inline where it would go.
253 if (I->getType() == Type::VoidTy || I->use_size() != 1 ||
254 isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I))
255 return false;
256
257 // Only inline instruction it it's use is in the same BB as the inst.
258 return I->getParent() == cast<Instruction>(I->use_back())->getParent();
259 }
260
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000261 // Instruction visitation functions
262 friend class InstVisitor<CWriter>;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000263
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000264 void visitReturnInst(ReturnInst *I);
265 void visitBranchInst(BranchInst *I);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000266
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000267 void visitPHINode(PHINode *I) {}
268 void visitNot(GenericUnaryInst *I);
269 void visitBinaryOperator(Instruction *I);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000270
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000271 void visitCastInst(CastInst *I);
272 void visitCallInst(CallInst *I);
Chris Lattner2f5f51a2002-05-09 03:28:37 +0000273 void visitShiftInst(ShiftInst *I) { visitBinaryOperator(I); }
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000274
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000275 void visitMallocInst(MallocInst *I);
276 void visitAllocaInst(AllocaInst *I);
277 void visitFreeInst(FreeInst *I);
278 void visitLoadInst(LoadInst *I);
279 void visitStoreInst(StoreInst *I);
280 void visitGetElementPtrInst(GetElementPtrInst *I);
Chris Lattner2f5f51a2002-05-09 03:28:37 +0000281
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000282 void visitInstruction(Instruction *I) {
283 cerr << "C Writer does not know about " << I;
284 abort();
285 }
286
287 void outputLValue(Instruction *I) {
288 Out << " " << getValueName(I) << " = ";
289 }
290 void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
291 unsigned Indent);
292 void printIndexingExpr(MemAccessInst *MAI);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000293 };
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000294}
295
Chris Lattner2f499022002-05-09 04:21:21 +0000296// We dont want identifier names with ., space, - in them.
297// So we replace them with _
298static string makeNameProper(string x) {
299 string tmp;
300 for (string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
301 switch (*sI) {
Chris Lattnerdeed7a52002-05-09 15:18:52 +0000302 case '.': tmp += "d_"; break;
303 case ' ': tmp += "s_"; break;
304 case '-': tmp += "D_"; break;
Chris Lattner2f499022002-05-09 04:21:21 +0000305 case '_': tmp += "__"; break;
306 default: tmp += *sI;
307 }
308
309 return tmp;
310}
311
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000312string CWriter::getValueName(const Value *V) {
Chris Lattner2f499022002-05-09 04:21:21 +0000313 if (V->hasName()) { // Print out the label if it exists...
314 if (isa<GlobalValue>(V)) // Do not mangle globals...
315 return makeNameProper(V->getName());
316
Chris Lattner2d05a1a2002-05-09 05:16:40 +0000317 return "l" + utostr(V->getType()->getUniqueID()) + "_" +
318 makeNameProper(V->getName());
Chris Lattner2f499022002-05-09 04:21:21 +0000319 }
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000320
321 int Slot = Table.getValSlot(V);
322 assert(Slot >= 0 && "Invalid value!");
Chris Lattner2d05a1a2002-05-09 05:16:40 +0000323 return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000324}
325
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000326void CWriter::writeOperandInternal(const Value *Operand) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000327 if (Operand->hasName()) {
328 Out << getValueName(Operand);
329 } else if (const Constant *CPV = dyn_cast<const Constant>(Operand)) {
330 if (isa<ConstantPointerNull>(CPV)) {
331 Out << "((";
332 printTypeVar(CPV->getType(), "");
333 Out << ")NULL)";
334 } else
335 Out << getConstStrValue(CPV);
336 } else {
337 int Slot = Table.getValSlot(Operand);
338 assert(Slot >= 0 && "Malformed LLVM!");
339 Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
340 }
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000341}
342
343void CWriter::writeOperand(const Value *Operand) {
344 if (Instruction *I = dyn_cast<Instruction>(Operand))
345 if (isInlinableInst(I)) {
346 // Should we inline this instruction to build a tree?
347 Out << "(";
348 visit(I);
349 Out << ")";
350 return;
351 }
352
353 if (isa<GlobalVariable>(Operand))
354 Out << "(&"; // Global variables are references as their addresses by llvm
355
356 writeOperandInternal(Operand);
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000357
358 if (isa<GlobalVariable>(Operand))
359 Out << ")";
360}
361
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000362void CWriter::printModule(Module *M) {
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000363 // printing stdlib inclusion
364 // Out << "#include <stdlib.h>\n";
365
Chris Lattner16c7bb22002-05-09 02:28:59 +0000366 // get declaration for alloca
367 Out << "/* Provide Declarations */\n"
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000368 << "#include <alloca.h>\n\n"
Chris Lattner16c7bb22002-05-09 02:28:59 +0000369
370 // Provide a definition for null if one does not already exist.
Chris Lattnerb5af06a2002-05-09 03:06:06 +0000371 << "#ifndef NULL\n#define NULL 0\n#endif\n\n"
Chris Lattner16c7bb22002-05-09 02:28:59 +0000372 << "typedef unsigned char bool;\n"
373
374 << "\n\n/* Global Symbols */\n";
375
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000376 // Loop over the symbol table, emitting all named constants...
377 if (M->hasSymbolTable())
378 printSymbolTable(*M->getSymbolTable());
379
Chris Lattner16c7bb22002-05-09 02:28:59 +0000380 Out << "\n\n/* Global Data */\n";
Chris Lattnerdeed7a52002-05-09 15:18:52 +0000381 for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
382 GlobalVariable *GV = *I;
383 if (GV->hasInternalLinkage()) Out << "static ";
384 printTypeVar(GV->getType()->getElementType(), getValueName(GV));
385
386 if (GV->hasInitializer()) {
387 Out << " = " ;
388 writeOperand(GV->getInitializer());
389 }
390 Out << ";\n";
391 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000392
Chris Lattner16c7bb22002-05-09 02:28:59 +0000393 // First output all the declarations of the functions as C requires Functions
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000394 // be declared before they are used.
Chris Lattner16c7bb22002-05-09 02:28:59 +0000395 //
396 Out << "\n\n/* Function Declarations */\n";
397 for_each(M->begin(), M->end(), bind_obj(this, &CWriter::printFunctionDecl));
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000398
Chris Lattner16c7bb22002-05-09 02:28:59 +0000399 // Output all of the functions...
400 Out << "\n\n/* Function Bodies */\n";
401 for_each(M->begin(), M->end(), bind_obj(this, &CWriter::printFunction));
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000402}
403
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000404
405// printSymbolTable - Run through symbol table looking for named constants
406// if a named constant is found, emit it's declaration...
407// Assuming that symbol table has only types and constants.
408void CWriter::printSymbolTable(const SymbolTable &ST) {
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000409 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
410 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
411 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
412
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000413 for (; I != End; ++I)
414 if (const Type *Ty = dyn_cast<const StructType>(I->second)) {
415 string Name = "struct l_" + I->first;
416 Out << Name << ";\n";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000417
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000418 TypeNames.insert(std::make_pair(Ty, Name));
419 }
420 }
421
422 Out << "\n";
423
424 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
425 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
426 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
427
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000428 for (; I != End; ++I) {
429 const Value *V = I->second;
Chris Lattner2d05a1a2002-05-09 05:16:40 +0000430 if (const Type *Ty = dyn_cast<const Type>(V)) {
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000431 string Name = "l_" + I->first;
Chris Lattner1f02c892002-05-09 20:14:10 +0000432 if (isa<StructType>(Ty))
433 Name = "struct " + Name;
434 else
435 Out << "typedef ";
436
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000437 Out << calcTypeNameVar(Ty, TypeNames, Name, true) << ";\n";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000438 }
439 }
440 }
441}
442
Chris Lattner3ef6dc72002-05-09 14:40:11 +0000443
Chris Lattner16c7bb22002-05-09 02:28:59 +0000444// printFunctionDecl - Print function declaration
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000445//
Chris Lattner16c7bb22002-05-09 02:28:59 +0000446void CWriter::printFunctionDecl(const Function *F) {
447 printFunctionSignature(F);
448 Out << ";\n";
449}
450
451void CWriter::printFunctionSignature(const Function *F) {
452 if (F->hasInternalLinkage()) Out << "static ";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000453
454 // Loop over the arguments, printing them...
Chris Lattner16c7bb22002-05-09 02:28:59 +0000455 const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000456
Chris Lattner16c7bb22002-05-09 02:28:59 +0000457 // Print out the return type and name...
Chris Lattner2a7ab2e2002-05-09 04:39:00 +0000458 printType(F->getReturnType());
Chris Lattner1f02c892002-05-09 20:14:10 +0000459 Out << getValueName(F) << "(";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000460
Chris Lattner16c7bb22002-05-09 02:28:59 +0000461 if (!F->isExternal()) {
Chris Lattnerdeed7a52002-05-09 15:18:52 +0000462 if (!F->getArgumentList().empty()) {
463 printTypeVar(F->getArgumentList().front()->getType(),
464 getValueName(F->getArgumentList().front()));
465
466 for (Function::ArgumentListType::const_iterator
467 I = F->getArgumentList().begin()+1,
468 E = F->getArgumentList().end(); I != E; ++I) {
469 Out << ", ";
470 printTypeVar((*I)->getType(), getValueName(*I));
471 }
472 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000473 } else {
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000474 // Loop over the arguments, printing them...
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000475 for (FunctionType::ParamTypes::const_iterator I =
Chris Lattner16c7bb22002-05-09 02:28:59 +0000476 FT->getParamTypes().begin(),
477 E = FT->getParamTypes().end(); I != E; ++I) {
478 if (I != FT->getParamTypes().begin()) Out << ", ";
Chris Lattner2a7ab2e2002-05-09 04:39:00 +0000479 printType(*I);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000480 }
481 }
482
483 // Finish printing arguments...
Chris Lattner16c7bb22002-05-09 02:28:59 +0000484 if (FT->isVarArg()) {
485 if (FT->getParamTypes().size()) Out << ", ";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000486 Out << "..."; // Output varargs portion of signature!
487 }
Chris Lattner16c7bb22002-05-09 02:28:59 +0000488 Out << ")";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000489}
490
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000491
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000492void CWriter::printFunction(Function *F) {
Chris Lattner16c7bb22002-05-09 02:28:59 +0000493 if (F->isExternal()) return;
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000494
Chris Lattnerf34ee812002-05-09 03:12:34 +0000495 Table.incorporateFunction(F);
496
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000497 printFunctionSignature(F);
498 Out << " {\n";
499
Chris Lattner497e19a2002-05-09 20:39:03 +0000500 // print local variable information for the function
Chris Lattner7683a122002-05-09 20:33:35 +0000501 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000502 if ((*I)->getType() != Type::VoidTy && !isInlinableInst(*I)) {
Chris Lattner16c7bb22002-05-09 02:28:59 +0000503 Out << " ";
Chris Lattner497e19a2002-05-09 20:39:03 +0000504 printTypeVar((*I)->getType(), getValueName(*I));
Chris Lattner16c7bb22002-05-09 02:28:59 +0000505 Out << ";\n";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000506 }
Chris Lattner16c7bb22002-05-09 02:28:59 +0000507
508 // print the basic blocks
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000509 for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
510 BasicBlock *BB = *I, *Prev = I != F->begin() ? *(I-1) : 0;
511
512 // Don't print the label for the basic block if there are no uses, or if the
513 // only terminator use is the precessor basic block's terminator. We have
514 // to scan the use list because PHI nodes use basic blocks too but do not
515 // require a label to be generated.
516 //
517 bool NeedsLabel = false;
518 for (Value::use_iterator UI = BB->use_begin(), UE = BB->use_end();
519 UI != UE; ++UI)
520 if (TerminatorInst *TI = dyn_cast<TerminatorInst>(*UI))
521 if (TI != Prev->getTerminator()) {
522 NeedsLabel = true;
523 break;
524 }
525
526 if (NeedsLabel) Out << getValueName(BB) << ":\n";
527
528 // Output all of the instructions in the basic block...
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000529 for (BasicBlock::iterator II = BB->begin(), E = BB->end()-1;
530 II != E; ++II) {
531 if (!isInlinableInst(*II) && !isa<PHINode>(*II)) {
532 Instruction *I = *II;
533 if (I->getType() != Type::VoidTy)
534 outputLValue(I);
535 else
536 Out << " ";
537 visit(I);
538 Out << ";\n";
539 }
540 }
541
542 // Don't emit prefix or suffix for the terminator...
543 visit(BB->getTerminator());
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000544 }
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000545
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000546 Out << "}\n\n";
Chris Lattnerf34ee812002-05-09 03:12:34 +0000547 Table.purgeFunction();
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000548}
549
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000550// Specific Instruction type classes... note that all of the casts are
551// neccesary because we use the instruction classes as opaque types...
552//
553void CWriter::visitReturnInst(ReturnInst *I) {
554 // Don't output a void return if this is the last basic block in the function
555 if (I->getNumOperands() == 0 &&
556 *(I->getParent()->getParent()->end()-1) == I->getParent())
557 return;
Chris Lattner44408262002-05-09 03:50:42 +0000558
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000559 Out << " return";
560 if (I->getNumOperands()) {
561 Out << " ";
562 writeOperand(I->getOperand(0));
Chris Lattner16c7bb22002-05-09 02:28:59 +0000563 }
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000564 Out << ";\n";
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000565}
566
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000567// Return true if BB1 immediately preceeds BB2.
568static bool BBFollowsBB(BasicBlock *BB1, BasicBlock *BB2) {
569 Function *F = BB1->getParent();
570 Function::iterator I = find(F->begin(), F->end(), BB1);
571 assert(I != F->end() && "BB not in function!");
572 return *(I+1) == BB2;
573}
574
575static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
576 // If PHI nodes need copies, we need the copy code...
577 if (isa<PHINode>(To->front()) ||
578 !BBFollowsBB(From, To)) // Not directly successor, need goto
579 return true;
580
581 // Otherwise we don't need the code.
582 return false;
583}
584
585void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
586 unsigned Indent) {
587 for (BasicBlock::iterator I = Succ->begin();
588 PHINode *PN = dyn_cast<PHINode>(*I); ++I) {
589 // now we have to do the printing
590 Out << string(Indent, ' ');
591 outputLValue(PN);
592 writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
593 Out << "; /* for PHI node */\n";
594 }
595
596 if (!BBFollowsBB(CurBB, Succ)) {
597 Out << string(Indent, ' ') << " goto ";
598 writeOperand(Succ);
599 Out << ";\n";
600 }
601}
602
603// Brach instruction printing - Avoid printing out a brach to a basic block that
604// immediately succeeds the current one.
605//
606void CWriter::visitBranchInst(BranchInst *I) {
607 if (I->isConditional()) {
608 if (isGotoCodeNeccessary(I->getParent(), I->getSuccessor(0))) {
609 Out << " if (";
610 writeOperand(I->getCondition());
611 Out << ") {\n";
612
613 printBranchToBlock(I->getParent(), I->getSuccessor(0), 2);
614
615 if (isGotoCodeNeccessary(I->getParent(), I->getSuccessor(1))) {
616 Out << " } else {\n";
617 printBranchToBlock(I->getParent(), I->getSuccessor(1), 2);
618 }
619 } else {
620 // First goto not neccesary, assume second one is...
621 Out << " if (!";
622 writeOperand(I->getCondition());
623 Out << ") {\n";
624
625 printBranchToBlock(I->getParent(), I->getSuccessor(1), 2);
626 }
627
628 Out << " }\n";
629 } else {
630 printBranchToBlock(I->getParent(), I->getSuccessor(0), 0);
631 }
632 Out << "\n";
633}
634
635
636void CWriter::visitNot(GenericUnaryInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000637 Out << "~";
638 writeOperand(I->getOperand(0));
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000639}
640
641void CWriter::visitBinaryOperator(Instruction *I) {
642 // binary instructions, shift instructions, setCond instructions.
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000643 if (isa<PointerType>(I->getType())) {
644 Out << "(";
645 printType(I->getType());
646 Out << ")";
647 }
648
649 if (isa<PointerType>(I->getType())) Out << "(long long)";
650 writeOperand(I->getOperand(0));
651
652 switch (I->getOpcode()) {
653 case Instruction::Add: Out << " + "; break;
654 case Instruction::Sub: Out << " - "; break;
655 case Instruction::Mul: Out << "*"; break;
656 case Instruction::Div: Out << "/"; break;
657 case Instruction::Rem: Out << "%"; break;
658 case Instruction::And: Out << " & "; break;
659 case Instruction::Or: Out << " | "; break;
660 case Instruction::Xor: Out << " ^ "; break;
661 case Instruction::SetEQ: Out << " == "; break;
662 case Instruction::SetNE: Out << " != "; break;
663 case Instruction::SetLE: Out << " <= "; break;
664 case Instruction::SetGE: Out << " >= "; break;
665 case Instruction::SetLT: Out << " < "; break;
666 case Instruction::SetGT: Out << " > "; break;
667 case Instruction::Shl : Out << " << "; break;
668 case Instruction::Shr : Out << " >> "; break;
669 default: cerr << "Invalid operator type!" << I; abort();
670 }
671
672 if (isa<PointerType>(I->getType())) Out << "(long long)";
673 writeOperand(I->getOperand(1));
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000674}
675
676void CWriter::visitCastInst(CastInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000677 Out << "(";
678 printType(I->getType());
679 Out << ")";
680 writeOperand(I->getOperand(0));
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000681}
682
683void CWriter::visitCallInst(CallInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000684 const PointerType *PTy = cast<PointerType>(I->getCalledValue()->getType());
685 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
686 const Type *RetTy = FTy->getReturnType();
687
688 Out << getValueName(I->getOperand(0)) << "(";
689
690 if (I->getNumOperands() > 1) {
691 writeOperand(I->getOperand(1));
692
693 for (unsigned op = 2, Eop = I->getNumOperands(); op != Eop; ++op) {
694 Out << ", ";
695 writeOperand(I->getOperand(op));
696 }
697 }
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000698 Out << ")";
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000699}
700
701void CWriter::visitMallocInst(MallocInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000702 Out << "(";
703 printType(I->getType());
704 Out << ")malloc(sizeof(";
705 printType(I->getType()->getElementType());
706 Out << ")";
707
708 if (I->isArrayAllocation()) {
709 Out << " * " ;
710 writeOperand(I->getOperand(0));
711 }
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000712 Out << ")";
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000713}
714
715void CWriter::visitAllocaInst(AllocaInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000716 Out << "(";
717 printType(I->getType());
718 Out << ") alloca(sizeof(";
719 printType(I->getType()->getElementType());
720 Out << ")";
721 if (I->isArrayAllocation()) {
722 Out << " * " ;
723 writeOperand(I->getOperand(0));
724 }
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000725 Out << ")";
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000726}
727
728void CWriter::visitFreeInst(FreeInst *I) {
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000729 Out << "free(";
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000730 writeOperand(I->getOperand(0));
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000731 Out << ")";
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000732}
733
734void CWriter::printIndexingExpr(MemAccessInst *MAI) {
735 MemAccessInst::op_iterator I = MAI->idx_begin(), E = MAI->idx_end();
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000736 if (I == E) {
737 // If accessing a global value with no indexing, avoid *(&GV) syndrome
738 if (GlobalValue *V = dyn_cast<GlobalValue>(MAI->getPointerOperand())) {
739 writeOperandInternal(V);
740 return;
741 }
742
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000743 Out << "*"; // Implicit zero first argument: '*x' is equivalent to 'x[0]'
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000744 }
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000745
746 writeOperand(MAI->getPointerOperand());
747
748 if (I == E) return;
749
750 // Print out the -> operator if possible...
751 Constant *CI = dyn_cast<Constant>(*I);
752 if (CI && CI->isNullValue() && I+1 != E &&
753 (*(I+1))->getType() == Type::UByteTy) {
Chris Lattnerd0c668c2002-05-09 21:18:38 +0000754 Out << "->field" << cast<ConstantUInt>(*(I+1))->getValue();
755 I += 2;
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000756 }
757
758 for (; I != E; ++I)
759 if ((*I)->getType() == Type::UIntTy) {
760 Out << "[";
761 writeOperand(*I);
762 Out << "]";
763 } else {
764 Out << ".field" << cast<ConstantUInt>(*I)->getValue();
765 }
766}
767
768void CWriter::visitLoadInst(LoadInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000769 printIndexingExpr(I);
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000770}
771
772void CWriter::visitStoreInst(StoreInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000773 printIndexingExpr(I);
774 Out << " = ";
775 writeOperand(I->getOperand(0));
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000776}
777
778void CWriter::visitGetElementPtrInst(GetElementPtrInst *I) {
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000779 Out << "&";
780 printIndexingExpr(I);
Chris Lattner4fbf26d2002-05-09 20:53:56 +0000781}
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000782
783//===----------------------------------------------------------------------===//
784// External Interface declaration
785//===----------------------------------------------------------------------===//
786
Chris Lattnerf34ee812002-05-09 03:12:34 +0000787void WriteToC(const Module *M, ostream &Out) {
788 assert(M && "You can't write a null module!!");
789 SlotCalculator SlotTable(M, false);
790 CWriter W(Out, SlotTable, M);
Chris Lattner8c3c4bf2002-05-09 15:49:41 +0000791 W.write((Module*)M);
Sumant Kowshik9ddc86c2002-05-08 18:09:58 +0000792 Out.flush();
793}