lib/Target/CBackend/Writer.cpp

   1 //===-- Writer.cpp - Library for converting LLVM code to C ----------------===//
   2 //
   3 // This library converts LLVM code to C code, compilable by GCC.
   4 //
   5 //===----------------------------------------------------------------------===//
   6 #include "llvm/Assembly/CWriter.h"
   7 #include "llvm/Constants.h"
   8 #include "llvm/DerivedTypes.h"
   9 #include "llvm/Module.h"
  10 #include "llvm/Instructions.h"
  11 #include "llvm/Pass.h"
  12 #include "llvm/SymbolTable.h"
  13 #include "llvm/SlotCalculator.h"
  14 #include "llvm/Analysis/FindUsedTypes.h"
  15 #include "llvm/Analysis/ConstantsScanner.h"
  16 #include "llvm/Support/InstVisitor.h"
  17 #include "llvm/Support/InstIterator.h"
  18 #include "Support/StringExtras.h"
  19 #include "Support/STLExtras.h"
  20 #include <algorithm>
  21 #include <set>
  22 #include <sstream>
  23
  24 namespace {
  25   class CWriter : public Pass, public InstVisitor<CWriter> {
  26     std::ostream &Out;
  27     SlotCalculator *Table;
  28     const Module *TheModule;
  29     std::map<const Type *, std::string> TypeNames;
  30     std::set<const Value*> MangledGlobals;
  31     bool needsMalloc;
  32
  33     std::map<const ConstantFP *, unsigned> FPConstantMap;
  34   public:
  35     CWriter(std::ostream &o) : Out(o) {}
  36
  37     void getAnalysisUsage(AnalysisUsage &AU) const {
  38       AU.setPreservesAll();
  39       AU.addRequired<FindUsedTypes>();
  40     }
  41
  42     virtual bool run(Module &M) {
  43       // Initialize
  44       Table = new SlotCalculator(&M, false);
  45       TheModule = &M;
  46
  47       // Ensure that all structure types have names...
  48       bool Changed = nameAllUsedStructureTypes(M);
  49
  50       // Run...
  51       printModule(&M);
  52
  53       // Free memory...
  54       delete Table;
  55       TypeNames.clear();
  56       MangledGlobals.clear();
  57       return false;
  58     }
  59
  60     std::ostream &printType(std::ostream &Out, const Type *Ty,
  61                             const std::string &VariableName = "",
  62                             bool IgnoreName = false, bool namedContext = true);
  63
  64     void writeOperand(Value *Operand);
  65     void writeOperandInternal(Value *Operand);
  66
  67     std::string getValueName(const Value *V);
  68
  69   private :
  70     bool nameAllUsedStructureTypes(Module &M);
  71     void printModule(Module *M);
  72     void printSymbolTable(const SymbolTable &ST);
  73     void printContainedStructs(const Type *Ty, std::set<const StructType *> &);
  74     void printGlobal(const GlobalVariable *GV);
  75     void printFunctionSignature(const Function *F, bool Prototype);
  76
  77     void printFunction(Function *);
  78
  79     void printConstant(Constant *CPV);
  80     void printConstantArray(ConstantArray *CPA);
  81
  82     // isInlinableInst - Attempt to inline instructions into their uses to build
  83     // trees as much as possible.  To do this, we have to consistently decide
  84     // what is acceptable to inline, so that variable declarations don't get
  85     // printed and an extra copy of the expr is not emitted.
  86     //
  87     static bool isInlinableInst(const Instruction &I) {
  88       // Must be an expression, must be used exactly once.  If it is dead, we
  89       // emit it inline where it would go.
  90       if (I.getType() == Type::VoidTy || I.use_size() != 1 ||
  91           isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I) ||
  92           isa<LoadInst>(I)) // Don't inline a load across a store!
  93         return false;
  94
  95       // Only inline instruction it it's use is in the same BB as the inst.
  96       return I.getParent() == cast<Instruction>(I.use_back())->getParent();
  97     }
  98
  99     // Instruction visitation functions
 100     friend class InstVisitor<CWriter>;
 101
 102     void visitReturnInst(ReturnInst &I);
 103     void visitBranchInst(BranchInst &I);
 104     void visitSwitchInst(SwitchInst &I);
 105
 106     void visitPHINode(PHINode &I) {}
 107     void visitBinaryOperator(Instruction &I);
 108
 109     void visitCastInst (CastInst &I);
 110     void visitCallInst (CallInst &I);
 111     void visitShiftInst(ShiftInst &I) { visitBinaryOperator(I); }
 112
 113     void visitMallocInst(MallocInst &I);
 114     void visitAllocaInst(AllocaInst &I);
 115     void visitFreeInst  (FreeInst   &I);
 116     void visitLoadInst  (LoadInst   &I);
 117     void visitStoreInst (StoreInst  &I);
 118     void visitGetElementPtrInst(GetElementPtrInst &I);
 119
 120     void visitInstruction(Instruction &I) {
 121       std::cerr << "C Writer does not know about " << I;
 122       abort();
 123     }
 124
 125     void outputLValue(Instruction *I) {
 126       Out << "  " << getValueName(I) << " = ";
 127     }
 128     void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
 129                             unsigned Indent);
 130     void printIndexingExpression(Value *Ptr, User::op_iterator I,
 131                                  User::op_iterator E);
 132   };
 133 }
 134
 135 // We dont want identifier names with ., space, -  in them.
 136 // So we replace them with _
 137 static std::string makeNameProper(std::string x) {
 138   std::string tmp;
 139   for (std::string::iterator sI = x.begin(), sEnd = x.end(); sI != sEnd; sI++)
 140     switch (*sI) {
 141     case '.': tmp += "d_"; break;
 142     case ' ': tmp += "s_"; break;
 143     case '-': tmp += "D_"; break;
 144     default:  tmp += *sI;
 145     }
 146
 147   return tmp;
 148 }
 149
 150 std::string CWriter::getValueName(const Value *V) {
 151   if (V->hasName()) {              // Print out the label if it exists...
 152     if (isa<GlobalValue>(V) &&     // Do not mangle globals...
 153         (cast<GlobalValue>(V)->hasExternalLinkage() &&// Unless it's internal or
 154          !MangledGlobals.count(V))) // Unless the name would collide if we don't
 155       return makeNameProper(V->getName());
 156
 157     return "l" + utostr(V->getType()->getUniqueID()) + "_" +
 158            makeNameProper(V->getName());
 159   }
 160
 161   int Slot = Table->getValSlot(V);
 162   assert(Slot >= 0 && "Invalid value!");
 163   return "ltmp_" + itostr(Slot) + "_" + utostr(V->getType()->getUniqueID());
 164 }
 165
 166 // A pointer type should not use parens around *'s alone, e.g., (**)
 167 inline bool ptrTypeNameNeedsParens(const std::string &NameSoFar) {
 168   return (NameSoFar.find_last_not_of('*') != std::string::npos);
 169 }
 170
 171 // Pass the Type* and the variable name and this prints out the variable
 172 // declaration.
 173 //
 174 std::ostream &CWriter::printType(std::ostream &Out, const Type *Ty,
 175                                  const std::string &NameSoFar,
 176                                  bool IgnoreName, bool namedContext) {
 177   if (Ty->isPrimitiveType())
 178     switch (Ty->getPrimitiveID()) {
 179     case Type::VoidTyID:   return Out << "void "               << NameSoFar;
 180     case Type::BoolTyID:   return Out << "bool "               << NameSoFar;
 181     case Type::UByteTyID:  return Out << "unsigned char "      << NameSoFar;
 182     case Type::SByteTyID:  return Out << "signed char "        << NameSoFar;
 183     case Type::UShortTyID: return Out << "unsigned short "     << NameSoFar;
 184     case Type::ShortTyID:  return Out << "short "              << NameSoFar;
 185     case Type::UIntTyID:   return Out << "unsigned "           << NameSoFar;
 186     case Type::IntTyID:    return Out << "int "                << NameSoFar;
 187     case Type::ULongTyID:  return Out << "unsigned long long " << NameSoFar;
 188     case Type::LongTyID:   return Out << "signed long long "   << NameSoFar;
 189     case Type::FloatTyID:  return Out << "float "              << NameSoFar;
 190     case Type::DoubleTyID: return Out << "double "             << NameSoFar;
 191     default :
 192       std::cerr << "Unknown primitive type: " << Ty << "\n";
 193       abort();
 194     }
 195
 196   // Check to see if the type is named.
 197   if (!IgnoreName || isa<OpaqueType>(Ty)) {
 198     std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
 199     if (I != TypeNames.end()) {
 200       return Out << I->second << " " << NameSoFar;
 201     }
 202   }
 203
 204   switch (Ty->getPrimitiveID()) {
 205   case Type::FunctionTyID: {
 206     const FunctionType *MTy = cast<FunctionType>(Ty);
 207     std::stringstream FunctionInards;
 208     FunctionInards << " (" << NameSoFar << ") (";
 209     for (FunctionType::ParamTypes::const_iterator
 210            I = MTy->getParamTypes().begin(),
 211            E = MTy->getParamTypes().end(); I != E; ++I) {
 212       if (I != MTy->getParamTypes().begin())
 213         FunctionInards << ", ";
 214       printType(FunctionInards, *I, "");
 215     }
 216     if (MTy->isVarArg()) {
 217       if (!MTy->getParamTypes().empty())
 218         FunctionInards << ", ";
 219       FunctionInards << "...";
 220     }
 221     FunctionInards << ")";
 222     std::string tstr = FunctionInards.str();
 223     printType(Out, MTy->getReturnType(), tstr);
 224     return Out;
 225   }
 226   case Type::StructTyID: {
 227     const StructType *STy = cast<StructType>(Ty);
 228     Out << NameSoFar + " {\n";
 229     unsigned Idx = 0;
 230     for (StructType::ElementTypes::const_iterator
 231            I = STy->getElementTypes().begin(),
 232            E = STy->getElementTypes().end(); I != E; ++I) {
 233       Out << "  ";
 234       printType(Out, *I, "field" + utostr(Idx++));
 235       Out << ";\n";
 236     }
 237     return Out << "}";
 238   }
 239
 240   case Type::PointerTyID: {
 241     const PointerType *PTy = cast<PointerType>(Ty);
 242     std::string ptrName = "*" + NameSoFar;
 243
 244     // Do not need parens around "* NameSoFar" if NameSoFar consists only
 245     // of zero or more '*' chars *and* this is not an unnamed pointer type
 246     // such as the result type in a cast statement.  Otherwise, enclose in ( ).
 247     if (ptrTypeNameNeedsParens(NameSoFar) || !namedContext ||
 248         PTy->getElementType()->getPrimitiveID() == Type::ArrayTyID)
 249       ptrName = "(" + ptrName + ")";    //
 250
 251     return printType(Out, PTy->getElementType(), ptrName);
 252   }Out <<"--";
 253
 254   case Type::ArrayTyID: {
 255     const ArrayType *ATy = cast<ArrayType>(Ty);
 256     unsigned NumElements = ATy->getNumElements();
 257     return printType(Out, ATy->getElementType(),
 258                      NameSoFar + "[" + utostr(NumElements) + "]");
 259   }
 260
 261   case Type::OpaqueTyID: {
 262     static int Count = 0;
 263     std::string TyName = "struct opaque_" + itostr(Count++);
 264     assert(TypeNames.find(Ty) == TypeNames.end());
 265     TypeNames[Ty] = TyName;
 266     return Out << TyName << " " << NameSoFar;
 267   }
 268   default:
 269     assert(0 && "Unhandled case in getTypeProps!");
 270     abort();
 271   }
 272
 273   return Out;
 274 }
 275
 276 void CWriter::printConstantArray(ConstantArray *CPA) {
 277
 278   // As a special case, print the array as a string if it is an array of
 279   // ubytes or an array of sbytes with positive values.
 280   //
 281   const Type *ETy = CPA->getType()->getElementType();
 282   bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
 283
 284   // Make sure the last character is a null char, as automatically added by C
 285   if (CPA->getNumOperands() == 0 ||
 286       !cast<Constant>(*(CPA->op_end()-1))->isNullValue())
 287     isString = false;
 288
 289   if (isString) {
 290     Out << "\"";
 291     // Do not include the last character, which we know is null
 292     for (unsigned i = 0, e = CPA->getNumOperands()-1; i != e; ++i) {
 293       unsigned char C = (ETy == Type::SByteTy) ?
 294         (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
 295         (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
 296
 297       if (isprint(C)) {
 298         if (C == '"' || C == '\\')
 299           Out << "\\" << C;
 300         else
 301           Out << C;
 302       } else {
 303         switch (C) {
 304         case '\n': Out << "\\n"; break;
 305         case '\t': Out << "\\t"; break;
 306         case '\r': Out << "\\r"; break;
 307         case '\v': Out << "\\v"; break;
 308         case '\a': Out << "\\a"; break;
 309         case '\"': Out << "\\\""; break;
 310         case '\'': Out << "\\\'"; break;
 311         default:
 312           Out << "\\x";
 313           Out << ( C/16  < 10) ? ( C/16 +'0') : ( C/16 -10+'A');
 314           Out << ((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A');
 315           break;
 316         }
 317       }
 318     }
 319     Out << "\"";
 320   } else {
 321     Out << "{";
 322     if (CPA->getNumOperands()) {
 323       Out << " ";
 324       printConstant(cast<Constant>(CPA->getOperand(0)));
 325       for (unsigned i = 1, e = CPA->getNumOperands(); i != e; ++i) {
 326         Out << ", ";
 327         printConstant(cast<Constant>(CPA->getOperand(i)));
 328       }
 329     }
 330     Out << " }";
 331   }
 332 }
 333
 334
 335 // printConstant - The LLVM Constant to C Constant converter.
 336 void CWriter::printConstant(Constant *CPV) {
 337   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
 338     switch (CE->getOpcode()) {
 339     case Instruction::Cast:
 340       Out << "((";
 341       printType(Out, CPV->getType());
 342       Out << ")";
 343       printConstant(cast<Constant>(CPV->getOperand(0)));
 344       Out << ")";
 345       return;
 346
 347     case Instruction::GetElementPtr:
 348       Out << "(&(";
 349       printIndexingExpression(CPV->getOperand(0),
 350                               CPV->op_begin()+1, CPV->op_end());
 351       Out << "))";
 352       return;
 353     case Instruction::Add:
 354       Out << "(";
 355       printConstant(cast<Constant>(CPV->getOperand(0)));
 356       Out << " + ";
 357       printConstant(cast<Constant>(CPV->getOperand(1)));
 358       Out << ")";
 359       return;
 360     case Instruction::Sub:
 361       Out << "(";
 362       printConstant(cast<Constant>(CPV->getOperand(0)));
 363       Out << " - ";
 364       printConstant(cast<Constant>(CPV->getOperand(1)));
 365       Out << ")";
 366       return;
 367
 368     default:
 369       std::cerr << "CWriter Error: Unhandled constant expression: "
 370                 << CE << "\n";
 371       abort();
 372     }
 373   }
 374
 375   switch (CPV->getType()->getPrimitiveID()) {
 376   case Type::BoolTyID:
 377     Out << (CPV == ConstantBool::False ? "0" : "1"); break;
 378   case Type::SByteTyID:
 379   case Type::ShortTyID:
 380   case Type::IntTyID:
 381     Out << cast<ConstantSInt>(CPV)->getValue(); break;
 382   case Type::LongTyID:
 383     Out << cast<ConstantSInt>(CPV)->getValue() << "ll"; break;
 384
 385   case Type::UByteTyID:
 386   case Type::UShortTyID:
 387     Out << cast<ConstantUInt>(CPV)->getValue(); break;
 388   case Type::UIntTyID:
 389     Out << cast<ConstantUInt>(CPV)->getValue() << "u"; break;
 390   case Type::ULongTyID:
 391     Out << cast<ConstantUInt>(CPV)->getValue() << "ull"; break;
 392
 393   case Type::FloatTyID:
 394   case Type::DoubleTyID: {
 395     ConstantFP *FPC = cast<ConstantFP>(CPV);
 396     std::map<const ConstantFP*, unsigned>::iterator I = FPConstantMap.find(FPC);
 397     if (I != FPConstantMap.end()) {
 398       // Because of FP precision problems we must load from a stack allocated
 399       // value that holds the value in hex.
 400       Out << "(*(" << (FPC->getType() == Type::FloatTy ? "float" : "double")
 401           << "*)&FloatConstant" << I->second << ")";
 402     } else {
 403       Out << FPC->getValue();
 404     }
 405     break;
 406   }
 407
 408   case Type::ArrayTyID:
 409     printConstantArray(cast<ConstantArray>(CPV));
 410     break;
 411
 412   case Type::StructTyID: {
 413     Out << "{";
 414     if (CPV->getNumOperands()) {
 415       Out << " ";
 416       printConstant(cast<Constant>(CPV->getOperand(0)));
 417       for (unsigned i = 1, e = CPV->getNumOperands(); i != e; ++i) {
 418         Out << ", ";
 419         printConstant(cast<Constant>(CPV->getOperand(i)));
 420       }
 421     }
 422     Out << " }";
 423     break;
 424   }
 425
 426   case Type::PointerTyID:
 427     if (isa<ConstantPointerNull>(CPV)) {
 428       Out << "(NULL)";
 429       break;
 430     } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CPV)) {
 431       writeOperand(CPR->getValue());
 432       break;
 433     }
 434     // FALL THROUGH
 435   default:
 436     std::cerr << "Unknown constant type: " << CPV << "\n";
 437     abort();
 438   }
 439 }
 440
 441 void CWriter::writeOperandInternal(Value *Operand) {
 442   if (Instruction *I = dyn_cast<Instruction>(Operand))
 443     if (isInlinableInst(*I)) {
 444       // Should we inline this instruction to build a tree?
 445       Out << "(";
 446       visit(*I);
 447       Out << ")";
 448       return;
 449     }
 450
 451   if (Operand->hasName()) {
 452     Out << getValueName(Operand);
 453   } else if (Constant *CPV = dyn_cast<Constant>(Operand)) {
 454     printConstant(CPV);
 455   } else {
 456     int Slot = Table->getValSlot(Operand);
 457     assert(Slot >= 0 && "Malformed LLVM!");
 458     Out << "ltmp_" << Slot << "_" << Operand->getType()->getUniqueID();
 459   }
 460 }
 461
 462 void CWriter::writeOperand(Value *Operand) {
 463   if (isa<GlobalVariable>(Operand))
 464     Out << "(&";  // Global variables are references as their addresses by llvm
 465
 466   writeOperandInternal(Operand);
 467
 468   if (isa<GlobalVariable>(Operand))
 469     Out << ")";
 470 }
 471
 472 // nameAllUsedStructureTypes - If there are structure types in the module that
 473 // are used but do not have names assigned to them in the symbol table yet then
 474 // we assign them names now.
 475 //
 476 bool CWriter::nameAllUsedStructureTypes(Module &M) {
 477   // Get a set of types that are used by the program...
 478   std::set<const Type *> UT = getAnalysis<FindUsedTypes>().getTypes();
 479
 480   // Loop over the module symbol table, removing types from UT that are already
 481   // named.
 482   //
 483   SymbolTable &MST = M.getSymbolTable();
 484   if (MST.find(Type::TypeTy) != MST.end())
 485     for (SymbolTable::type_iterator I = MST.type_begin(Type::TypeTy),
 486            E = MST.type_end(Type::TypeTy); I != E; ++I)
 487       UT.erase(cast<Type>(I->second));
 488
 489   // UT now contains types that are not named.  Loop over it, naming structure
 490   // types.
 491   //
 492   bool Changed = false;
 493   for (std::set<const Type *>::const_iterator I = UT.begin(), E = UT.end();
 494        I != E; ++I)
 495     if (const StructType *ST = dyn_cast<StructType>(*I)) {
 496       ((Value*)ST)->setName("unnamed", &MST);
 497       Changed = true;
 498     }
 499   return Changed;
 500 }
 501
 502 static void generateAllocaDecl(std::ostream& Out) {
 503   // On SunOS, we need to insert the alloca macro & proto for the builtin.
 504   Out << "#ifdef sun\n"
 505       << "extern void *__builtin_alloca(unsigned long);\n"
 506       << "#define alloca(x) __builtin_alloca(x)\n"
 507       << "#else\n"
 508       << "#include <alloca.h>\n"
 509       << "#endif\n\n";
 510 }
 511
 512 void CWriter::printModule(Module *M) {
 513   // Calculate which global values have names that will collide when we throw
 514   // away type information.
 515   {  // Scope to delete the FoundNames set when we are done with it...
 516     std::set<std::string> FoundNames;
 517     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 518       if (I->hasName())                      // If the global has a name...
 519         if (FoundNames.count(I->getName()))  // And the name is already used
 520           MangledGlobals.insert(I);          // Mangle the name
 521         else
 522           FoundNames.insert(I->getName());   // Otherwise, keep track of name
 523
 524     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 525       if (I->hasName())                      // If the global has a name...
 526         if (FoundNames.count(I->getName()))  // And the name is already used
 527           MangledGlobals.insert(I);          // Mangle the name
 528         else
 529           FoundNames.insert(I->getName());   // Otherwise, keep track of name
 530   }
 531
 532   // printing stdlib inclusion
 533   //Out << "#include <stdlib.h>\n";
 534
 535   // get declaration for alloca
 536   Out << "/* Provide Declarations */\n";
 537   generateAllocaDecl(Out);
 538
 539   // Provide a definition for null if one does not already exist,
 540   // and for `bool' if not compiling with a C++ compiler.
 541   Out << "#ifndef NULL\n#define NULL 0\n#endif\n\n"
 542       << "#ifndef __cplusplus\ntypedef unsigned char bool;\n#endif\n"
 543
 544       << "\n\n/* Support for floating point constants */\n"
 545       << "typedef unsigned long long ConstantDoubleTy;\n"
 546       << "typedef unsigned int        ConstantFloatTy;\n"
 547
 548       << "\n\n/* Global Declarations */\n";
 549
 550   // First output all the declarations for the program, because C requires
 551   // Functions & globals to be declared before they are used.
 552   //
 553
 554   // Loop over the symbol table, emitting all named constants...
 555   printSymbolTable(M->getSymbolTable());
 556
 557   // Global variable declarations...
 558   if (!M->gempty()) {
 559     Out << "\n/* External Global Variable Declarations */\n";
 560     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I) {
 561       if (I->hasExternalLinkage()) {
 562         Out << "extern ";
 563         printType(Out, I->getType()->getElementType(), getValueName(I));
 564         Out << ";\n";
 565       }
 566     }
 567   }
 568
 569   // Function declarations
 570   if (!M->empty()) {
 571     Out << "\n/* Function Declarations */\n";
 572     needsMalloc = true;
 573     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I) {
 574       // If the function is external and the name collides don't print it.
 575       // Sometimes the bytecode likes to have multiple "declerations" for
 576       // external functions
 577       if (I->hasInternalLinkage() || !MangledGlobals.count(I)){
 578         printFunctionSignature(I, true);
 579         Out << ";\n";
 580       }
 581     }
 582   }
 583
 584   // Print Malloc prototype if needed
 585   if (needsMalloc){
 586     Out << "\n/* Malloc to make sun happy */\n";
 587     Out << "extern void * malloc(size_t);\n\n";
 588   }
 589
 590   // Output the global variable declerations
 591   if (!M->gempty()) {
 592     Out << "\n\n/* Global Variable Declerations */\n";
 593     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 594       if (!I->isExternal()) {
 595         Out << "extern ";
 596         printType(Out, I->getType()->getElementType(), getValueName(I));
 597
 598         Out << ";\n";
 599       }
 600   }
 601
 602
 603   // Output the global variable definitions and contents...
 604   if (!M->gempty()) {
 605     Out << "\n\n/* Global Variable Definitions and Initialization */\n";
 606     for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 607       if (!I->isExternal()) {
 608         if (I->hasInternalLinkage())
 609           Out << "static ";
 610         printType(Out, I->getType()->getElementType(), getValueName(I));
 611
 612         Out << " = " ;
 613         writeOperand(I->getInitializer());
 614         Out << ";\n";
 615       }
 616   }
 617
 618   // Output all of the functions...
 619   if (!M->empty()) {
 620     Out << "\n\n/* Function Bodies */\n";
 621     for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 622       printFunction(I);
 623   }
 624 }
 625
 626
 627 /// printSymbolTable - Run through symbol table looking for type names.  If a
 628 /// type name is found, emit it's declaration...
 629 ///
 630 void CWriter::printSymbolTable(const SymbolTable &ST) {
 631   // If there are no type names, exit early.
 632   if (ST.find(Type::TypeTy) == ST.end())
 633     return;
 634
 635   // We are only interested in the type plane of the symbol table...
 636   SymbolTable::type_const_iterator I   = ST.type_begin(Type::TypeTy);
 637   SymbolTable::type_const_iterator End = ST.type_end(Type::TypeTy);
 638
 639   // Print out forward declarations for structure types before anything else!
 640   Out << "/* Structure forward decls */\n";
 641   for (; I != End; ++I)
 642     if (const Type *STy = dyn_cast<StructType>(I->second)) {
 643       std::string Name = "struct l_" + makeNameProper(I->first);
 644       Out << Name << ";\n";
 645       TypeNames.insert(std::make_pair(STy, Name));
 646     }
 647
 648   Out << "\n";
 649
 650   // Now we can print out typedefs...
 651   Out << "/* Typedefs */\n";
 652   for (I = ST.type_begin(Type::TypeTy); I != End; ++I) {
 653     const Type *Ty = cast<Type>(I->second);
 654     std::string Name = "l_" + makeNameProper(I->first);
 655     Out << "typedef ";
 656     printType(Out, Ty, Name);
 657     Out << ";\n";
 658   }
 659
 660   Out << "\n";
 661
 662   // Keep track of which structures have been printed so far...
 663   std::set<const StructType *> StructPrinted;
 664
 665   // Loop over all structures then push them into the stack so they are
 666   // printed in the correct order.
 667   //
 668   Out << "/* Structure contents */\n";
 669   for (I = ST.type_begin(Type::TypeTy); I != End; ++I)
 670     if (const StructType *STy = dyn_cast<StructType>(I->second))
 671       printContainedStructs(STy, StructPrinted);
 672 }
 673
 674 // Push the struct onto the stack and recursively push all structs
 675 // this one depends on.
 676 void CWriter::printContainedStructs(const Type *Ty,
 677                                     std::set<const StructType*> &StructPrinted){
 678   if (const StructType *STy = dyn_cast<StructType>(Ty)){
 679     //Check to see if we have already printed this struct
 680     if (StructPrinted.count(STy) == 0) {
 681       // Print all contained types first...
 682       for (StructType::ElementTypes::const_iterator
 683              I = STy->getElementTypes().begin(),
 684              E = STy->getElementTypes().end(); I != E; ++I) {
 685         const Type *Ty1 = I->get();
 686         if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
 687           printContainedStructs(Ty1, StructPrinted);
 688       }
 689
 690       //Print structure type out..
 691       StructPrinted.insert(STy);
 692       std::string Name = TypeNames[STy];
 693       printType(Out, STy, Name, true);
 694       Out << ";\n\n";
 695     }
 696
 697     // If it is an array, check contained types and continue
 698   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)){
 699     const Type *Ty1 = ATy->getElementType();
 700     if (isa<StructType>(Ty1) || isa<ArrayType>(Ty1))
 701       printContainedStructs(Ty1, StructPrinted);
 702   }
 703 }
 704
 705
 706 void CWriter::printFunctionSignature(const Function *F, bool Prototype) {
 707   // If the program provides it's own malloc prototype we don't need
 708   // to include the general one.
 709   if (getValueName(F) == "malloc")
 710     needsMalloc = false;
 711   if (F->hasInternalLinkage()) Out << "static ";
 712   // Loop over the arguments, printing them...
 713   const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
 714
 715   std::stringstream FunctionInards;
 716
 717   // Print out the name...
 718   FunctionInards << getValueName(F) << "(";
 719
 720   if (!F->isExternal()) {
 721     if (!F->aempty()) {
 722       std::string ArgName;
 723       if (F->abegin()->hasName() || !Prototype)
 724         ArgName = getValueName(F->abegin());
 725       printType(FunctionInards, F->afront().getType(), ArgName);
 726       for (Function::const_aiterator I = ++F->abegin(), E = F->aend();
 727            I != E; ++I) {
 728         FunctionInards << ", ";
 729         if (I->hasName() || !Prototype)
 730           ArgName = getValueName(I);
 731         else
 732           ArgName = "";
 733         printType(FunctionInards, I->getType(), ArgName);
 734       }
 735     }
 736   } else {
 737     // Loop over the arguments, printing them...
 738     for (FunctionType::ParamTypes::const_iterator I =
 739            FT->getParamTypes().begin(),
 740            E = FT->getParamTypes().end(); I != E; ++I) {
 741       if (I != FT->getParamTypes().begin()) FunctionInards << ", ";
 742       printType(FunctionInards, *I);
 743     }
 744   }
 745
 746   // Finish printing arguments... if this is a vararg function, print the ...,
 747   // unless there are no known types, in which case, we just emit ().
 748   //
 749   if (FT->isVarArg() && !FT->getParamTypes().empty()) {
 750     if (FT->getParamTypes().size()) FunctionInards << ", ";
 751     FunctionInards << "...";  // Output varargs portion of signature!
 752   }
 753   FunctionInards << ")";
 754   // Print out the return type and the entire signature for that matter
 755   printType(Out, F->getReturnType(), FunctionInards.str());
 756
 757 }
 758
 759
 760 void CWriter::printFunction(Function *F) {
 761   if (F->isExternal()) return;
 762
 763   Table->incorporateFunction(F);
 764
 765   printFunctionSignature(F, false);
 766   Out << " {\n";
 767
 768   // print local variable information for the function
 769   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
 770     if ((*I)->getType() != Type::VoidTy && !isInlinableInst(**I)) {
 771       Out << "  ";
 772       printType(Out, (*I)->getType(), getValueName(*I));
 773       Out << ";\n";
 774     }
 775
 776   Out << "\n";
 777
 778   // Scan the function for floating point constants.  If any FP constant is used
 779   // in the function, we want to redirect it here so that we do not depend on
 780   // the precision of the printed form.
 781   //
 782   unsigned FPCounter = 0;
 783   for (constant_iterator I = constant_begin(F), E = constant_end(F); I != E;++I)
 784     if (const ConstantFP *FPC = dyn_cast<ConstantFP>(*I))
 785       if (FPConstantMap.find(FPC) == FPConstantMap.end()) {
 786         double Val = FPC->getValue();
 787
 788         FPConstantMap[FPC] = FPCounter;  // Number the FP constants
 789
 790         if (FPC->getType() == Type::DoubleTy)
 791           Out << "  const ConstantDoubleTy FloatConstant" << FPCounter++
 792               << " = 0x" << std::hex << *(unsigned long long*)&Val << std::dec
 793               << ";    /* " << Val << " */\n";
 794         else if (FPC->getType() == Type::FloatTy) {
 795           float fVal = Val;
 796           Out << "  const ConstantFloatTy FloatConstant" << FPCounter++
 797               << " = 0x" << std::hex << *(unsigned*)&fVal << std::dec
 798               << ";    /* " << Val << " */\n";
 799         } else
 800           assert(0 && "Unknown float type!");
 801       }
 802
 803   Out << "\n";
 804
 805   // print the basic blocks
 806   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 807     BasicBlock *Prev = BB->getPrev();
 808
 809     // Don't print the label for the basic block if there are no uses, or if the
 810     // only terminator use is the precessor basic block's terminator.  We have
 811     // to scan the use list because PHI nodes use basic blocks too but do not
 812     // require a label to be generated.
 813     //
 814     bool NeedsLabel = false;
 815     for (Value::use_iterator UI = BB->use_begin(), UE = BB->use_end();
 816          UI != UE; ++UI)
 817       if (TerminatorInst *TI = dyn_cast<TerminatorInst>(*UI))
 818         if (TI != Prev->getTerminator() ||
 819             isa<SwitchInst>(Prev->getTerminator())) {
 820           NeedsLabel = true;
 821           break;
 822         }
 823
 824     if (NeedsLabel) Out << getValueName(BB) << ":\n";
 825
 826     // Output all of the instructions in the basic block...
 827     for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E; ++II){
 828       if (!isInlinableInst(*II) && !isa<PHINode>(*II)) {
 829         if (II->getType() != Type::VoidTy)
 830           outputLValue(II);
 831         else
 832           Out << "  ";
 833         visit(*II);
 834         Out << ";\n";
 835       }
 836     }
 837
 838     // Don't emit prefix or suffix for the terminator...
 839     visit(*BB->getTerminator());
 840   }
 841
 842   Out << "}\n\n";
 843   Table->purgeFunction();
 844   FPConstantMap.clear();
 845 }
 846
 847 // Specific Instruction type classes... note that all of the casts are
 848 // neccesary because we use the instruction classes as opaque types...
 849 //
 850 void CWriter::visitReturnInst(ReturnInst &I) {
 851   // Don't output a void return if this is the last basic block in the function
 852   if (I.getNumOperands() == 0 &&
 853       &*--I.getParent()->getParent()->end() == I.getParent() &&
 854       !I.getParent()->size() == 1) {
 855     return;
 856   }
 857
 858   Out << "  return";
 859   if (I.getNumOperands()) {
 860     Out << " ";
 861     writeOperand(I.getOperand(0));
 862   }
 863   Out << ";\n";
 864 }
 865
 866 void CWriter::visitSwitchInst(SwitchInst &SI) {
 867   Out << "  switch (";
 868   writeOperand(SI.getOperand(0));
 869   Out << ") {\n  default:\n";
 870   printBranchToBlock(SI.getParent(), SI.getDefaultDest(), 2);
 871   Out << ";\n";
 872   for (unsigned i = 2, e = SI.getNumOperands(); i != e; i += 2) {
 873     Out << "  case ";
 874     writeOperand(SI.getOperand(i));
 875     Out << ":\n";
 876     BasicBlock *Succ = cast<BasicBlock>(SI.getOperand(i+1));
 877     printBranchToBlock(SI.getParent(), Succ, 2);
 878     if (Succ == SI.getParent()->getNext())
 879       Out << "    break;\n";
 880   }
 881   Out << "  }\n";
 882 }
 883
 884
 885 static bool isGotoCodeNeccessary(BasicBlock *From, BasicBlock *To) {
 886   // If PHI nodes need copies, we need the copy code...
 887   if (isa<PHINode>(To->front()) ||
 888       From->getNext() != To)      // Not directly successor, need goto
 889     return true;
 890
 891   // Otherwise we don't need the code.
 892   return false;
 893 }
 894
 895 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
 896                                            unsigned Indent) {
 897   for (BasicBlock::iterator I = Succ->begin();
 898        PHINode *PN = dyn_cast<PHINode>(I); ++I) {
 899     //  now we have to do the printing
 900     Out << std::string(Indent, ' ');
 901     outputLValue(PN);
 902     writeOperand(PN->getIncomingValue(PN->getBasicBlockIndex(CurBB)));
 903     Out << ";   /* for PHI node */\n";
 904   }
 905
 906   if (CurBB->getNext() != Succ) {
 907     Out << std::string(Indent, ' ') << "  goto ";
 908     writeOperand(Succ);
 909     Out << ";\n";
 910   }
 911 }
 912
 913 // Brach instruction printing - Avoid printing out a brach to a basic block that
 914 // immediately succeeds the current one.
 915 //
 916 void CWriter::visitBranchInst(BranchInst &I) {
 917   if (I.isConditional()) {
 918     if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(0))) {
 919       Out << "  if (";
 920       writeOperand(I.getCondition());
 921       Out << ") {\n";
 922
 923       printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
 924
 925       if (isGotoCodeNeccessary(I.getParent(), I.getSuccessor(1))) {
 926         Out << "  } else {\n";
 927         printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
 928       }
 929     } else {
 930       // First goto not neccesary, assume second one is...
 931       Out << "  if (!";
 932       writeOperand(I.getCondition());
 933       Out << ") {\n";
 934
 935       printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
 936     }
 937
 938     Out << "  }\n";
 939   } else {
 940     printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
 941   }
 942   Out << "\n";
 943 }
 944
 945
 946 void CWriter::visitBinaryOperator(Instruction &I) {
 947   // binary instructions, shift instructions, setCond instructions.
 948   assert(!isa<PointerType>(I.getType()));
 949
 950   writeOperand(I.getOperand(0));
 951
 952   switch (I.getOpcode()) {
 953   case Instruction::Add: Out << " + "; break;
 954   case Instruction::Sub: Out << " - "; break;
 955   case Instruction::Mul: Out << "*"; break;
 956   case Instruction::Div: Out << "/"; break;
 957   case Instruction::Rem: Out << "%"; break;
 958   case Instruction::And: Out << " & "; break;
 959   case Instruction::Or: Out << " | "; break;
 960   case Instruction::Xor: Out << " ^ "; break;
 961   case Instruction::SetEQ: Out << " == "; break;
 962   case Instruction::SetNE: Out << " != "; break;
 963   case Instruction::SetLE: Out << " <= "; break;
 964   case Instruction::SetGE: Out << " >= "; break;
 965   case Instruction::SetLT: Out << " < "; break;
 966   case Instruction::SetGT: Out << " > "; break;
 967   case Instruction::Shl : Out << " << "; break;
 968   case Instruction::Shr : Out << " >> "; break;
 969   default: std::cerr << "Invalid operator type!" << I; abort();
 970   }
 971
 972   writeOperand(I.getOperand(1));
 973 }
 974
 975 void CWriter::visitCastInst(CastInst &I) {
 976   Out << "(";
 977   printType(Out, I.getType(), "", /*ignoreName*/false, /*namedContext*/false);
 978   Out << ")";
 979   if (isa<PointerType>(I.getType())&&I.getOperand(0)->getType()->isIntegral() ||
 980       isa<PointerType>(I.getOperand(0)->getType())&&I.getType()->isIntegral()) {
 981     // Avoid "cast to pointer from integer of different size" warnings
 982     Out << "(long)";
 983   }
 984
 985   writeOperand(I.getOperand(0));
 986 }
 987
 988 void CWriter::visitCallInst(CallInst &I) {
 989   const PointerType  *PTy   = cast<PointerType>(I.getCalledValue()->getType());
 990   const FunctionType *FTy   = cast<FunctionType>(PTy->getElementType());
 991   const Type         *RetTy = FTy->getReturnType();
 992
 993   writeOperand(I.getOperand(0));
 994   Out << "(";
 995
 996   if (I.getNumOperands() > 1) {
 997     writeOperand(I.getOperand(1));
 998
 999     for (unsigned op = 2, Eop = I.getNumOperands(); op != Eop; ++op) {
1000       Out << ", ";
1001       writeOperand(I.getOperand(op));
1002     }
1003   }
1004   Out << ")";
1005 }
1006
1007 void CWriter::visitMallocInst(MallocInst &I) {
1008   Out << "(";
1009   printType(Out, I.getType());
1010   Out << ")malloc(sizeof(";
1011   printType(Out, I.getType()->getElementType());
1012   Out << ")";
1013
1014   if (I.isArrayAllocation()) {
1015     Out << " * " ;
1016     writeOperand(I.getOperand(0));
1017   }
1018   Out << ")";
1019 }
1020
1021 void CWriter::visitAllocaInst(AllocaInst &I) {
1022   Out << "(";
1023   printType(Out, I.getType());
1024   Out << ") alloca(sizeof(";
1025   printType(Out, I.getType()->getElementType());
1026   Out << ")";
1027   if (I.isArrayAllocation()) {
1028     Out << " * " ;
1029     writeOperand(I.getOperand(0));
1030   }
1031   Out << ")";
1032 }
1033
1034 void CWriter::visitFreeInst(FreeInst &I) {
1035   Out << "free(";
1036   writeOperand(I.getOperand(0));
1037   Out << ")";
1038 }
1039
1040 void CWriter::printIndexingExpression(Value *Ptr, User::op_iterator I,
1041                                       User::op_iterator E) {
1042   bool HasImplicitAddress = false;
1043   // If accessing a global value with no indexing, avoid *(&GV) syndrome
1044   if (GlobalValue *V = dyn_cast<GlobalValue>(Ptr)) {
1045     HasImplicitAddress = true;
1046   } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(Ptr)) {
1047     HasImplicitAddress = true;
1048     Ptr = CPR->getValue();         // Get to the global...
1049   }
1050
1051   if (I == E) {
1052     if (!HasImplicitAddress)
1053       Out << "*";  // Implicit zero first argument: '*x' is equivalent to 'x[0]'
1054
1055     writeOperandInternal(Ptr);
1056     return;
1057   }
1058
1059   const Constant *CI = dyn_cast<Constant>(I->get());
1060   if (HasImplicitAddress && (!CI || !CI->isNullValue()))
1061     Out << "(&";
1062
1063   writeOperandInternal(Ptr);
1064
1065   if (HasImplicitAddress && (!CI || !CI->isNullValue())) {
1066     Out << ")";
1067     HasImplicitAddress = false;  // HIA is only true if we haven't addressed yet
1068   }
1069
1070   assert(!HasImplicitAddress || (CI && CI->isNullValue()) &&
1071          "Can only have implicit address with direct accessing");
1072
1073   if (HasImplicitAddress) {
1074     ++I;
1075   } else if (CI && CI->isNullValue() && I+1 != E) {
1076     // Print out the -> operator if possible...
1077     if ((*(I+1))->getType() == Type::UByteTy) {
1078       Out << (HasImplicitAddress ? "." : "->");
1079       Out << "field" << cast<ConstantUInt>(*(I+1))->getValue();
1080       I += 2;
1081     }
1082   }
1083
1084   for (; I != E; ++I)
1085     if ((*I)->getType() == Type::LongTy) {
1086       Out << "[";
1087       writeOperand(*I);
1088       Out << "]";
1089     } else {
1090       Out << ".field" << cast<ConstantUInt>(*I)->getValue();
1091     }
1092 }
1093
1094 void CWriter::visitLoadInst(LoadInst &I) {
1095   Out << "*";
1096   writeOperand(I.getOperand(0));
1097 }
1098
1099 void CWriter::visitStoreInst(StoreInst &I) {
1100   Out << "*";
1101   writeOperand(I.getPointerOperand());
1102   Out << " = ";
1103   writeOperand(I.getOperand(0));
1104 }
1105
1106 void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
1107   Out << "&";
1108   printIndexingExpression(I.getPointerOperand(), I.idx_begin(), I.idx_end());
1109 }
1110
1111 //===----------------------------------------------------------------------===//
1112 //                       External Interface declaration
1113 //===----------------------------------------------------------------------===//
1114
1115 Pass *createWriteToCPass(std::ostream &o) { return new CWriter(o); }