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