tools/gccld/gccld.cpp

   1 //===----------------------------------------------------------------------===//
   2 // LLVM 'GCCLD' UTILITY
   3 //
   4 // This utility is intended to be compatible with GCC, and follows standard
   5 // system ld conventions.  As such, the default output file is ./a.out.
   6 // Additionally, this program outputs a shell script that is used to invoke LLI
   7 // to execute the program.  In this manner, the generated executable (a.out for
   8 // example), is directly executable, whereas the bytecode file actually lives in
   9 // the a.out.bc file generated by this program.  Also, Force is on by default.
  10 //
  11 // Note that if someone (or a script) deletes the executable program generated,
  12 // the .bc file will be left around.  Considering that this is a temporary hack,
  13 // I'm not to worried about this.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Transforms/Utils/Linker.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/PassManager.h"
  20 #include "llvm/Bytecode/Reader.h"
  21 #include "llvm/Bytecode/WriteBytecodePass.h"
  22 #include "llvm/Transforms/IPO.h"
  23 #include "llvm/Transforms/Scalar.h"
  24 #include "Support/CommandLine.h"
  25 #include "Support/Signals.h"
  26 #include <fstream>
  27 #include <memory>
  28 #include <algorithm>
  29 #include <sys/types.h>     // For FileExists
  30 #include <sys/stat.h>
  31 using std::cerr;
  32
  33 static cl::list<std::string>
  34 InputFilenames(cl::Positional, cl::desc("<input bytecode files>"),
  35                cl::OneOrMore);
  36
  37 static cl::opt<std::string>
  38 OutputFilename("o", cl::desc("Override output filename"), cl::init("a.out"),
  39                cl::value_desc("filename"));
  40
  41 static cl::opt<bool>
  42 Verbose("v", cl::desc("Print information about actions taken"));
  43
  44 static cl::list<std::string>
  45 LibPaths("L", cl::desc("Specify a library search path"), cl::Prefix,
  46          cl::value_desc("directory"));
  47
  48 static cl::list<std::string>
  49 Libraries("l", cl::desc("Specify libraries to link to"), cl::Prefix,
  50           cl::value_desc("library prefix"));
  51
  52 static cl::opt<bool>
  53 Strip("s", cl::desc("Strip symbol info from executable"));
  54
  55
  56 // FileExists - Return true if the specified string is an openable file...
  57 static inline bool FileExists(const std::string &FN) {
  58   struct stat StatBuf;
  59   return stat(FN.c_str(), &StatBuf) != -1;
  60 }
  61
  62 // LoadFile - Read the specified bytecode file in and return it.  This routine
  63 // searches the link path for the specified file to try to find it...
  64 //
  65 static inline std::auto_ptr<Module> LoadFile(const std::string &FN) {
  66   std::string Filename = FN;
  67   std::string ErrorMessage;
  68
  69   unsigned NextLibPathIdx = 0;
  70   bool FoundAFile = false;
  71
  72   while (1) {
  73     if (Verbose) cerr << "Loading '" << Filename << "'\n";
  74     if (FileExists(Filename)) FoundAFile = true;
  75     Module *Result = ParseBytecodeFile(Filename, &ErrorMessage);
  76     if (Result) return std::auto_ptr<Module>(Result);   // Load successful!
  77
  78     if (Verbose) {
  79       cerr << "Error opening bytecode file: '" << Filename << "'";
  80       if (ErrorMessage.size()) cerr << ": " << ErrorMessage;
  81       cerr << "\n";
  82     }
  83
  84     if (NextLibPathIdx == LibPaths.size()) break;
  85     Filename = LibPaths[NextLibPathIdx++] + "/" + FN;
  86   }
  87
  88   if (FoundAFile)
  89     cerr << "Bytecode file '" << FN << "' corrupt!  "
  90          << "Use 'gccld -v ...' for more info.\n";
  91   else
  92     cerr << "Could not locate bytecode file: '" << FN << "'\n";
  93   return std::auto_ptr<Module>();
  94 }
  95
  96
  97 int main(int argc, char **argv) {
  98   cl::ParseCommandLineOptions(argc, argv, " llvm linker for GCC\n");
  99
 100   unsigned BaseArg = 0;
 101   std::string ErrorMessage;
 102
 103   if (!Libraries.empty()) {
 104     // Sort libraries list...
 105     std::sort(Libraries.begin(), Libraries.end());
 106
 107     // Remove duplicate libraries entries...
 108     Libraries.erase(unique(Libraries.begin(), Libraries.end()),
 109                     Libraries.end());
 110
 111     // Add all of the libraries to the end of the link line...
 112     for (unsigned i = 0; i < Libraries.size(); ++i)
 113       InputFilenames.push_back("lib" + Libraries[i] + ".bc");
 114   }
 115
 116   std::auto_ptr<Module> Composite(LoadFile(InputFilenames[BaseArg]));
 117   if (Composite.get() == 0) return 1;
 118
 119   for (unsigned i = BaseArg+1; i < InputFilenames.size(); ++i) {
 120     std::auto_ptr<Module> M(LoadFile(InputFilenames[i]));
 121     if (M.get() == 0) return 1;
 122
 123     if (Verbose) cerr << "Linking in '" << InputFilenames[i] << "'\n";
 124
 125     if (LinkModules(Composite.get(), M.get(), &ErrorMessage)) {
 126       cerr << argv[0] << ": error linking in '" << InputFilenames[i] << "': "
 127            << ErrorMessage << "\n";
 128       return 1;
 129     }
 130   }
 131
 132   // In addition to just linking the input from GCC, we also want to spiff it up
 133   // a little bit.  Do this now.
 134   //
 135   PassManager Passes;
 136
 137   // Linking modules together can lead to duplicated global constants, only keep
 138   // one copy of each constant...
 139   //
 140   Passes.add(createConstantMergePass());
 141
 142   // If the -s command line option was specified, strip the symbols out of the
 143   // resulting program to make it smaller.  -s is a GCC option that we are
 144   // supporting.
 145   //
 146   if (Strip)
 147     Passes.add(createSymbolStrippingPass());
 148
 149   // Often if the programmer does not specify proper prototypes for the
 150   // functions they are calling, they end up calling a vararg version of the
 151   // function that does not get a body filled in (the real function has typed
 152   // arguments).  This pass merges the two functions.
 153   //
 154   Passes.add(createFunctionResolvingPass());
 155
 156   // Now that composite has been compiled, scan through the module, looking for
 157   // a main function.  If main is defined, mark all other functions internal.
 158   //
 159   Passes.add(createInternalizePass());
 160
 161   // Now that we have optimized the program, discard unreachable functions...
 162   //
 163   Passes.add(createGlobalDCEPass());
 164
 165   // Add the pass that writes bytecode to the output file...
 166   std::ofstream Out((OutputFilename+".bc").c_str());
 167   if (!Out.good()) {
 168     cerr << argv[0] << ": error opening '" << OutputFilename
 169          << ".bc' for writing!\n";
 170     return 1;
 171   }
 172   Passes.add(new WriteBytecodePass(&Out));        // Write bytecode to file...
 173
 174   // Make sure that the Out file gets unlink'd from the disk if we get a SIGINT
 175   RemoveFileOnSignal(OutputFilename+".bc");
 176
 177   // Run our queue of passes all at once now, efficiently.
 178   Passes.run(*Composite.get());
 179   Out.close();
 180
 181   // Output the script to start the program...
 182   std::ofstream Out2(OutputFilename.c_str());
 183   if (!Out2.good()) {
 184     cerr << argv[0] << ": error opening '" << OutputFilename
 185          << "' for writing!\n";
 186     return 1;
 187   }
 188   Out2 << "#!/bin/sh\nlli -q $0.bc $*\n";
 189   Out2.close();
 190
 191   // Make the script executable...
 192   chmod(OutputFilename.c_str(), 0755);
 193
 194   return 0;
 195 }