lib/Target/CBackend/CBackend.cpp

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