tools/gccld/gccld.cpp

   1 //===- gccld.cpp - LLVM 'ld' compatible linker ----------------------------===//
   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 utility is intended to be compatible with GCC, and follows standard
  11 // system 'ld' conventions.  As such, the default output file is ./a.out.
  12 // Additionally, this program outputs a shell script that is used to invoke LLI
  13 // to execute the program.  In this manner, the generated executable (a.out for
  14 // example), is directly executable, whereas the bytecode file actually lives in
  15 // the a.out.bc file generated by this program.  Also, Force is on by default.
  16 //
  17 // Note that if someone (or a script) deletes the executable program generated,
  18 // the .bc file will be left around.  Considering that this is a temporary hack,
  19 // I'm not too worried about this.
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #include "gccld.h"
  24 #include "llvm/Linker.h"
  25 #include "llvm/Module.h"
  26 #include "llvm/PassManager.h"
  27 #include "llvm/Bytecode/Reader.h"
  28 #include "llvm/Bytecode/WriteBytecodePass.h"
  29 #include "llvm/Target/TargetData.h"
  30 #include "llvm/Transforms/IPO.h"
  31 #include "llvm/Transforms/Scalar.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/FileUtilities.h"
  34 #include "llvm/System/Signals.h"
  35 #include "llvm/Support/SystemUtils.h"
  36 #include <fstream>
  37 #include <memory>
  38 using namespace llvm;
  39
  40 namespace {
  41   cl::list<std::string>
  42   InputFilenames(cl::Positional, cl::desc("<input bytecode files>"),
  43                  cl::OneOrMore);
  44
  45   cl::opt<std::string>
  46   OutputFilename("o", cl::desc("Override output filename"), cl::init("a.out"),
  47                  cl::value_desc("filename"));
  48
  49   cl::opt<bool>
  50   Verbose("v", cl::desc("Print information about actions taken"));
  51
  52   cl::list<std::string>
  53   LibPaths("L", cl::desc("Specify a library search path"), cl::Prefix,
  54            cl::value_desc("directory"));
  55
  56   cl::list<std::string>
  57   Libraries("l", cl::desc("Specify libraries to link to"), cl::Prefix,
  58             cl::value_desc("library prefix"));
  59
  60   cl::opt<bool>
  61   Strip("strip-all", cl::desc("Strip all symbol info from executable"));
  62   cl::opt<bool>
  63   StripDebug("strip-debug",
  64              cl::desc("Strip debugger symbol info from executable"));
  65
  66   cl::opt<bool>
  67   NoInternalize("disable-internalize",
  68                 cl::desc("Do not mark all symbols as internal"));
  69   cl::alias
  70   ExportDynamic("export-dynamic", cl::desc("Alias for -disable-internalize"),
  71                 cl::aliasopt(NoInternalize));
  72
  73   cl::opt<bool>
  74   LinkAsLibrary("link-as-library", cl::desc("Link the .bc files together as a"
  75                                             " library, not an executable"));
  76   cl::alias
  77   Relink("r", cl::desc("Alias for -link-as-library"),
  78          cl::aliasopt(LinkAsLibrary));
  79
  80   cl::opt<bool>
  81   Native("native",
  82          cl::desc("Generate a native binary instead of a shell script"));
  83   cl::opt<bool>
  84   NativeCBE("native-cbe",
  85             cl::desc("Generate a native binary with the C backend and GCC"));
  86
  87   cl::opt<bool>
  88   SaveTemps("save-temps",
  89          cl::desc("Do not delete temporary files"));
  90
  91   cl::opt<std::string>
  92   RPath("rpath",
  93         cl::desc("Set runtime shared library search path (requires -native or"
  94                  " -native-cbe)"),
  95         cl::Prefix, cl::value_desc("directory"));
  96
  97   cl::opt<std::string>
  98   SOName("soname",
  99          cl::desc("Set internal name of shared library (requires -native or"
 100                  " -native-cbe)"),
 101          cl::Prefix, cl::value_desc("name"));
 102
 103   // Compatibility options that are ignored but supported by LD
 104   cl::opt<std::string>
 105   CO4("version-script", cl::Hidden, cl::desc("Compatibility option: ignored"));
 106   cl::opt<bool>
 107   CO5("eh-frame-hdr", cl::Hidden, cl::desc("Compatibility option: ignored"));
 108   cl::opt<std::string>
 109   CO6("h", cl::Hidden, cl::desc("Compatibility option: ignored"));
 110
 111   cl::alias A0("s", cl::desc("Alias for --strip-all"),
 112                cl::aliasopt(Strip));
 113   cl::alias A1("S", cl::desc("Alias for --strip-debug"),
 114                cl::aliasopt(StripDebug));
 115
 116 }
 117
 118 /// PrintAndReturn - Prints a message to standard error and returns true.
 119 ///
 120 /// Inputs:
 121 ///  progname - The name of the program (i.e. argv[0]).
 122 ///  Message  - The message to print to standard error.
 123 ///
 124 static int PrintAndReturn(const char *progname, const std::string &Message) {
 125   std::cerr << progname << ": " << Message << "\n";
 126   return 1;
 127 }
 128
 129 /// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
 130 /// bytecode file for the program.
 131 static void EmitShellScript(char **argv) {
 132 #if defined(_WIN32) || defined(__CYGWIN__)
 133   // Windows doesn't support #!/bin/sh style shell scripts in .exe files.  To
 134   // support windows systems, we copy the llvm-stub.exe executable from the
 135   // build tree to the destination file.
 136   std::string llvmstub = FindExecutable("llvm-stub.exe", argv[0]).toString();
 137   if (llvmstub.empty()) {
 138     std::cerr << "Could not find llvm-stub.exe executable!\n";
 139     exit(1);
 140   }
 141   sys::CopyFile(sys::Path(OutputFilename), sys::Path(llvmstub));
 142   return;
 143 #endif
 144
 145   // Output the script to start the program...
 146   std::ofstream Out2(OutputFilename.c_str());
 147   if (!Out2.good())
 148     exit(PrintAndReturn(argv[0], "error opening '" + OutputFilename +
 149                                  "' for writing!"));
 150
 151   Out2 << "#!/bin/sh\n";
 152   // Allow user to setenv LLVMINTERP if lli is not in their PATH.
 153   Out2 << "lli=${LLVMINTERP-lli}\n";
 154   Out2 << "exec $lli \\\n";
 155
 156   // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
 157   // shared object at all! See RH 8: plain text.
 158   std::vector<std::string>::iterator libc =
 159     std::find(Libraries.begin(), Libraries.end(), "c");
 160   if (libc != Libraries.end()) Libraries.erase(libc);
 161   // List all the shared object (native) libraries this executable will need
 162   // on the command line, so that we don't have to do this manually!
 163   for (std::vector<std::string>::iterator i = Libraries.begin(),
 164          e = Libraries.end(); i != e; ++i) {
 165     sys::Path FullLibraryPath = sys::Path::FindLibrary(*i);
 166     if (!FullLibraryPath.isEmpty() && FullLibraryPath.isDynamicLibrary())
 167       Out2 << "    -load=" << FullLibraryPath.toString() << " \\\n";
 168   }
 169   Out2 << "    $0.bc ${1+\"$@\"}\n";
 170   Out2.close();
 171 }
 172
 173 // BuildLinkItems -- This function generates a LinkItemList for the LinkItems
 174 // linker function by combining the Files and Libraries in the order they were
 175 // declared on the command line.
 176 static void BuildLinkItems(
 177   Linker::ItemList& Items,
 178   const cl::list<std::string>& Files,
 179   const cl::list<std::string>& Libraries) {
 180
 181   // Build the list of linkage items for LinkItems.
 182
 183   cl::list<std::string>::const_iterator fileIt = Files.begin();
 184   cl::list<std::string>::const_iterator libIt  = Libraries.begin();
 185
 186   int libPos = -1, filePos = -1;
 187   while ( libIt != Libraries.end() || fileIt != Files.end() ) {
 188     if (libIt != Libraries.end())
 189       libPos = Libraries.getPosition(libIt - Libraries.begin());
 190     else
 191       libPos = -1;
 192     if (fileIt != Files.end())
 193       filePos = Files.getPosition(fileIt - Files.begin());
 194     else
 195       filePos = -1;
 196
 197     if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
 198       // Add a source file
 199       Items.push_back(std::make_pair(*fileIt++, false));
 200     } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
 201       // Add a library
 202       Items.push_back(std::make_pair(*libIt++, true));
 203     }
 204   }
 205 }
 206
 207 int main(int argc, char **argv, char **envp ) {
 208   cl::ParseCommandLineOptions(argc, argv, " llvm linker for GCC\n");
 209   sys::PrintStackTraceOnErrorSignal();
 210
 211   int exitCode = 0;
 212
 213   std::string ProgName = sys::Path(argv[0]).getBasename();
 214   Linker TheLinker(ProgName, Verbose);
 215
 216   try {
 217     // Remove any consecutive duplicates of the same library...
 218     Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
 219                     Libraries.end());
 220
 221     TheLinker.addPaths(LibPaths);
 222     TheLinker.addSystemPaths();
 223
 224     if (LinkAsLibrary) {
 225       std::vector<sys::Path> Files;
 226       for (unsigned i = 0; i < InputFilenames.size(); ++i )
 227         Files.push_back(sys::Path(InputFilenames[i]));
 228
 229       if (TheLinker.LinkInFiles(Files))
 230         return 1; // Error already printed by linker
 231
 232       // The libraries aren't linked in but are noted as "dependent" in the
 233       // module.
 234       for (cl::list<std::string>::const_iterator I = Libraries.begin(),
 235            E = Libraries.end(); I != E ; ++I) {
 236         TheLinker.getModule()->addLibrary(*I);
 237       }
 238
 239     } else {
 240       // Build a list of the items from our command line
 241       Linker::ItemList Items;
 242       BuildLinkItems(Items, InputFilenames, Libraries);
 243
 244       // Link all the items together
 245       if (TheLinker.LinkInItems(Items))
 246         return 1; // Error already printed
 247     }
 248
 249     // We're done with the Linker, so tell it to release its module
 250     std::auto_ptr<Module> Composite(TheLinker.releaseModule());
 251
 252     // Create the output file.
 253     std::string RealBytecodeOutput = OutputFilename;
 254     if (!LinkAsLibrary || Native || NativeCBE) RealBytecodeOutput += ".bc";
 255     std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 256                                  std::ios::binary;
 257     std::ofstream Out(RealBytecodeOutput.c_str(), io_mode);
 258     if (!Out.good())
 259       return PrintAndReturn(argv[0], "error opening '" + RealBytecodeOutput +
 260                                      "' for writing!");
 261
 262     // Ensure that the bytecode file gets removed from the disk if we get a
 263     // SIGINT signal.
 264     sys::RemoveFileOnSignal(sys::Path(RealBytecodeOutput));
 265
 266     // Strip everything if Strip is set, otherwise if stripdebug is set, just
 267     // strip debug info.
 268     int StripLevel = Strip ? 2 : (StripDebug ? 1 : 0);
 269
 270     // Internalize the module if neither -disable-internalize nor
 271     // -link-as-library are passed in.
 272     bool ShouldInternalize = !NoInternalize & !LinkAsLibrary;
 273
 274     // Generate the bytecode file.
 275     if (GenerateBytecode(Composite.get(), StripLevel, ShouldInternalize, &Out)){
 276       Out.close();
 277       return PrintAndReturn(argv[0], "error generating bytecode");
 278     }
 279
 280     // Close the bytecode file.
 281     Out.close();
 282
 283     // Generate either a native file or a JIT shell script.  If the user wants
 284     // to generate a native file, compile it from the bytecode file. Otherwise,
 285     // if the target is not a library, create a script that will run the
 286     // bytecode through the JIT.
 287     if (Native) {
 288       // Name of the Assembly Language output file
 289       sys::Path AssemblyFile (OutputFilename);
 290       AssemblyFile.appendSuffix("s");
 291
 292       // Mark the output files for removal if we get an interrupt.
 293       sys::RemoveFileOnSignal(AssemblyFile);
 294       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 295
 296       // Determine the locations of the llc and gcc programs.
 297       sys::Path llc = FindExecutable("llc", argv[0]);
 298       if (llc.isEmpty())
 299         return PrintAndReturn(argv[0], "Failed to find llc");
 300
 301       sys::Path gcc = FindExecutable("gcc", argv[0]);
 302       if (gcc.isEmpty())
 303         return PrintAndReturn(argv[0], "Failed to find gcc");
 304
 305       // Generate an assembly language file for the bytecode.
 306       if (Verbose) std::cout << "Generating Assembly Code\n";
 307       GenerateAssembly(AssemblyFile.toString(), RealBytecodeOutput, llc,
 308                        Verbose);
 309       if (Verbose) std::cout << "Generating Native Code\n";
 310       GenerateNative(OutputFilename, AssemblyFile.toString(),
 311                      LibPaths, Libraries, gcc, envp, LinkAsLibrary,
 312                      NoInternalize, RPath, SOName, Verbose);
 313
 314       if (!SaveTemps) {
 315         // Remove the assembly language file.
 316         AssemblyFile.eraseFromDisk();
 317         // Remove the bytecode language file.
 318         sys::Path(RealBytecodeOutput).eraseFromDisk();
 319       }
 320
 321     } else if (NativeCBE) {
 322       sys::Path CFile (OutputFilename);
 323       CFile.appendSuffix("cbe.c");
 324
 325       // Mark the output files for removal if we get an interrupt.
 326       sys::RemoveFileOnSignal(CFile);
 327       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 328
 329       // Determine the locations of the llc and gcc programs.
 330       sys::Path llc = FindExecutable("llc", argv[0]);
 331       if (llc.isEmpty())
 332         return PrintAndReturn(argv[0], "Failed to find llc");
 333
 334       sys::Path gcc = FindExecutable("gcc", argv[0]);
 335       if (gcc.isEmpty())
 336         return PrintAndReturn(argv[0], "Failed to find gcc");
 337
 338       // Generate an assembly language file for the bytecode.
 339       if (Verbose) std::cout << "Generating C Source Code\n";
 340       GenerateCFile(CFile.toString(), RealBytecodeOutput, llc, Verbose);
 341       if (Verbose) std::cout << "Generating Native Code\n";
 342       GenerateNative(OutputFilename, CFile.toString(),
 343                      LibPaths, Libraries, gcc, envp, LinkAsLibrary,
 344                      NoInternalize, RPath, SOName, Verbose);
 345
 346       if (!SaveTemps) {
 347         // Remove the assembly language file.
 348         CFile.eraseFromDisk();
 349         // Remove the bytecode language file.
 350         sys::Path(RealBytecodeOutput).eraseFromDisk();
 351       }
 352
 353     } else if (!LinkAsLibrary) {
 354       EmitShellScript(argv);
 355
 356       // Make the bytecode file readable and directly executable in LLEE
 357       sys::Path(RealBytecodeOutput).makeExecutableOnDisk();
 358       sys::Path(RealBytecodeOutput).makeReadableOnDisk();
 359     }
 360
 361     // Make the output, whether native or script, executable as well...
 362     sys::Path(OutputFilename).makeExecutableOnDisk();
 363
 364   } catch (const char*msg) {
 365     std::cerr << argv[0] << ": " << msg << "\n";
 366     exitCode = 1;
 367   } catch (const std::string& msg) {
 368     std::cerr << argv[0] << ": " << msg << "\n";
 369     exitCode = 2;
 370   } catch (...) {
 371     // This really shouldn't happen, but just in case ....
 372     std::cerr << argv[0] << ": An unexpected unknown exception occurred.\n";
 373     exitCode = 3;
 374   }
 375
 376   return exitCode;
 377 }