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