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