The first hunk corrects a bug when printing undef null values. We would print
[oota-llvm.git] / lib / Target / CBackend / Writer.cpp
1 //===-- Writer.cpp - Library for converting LLVM code to C ----------------===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This library converts LLVM code to C code, compilable by GCC and other C
11 // compilers.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "CTargetMachine.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/Module.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Pass.h"
21 #include "llvm/PassManager.h"
22 #include "llvm/SymbolTable.h"
23 #include "llvm/Intrinsics.h"
24 #include "llvm/Analysis/ConstantsScanner.h"
25 #include "llvm/Analysis/FindUsedTypes.h"
26 #include "llvm/Analysis/LoopInfo.h"
27 #include "llvm/CodeGen/IntrinsicLowering.h"
28 #include "llvm/Transforms/Scalar.h"
29 #include "llvm/Target/TargetMachineRegistry.h"
30 #include "llvm/Support/CallSite.h"
31 #include "llvm/Support/CFG.h"
32 #include "llvm/Support/GetElementPtrTypeIterator.h"
33 #include "llvm/Support/InstVisitor.h"
34 #include "llvm/Support/Mangler.h"
35 #include "llvm/ADT/StringExtras.h"
36 #include "llvm/Support/MathExtras.h"
37 #include "llvm/Config/config.h"
38 #include <algorithm>
39 #include <iostream>
40 #include <sstream>
41 using namespace llvm;
42
43 namespace {
44   // Register the target.
45   RegisterTarget<CTargetMachine> X("c", "  C backend");
46
47   /// NameAllUsedStructs - This pass inserts names for any unnamed structure
48   /// types that are used by the program.
49   ///
50   class CBackendNameAllUsedStructs : public ModulePass {
51     void getAnalysisUsage(AnalysisUsage &AU) const {
52       AU.addRequired<FindUsedTypes>();
53     }
54
55     virtual const char *getPassName() const {
56       return "C backend type canonicalizer";
57     }
58
59     virtual bool runOnModule(Module &M);
60   };
61   
62   /// CWriter - This class is the main chunk of code that converts an LLVM
63   /// module to a C translation unit.
64   class CWriter : public FunctionPass, public InstVisitor<CWriter> {
65     std::ostream &Out; 
66     IntrinsicLowering &IL;
67     Mangler *Mang;
68     LoopInfo *LI;
69     const Module *TheModule;
70     std::map<const Type *, std::string> TypeNames;
71
72     std::map<const ConstantFP *, unsigned> FPConstantMap;
73   public:
74     CWriter(std::ostream &o, IntrinsicLowering &il) : Out(o), IL(il) {}
75
76     virtual const char *getPassName() const { return "C backend"; }
77
78     void getAnalysisUsage(AnalysisUsage &AU) const {
79       AU.addRequired<LoopInfo>();
80       AU.setPreservesAll();
81     }
82
83     virtual bool doInitialization(Module &M);
84
85     bool runOnFunction(Function &F) {
86       LI = &getAnalysis<LoopInfo>();
87
88       // Output all floating point constants that cannot be printed accurately.
89       printFloatingPointConstants(F);
90   
91       lowerIntrinsics(F);
92       printFunction(F);
93       FPConstantMap.clear();
94       return false;
95     }
96
97     virtual bool doFinalization(Module &M) {
98       // Free memory...
99       delete Mang;
100       TypeNames.clear();
101       return false;
102     }
103
104     std::ostream &printType(std::ostream &Out, const Type *Ty,
105                             const std::string &VariableName = "",
106                             bool IgnoreName = false);
107
108     void writeOperand(Value *Operand);
109     void writeOperandInternal(Value *Operand);
110
111   private :
112     void lowerIntrinsics(Function &F);
113
114     bool nameAllUsedStructureTypes(Module &M);
115     void printModule(Module *M);
116     void printModuleTypes(const SymbolTable &ST);
117     void printContainedStructs(const Type *Ty, std::set<const StructType *> &);
118     void printFloatingPointConstants(Function &F);
119     void printFunctionSignature(const Function *F, bool Prototype);
120
121     void printFunction(Function &);
122     void printBasicBlock(BasicBlock *BB);
123     void printLoop(Loop *L);
124
125     void printConstant(Constant *CPV);
126     void printConstantArray(ConstantArray *CPA);
127
128     // isInlinableInst - Attempt to inline instructions into their uses to build
129     // trees as much as possible.  To do this, we have to consistently decide
130     // what is acceptable to inline, so that variable declarations don't get
131     // printed and an extra copy of the expr is not emitted.
132     //
133     static bool isInlinableInst(const Instruction &I) {
134       // Always inline setcc instructions, even if they are shared by multiple
135       // expressions.  GCC generates horrible code if we don't.
136       if (isa<SetCondInst>(I)) return true;
137
138       // Must be an expression, must be used exactly once.  If it is dead, we
139       // emit it inline where it would go.
140       if (I.getType() == Type::VoidTy || !I.hasOneUse() ||
141           isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I) || 
142           isa<LoadInst>(I) || isa<VAArgInst>(I) || isa<VANextInst>(I))
143         // Don't inline a load across a store or other bad things!
144         return false;
145
146       // Only inline instruction it it's use is in the same BB as the inst.
147       return I.getParent() == cast<Instruction>(I.use_back())->getParent();
148     }
149
150     // isDirectAlloca - Define fixed sized allocas in the entry block as direct
151     // variables which are accessed with the & operator.  This causes GCC to
152     // generate significantly better code than to emit alloca calls directly.
153     //
154     static const AllocaInst *isDirectAlloca(const Value *V) {
155       const AllocaInst *AI = dyn_cast<AllocaInst>(V);
156       if (!AI) return false;
157       if (AI->isArrayAllocation())
158         return 0;   // FIXME: we can also inline fixed size array allocas!
159       if (AI->getParent() != &AI->getParent()->getParent()->getEntryBlock())
160         return 0;
161       return AI;
162     }
163
164     // Instruction visitation functions
165     friend class InstVisitor<CWriter>;
166
167     void visitReturnInst(ReturnInst &I);
168     void visitBranchInst(BranchInst &I);
169     void visitSwitchInst(SwitchInst &I);
170     void visitInvokeInst(InvokeInst &I) {
171       assert(0 && "Lowerinvoke pass didn't work!");
172     }
173
174     void visitUnwindInst(UnwindInst &I) {
175       assert(0 && "Lowerinvoke pass didn't work!");
176     }
177     void visitUnreachableInst(UnreachableInst &I);
178
179     void visitPHINode(PHINode &I);
180     void visitBinaryOperator(Instruction &I);
181
182     void visitCastInst (CastInst &I);
183     void visitSelectInst(SelectInst &I);
184     void visitCallInst (CallInst &I);
185     void visitCallSite (CallSite CS);
186     void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
187
188     void visitMallocInst(MallocInst &I);
189     void visitAllocaInst(AllocaInst &I);
190     void visitFreeInst  (FreeInst   &I);
191     void visitLoadInst  (LoadInst   &I);
192     void visitStoreInst (StoreInst  &I);
193     void visitGetElementPtrInst(GetElementPtrInst &I);
194     void visitVANextInst(VANextInst &I);
195     void visitVAArgInst (VAArgInst &I);
196
197     void visitInstruction(Instruction &I) {
198       std::cerr << "C Writer does not know about " << I;
199       abort();
200     }
201
202     void outputLValue(Instruction *I) {
203       Out << "  " << Mang->getValueName(I) << " = ";
204     }
205
206     bool isGotoCodeNecessary(BasicBlock *From, BasicBlock *To);
207     void printPHICopiesForSuccessors(BasicBlock *CurBlock, 
208                                      unsigned Indent);
209     void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
210                             unsigned Indent);
211     void printIndexingExpression(Value *Ptr, gep_type_iterator I,
212                                  gep_type_iterator E);
213   };
214 }
215
216 /// This method inserts names for any unnamed structure types that are used by
217 /// the program, and removes names from structure types that are not used by the
218 /// program.
219 ///
220 bool CBackendNameAllUsedStructs::runOnModule(Module &M) {
221   // Get a set of types that are used by the program...
222   std::set<const Type *> UT = getAnalysis<FindUsedTypes>().getTypes();
223   
224   // Loop over the module symbol table, removing types from UT that are
225   // already named, and removing names for structure types that are not used.
226   //
227   SymbolTable &MST = M.getSymbolTable();
228   for (SymbolTable::type_iterator TI = MST.type_begin(), TE = MST.type_end();
229        TI != TE; ) {
230     SymbolTable::type_iterator I = TI++;
231     if (const StructType *STy = dyn_cast<StructType>(I->second)) {
232       // If this is not used, remove it from the symbol table.
233       std::set<const Type *>::iterator UTI = UT.find(STy);
234       if (UTI == UT.end())
235         MST.remove(I);
236       else
237         UT.erase(UTI);
238     }
239   }
240
241   // UT now contains types that are not named.  Loop over it, naming
242   // structure types.
243   //
244   bool Changed = false;
245   unsigned RenameCounter = 0;
246   for (std::set<const Type *>::const_iterator I = UT.begin(), E = UT.end();
247        I != E; ++I)
248     if (const StructType *ST = dyn_cast<StructType>(*I)) {
249       while (M.addTypeName("unnamed"+utostr(RenameCounter), ST))
250         ++RenameCounter;
251       Changed = true;
252     }
253   return Changed;
254 }
255
256
257 // Pass the Type* and the variable name and this prints out the variable
258 // declaration.
259 //
260 std::ostream &CWriter::printType(std::ostream &Out, const Type *Ty,
261                                  const std::string &NameSoFar,
262                                  bool IgnoreName) {
263   if (Ty->isPrimitiveType())
264     switch (Ty->getTypeID()) {
265     case Type::VoidTyID:   return Out << "void "               << NameSoFar;
266     case Type::BoolTyID:   return Out << "bool "               << NameSoFar;
267     case Type::UByteTyID:  return Out << "unsigned char "      << NameSoFar;
268     case Type::SByteTyID:  return Out << "signed char "        << NameSoFar;
269     case Type::UShortTyID: return Out << "unsigned short "     << NameSoFar;
270     case Type::ShortTyID:  return Out << "short "              << NameSoFar;
271     case Type::UIntTyID:   return Out << "unsigned "           << NameSoFar;
272     case Type::IntTyID:    return Out << "int "                << NameSoFar;
273     case Type::ULongTyID:  return Out << "unsigned long long " << NameSoFar;
274     case Type::LongTyID:   return Out << "signed long long "   << NameSoFar;
275     case Type::FloatTyID:  return Out << "float "              << NameSoFar;
276     case Type::DoubleTyID: return Out << "double "             << NameSoFar;
277     default :
278       std::cerr << "Unknown primitive type: " << *Ty << "\n";
279       abort();
280     }
281   
282   // Check to see if the type is named.
283   if (!IgnoreName || isa<OpaqueType>(Ty)) {
284     std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
285     if (I != TypeNames.end()) return Out << I->second << " " << NameSoFar;
286   }
287
288   switch (Ty->getTypeID()) {
289   case Type::FunctionTyID: {
290     const FunctionType *MTy = cast<FunctionType>(Ty);
291     std::stringstream FunctionInnards; 
292     FunctionInnards << " (" << NameSoFar << ") (";
293     for (FunctionType::param_iterator I = MTy->param_begin(),
294            E = MTy->param_end(); I != E; ++I) {
295       if (I != MTy->param_begin())
296         FunctionInnards << ", ";
297       printType(FunctionInnards, *I, "");
298     }
299     if (MTy->isVarArg()) {
300       if (MTy->getNumParams()) 
301         FunctionInnards << ", ...";
302     } else if (!MTy->getNumParams()) {
303       FunctionInnards << "void";
304     }
305     FunctionInnards << ")";
306     std::string tstr = FunctionInnards.str();
307     printType(Out, MTy->getReturnType(), tstr);
308     return Out;
309   }
310   case Type::StructTyID: {
311     const StructType *STy = cast<StructType>(Ty);
312     Out << NameSoFar + " {\n";
313     unsigned Idx = 0;
314     for (StructType::element_iterator I = STy->element_begin(),
315            E = STy->element_end(); I != E; ++I) {
316       Out << "  ";
317       printType(Out, *I, "field" + utostr(Idx++));
318       Out << ";\n";
319     }
320     return Out << "}";
321   }  
322
323   case Type::PointerTyID: {
324     const PointerType *PTy = cast<PointerType>(Ty);
325     std::string ptrName = "*" + NameSoFar;
326
327     if (isa<ArrayType>(PTy->getElementType()))
328       ptrName = "(" + ptrName + ")";
329
330     return printType(Out, PTy->getElementType(), ptrName);
331   }
332
333   case Type::ArrayTyID: {
334     const ArrayType *ATy = cast<ArrayType>(Ty);
335     unsigned NumElements = ATy->getNumElements();
336     return printType(Out, ATy->getElementType(),
337                      NameSoFar + "[" + utostr(NumElements) + "]");
338   }
339
340   case Type::OpaqueTyID: {
341     static int Count = 0;
342     std::string TyName = "struct opaque_" + itostr(Count++);
343     assert(TypeNames.find(Ty) == TypeNames.end());
344     TypeNames[Ty] = TyName;
345     return Out << TyName << " " << NameSoFar;
346   }
347   default:
348     assert(0 && "Unhandled case in getTypeProps!");
349     abort();
350   }
351
352   return Out;
353 }
354
355 void CWriter::printConstantArray(ConstantArray *CPA) {
356
357   // As a special case, print the array as a string if it is an array of
358   // ubytes or an array of sbytes with positive values.
359   // 
360   const Type *ETy = CPA->getType()->getElementType();
361   bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
362
363   // Make sure the last character is a null char, as automatically added by C
364   if (isString && (CPA->getNumOperands() == 0 ||
365                    !cast<Constant>(*(CPA->op_end()-1))->isNullValue()))
366     isString = false;
367   
368   if (isString) {
369     Out << "\"";
370     // Keep track of whether the last number was a hexadecimal escape
371     bool LastWasHex = false;
372
373     // Do not include the last character, which we know is null
374     for (unsigned i = 0, e = CPA->getNumOperands()-1; i != e; ++i) {
375       unsigned char C = cast<ConstantInt>(CPA->getOperand(i))->getRawValue();
376       
377       // Print it out literally if it is a printable character.  The only thing
378       // to be careful about is when the last letter output was a hex escape
379       // code, in which case we have to be careful not to print out hex digits
380       // explicitly (the C compiler thinks it is a continuation of the previous
381       // character, sheesh...)
382       //
383       if (isprint(C) && (!LastWasHex || !isxdigit(C))) {
384         LastWasHex = false;
385         if (C == '"' || C == '\\')
386           Out << "\\" << C;
387         else
388           Out << C;
389       } else {
390         LastWasHex = false;
391         switch (C) {
392         case '\n': Out << "\\n"; break;
393         case '\t': Out << "\\t"; break;
394         case '\r': Out << "\\r"; break;
395         case '\v': Out << "\\v"; break;
396         case '\a': Out << "\\a"; break;
397         case '\"': Out << "\\\""; break;
398         case '\'': Out << "\\\'"; break;           
399         default:
400           Out << "\\x";
401           Out << (char)(( C/16  < 10) ? ( C/16 +'0') : ( C/16 -10+'A'));
402           Out << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
403           LastWasHex = true;
404           break;
405         }
406       }
407     }
408     Out << "\"";
409   } else {
410     Out << "{";
411     if (CPA->getNumOperands()) {
412       Out << " ";
413       printConstant(cast<Constant>(CPA->getOperand(0)));
414       for (unsigned i = 1, e = CPA->getNumOperands(); i != e; ++i) {
415         Out << ", ";
416         printConstant(cast<Constant>(CPA->getOperand(i)));
417       }
418     }
419     Out << " }";
420   }
421 }
422
423 // isFPCSafeToPrint - Returns true if we may assume that CFP may be written out
424 // textually as a double (rather than as a reference to a stack-allocated
425 // variable). We decide this by converting CFP to a string and back into a
426 // double, and then checking whether the conversion results in a bit-equal
427 // double to the original value of CFP. This depends on us and the target C
428 // compiler agreeing on the conversion process (which is pretty likely since we
429 // only deal in IEEE FP).
430 //
431 static bool isFPCSafeToPrint(const ConstantFP *CFP) {
432 #if HAVE_PRINTF_A
433   char Buffer[100];
434   sprintf(Buffer, "%a", CFP->getValue());
435
436   if (!strncmp(Buffer, "0x", 2) ||
437       !strncmp(Buffer, "-0x", 3) ||
438       !strncmp(Buffer, "+0x", 3))
439     return atof(Buffer) == CFP->getValue();
440   return false;
441 #else
442   std::string StrVal = ftostr(CFP->getValue());
443
444   while (StrVal[0] == ' ')
445     StrVal.erase(StrVal.begin());
446
447   // Check to make sure that the stringized number is not some string like "Inf"
448   // or NaN.  Check that the string matches the "[-+]?[0-9]" regex.
449   if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
450       ((StrVal[0] == '-' || StrVal[0] == '+') &&
451        (StrVal[1] >= '0' && StrVal[1] <= '9')))
452     // Reparse stringized version!
453     return atof(StrVal.c_str()) == CFP->getValue();
454   return false;
455 #endif
456 }
457
458 // printConstant - The LLVM Constant to C Constant converter.
459 void CWriter::printConstant(Constant *CPV) {
460   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
461     switch (CE->getOpcode()) {
462     case Instruction::Cast:
463       Out << "((";
464       printType(Out, CPV->getType());
465       Out << ")";
466       printConstant(CE->getOperand(0));
467       Out << ")";
468       return;
469
470     case Instruction::GetElementPtr:
471       Out << "(&(";
472       printIndexingExpression(CE->getOperand(0), gep_type_begin(CPV),
473                               gep_type_end(CPV));
474       Out << "))";
475       return;
476     case Instruction::Select:
477       Out << "(";
478       printConstant(CE->getOperand(0));
479       Out << "?";
480       printConstant(CE->getOperand(1));
481       Out << ":";
482       printConstant(CE->getOperand(2));
483       Out << ")";
484       return;
485     case Instruction::Add:
486     case Instruction::Sub:
487     case Instruction::Mul:
488     case Instruction::Div:
489     case Instruction::Rem:
490     case Instruction::SetEQ:
491     case Instruction::SetNE:
492     case Instruction::SetLT:
493     case Instruction::SetLE:
494     case Instruction::SetGT:
495     case Instruction::SetGE:
496     case Instruction::Shl:
497     case Instruction::Shr:
498       Out << "(";
499       printConstant(CE->getOperand(0));
500       switch (CE->getOpcode()) {
501       case Instruction::Add: Out << " + "; break;
502       case Instruction::Sub: Out << " - "; break;
503       case Instruction::Mul: Out << " * "; break;
504       case Instruction::Div: Out << " / "; break;
505       case Instruction::Rem: Out << " % "; break;
506       case Instruction::SetEQ: Out << " == "; break;
507       case Instruction::SetNE: Out << " != "; break;
508       case Instruction::SetLT: Out << " < "; break;
509       case Instruction::SetLE: Out << " <= "; break;
510       case Instruction::SetGT: Out << " > "; break;
511       case Instruction::SetGE: Out << " >= "; break;
512       case Instruction::Shl: Out << " << "; break;
513       case Instruction::Shr: Out << " >> "; break;
514       default: assert(0 && "Illegal opcode here!");
515       }
516       printConstant(CE->getOperand(1));
517       Out << ")";
518       return;
519
520     default:
521       std::cerr << "CWriter Error: Unhandled constant expression: "
522                 << *CE << "\n";
523       abort();
524     }
525   } else if (isa<UndefValue>(CPV) && CPV->getType()->isFirstClassType()) {
526     Out << "((";
527     printType(Out, CPV->getType());
528     Out << ")/*UNDEF*/0)";
529     return;
530   }
531
532   switch (CPV->getType()->getTypeID()) {
533   case Type::BoolTyID:
534     Out << (CPV == ConstantBool::False ? "0" : "1"); break;
535   case Type::SByteTyID:
536   case Type::ShortTyID:
537     Out << cast<ConstantSInt>(CPV)->getValue(); break;
538   case Type::IntTyID:
539     if ((int)cast<ConstantSInt>(CPV)->getValue() == (int)0x80000000)
540       Out << "((int)0x80000000)";   // Handle MININT specially to avoid warning
541     else
542       Out << cast<ConstantSInt>(CPV)->getValue();
543     break;
544
545   case Type::LongTyID:
546     Out << cast<ConstantSInt>(CPV)->getValue() << "ll"; break;
547
548   case Type::UByteTyID:
549   case Type::UShortTyID:
550     Out << cast<ConstantUInt>(CPV)->getValue(); break;
551   case Type::UIntTyID:
552     Out << cast<ConstantUInt>(CPV)->getValue() << "u"; break;
553   case Type::ULongTyID:
554     Out << cast<ConstantUInt>(CPV)->getValue() << "ull"; break;
555
556   case Type::FloatTyID:
557   case Type::DoubleTyID: {
558     ConstantFP *FPC = cast<ConstantFP>(CPV);
559     std::map<const ConstantFP*, unsigned>::iterator I = FPConstantMap.find(FPC);
560     if (I != FPConstantMap.end()) {
561       // Because of FP precision problems we must load from a stack allocated
562       // value that holds the value in hex.
563       Out << "(*(" << (FPC->getType() == Type::FloatTy ? "float" : "double")
564           << "*)&FPConstant" << I->second << ")";
565     } else {
566       if (IsNAN(FPC->getValue())) {
567         // The value is NaN
568  
569         // The prefix for a quiet NaN is 0x7FF8. For a signalling NaN,
570         // it's 0x7ff4.
571         const unsigned long QuietNaN = 0x7ff8UL;
572         const unsigned long SignalNaN = 0x7ff4UL;
573
574         // We need to grab the first part of the FP #
575         union {
576           double   d;
577           uint64_t ll;
578         } DHex;
579         char Buffer[100];
580
581         DHex.d = FPC->getValue();
582         sprintf(Buffer, "0x%llx", (unsigned long long)DHex.ll);
583
584         std::string Num(&Buffer[0], &Buffer[6]);
585         unsigned long Val = strtoul(Num.c_str(), 0, 16);
586
587         if (FPC->getType() == Type::FloatTy)
588           Out << "LLVM_NAN" << (Val == QuietNaN ? "" : "S") << "F(\""
589               << Buffer << "\") /*nan*/ ";
590         else
591           Out << "LLVM_NAN" << (Val == QuietNaN ? "" : "S") << "(\""
592               << Buffer << "\") /*nan*/ ";
593       } else if (IsInf(FPC->getValue())) {
594         // The value is Inf
595         if (FPC->getValue() < 0) Out << "-";
596         Out << "LLVM_INF" << (FPC->getType() == Type::FloatTy ? "F" : "")
597             << " /*inf*/ ";
598       } else {
599         std::string Num;
600 #if HAVE_PRINTF_A
601         // Print out the constant as a floating point number.
602         char Buffer[100];
603         sprintf(Buffer, "%a", FPC->getValue());
604         Num = Buffer;
605 #else
606         Num = ftostr(FPC->getValue());
607 #endif
608         Out << Num;
609       }
610     }
611     break;
612   }
613
614   case Type::ArrayTyID:
615     if (isa<ConstantAggregateZero>(CPV) || isa<UndefValue>(CPV)) {
616       const ArrayType *AT = cast<ArrayType>(CPV->getType());
617       Out << "{";
618       if (AT->getNumElements()) {
619         Out << " ";
620         Constant *CZ = Constant::getNullValue(AT->getElementType());
621         printConstant(CZ);
622         for (unsigned i = 1, e = AT->getNumElements(); i != e; ++i) {
623           Out << ", ";
624           printConstant(CZ);
625         }
626       }
627       Out << " }";
628     } else {
629       printConstantArray(cast<ConstantArray>(CPV));
630     }
631     break;
632
633   case Type::StructTyID:
634     if (isa<ConstantAggregateZero>(CPV) || isa<UndefValue>(CPV)) {
635       const StructType *ST = cast<StructType>(CPV->getType());
636       Out << "{";
637       if (ST->getNumElements()) {
638         Out << " ";
639         printConstant(Constant::getNullValue(ST->getElementType(0)));
640         for (unsigned i = 1, e = ST->getNumElements(); i != e; ++i) {
641           Out << ", ";
642           printConstant(Constant::getNullValue(ST->getElementType(i)));
643         }
644       }
645       Out << " }";
646     } else {
647       Out << "{";
648       if (CPV->getNumOperands()) {
649         Out << " ";
650         printConstant(cast<Constant>(CPV->getOperand(0)));
651         for (unsigned i = 1, e = CPV->getNumOperands(); i != e; ++i) {
652           Out << ", ";
653           printConstant(cast<Constant>(CPV->getOperand(i)));
654         }
655       }
656       Out << " }";
657     }
658     break;
659
660   case Type::PointerTyID:
661     if (isa<ConstantPointerNull>(CPV)) {
662       Out << "((";
663       printType(Out, CPV->getType());
664       Out << ")/*NULL*/0)";
665       break;
666     } else if (GlobalValue *GV = dyn_cast<GlobalValue>(CPV)) {
667       writeOperand(GV);
668       break;
669     }
670     // FALL THROUGH
671   default:
672     std::cerr << "Unknown constant type: " << *CPV << "\n";
673     abort();
674   }
675 }
676
677 void CWriter::writeOperandInternal(Value *Operand) {
678   if (Instruction *I = dyn_cast<Instruction>(Operand))
679     if (isInlinableInst(*I) && !isDirectAlloca(I)) {
680       // Should we inline this instruction to build a tree?
681       Out << "(";
682       visit(*I);
683       Out << ")";    
684       return;
685     }
686   
687   Constant* CPV = dyn_cast<Constant>(Operand);
688   if (CPV && !isa<GlobalValue>(CPV)) {
689     printConstant(CPV); 
690   } else {
691     Out << Mang->getValueName(Operand);
692   }
693 }
694
695 void CWriter::writeOperand(Value *Operand) {
696   if (isa<GlobalVariable>(Operand) || isDirectAlloca(Operand))
697     Out << "(&";  // Global variables are references as their addresses by llvm
698
699   writeOperandInternal(Operand);
700
701   if (isa<GlobalVariable>(Operand) || isDirectAlloca(Operand))
702     Out << ")";
703 }
704
705 // generateCompilerSpecificCode - This is where we add conditional compilation
706 // directives to cater to specific compilers as need be.
707 //
708 static void generateCompilerSpecificCode(std::ostream& Out) {
709   // Alloca is hard to get, and we don't want to include stdlib.h here...
710   Out << "/* get a declaration for alloca */\n"
711       << "#if defined(sun) || defined(__CYGWIN__) || defined(__APPLE__)\n"
712       << "extern void *__builtin_alloca(unsigned long);\n"
713       << "#define alloca(x) __builtin_alloca(x)\n"
714       << "#elif defined(__FreeBSD__)\n"
715       << "#define alloca(x) __builtin_alloca(x)\n"
716       << "#else\n"
717       << "#include <alloca.h>\n"
718       << "#endif\n\n";
719
720   // We output GCC specific attributes to preserve 'linkonce'ness on globals.
721   // If we aren't being compiled with GCC, just drop these attributes.
722   Out << "#ifndef __GNUC__  /* Can only support \"linkonce\" vars with GCC */\n"
723       << "#define __attribute__(X)\n"
724       << "#endif\n\n";
725
726 #if 0
727   // At some point, we should support "external weak" vs. "weak" linkages.
728   // On Mac OS X, "external weak" is spelled "__attribute__((weak_import))".
729   Out << "#if defined(__GNUC__) && defined(__APPLE_CC__)\n"
730       << "#define __EXTERNAL_WEAK__ __attribute__((weak_import))\n"
731       << "#elif defined(__GNUC__)\n"
732       << "#define __EXTERNAL_WEAK__ __attribute__((weak))\n"
733       << "#else\n"
734       << "#define __EXTERNAL_WEAK__\n"
735       << "#endif\n\n";
736 #endif
737
738   // For now, turn off the weak linkage attribute on Mac OS X. (See above.)
739   Out << "#if defined(__GNUC__) && defined(__APPLE_CC__)\n"
740       << "#define __ATTRIBUTE_WEAK__\n"
741       << "#elif defined(__GNUC__)\n"
742       << "#define __ATTRIBUTE_WEAK__ __attribute__((weak))\n"
743       << "#else\n"
744       << "#define __ATTRIBUTE_WEAK__\n"
745       << "#endif\n\n";
746
747   // Define NaN and Inf as GCC builtins if using GCC, as 0 otherwise
748   // From the GCC documentation:
749   // 
750   //   double __builtin_nan (const char *str)
751   //
752   // This is an implementation of the ISO C99 function nan.
753   //
754   // Since ISO C99 defines this function in terms of strtod, which we do
755   // not implement, a description of the parsing is in order. The string is
756   // parsed as by strtol; that is, the base is recognized by leading 0 or
757   // 0x prefixes. The number parsed is placed in the significand such that
758   // the least significant bit of the number is at the least significant
759   // bit of the significand. The number is truncated to fit the significand
760   // field provided. The significand is forced to be a quiet NaN.
761   //
762   // This function, if given a string literal, is evaluated early enough
763   // that it is considered a compile-time constant.
764   //
765   //   float __builtin_nanf (const char *str)
766   //
767   // Similar to __builtin_nan, except the return type is float.
768   //
769   //   double __builtin_inf (void)
770   //
771   // Similar to __builtin_huge_val, except a warning is generated if the
772   // target floating-point format does not support infinities. This
773   // function is suitable for implementing the ISO C99 macro INFINITY.
774   //
775   //   float __builtin_inff (void)
776   //
777   // Similar to __builtin_inf, except the return type is float.
778   Out << "#ifdef __GNUC__\n"
779       << "#define LLVM_NAN(NanStr)   __builtin_nan(NanStr)   /* Double */\n"
780       << "#define LLVM_NANF(NanStr)  __builtin_nanf(NanStr)  /* Float */\n"
781       << "#define LLVM_NANS(NanStr)  __builtin_nans(NanStr)  /* Double */\n"
782       << "#define LLVM_NANSF(NanStr) __builtin_nansf(NanStr) /* Float */\n"
783       << "#define LLVM_INF           __builtin_inf()         /* Double */\n"
784       << "#define LLVM_INFF          __builtin_inff()        /* Float */\n"
785       << "#else\n"
786       << "#define LLVM_NAN(NanStr)   ((double)0.0)           /* Double */\n"
787       << "#define LLVM_NANF(NanStr)  0.0F                    /* Float */\n"
788       << "#define LLVM_NANS(NanStr)  ((double)0.0)           /* Double */\n"
789       << "#define LLVM_NANSF(NanStr) 0.0F                    /* Float */\n"
790       << "#define LLVM_INF           ((double)0.0)           /* Double */\n"
791       << "#define LLVM_INFF          0.0F                    /* Float */\n"
792       << "#endif\n";
793 }
794
795 bool CWriter::doInitialization(Module &M) {
796   // Initialize
797   TheModule = &M;
798
799   IL.AddPrototypes(M);
800   
801   // Ensure that all structure types have names...
802   Mang = new Mangler(M);
803
804   // get declaration for alloca
805   Out << "/* Provide Declarations */\n";
806   Out << "#include <stdarg.h>\n";      // Varargs support
807   Out << "#include <setjmp.h>\n";      // Unwind support
808   generateCompilerSpecificCode(Out);
809
810   // Provide a definition for `bool' if not compiling with a C++ compiler.
811   Out << "\n"
812       << "#ifndef __cplusplus\ntypedef unsigned char bool;\n#endif\n"
813     
814       << "\n\n/* Support for floating point constants */\n"
815       << "typedef unsigned long long ConstantDoubleTy;\n"
816       << "typedef unsigned int        ConstantFloatTy;\n"
817     
818       << "\n\n/* Global Declarations */\n";
819
820   // First output all the declarations for the program, because C requires
821   // Functions & globals to be declared before they are used.
822   //
823
824   // Loop over the symbol table, emitting all named constants...
825   printModuleTypes(M.getSymbolTable());
826
827   // Global variable declarations...
828   if (!M.gempty()) {
829     Out << "\n/* External Global Variable Declarations */\n";
830     for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I) {
831       if (I->hasExternalLinkage()) {
832         Out << "extern ";
833         printType(Out, I->getType()->getElementType(), Mang->getValueName(I));
834         Out << ";\n";
835       }
836     }
837   }
838
839   // Function declarations
840   if (!M.empty()) {
841     Out << "\n/* Function Declarations */\n";
842     for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
843       // Don't print declarations for intrinsic functions.
844       if (!I->getIntrinsicID() && 
845           I->getName() != "setjmp" && I->getName() != "longjmp") {
846         printFunctionSignature(I, true);
847         if (I->hasWeakLinkage()) Out << " __ATTRIBUTE_WEAK__";
848         if (I->hasLinkOnceLinkage()) Out << " __ATTRIBUTE_WEAK__";
849         Out << ";\n";
850       }
851     }
852   }
853
854   // Output the global variable declarations
855   if (!M.gempty()) {
856     Out << "\n\n/* Global Variable Declarations */\n";
857     for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
858       if (!I->isExternal()) {
859         Out << "extern ";
860         printType(Out, I->getType()->getElementType(), Mang->getValueName(I));
861
862         if (I->hasLinkOnceLinkage())
863           Out << " __attribute__((common))";
864         else if (I->hasWeakLinkage())
865           Out << " __ATTRIBUTE_WEAK__";
866         Out << ";\n";
867       }
868   }
869
870   // Output the global variable definitions and contents...
871   if (!M.gempty()) {
872     Out << "\n\n/* Global Variable Definitions and Initialization */\n";
873     for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
874       if (!I->isExternal()) {
875         if (I->hasInternalLinkage())
876           Out << "static ";
877         printType(Out, I->getType()->getElementType(), Mang->getValueName(I));
878         if (I->hasLinkOnceLinkage())
879           Out << " __attribute__((common))";
880         else if (I->hasWeakLinkage())
881           Out << " __ATTRIBUTE_WEAK__";
882
883         // If the initializer is not null, emit the initializer.  If it is null,
884         // we try to avoid emitting large amounts of zeros.  The problem with
885         // this, however, occurs when the variable has weak linkage.  In this
886         // case, the assembler will complain about the variable being both weak
887         // and common, so we disable this optimization.
888         if (!I->getInitializer()->isNullValue()) {
889           Out << " = " ;
890           writeOperand(I->getInitializer());
891         } else if (I->hasWeakLinkage()) {
892           // We have to specify an initializer, but it doesn't have to be
893           // complete.  If the value is an aggregate, print out { 0 }, and let
894           // the compiler figure out the rest of the zeros.
895           Out << " = " ;
896           if (isa<StructType>(I->getInitializer()->getType()) ||
897               isa<ArrayType>(I->getInitializer()->getType())) {
898             Out << "{ 0 }";
899           } else {
900             // Just print it out normally.
901             writeOperand(I->getInitializer());
902           }
903         }
904         Out << ";\n";
905       }
906   }
907
908   if (!M.empty())
909     Out << "\n\n/* Function Bodies */\n";
910   return false;
911 }
912
913
914 /// Output all floating point constants that cannot be printed accurately...
915 void CWriter::printFloatingPointConstants(Function &F) {
916   union {
917     double D;
918     uint64_t U;
919   } DBLUnion;
920
921   union {
922     float F;
923     unsigned U;
924   } FLTUnion;
925
926   // Scan the module for floating point constants.  If any FP constant is used
927   // in the function, we want to redirect it here so that we do not depend on
928   // the precision of the printed form, unless the printed form preserves
929   // precision.
930   //
931   static unsigned FPCounter = 0;
932   for (constant_iterator I = constant_begin(&F), E = constant_end(&F);
933        I != E; ++I)
934     if (const ConstantFP *FPC = dyn_cast<ConstantFP>(*I))
935       if (!isFPCSafeToPrint(FPC) && // Do not put in FPConstantMap if safe.
936           !FPConstantMap.count(FPC)) {
937         double Val = FPC->getValue();
938         
939         FPConstantMap[FPC] = FPCounter;  // Number the FP constants
940         
941         if (FPC->getType() == Type::DoubleTy) {
942           DBLUnion.D = Val;
943           Out << "static const ConstantDoubleTy FPConstant" << FPCounter++
944               << " = 0x" << std::hex << DBLUnion.U << std::dec
945               << "ULL;    /* " << Val << " */\n";
946         } else if (FPC->getType() == Type::FloatTy) {
947           FLTUnion.F = Val;
948           Out << "static const ConstantFloatTy FPConstant" << FPCounter++
949               << " = 0x" << std::hex << FLTUnion.U << std::dec
950               << "U;    /* " << Val << " */\n";
951         } else
952           assert(0 && "Unknown float type!");
953       }
954   
955   Out << "\n";
956 }
957
958
959 /// printSymbolTable - Run through symbol table looking for type names.  If a
960 /// type name is found, emit it's declaration...
961 ///
962 void CWriter::printModuleTypes(const SymbolTable &ST) {
963   // If there are no type names, exit early.
964   if ( ! ST.hasTypes() )
965     return;
966
967   // We are only interested in the type plane of the symbol table...
968   SymbolTable::type_const_iterator I   = ST.type_begin();
969   SymbolTable::type_const_iterator End = ST.type_end();
970   
971   // Print out forward declarations for structure types before anything else!
972   Out << "/* Structure forward decls */\n";
973   for (; I != End; ++I)
974     if (const Type *STy = dyn_cast<StructType>(I->second)) {
975       std::string Name = "struct l_" + Mangler::makeNameProper(I->first);
976       Out << Name << ";\n";
977       TypeNames.insert(std::make_pair(STy, Name));
978     }
979
980   Out << "\n";
981
982   // Now we can print out typedefs...
983   Out << "/* Typedefs */\n";
984   for (I = ST.type_begin(); I != End; ++I) {
985     const Type *Ty = cast<Type>(I->second);
986     std::string Name = "l_" + Mangler::makeNameProper(I->first);
987     Out << "typedef ";
988     printType(Out, Ty, Name);
989     Out << ";\n";
990   }
991   
992   Out << "\n";
993
994   // Keep track of which structures have been printed so far...
995   std::set<const StructType *> StructPrinted;
996
997   // Loop over all structures then push them into the stack so they are
998   // printed in the correct order.
999   //
1000   Out << "/* Structure contents */\n";
1001   for (I = ST.type_begin(); I != End; ++I)
1002     if (const StructType *STy = dyn_cast<StructType>(I->second))
1003       // Only print out used types!
1004       printContainedStructs(STy, StructPrinted);
1005 }
1006
1007 // Push the struct onto the stack and recursively push all structs
1008 // this one depends on.
1009 void CWriter::printContainedStructs(const Type *Ty,
1010                                     std::set<const StructType*> &StructPrinted){
1011   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
1012     //Check to see if we have already printed this struct
1013     if (StructPrinted.count(STy) == 0) {
1014       // Print all contained types first...
1015       for (StructType::element_iterator I = STy->element_begin(),
1016              E = STy->element_end(); I != E; ++I) {
1017         const Type *Ty1 = I->get();
1018         if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
1019           printContainedStructs(*I, StructPrinted);
1020       }
1021       
1022       //Print structure type out..
1023       StructPrinted.insert(STy);
1024       std::string Name = TypeNames[STy];  
1025       printType(Out, STy, Name, true);
1026       Out << ";\n\n";
1027     }
1028
1029     // If it is an array, check contained types and continue
1030   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)){
1031     const Type *Ty1 = ATy->getElementType();
1032     if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
1033       printContainedStructs(Ty1, StructPrinted);
1034   }
1035 }
1036
1037
1038 void CWriter::printFunctionSignature(const Function *F, bool Prototype) {
1039   if (F->hasInternalLinkage()) Out << "static ";
1040   
1041   // Loop over the arguments, printing them...
1042   const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
1043   
1044   std::stringstream FunctionInnards; 
1045     
1046   // Print out the name...
1047   FunctionInnards << Mang->getValueName(F) << "(";
1048     
1049   if (!F->isExternal()) {
1050     if (!F->aempty()) {
1051       std::string ArgName;
1052       if (F->abegin()->hasName() || !Prototype)
1053         ArgName = Mang->getValueName(F->abegin());
1054       printType(FunctionInnards, F->afront().getType(), ArgName);
1055       for (Function::const_aiterator I = ++F->abegin(), E = F->aend();
1056            I != E; ++I) {
1057         FunctionInnards << ", ";
1058         if (I->hasName() || !Prototype)
1059           ArgName = Mang->getValueName(I);
1060         else 
1061           ArgName = "";
1062         printType(FunctionInnards, I->getType(), ArgName);
1063       }
1064     }
1065   } else {
1066     // Loop over the arguments, printing them...
1067     for (FunctionType::param_iterator I = FT->param_begin(),
1068            E = FT->param_end(); I != E; ++I) {
1069       if (I != FT->param_begin()) FunctionInnards << ", ";
1070       printType(FunctionInnards, *I);
1071     }
1072   }
1073
1074   // Finish printing arguments... if this is a vararg function, print the ...,
1075   // unless there are no known types, in which case, we just emit ().
1076   //
1077   if (FT->isVarArg() && FT->getNumParams()) {
1078     if (FT->getNumParams()) FunctionInnards << ", ";
1079     FunctionInnards << "...";  // Output varargs portion of signature!
1080   } else if (!FT->isVarArg() && FT->getNumParams() == 0) {
1081     FunctionInnards << "void"; // ret() -> ret(void) in C.
1082   }
1083   FunctionInnards << ")";
1084   // Print out the return type and the entire signature for that matter
1085   printType(Out, F->getReturnType(), FunctionInnards.str());
1086 }
1087
1088 void CWriter::printFunction(Function &F) {
1089   printFunctionSignature(&F, false);
1090   Out << " {\n";
1091
1092   // print local variable information for the function
1093   for (inst_iterator I = inst_begin(&F), E = inst_end(&F); I != E; ++I)
1094     if (const AllocaInst *AI = isDirectAlloca(&*I)) {
1095       Out << "  ";
1096       printType(Out, AI->getAllocatedType(), Mang->getValueName(AI));
1097       Out << ";    /* Address exposed local */\n";
1098     } else if (I->getType() != Type::VoidTy && !isInlinableInst(*I)) {
1099       Out << "  ";
1100       printType(Out, I->getType(), Mang->getValueName(&*I));
1101       Out << ";\n";
1102       
1103       if (isa<PHINode>(*I)) {  // Print out PHI node temporaries as well...
1104         Out << "  ";
1105         printType(Out, I->getType(),
1106                   Mang->getValueName(&*I)+"__PHI_TEMPORARY");
1107         Out << ";\n";
1108       }
1109     }
1110
1111   Out << "\n";
1112
1113   // print the basic blocks
1114   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
1115     if (Loop *L = LI->getLoopFor(BB)) {
1116       if (L->getHeader() == BB && L->getParentLoop() == 0)
1117         printLoop(L);
1118     } else {
1119       printBasicBlock(BB);
1120     }
1121   }
1122   
1123   Out << "}\n\n";
1124 }
1125
1126 void CWriter::printLoop(Loop *L) {
1127   Out << "  do {     /* Syntactic loop '" << L->getHeader()->getName()
1128       << "' to make GCC happy */\n";
1129   for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i) {
1130     BasicBlock *BB = L->getBlocks()[i];
1131     Loop *BBLoop = LI->getLoopFor(BB);
1132     if (BBLoop == L)
1133       printBasicBlock(BB);
1134     else if (BB == BBLoop->getHeader() && BBLoop->getParentLoop() == L)
1135       printLoop(BBLoop);      
1136   }
1137   Out << "  } while (1); /* end of syntactic loop '"
1138       << L->getHeader()->getName() << "' */\n";
1139 }
1140
1141 void CWriter::printBasicBlock(BasicBlock *BB) {
1142
1143   // Don't print the label for the basic block if there are no uses, or if
1144   // the only terminator use is the predecessor basic block's terminator.
1145   // We have to scan the use list because PHI nodes use basic blocks too but
1146   // do not require a label to be generated.
1147   //
1148   bool NeedsLabel = false;
1149   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1150     if (isGotoCodeNecessary(*PI, BB)) {
1151       NeedsLabel = true;
1152       break;
1153     }
1154       
1155   if (NeedsLabel) Out << Mang->getValueName(BB) << ":\n";
1156       
1157   // Output all of the instructions in the basic block...
1158   for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E;
1159        ++II) {
1160     if (!isInlinableInst(*II) && !isDirectAlloca(II)) {
1161       if (II->getType() != Type::VoidTy)
1162         outputLValue(II);
1163       else
1164         Out << "  ";
1165       visit(*II);
1166       Out << ";\n";
1167     }
1168   }
1169       
1170   // Don't emit prefix or suffix for the terminator...
1171   visit(*BB->getTerminator());
1172 }
1173
1174
1175 // Specific Instruction type classes... note that all of the casts are
1176 // necessary because we use the instruction classes as opaque types...
1177 //
1178 void CWriter::visitReturnInst(ReturnInst &I) {
1179   // Don't output a void return if this is the last basic block in the function
1180   if (I.getNumOperands() == 0 && 
1181       &*--I.getParent()->getParent()->end() == I.getParent() &&
1182       !I.getParent()->size() == 1) {
1183     return;
1184   }
1185
1186   Out << "  return";
1187   if (I.getNumOperands()) {
1188     Out << " ";
1189     writeOperand(I.getOperand(0));
1190   }
1191   Out << ";\n";
1192 }
1193
1194 void CWriter::visitSwitchInst(SwitchInst &SI) {
1195   printPHICopiesForSuccessors(SI.getParent(), 0);
1196
1197   Out << "  switch (";
1198   writeOperand(SI.getOperand(0));
1199   Out << ") {\n  default:\n";
1200   printBranchToBlock(SI.getParent(), SI.getDefaultDest(), 2);
1201   Out << ";\n";
1202   for (unsigned i = 2, e = SI.getNumOperands(); i != e; i += 2) {
1203     Out << "  case ";
1204     writeOperand(SI.getOperand(i));
1205     Out << ":\n";
1206     BasicBlock *Succ = cast<BasicBlock>(SI.getOperand(i+1));
1207     printBranchToBlock(SI.getParent(), Succ, 2);
1208     if (Succ == SI.getParent()->getNext())
1209       Out << "    break;\n";
1210   }
1211   Out << "  }\n";
1212 }
1213
1214 void CWriter::visitUnreachableInst(UnreachableInst &I) {
1215   Out << "  /*UNREACHABLE*/\n";
1216 }
1217
1218 bool CWriter::isGotoCodeNecessary(BasicBlock *From, BasicBlock *To) {
1219   /// FIXME: This should be reenabled, but loop reordering safe!!
1220   return true;
1221
1222   if (From->getNext() != To) // Not the direct successor, we need a goto
1223     return true; 
1224
1225   //isa<SwitchInst>(From->getTerminator())
1226
1227
1228   if (LI->getLoopFor(From) != LI->getLoopFor(To))
1229     return true;
1230   return false;
1231 }
1232
1233 void CWriter::printPHICopiesForSuccessors(BasicBlock *CurBlock, 
1234                                           unsigned Indent) {
1235   for (succ_iterator SI = succ_begin(CurBlock), E = succ_end(CurBlock);
1236        SI != E; ++SI)
1237     for (BasicBlock::iterator I = SI->begin(); isa<PHINode>(I); ++I) {
1238       PHINode *PN = cast<PHINode>(I);
1239       // Now we have to do the printing.
1240       Value *IV = PN->getIncomingValueForBlock(CurBlock);
1241       if (!isa<UndefValue>(IV)) {
1242         Out << std::string(Indent, ' ');
1243         Out << "  " << Mang->getValueName(I) << "__PHI_TEMPORARY = ";
1244         writeOperand(IV);
1245         Out << ";   /* for PHI node */\n";
1246       }
1247     }
1248 }
1249
1250
1251 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
1252                                  unsigned Indent) {
1253   if (isGotoCodeNecessary(CurBB, Succ)) {
1254     Out << std::string(Indent, ' ') << "  goto ";
1255     writeOperand(Succ);
1256     Out << ";\n";
1257   }
1258 }
1259
1260 // Branch instruction printing - Avoid printing out a branch to a basic block
1261 // that immediately succeeds the current one.
1262 //
1263 void CWriter::visitBranchInst(BranchInst &I) {
1264   printPHICopiesForSuccessors(I.getParent(), 0);
1265
1266   if (I.isConditional()) {
1267     if (isGotoCodeNecessary(I.getParent(), I.getSuccessor(0))) {
1268       Out << "  if (";
1269       writeOperand(I.getCondition());
1270       Out << ") {\n";
1271       
1272       printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
1273       
1274       if (isGotoCodeNecessary(I.getParent(), I.getSuccessor(1))) {
1275         Out << "  } else {\n";
1276         printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
1277       }
1278     } else {
1279       // First goto not necessary, assume second one is...
1280       Out << "  if (!";
1281       writeOperand(I.getCondition());
1282       Out << ") {\n";
1283
1284       printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
1285     }
1286
1287     Out << "  }\n";
1288   } else {
1289     printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
1290   }
1291   Out << "\n";
1292 }
1293
1294 // PHI nodes get copied into temporary values at the end of predecessor basic
1295 // blocks.  We now need to copy these temporary values into the REAL value for
1296 // the PHI.
1297 void CWriter::visitPHINode(PHINode &I) {
1298   writeOperand(&I);
1299   Out << "__PHI_TEMPORARY";
1300 }
1301
1302
1303 void CWriter::visitBinaryOperator(Instruction &I) {
1304   // binary instructions, shift instructions, setCond instructions.
1305   assert(!isa<PointerType>(I.getType()));
1306
1307   // We must cast the results of binary operations which might be promoted.
1308   bool needsCast = false;
1309   if ((I.getType() == Type::UByteTy) || (I.getType() == Type::SByteTy)
1310       || (I.getType() == Type::UShortTy) || (I.getType() == Type::ShortTy)
1311       || (I.getType() == Type::FloatTy)) {
1312     needsCast = true;
1313     Out << "((";
1314     printType(Out, I.getType());
1315     Out << ")(";
1316   }
1317       
1318   writeOperand(I.getOperand(0));
1319
1320   switch (I.getOpcode()) {
1321   case Instruction::Add: Out << " + "; break;
1322   case Instruction::Sub: Out << " - "; break;
1323   case Instruction::Mul: Out << "*"; break;
1324   case Instruction::Div: Out << "/"; break;
1325   case Instruction::Rem: Out << "%"; break;
1326   case Instruction::And: Out << " & "; break;
1327   case Instruction::Or: Out << " | "; break;
1328   case Instruction::Xor: Out << " ^ "; break;
1329   case Instruction::SetEQ: Out << " == "; break;
1330   case Instruction::SetNE: Out << " != "; break;
1331   case Instruction::SetLE: Out << " <= "; break;
1332   case Instruction::SetGE: Out << " >= "; break;
1333   case Instruction::SetLT: Out << " < "; break;
1334   case Instruction::SetGT: Out << " > "; break;
1335   case Instruction::Shl : Out << " << "; break;
1336   case Instruction::Shr : Out << " >> "; break;
1337   default: std::cerr << "Invalid operator type!" << I; abort();
1338   }
1339
1340   writeOperand(I.getOperand(1));
1341
1342   if (needsCast) {
1343     Out << "))";
1344   }
1345 }
1346
1347 void CWriter::visitCastInst(CastInst &I) {
1348   if (I.getType() == Type::BoolTy) {
1349     Out << "(";
1350     writeOperand(I.getOperand(0));
1351     Out << " != 0)";
1352     return;
1353   }
1354   Out << "(";
1355   printType(Out, I.getType());
1356   Out << ")";
1357   if (isa<PointerType>(I.getType())&&I.getOperand(0)->getType()->isIntegral() ||
1358       isa<PointerType>(I.getOperand(0)->getType())&&I.getType()->isIntegral()) {
1359     // Avoid "cast to pointer from integer of different size" warnings
1360     Out << "(long)";  
1361   }
1362   
1363   writeOperand(I.getOperand(0));
1364 }
1365
1366 void CWriter::visitSelectInst(SelectInst &I) {
1367   Out << "((";
1368   writeOperand(I.getCondition());
1369   Out << ") ? (";
1370   writeOperand(I.getTrueValue());
1371   Out << ") : (";
1372   writeOperand(I.getFalseValue());
1373   Out << "))";    
1374 }
1375
1376
1377 void CWriter::lowerIntrinsics(Function &F) {
1378   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
1379     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; )
1380       if (CallInst *CI = dyn_cast<CallInst>(I++))
1381         if (Function *F = CI->getCalledFunction())
1382           switch (F->getIntrinsicID()) {
1383           case Intrinsic::not_intrinsic:
1384           case Intrinsic::vastart:
1385           case Intrinsic::vacopy:
1386           case Intrinsic::vaend:
1387           case Intrinsic::returnaddress:
1388           case Intrinsic::frameaddress:
1389           case Intrinsic::setjmp:
1390           case Intrinsic::longjmp:
1391             // We directly implement these intrinsics
1392             break;
1393           default:
1394             // All other intrinsic calls we must lower.
1395             Instruction *Before = CI->getPrev();
1396             IL.LowerIntrinsicCall(CI);
1397             if (Before) {        // Move iterator to instruction after call
1398               I = Before; ++I;
1399             } else {
1400               I = BB->begin();
1401             }
1402           }
1403 }
1404
1405
1406
1407 void CWriter::visitCallInst(CallInst &I) {
1408   // Handle intrinsic function calls first...
1409   if (Function *F = I.getCalledFunction())
1410     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID()) {
1411       switch (ID) {
1412       default: assert(0 && "Unknown LLVM intrinsic!");
1413       case Intrinsic::vastart: 
1414         Out << "0; ";
1415         
1416         Out << "va_start(*(va_list*)&" << Mang->getValueName(&I) << ", ";
1417         // Output the last argument to the enclosing function...
1418         if (I.getParent()->getParent()->aempty()) {
1419           std::cerr << "The C backend does not currently support zero "
1420                     << "argument varargs functions, such as '"
1421                     << I.getParent()->getParent()->getName() << "'!\n";
1422           abort();
1423         }
1424         writeOperand(&I.getParent()->getParent()->aback());
1425         Out << ")";
1426         return;
1427       case Intrinsic::vaend:
1428         if (!isa<ConstantPointerNull>(I.getOperand(1))) {
1429           Out << "va_end(*(va_list*)&";
1430           writeOperand(I.getOperand(1));
1431           Out << ")";
1432         } else {
1433           Out << "va_end(*(va_list*)0)";
1434         }
1435         return;
1436       case Intrinsic::vacopy:
1437         Out << "0;";
1438         Out << "va_copy(*(va_list*)&" << Mang->getValueName(&I) << ", ";
1439         Out << "*(va_list*)&";
1440         writeOperand(I.getOperand(1));
1441         Out << ")";
1442         return;
1443       case Intrinsic::returnaddress:
1444         Out << "__builtin_return_address(";
1445         writeOperand(I.getOperand(1));
1446         Out << ")";
1447         return;
1448       case Intrinsic::frameaddress:
1449         Out << "__builtin_frame_address(";
1450         writeOperand(I.getOperand(1));
1451         Out << ")";
1452         return;
1453       case Intrinsic::setjmp:
1454         Out << "setjmp(*(jmp_buf*)";
1455         writeOperand(I.getOperand(1));
1456         Out << ")";
1457         return;
1458       case Intrinsic::longjmp:
1459         Out << "longjmp(*(jmp_buf*)";
1460         writeOperand(I.getOperand(1));
1461         Out << ", ";
1462         writeOperand(I.getOperand(2));
1463         Out << ")";
1464         return;
1465       }
1466     }
1467   visitCallSite(&I);
1468 }
1469
1470 void CWriter::visitCallSite(CallSite CS) {
1471   const PointerType  *PTy   = cast<PointerType>(CS.getCalledValue()->getType());
1472   const FunctionType *FTy   = cast<FunctionType>(PTy->getElementType());
1473   const Type         *RetTy = FTy->getReturnType();
1474   
1475   writeOperand(CS.getCalledValue());
1476   Out << "(";
1477
1478   if (CS.arg_begin() != CS.arg_end()) {
1479     CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
1480     writeOperand(*AI);
1481
1482     for (++AI; AI != AE; ++AI) {
1483       Out << ", ";
1484       writeOperand(*AI);
1485     }
1486   }
1487   Out << ")";
1488 }  
1489
1490 void CWriter::visitMallocInst(MallocInst &I) {
1491   assert(0 && "lowerallocations pass didn't work!");
1492 }
1493
1494 void CWriter::visitAllocaInst(AllocaInst &I) {
1495   Out << "(";
1496   printType(Out, I.getType());
1497   Out << ") alloca(sizeof(";
1498   printType(Out, I.getType()->getElementType());
1499   Out << ")";
1500   if (I.isArrayAllocation()) {
1501     Out << " * " ;
1502     writeOperand(I.getOperand(0));
1503   }
1504   Out << ")";
1505 }
1506
1507 void CWriter::visitFreeInst(FreeInst &I) {
1508   assert(0 && "lowerallocations pass didn't work!");
1509 }
1510
1511 void CWriter::printIndexingExpression(Value *Ptr, gep_type_iterator I,
1512                                       gep_type_iterator E) {
1513   bool HasImplicitAddress = false;
1514   // If accessing a global value with no indexing, avoid *(&GV) syndrome
1515   if (GlobalValue *V = dyn_cast<GlobalValue>(Ptr)) {
1516     HasImplicitAddress = true;
1517   } else if (isDirectAlloca(Ptr)) {
1518     HasImplicitAddress = true;
1519   }
1520
1521   if (I == E) {
1522     if (!HasImplicitAddress)
1523       Out << "*";  // Implicit zero first argument: '*x' is equivalent to 'x[0]'
1524
1525     writeOperandInternal(Ptr);
1526     return;
1527   }
1528
1529   const Constant *CI = dyn_cast<Constant>(I.getOperand());
1530   if (HasImplicitAddress && (!CI || !CI->isNullValue()))
1531     Out << "(&";
1532
1533   writeOperandInternal(Ptr);
1534
1535   if (HasImplicitAddress && (!CI || !CI->isNullValue())) {
1536     Out << ")";
1537     HasImplicitAddress = false;  // HIA is only true if we haven't addressed yet
1538   }
1539
1540   assert(!HasImplicitAddress || (CI && CI->isNullValue()) &&
1541          "Can only have implicit address with direct accessing");
1542
1543   if (HasImplicitAddress) {
1544     ++I;
1545   } else if (CI && CI->isNullValue()) {
1546     gep_type_iterator TmpI = I; ++TmpI;
1547
1548     // Print out the -> operator if possible...
1549     if (TmpI != E && isa<StructType>(*TmpI)) {
1550       Out << (HasImplicitAddress ? "." : "->");
1551       Out << "field" << cast<ConstantUInt>(TmpI.getOperand())->getValue();
1552       I = ++TmpI;
1553     }
1554   }
1555
1556   for (; I != E; ++I)
1557     if (isa<StructType>(*I)) {
1558       Out << ".field" << cast<ConstantUInt>(I.getOperand())->getValue();
1559     } else {
1560       Out << "[";
1561       writeOperand(I.getOperand());
1562       Out << "]";
1563     }
1564 }
1565
1566 void CWriter::visitLoadInst(LoadInst &I) {
1567   Out << "*";
1568   writeOperand(I.getOperand(0));
1569 }
1570
1571 void CWriter::visitStoreInst(StoreInst &I) {
1572   Out << "*";
1573   writeOperand(I.getPointerOperand());
1574   Out << " = ";
1575   writeOperand(I.getOperand(0));
1576 }
1577
1578 void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
1579   Out << "&";
1580   printIndexingExpression(I.getPointerOperand(), gep_type_begin(I),
1581                           gep_type_end(I));
1582 }
1583
1584 void CWriter::visitVANextInst(VANextInst &I) {
1585   Out << Mang->getValueName(I.getOperand(0));
1586   Out << ";  va_arg(*(va_list*)&" << Mang->getValueName(&I) << ", ";
1587   printType(Out, I.getArgType());
1588   Out << ")";  
1589 }
1590
1591 void CWriter::visitVAArgInst(VAArgInst &I) {
1592   Out << "0;\n";
1593   Out << "{ va_list Tmp; va_copy(Tmp, *(va_list*)&";
1594   writeOperand(I.getOperand(0));
1595   Out << ");\n  " << Mang->getValueName(&I) << " = va_arg(Tmp, ";
1596   printType(Out, I.getType());
1597   Out << ");\n  va_end(Tmp); }";
1598 }
1599
1600 //===----------------------------------------------------------------------===//
1601 //                       External Interface declaration
1602 //===----------------------------------------------------------------------===//
1603
1604 bool CTargetMachine::addPassesToEmitAssembly(PassManager &PM, std::ostream &o) {
1605   PM.add(createLowerGCPass());
1606   PM.add(createLowerAllocationsPass());
1607   PM.add(createLowerInvokePass());
1608   PM.add(new CBackendNameAllUsedStructs());
1609   PM.add(new CWriter(o, getIntrinsicLowering()));
1610   return false;
1611 }
1612
1613 // vim: sw=2