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/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";
 589 }
 590
 591 // generateProcessorSpecificCode - This is where we add conditional compilation
 592 // directives to cater to specific processors as need be.
 593 //
 594 static void generateProcessorSpecificCode(std::ostream& Out) {
 595   // According to ANSI C, longjmp'ing to a setjmp could invalidate any
 596   // non-volatile variable in the scope of the setjmp.  For now, we are not
 597   // doing analysis to determine which variables need to be marked volatile, so
 598   // we just mark them all.
 599   //
 600   // HOWEVER, many targets implement setjmp by saving and restoring the register
 601   // file, so they DON'T need variables to be marked volatile, and this is a
 602   // HUGE pessimization for them.  For this reason, on known-good processors, we
 603   // do not emit volatile qualifiers.
 604   Out << "#if defined(__386__) || defined(__i386__) || \\\n"
 605       << "    defined(i386) || defined(WIN32)\n"
 606       << "/* setjmp does not require variables to be marked volatile */"
 607       << "#define VOLATILE_FOR_SETJMP\n"
 608       << "#else\n"
 609       << "#define VOLATILE_FOR_SETJMP volatile\n"
 610       << "#endif\n\n";
 611 }
 612
 613
 614 void CWriter::printModule(Module *M) {
 615   // Calculate which global values have names that will collide when we throw
 616   // away type information.
 617   {  // Scope to delete the FoundNames set when we are done with it...
 618     std::set<std::string> FoundNames;
 619     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 620       if (I->hasName())                      // If the global has a name...
 621         if (FoundNames.count(I->getName()))  // And the name is already used
 622           MangledGlobals.insert(I);          // Mangle the name
 623         else
 624           FoundNames.insert(I->getName());   // Otherwise, keep track of name
 625
 626     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 627       if (I->hasName())                      // If the global has a name...
 628         if (FoundNames.count(I->getName()))  // And the name is already used
 629           MangledGlobals.insert(I);          // Mangle the name
 630         else
 631           FoundNames.insert(I->getName());   // Otherwise, keep track of name
 632   }
 633
 634   // get declaration for alloca
 635   Out << "/* Provide Declarations */\n";
 636   Out << "#include <stdarg.h>\n";      // Varargs support
 637   Out << "#include <setjmp.h>\n";      // Unwind support
 638   generateCompilerSpecificCode(Out);
 639   generateProcessorSpecificCode(Out);
 640
 641   // Provide a definition for `bool' if not compiling with a C++ compiler.
 642   Out << "\n"
 643       << "#ifndef __cplusplus\ntypedef unsigned char bool;\n#endif\n"
 644
 645       << "\n\n/* Support for floating point constants */\n"
 646       << "typedef unsigned long long ConstantDoubleTy;\n"
 647       << "typedef unsigned int        ConstantFloatTy;\n"
 648
 649       << "\n\n/* Support for the invoke instruction */\n"
 650       << "extern struct __llvm_jmpbuf_list_t {\n"
 651       << "  jmp_buf buf; struct __llvm_jmpbuf_list_t *next;\n"
 652       << "} *__llvm_jmpbuf_list;\n"
 653
 654       << "\n\n/* Global Declarations */\n";
 655
 656   // First output all the declarations for the program, because C requires
 657   // Functions & globals to be declared before they are used.
 658   //
 659
 660   // Loop over the symbol table, emitting all named constants...
 661   printSymbolTable(M->getSymbolTable());
 662
 663   // Global variable declarations...
 664   if (!M->gempty()) {
 665     Out << "\n/* External Global Variable Declarations */\n";
 666     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
 667       if (I->hasExternalLinkage()) {
 668         Out << "extern ";
 669         printType(Out, I->getType()->getElementType(), Mang->getValueName(I));
 670         Out << ";\n";
 671       }
 672     }
 673   }
 674
 675   // Function declarations
 676   if (!M->empty()) {
 677     Out << "\n/* Function Declarations */\n";
 678     needsMalloc = true;
 679     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) {
 680       // If the function is external and the name collides don't print it.
 681       // Sometimes the bytecode likes to have multiple "declarations" for
 682       // external functions
 683       if ((I->hasInternalLinkage() || !MangledGlobals.count(I)) &&
 684           !I->getIntrinsicID()) {
 685         printFunctionSignature(I, true);
 686         if (I->hasWeakLinkage()) Out << " __attribute__((weak))";
 687         Out << ";\n";
 688       }
 689     }
 690   }
 691
 692   // Print Malloc prototype if needed
 693   if (needsMalloc) {
 694     Out << "\n/* Malloc to make sun happy */\n";
 695     Out << "extern void * malloc();\n\n";
 696   }
 697
 698   // Output the global variable declarations
 699   if (!M->gempty()) {
 700     Out << "\n\n/* Global Variable Declarations */\n";
 701     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 702       if (!I->isExternal()) {
 703         Out << "extern ";
 704         printType(Out, I->getType()->getElementType(), Mang->getValueName(I));
 705
 706         if (I->hasLinkOnceLinkage())
 707           Out << " __attribute__((common))";
 708         else if (I->hasWeakLinkage())
 709           Out << " __attribute__((weak))";
 710         Out << ";\n";
 711       }
 712   }
 713
 714   // Output the global variable definitions and contents...
 715   if (!M->gempty()) {
 716     Out << "\n\n/* Global Variable Definitions and Initialization */\n";
 717     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 718       if (!I->isExternal()) {
 719         if (I->hasInternalLinkage())
 720           Out << "static ";
 721         printType(Out, I->getType()->getElementType(), Mang->getValueName(I));
 722         if (I->hasLinkOnceLinkage())
 723           Out << " __attribute__((common))";
 724         else if (I->hasWeakLinkage())
 725           Out << " __attribute__((weak))";
 726
 727         // If the initializer is not null, emit the initializer.  If it is null,
 728         // we try to avoid emitting large amounts of zeros.  The problem with
 729         // this, however, occurs when the variable has weak linkage.  In this
 730         // case, the assembler will complain about the variable being both weak
 731         // and common, so we disable this optimization.
 732         if (!I->getInitializer()->isNullValue() ||
 733             I->hasWeakLinkage()) {
 734           Out << " = " ;
 735           writeOperand(I->getInitializer());
 736         }
 737         Out << ";\n";
 738       }
 739   }
 740
 741   // Output all floating point constants that cannot be printed accurately...
 742   printFloatingPointConstants(*M);
 743
 744   // Output all of the functions...
 745   emittedInvoke = false;
 746   if (!M->empty()) {
 747     Out << "\n\n/* Function Bodies */\n";
 748     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 749       printFunction(I);
 750   }
 751
 752   // If the program included an invoke instruction, we need to output the
 753   // support code for it here!
 754   if (emittedInvoke) {
 755     Out << "\n/* More support for the invoke instruction */\n"
 756         << "struct __llvm_jmpbuf_list_t *__llvm_jmpbuf_list "
 757         << "__attribute__((common)) = 0;\n";
 758   }
 759
 760   // Done with global FP constants
 761   FPConstantMap.clear();
 762 }
 763
 764 /// Output all floating point constants that cannot be printed accurately...
 765 void CWriter::printFloatingPointConstants(Module &M) {
 766   union {
 767     double D;
 768     unsigned long long U;
 769   } DBLUnion;
 770
 771   union {
 772     float F;
 773     unsigned U;
 774   } FLTUnion;
 775
 776   // Scan the module for floating point constants.  If any FP constant is used
 777   // in the function, we want to redirect it here so that we do not depend on
 778   // the precision of the printed form, unless the printed form preserves
 779   // precision.
 780   //
 781   unsigned FPCounter = 0;
 782   for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F)
 783     for (constant_iterator I = constant_begin(F), E = constant_end(F);
 784          I != E; ++I)
 785       if (const ConstantFP *FPC = dyn_cast<ConstantFP>(*I))
 786         if (!isFPCSafeToPrint(FPC) && // Do not put in FPConstantMap if safe.
 787             !FPConstantMap.count(FPC)) {
 788           double Val = FPC->getValue();
 789
 790           FPConstantMap[FPC] = FPCounter;  // Number the FP constants
 791
 792           if (FPC->getType() == Type::DoubleTy) {
 793             DBLUnion.D = Val;
 794             Out << "const ConstantDoubleTy FPConstant" << FPCounter++
 795                 << " = 0x" << std::hex << DBLUnion.U << std::dec
 796                 << "ULL;    /* " << Val << " */\n";
 797           } else if (FPC->getType() == Type::FloatTy) {
 798             FLTUnion.F = Val;
 799             Out << "const ConstantFloatTy FPConstant" << FPCounter++
 800                 << " = 0x" << std::hex << FLTUnion.U << std::dec
 801                 << "U;    /* " << Val << " */\n";
 802           } else
 803             assert(0 && "Unknown float type!");
 804         }
 805
 806   Out << "\n";
 807  }
 808
 809
 810 /// printSymbolTable - Run through symbol table looking for type names.  If a
 811 /// type name is found, emit it's declaration...
 812 ///
 813 void CWriter::printSymbolTable(const SymbolTable &ST) {
 814   // If there are no type names, exit early.
 815   if (ST.find(Type::TypeTy) == ST.end())
 816     return;
 817
 818   // We are only interested in the type plane of the symbol table...
 819   SymbolTable::type_const_iterator I   = ST.type_begin(Type::TypeTy);
 820   SymbolTable::type_const_iterator End = ST.type_end(Type::TypeTy);
 821
 822   // Print out forward declarations for structure types before anything else!
 823   Out << "/* Structure forward decls */\n";
 824   for (; I != End; ++I)
 825     if (const Type *STy = dyn_cast<StructType>(I->second))
 826       // Only print out used types!
 827       if (FUT->getTypes().count(STy)) {
 828         std::string Name = "struct l_" + Mangler::makeNameProper(I->first);
 829         Out << Name << ";\n";
 830         TypeNames.insert(std::make_pair(STy, Name));
 831       }
 832
 833   Out << "\n";
 834
 835   // Now we can print out typedefs...
 836   Out << "/* Typedefs */\n";
 837   for (I = ST.type_begin(Type::TypeTy); I != End; ++I)
 838     // Only print out used types!
 839     if (FUT->getTypes().count(cast<Type>(I->second))) {
 840       const Type *Ty = cast<Type>(I->second);
 841       std::string Name = "l_" + Mangler::makeNameProper(I->first);
 842       Out << "typedef ";
 843       printType(Out, Ty, Name);
 844       Out << ";\n";
 845     }
 846
 847   Out << "\n";
 848
 849   // Keep track of which structures have been printed so far...
 850   std::set<const StructType *> StructPrinted;
 851
 852   // Loop over all structures then push them into the stack so they are
 853   // printed in the correct order.
 854   //
 855   Out << "/* Structure contents */\n";
 856   for (I = ST.type_begin(Type::TypeTy); I != End; ++I)
 857     if (const StructType *STy = dyn_cast<StructType>(I->second))
 858       // Only print out used types!
 859       if (FUT->getTypes().count(STy))
 860         printContainedStructs(STy, StructPrinted);
 861 }
 862
 863 // Push the struct onto the stack and recursively push all structs
 864 // this one depends on.
 865 void CWriter::printContainedStructs(const Type *Ty,
 866                                     std::set<const StructType*> &StructPrinted){
 867   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
 868     //Check to see if we have already printed this struct
 869     if (StructPrinted.count(STy) == 0) {
 870       // Print all contained types first...
 871       for (StructType::ElementTypes::const_iterator
 872              I = STy->getElementTypes().begin(),
 873              E = STy->getElementTypes().end(); I != E; ++I) {
 874         const Type *Ty1 = I->get();
 875         if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
 876           printContainedStructs(*I, StructPrinted);
 877       }
 878
 879       //Print structure type out..
 880       StructPrinted.insert(STy);
 881       std::string Name = TypeNames[STy];
 882       printType(Out, STy, Name, true);
 883       Out << ";\n\n";
 884     }
 885
 886     // If it is an array, check contained types and continue
 887   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)){
 888     const Type *Ty1 = ATy->getElementType();
 889     if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
 890       printContainedStructs(Ty1, StructPrinted);
 891   }
 892 }
 893
 894
 895 void CWriter::printFunctionSignature(const Function *F, bool Prototype) {
 896   // If the program provides its own malloc prototype we don't need
 897   // to include the general one.
 898   if (Mang->getValueName(F) == "malloc")
 899     needsMalloc = false;
 900
 901   if (F->hasInternalLinkage()) Out << "static ";
 902   if (F->hasLinkOnceLinkage()) Out << "inline ";
 903
 904   // Loop over the arguments, printing them...
 905   const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
 906
 907   std::stringstream FunctionInnards;
 908
 909   // Print out the name...
 910   FunctionInnards << Mang->getValueName(F) << "(";
 911
 912   if (!F->isExternal()) {
 913     if (!F->aempty()) {
 914       std::string ArgName;
 915       if (F->abegin()->hasName() || !Prototype)
 916         ArgName = Mang->getValueName(F->abegin());
 917       printType(FunctionInnards, F->afront().getType(), ArgName);
 918       for (Function::const_aiterator I = ++F->abegin(), E = F->aend();
 919            I != E; ++I) {
 920         FunctionInnards << ", ";
 921         if (I->hasName() || !Prototype)
 922           ArgName = Mang->getValueName(I);
 923         else
 924           ArgName = "";
 925         printType(FunctionInnards, I->getType(), ArgName);
 926       }
 927     }
 928   } else {
 929     // Loop over the arguments, printing them...
 930     for (FunctionType::ParamTypes::const_iterator I =
 931            FT->getParamTypes().begin(),
 932            E = FT->getParamTypes().end(); I != E; ++I) {
 933       if (I != FT->getParamTypes().begin()) FunctionInnards << ", ";
 934       printType(FunctionInnards, *I);
 935     }
 936   }
 937
 938   // Finish printing arguments... if this is a vararg function, print the ...,
 939   // unless there are no known types, in which case, we just emit ().
 940   //
 941   if (FT->isVarArg() && !FT->getParamTypes().empty()) {
 942     if (FT->getParamTypes().size()) FunctionInnards << ", ";
 943     FunctionInnards << "...";  // Output varargs portion of signature!
 944   } else if (!FT->isVarArg() && FT->getParamTypes().empty()) {
 945     FunctionInnards << "void"; // ret() -> ret(void) in C.
 946   }
 947   FunctionInnards << ")";
 948   // Print out the return type and the entire signature for that matter
 949   printType(Out, F->getReturnType(), FunctionInnards.str());
 950 }
 951
 952 void CWriter::printFunction(Function *F) {
 953   if (F->isExternal()) return;
 954
 955   printFunctionSignature(F, false);
 956   Out << " {\n";
 957
 958   // Determine whether or not the function contains any invoke instructions.
 959   bool HasInvoke = false;
 960   for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I)
 961     if (isa<InvokeInst>(I->getTerminator())) {
 962       HasInvoke = true;
 963       break;
 964     }
 965
 966   // print local variable information for the function
 967   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
 968     if (const AllocaInst *AI = isDirectAlloca(*I)) {
 969       Out << "  ";
 970       if (HasInvoke) Out << "VOLATILE_FOR_SETJMP ";
 971       printType(Out, AI->getAllocatedType(), Mang->getValueName(AI));
 972       Out << ";    /* Address exposed local */\n";
 973     } else if ((*I)->getType() != Type::VoidTy && !isInlinableInst(**I)) {
 974       Out << "  ";
 975       if (HasInvoke) Out << "VOLATILE_FOR_SETJMP ";
 976       printType(Out, (*I)->getType(), Mang->getValueName(*I));
 977       Out << ";\n";
 978
 979       if (isa<PHINode>(*I)) {  // Print out PHI node temporaries as well...
 980         Out << "  ";
 981         if (HasInvoke) Out << "VOLATILE_FOR_SETJMP ";
 982         printType(Out, (*I)->getType(),
 983                   Mang->getValueName(*I)+"__PHI_TEMPORARY");
 984         Out << ";\n";
 985       }
 986     }
 987
 988   Out << "\n";
 989
 990   // print the basic blocks
 991   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 992     BasicBlock *Prev = BB->getPrev();
 993
 994     // Don't print the label for the basic block if there are no uses, or if the
 995     // only terminator use is the predecessor basic block's terminator.  We have
 996     // to scan the use list because PHI nodes use basic blocks too but do not
 997     // require a label to be generated.
 998     //
 999     bool NeedsLabel = false;
1000     for (Value::use_iterator UI = BB->use_begin(), UE = BB->use_end();
1001          UI != UE; ++UI)
1002       if (TerminatorInst *TI = dyn_cast<TerminatorInst>(*UI))
1003         if (TI != Prev->getTerminator() ||
1004             isa<SwitchInst>(Prev->getTerminator()) ||
1005             isa<InvokeInst>(Prev->getTerminator())) {
1006           NeedsLabel = true;
1007           break;
1008         }
1009
1010     if (NeedsLabel) Out << Mang->getValueName(BB) << ":\n";
1011
1012     // Output all of the instructions in the basic block...
1013     for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E; ++II){
1014       if (!isInlinableInst(*II) && !isDirectAlloca(II)) {
1015         if (II->getType() != Type::VoidTy)
1016           outputLValue(II);
1017         else
1018           Out << "  ";
1019         visit(*II);
1020         Out << ";\n";
1021       }
1022     }
1023
1024     // Don't emit prefix or suffix for the terminator...
1025     visit(*BB->getTerminator());
1026   }
1027
1028   Out << "}\n\n";
1029 }
1030
1031 // Specific Instruction type classes... note that all of the casts are
1032 // necessary because we use the instruction classes as opaque types...
1033 //
1034 void CWriter::visitReturnInst(ReturnInst &I) {
1035   // Don't output a void return if this is the last basic block in the function
1036   if (I.getNumOperands() == 0 &&
1037       &*--I.getParent()->getParent()->end() == I.getParent() &&
1038       !I.getParent()->size() == 1) {
1039     return;
1040   }
1041
1042   Out << "  return";
1043   if (I.getNumOperands()) {
1044     Out << " ";
1045     writeOperand(I.getOperand(0));
1046   }
1047   Out << ";\n";
1048 }
1049
1050 void CWriter::visitSwitchInst(SwitchInst &SI) {
1051   Out << "  switch (";
1052   writeOperand(SI.getOperand(0));
1053   Out << ") {\n  default:\n";
1054   printBranchToBlock(SI.getParent(), SI.getDefaultDest(), 2);
1055   Out << ";\n";
1056   for (unsigned i = 2, e = SI.getNumOperands(); i != e; i += 2) {
1057     Out << "  case ";
1058     writeOperand(SI.getOperand(i));
1059     Out << ":\n";
1060     BasicBlock *Succ = cast<BasicBlock>(SI.getOperand(i+1));
1061     printBranchToBlock(SI.getParent(), Succ, 2);
1062     if (Succ == SI.getParent()->getNext())
1063       Out << "    break;\n";
1064   }
1065   Out << "  }\n";
1066 }
1067
1068 void CWriter::visitInvokeInst(InvokeInst &II) {
1069   Out << "  {\n"
1070       << "    struct __llvm_jmpbuf_list_t Entry;\n"
1071       << "    Entry.next = __llvm_jmpbuf_list;\n"
1072       << "    if (setjmp(Entry.buf)) {\n"
1073       << "      __llvm_jmpbuf_list = Entry.next;\n";
1074   printBranchToBlock(II.getParent(), II.getExceptionalDest(), 4);
1075   Out << "    }\n"
1076       << "    __llvm_jmpbuf_list = &Entry;\n"
1077       << "    ";
1078
1079   if (II.getType() != Type::VoidTy) outputLValue(&II);
1080   visitCallSite(&II);
1081   Out << ";\n"
1082       << "    __llvm_jmpbuf_list = Entry.next;\n"
1083       << "  }\n";
1084   printBranchToBlock(II.getParent(), II.getNormalDest(), 0);
1085   emittedInvoke = true;
1086 }
1087
1088
1089 void CWriter::visitUnwindInst(UnwindInst &I) {
1090   // The unwind instructions causes a control flow transfer out of the current
1091   // function, unwinding the stack until a caller who used the invoke
1092   // instruction is found.  In this context, we code generated the invoke
1093   // instruction to add an entry to the top of the jmpbuf_list.  Thus, here we
1094   // just have to longjmp to the specified handler.
1095   Out << "  if (__llvm_jmpbuf_list == 0) {  /* unwind */\n"
1096       << "#ifdef _LP64\n"
1097       << "    extern signed long long write();\n"
1098       << "#else\n"
1099       << "    extern write();\n"
1100       << "#endif\n"
1101       << "    ((void (*)(int, void*, unsigned))write)(2,\n"
1102       << "           \"throw found with no handler!\\n\", 31); abort();\n"
1103       << "  }\n"
1104       << "  longjmp(__llvm_jmpbuf_list->buf, 1);\n";
1105   emittedInvoke = true;
1106 }
1107
1108 bool isGotoCodeNecessary(BasicBlock *From, BasicBlock *To) {
1109   // If PHI nodes need copies, we need the copy code...
1110   if (isa<PHINode>(To->front()) ||
1111       From->getNext() != To)      // Not directly successor, need goto
1112     return true;
1113
1114   // Otherwise we don't need the code.
1115   return false;
1116 }
1117
1118 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
1119                                  unsigned Indent) {
1120   for (BasicBlock::iterator I = Succ->begin();
1121        PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1122     //  now we have to do the printing
1123     Out << std::string(Indent, ' ');
1124     Out << "  " << Mang->getValueName(I) << "__PHI_TEMPORARY = ";
1125     writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
1126     Out << ";   /* for PHI node */\n";
1127   }
1128
1129   if (CurBB->getNext() != Succ ||
1130       isa<InvokeInst>(CurBB->getTerminator()) ||
1131       isa<SwitchInst>(CurBB->getTerminator())) {
1132     Out << std::string(Indent, ' ') << "  goto ";
1133     writeOperand(Succ);
1134     Out << ";\n";
1135   }
1136 }
1137
1138 // Branch instruction printing - Avoid printing out a branch to a basic block
1139 // that immediately succeeds the current one.
1140 //
1141 void CWriter::visitBranchInst(BranchInst &I) {
1142   if (I.isConditional()) {
1143     if (isGotoCodeNecessary(I.getParent(), I.getSuccessor(0))) {
1144       Out << "  if (";
1145       writeOperand(I.getCondition());
1146       Out << ") {\n";
1147
1148       printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
1149
1150       if (isGotoCodeNecessary(I.getParent(), I.getSuccessor(1))) {
1151         Out << "  } else {\n";
1152         printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
1153       }
1154     } else {
1155       // First goto not necessary, assume second one is...
1156       Out << "  if (!";
1157       writeOperand(I.getCondition());
1158       Out << ") {\n";
1159
1160       printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
1161     }
1162
1163     Out << "  }\n";
1164   } else {
1165     printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
1166   }
1167   Out << "\n";
1168 }
1169
1170 // PHI nodes get copied into temporary values at the end of predecessor basic
1171 // blocks.  We now need to copy these temporary values into the REAL value for
1172 // the PHI.
1173 void CWriter::visitPHINode(PHINode &I) {
1174   writeOperand(&I);
1175   Out << "__PHI_TEMPORARY";
1176 }
1177
1178
1179 void CWriter::visitBinaryOperator(Instruction &I) {
1180   // binary instructions, shift instructions, setCond instructions.
1181   assert(!isa<PointerType>(I.getType()));
1182
1183   // We must cast the results of binary operations which might be promoted.
1184   bool needsCast = false;
1185   if ((I.getType() == Type::UByteTy) || (I.getType() == Type::SByteTy)
1186       || (I.getType() == Type::UShortTy) || (I.getType() == Type::ShortTy)
1187       || (I.getType() == Type::FloatTy)) {
1188     needsCast = true;
1189     Out << "((";
1190     printType(Out, I.getType());
1191     Out << ")(";
1192   }
1193
1194   writeOperand(I.getOperand(0));
1195
1196   switch (I.getOpcode()) {
1197   case Instruction::Add: Out << " + "; break;
1198   case Instruction::Sub: Out << " - "; break;
1199   case Instruction::Mul: Out << "*"; break;
1200   case Instruction::Div: Out << "/"; break;
1201   case Instruction::Rem: Out << "%"; break;
1202   case Instruction::And: Out << " & "; break;
1203   case Instruction::Or: Out << " | "; break;
1204   case Instruction::Xor: Out << " ^ "; break;
1205   case Instruction::SetEQ: Out << " == "; break;
1206   case Instruction::SetNE: Out << " != "; break;
1207   case Instruction::SetLE: Out << " <= "; break;
1208   case Instruction::SetGE: Out << " >= "; break;
1209   case Instruction::SetLT: Out << " < "; break;
1210   case Instruction::SetGT: Out << " > "; break;
1211   case Instruction::Shl : Out << " << "; break;
1212   case Instruction::Shr : Out << " >> "; break;
1213   default: std::cerr << "Invalid operator type!" << I; abort();
1214   }
1215
1216   writeOperand(I.getOperand(1));
1217
1218   if (needsCast) {
1219     Out << "))";
1220   }
1221 }
1222
1223 void CWriter::visitCastInst(CastInst &I) {
1224   if (I.getType() == Type::BoolTy) {
1225     Out << "(";
1226     writeOperand(I.getOperand(0));
1227     Out << " != 0)";
1228     return;
1229   }
1230   Out << "(";
1231   printType(Out, I.getType());
1232   Out << ")";
1233   if (isa<PointerType>(I.getType())&&I.getOperand(0)->getType()->isIntegral() ||
1234       isa<PointerType>(I.getOperand(0)->getType())&&I.getType()->isIntegral()) {
1235     // Avoid "cast to pointer from integer of different size" warnings
1236     Out << "(long)";
1237   }
1238
1239   writeOperand(I.getOperand(0));
1240 }
1241
1242 void CWriter::visitCallInst(CallInst &I) {
1243   // Handle intrinsic function calls first...
1244   if (Function *F = I.getCalledFunction())
1245     if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID()) {
1246       switch (ID) {
1247       default:  assert(0 && "Unknown LLVM intrinsic!");
1248       case Intrinsic::va_start:
1249         Out << "0; ";
1250
1251         Out << "va_start(*(va_list*)&" << Mang->getValueName(&I) << ", ";
1252         // Output the last argument to the enclosing function...
1253         if (I.getParent()->getParent()->aempty()) {
1254           std::cerr << "The C backend does not currently support zero "
1255                     << "argument varargs functions, such as '"
1256                     << I.getParent()->getParent()->getName() << "'!\n";
1257           abort();
1258         }
1259         writeOperand(&I.getParent()->getParent()->aback());
1260         Out << ")";
1261         return;
1262       case Intrinsic::va_end:
1263         Out << "va_end(*(va_list*)&";
1264         writeOperand(I.getOperand(1));
1265         Out << ")";
1266         return;
1267       case Intrinsic::va_copy:
1268         Out << "0;";
1269         Out << "va_copy(*(va_list*)&" << Mang->getValueName(&I) << ", ";
1270         Out << "*(va_list*)&";
1271         writeOperand(I.getOperand(1));
1272         Out << ")";
1273         return;
1274       case Intrinsic::setjmp:
1275       case Intrinsic::sigsetjmp:
1276         // This intrinsic should never exist in the program, but until we get
1277         // setjmp/longjmp transformations going on, we should codegen it to
1278         // something reasonable.  This will allow code that never calls longjmp
1279         // to work.
1280         Out << "0";
1281         return;
1282       case Intrinsic::longjmp:
1283       case Intrinsic::siglongjmp:
1284         // Longjmp is not implemented, and never will be.  It would cause an
1285         // exception throw.
1286         Out << "abort()";
1287         return;
1288       }
1289     }
1290   visitCallSite(&I);
1291 }
1292
1293 void CWriter::visitCallSite(CallSite CS) {
1294   const PointerType  *PTy   = cast<PointerType>(CS.getCalledValue()->getType());
1295   const FunctionType *FTy   = cast<FunctionType>(PTy->getElementType());
1296   const Type         *RetTy = FTy->getReturnType();
1297
1298   writeOperand(CS.getCalledValue());
1299   Out << "(";
1300
1301   if (CS.arg_begin() != CS.arg_end()) {
1302     CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
1303     writeOperand(*AI);
1304
1305     for (++AI; AI != AE; ++AI) {
1306       Out << ", ";
1307       writeOperand(*AI);
1308     }
1309   }
1310   Out << ")";
1311 }
1312
1313 void CWriter::visitMallocInst(MallocInst &I) {
1314   Out << "(";
1315   printType(Out, I.getType());
1316   Out << ")malloc(sizeof(";
1317   printType(Out, I.getType()->getElementType());
1318   Out << ")";
1319
1320   if (I.isArrayAllocation()) {
1321     Out << " * " ;
1322     writeOperand(I.getOperand(0));
1323   }
1324   Out << ")";
1325 }
1326
1327 void CWriter::visitAllocaInst(AllocaInst &I) {
1328   Out << "(";
1329   printType(Out, I.getType());
1330   Out << ") alloca(sizeof(";
1331   printType(Out, I.getType()->getElementType());
1332   Out << ")";
1333   if (I.isArrayAllocation()) {
1334     Out << " * " ;
1335     writeOperand(I.getOperand(0));
1336   }
1337   Out << ")";
1338 }
1339
1340 void CWriter::visitFreeInst(FreeInst &I) {
1341   Out << "free((char*)";
1342   writeOperand(I.getOperand(0));
1343   Out << ")";
1344 }
1345
1346 void CWriter::printIndexingExpression(Value *Ptr, gep_type_iterator I,
1347                                       gep_type_iterator E) {
1348   bool HasImplicitAddress = false;
1349   // If accessing a global value with no indexing, avoid *(&GV) syndrome
1350   if (GlobalValue *V = dyn_cast<GlobalValue>(Ptr)) {
1351     HasImplicitAddress = true;
1352   } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Ptr)) {
1353     HasImplicitAddress = true;
1354     Ptr = CPR->getValue();         // Get to the global...
1355   } else if (isDirectAlloca(Ptr)) {
1356     HasImplicitAddress = true;
1357   }
1358
1359   if (I == E) {
1360     if (!HasImplicitAddress)
1361       Out << "*";  // Implicit zero first argument: '*x' is equivalent to 'x[0]'
1362
1363     writeOperandInternal(Ptr);
1364     return;
1365   }
1366
1367   const Constant *CI = dyn_cast<Constant>(I.getOperand());
1368   if (HasImplicitAddress && (!CI || !CI->isNullValue()))
1369     Out << "(&";
1370
1371   writeOperandInternal(Ptr);
1372
1373   if (HasImplicitAddress && (!CI || !CI->isNullValue())) {
1374     Out << ")";
1375     HasImplicitAddress = false;  // HIA is only true if we haven't addressed yet
1376   }
1377
1378   assert(!HasImplicitAddress || (CI && CI->isNullValue()) &&
1379          "Can only have implicit address with direct accessing");
1380
1381   if (HasImplicitAddress) {
1382     ++I;
1383   } else if (CI && CI->isNullValue()) {
1384     gep_type_iterator TmpI = I; ++TmpI;
1385
1386     // Print out the -> operator if possible...
1387     if (TmpI != E && isa<StructType>(*TmpI)) {
1388       Out << (HasImplicitAddress ? "." : "->");
1389       Out << "field" << cast<ConstantUInt>(TmpI.getOperand())->getValue();
1390       I = ++TmpI;
1391     }
1392   }
1393
1394   for (; I != E; ++I)
1395     if (isa<StructType>(*I)) {
1396       Out << ".field" << cast<ConstantUInt>(I.getOperand())->getValue();
1397     } else {
1398       Out << "[";
1399       writeOperand(I.getOperand());
1400       Out << "]";
1401     }
1402 }
1403
1404 void CWriter::visitLoadInst(LoadInst &I) {
1405   Out << "*";
1406   writeOperand(I.getOperand(0));
1407 }
1408
1409 void CWriter::visitStoreInst(StoreInst &I) {
1410   Out << "*";
1411   writeOperand(I.getPointerOperand());
1412   Out << " = ";
1413   writeOperand(I.getOperand(0));
1414 }
1415
1416 void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
1417   Out << "&";
1418   printIndexingExpression(I.getPointerOperand(), gep_type_begin(I),
1419                           gep_type_end(I));
1420 }
1421
1422 void CWriter::visitVANextInst(VANextInst &I) {
1423   Out << Mang->getValueName(I.getOperand(0));
1424   Out << ";  va_arg(*(va_list*)&" << Mang->getValueName(&I) << ", ";
1425   printType(Out, I.getArgType());
1426   Out << ")";
1427 }
1428
1429 void CWriter::visitVAArgInst(VAArgInst &I) {
1430   Out << "0;\n";
1431   Out << "{ va_list Tmp; va_copy(Tmp, *(va_list*)&";
1432   writeOperand(I.getOperand(0));
1433   Out << ");\n  " << Mang->getValueName(&I) << " = va_arg(Tmp, ";
1434   printType(Out, I.getType());
1435   Out << ");\n  va_end(Tmp); }";
1436 }
1437
1438 }
1439
1440 //===----------------------------------------------------------------------===//
1441 //                       External Interface declaration
1442 //===----------------------------------------------------------------------===//
1443
1444 Pass *createWriteToCPass(std::ostream &o) { return new CWriter(o); }
1445
1446 } // End llvm namespace