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