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("s", cl::desc("Strip symbol info from executable"));
  62
  63   cl::opt<bool>
  64   NoInternalize("disable-internalize",
  65                 cl::desc("Do not mark all symbols as internal"));
  66   cl::alias
  67   ExportDynamic("export-dynamic", cl::desc("Alias for -disable-internalize"),
  68                 cl::aliasopt(NoInternalize));
  69
  70   cl::opt<bool>
  71   LinkAsLibrary("link-as-library", cl::desc("Link the .bc files together as a"
  72                                             " library, not an executable"));
  73   cl::alias
  74   Relink("r", cl::desc("Alias for -link-as-library"),
  75          cl::aliasopt(LinkAsLibrary));
  76
  77   cl::opt<bool>
  78   Native("native",
  79          cl::desc("Generate a native binary instead of a shell script"));
  80   cl::opt<bool>
  81   NativeCBE("native-cbe",
  82             cl::desc("Generate a native binary with the C backend and GCC"));
  83
  84   // Compatibility options that are ignored but supported by LD
  85   cl::opt<std::string>
  86   CO3("soname", cl::Hidden, cl::desc("Compatibility option: ignored"));
  87   cl::opt<std::string>
  88   CO4("version-script", cl::Hidden, cl::desc("Compatibility option: ignored"));
  89   cl::opt<bool>
  90   CO5("eh-frame-hdr", cl::Hidden, cl::desc("Compatibility option: ignored"));
  91   cl::opt<std::string>
  92   CO6("h", cl::Hidden, cl::desc("Compatibility option: ignored"));
  93 }
  94
  95 /// PrintAndReturn - Prints a message to standard error and returns true.
  96 ///
  97 /// Inputs:
  98 ///  progname - The name of the program (i.e. argv[0]).
  99 ///  Message  - The message to print to standard error.
 100 ///
 101 static int PrintAndReturn(const char *progname, const std::string &Message) {
 102   std::cerr << progname << ": " << Message << "\n";
 103   return 1;
 104 }
 105
 106 /// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
 107 /// bytecode file for the program.
 108 static void EmitShellScript(char **argv) {
 109 #if defined(_WIN32) || defined(__CYGWIN__)
 110   // Windows doesn't support #!/bin/sh style shell scripts in .exe files.  To
 111   // support windows systems, we copy the llvm-stub.exe executable from the
 112   // build tree to the destination file.
 113   std::string llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
 114   if (llvmstub.empty()) {
 115     std::cerr << "Could not find llvm-stub.exe executable!\n";
 116     exit(1);
 117   }
 118   if (CopyFile(OutputFilename, llvmstub)) {
 119     std::cerr << "Could not copy the llvm-stub.exe executable!\n";
 120     exit(1);
 121   }
 122   return;
 123 #endif
 124
 125   // Output the script to start the program...
 126   std::ofstream Out2(OutputFilename.c_str());
 127   if (!Out2.good())
 128     exit(PrintAndReturn(argv[0], "error opening '" + OutputFilename +
 129                                  "' for writing!"));
 130
 131   Out2 << "#!/bin/sh\n";
 132   // Allow user to setenv LLVMINTERP if lli is not in their PATH.
 133   Out2 << "lli=${LLVMINTERP-lli}\n";
 134   Out2 << "exec $lli \\\n";
 135   // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
 136   LibPaths.push_back("/lib");
 137   LibPaths.push_back("/usr/lib");
 138   LibPaths.push_back("/usr/X11R6/lib");
 139   // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
 140   // shared object at all! See RH 8: plain text.
 141   std::vector<std::string>::iterator libc =
 142     std::find(Libraries.begin(), Libraries.end(), "c");
 143   if (libc != Libraries.end()) Libraries.erase(libc);
 144   // List all the shared object (native) libraries this executable will need
 145   // on the command line, so that we don't have to do this manually!
 146   for (std::vector<std::string>::iterator i = Libraries.begin(),
 147          e = Libraries.end(); i != e; ++i) {
 148     std::string FullLibraryPath = FindLib(*i, LibPaths, true);
 149     if (!FullLibraryPath.empty() && IsSharedObject(FullLibraryPath))
 150       Out2 << "    -load=" << FullLibraryPath << " \\\n";
 151   }
 152   Out2 << "    $0.bc ${1+\"$@\"}\n";
 153   Out2.close();
 154 }
 155
 156 int main(int argc, char **argv, char **envp) {
 157   cl::ParseCommandLineOptions(argc, argv, " llvm linker for GCC\n");
 158   sys::PrintStackTraceOnErrorSignal();
 159
 160   int exitCode = 0;
 161
 162   try {
 163     std::string ModuleID("gccld-output");
 164     std::auto_ptr<Module> Composite(new Module(ModuleID));
 165
 166     // We always look first in the current directory when searching for libraries.
 167     LibPaths.insert(LibPaths.begin(), ".");
 168
 169     // If the user specified an extra search path in their environment, respect
 170     // it.
 171     if (char *SearchPath = getenv("LLVM_LIB_SEARCH_PATH"))
 172       LibPaths.push_back(SearchPath);
 173
 174     // Remove any consecutive duplicates of the same library...
 175     Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
 176                     Libraries.end());
 177
 178     // Link in all of the files
 179     if (LinkFiles(argv[0], Composite.get(), InputFilenames, Verbose))
 180       return 1; // Error already printed
 181
 182     if (!LinkAsLibrary)
 183       LinkLibraries(argv[0], Composite.get(), Libraries, LibPaths,
 184                     Verbose, Native);
 185
 186     // Link in all of the libraries next...
 187
 188     // Create the output file.
 189     std::string RealBytecodeOutput = OutputFilename;
 190     if (!LinkAsLibrary) RealBytecodeOutput += ".bc";
 191     std::ofstream Out(RealBytecodeOutput.c_str());
 192     if (!Out.good())
 193       return PrintAndReturn(argv[0], "error opening '" + RealBytecodeOutput +
 194                                      "' for writing!");
 195
 196     // Ensure that the bytecode file gets removed from the disk if we get a
 197     // SIGINT signal.
 198     sys::RemoveFileOnSignal(sys::Path(RealBytecodeOutput));
 199
 200     // Generate the bytecode file.
 201     if (GenerateBytecode(Composite.get(), Strip, !NoInternalize, &Out)) {
 202       Out.close();
 203       return PrintAndReturn(argv[0], "error generating bytecode");
 204     }
 205
 206     // Close the bytecode file.
 207     Out.close();
 208
 209     // If we are not linking a library, generate either a native executable
 210     // or a JIT shell script, depending upon what the user wants.
 211     if (!LinkAsLibrary) {
 212       // If the user wants to generate a native executable, compile it from the
 213       // bytecode file.
 214       //
 215       // Otherwise, create a script that will run the bytecode through the JIT.
 216       if (Native) {
 217         // Name of the Assembly Language output file
 218         std::string AssemblyFile = OutputFilename + ".s";
 219
 220         // Mark the output files for removal if we get an interrupt.
 221         sys::RemoveFileOnSignal(sys::Path(AssemblyFile));
 222         sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 223
 224         // Determine the locations of the llc and gcc programs.
 225         std::string llc = FindExecutable("llc", argv[0]);
 226         std::string gcc = FindExecutable("gcc", argv[0]);
 227         if (llc.empty())
 228           return PrintAndReturn(argv[0], "Failed to find llc");
 229
 230         if (gcc.empty())
 231           return PrintAndReturn(argv[0], "Failed to find gcc");
 232
 233         // Generate an assembly language file for the bytecode.
 234         if (Verbose) std::cout << "Generating Assembly Code\n";
 235         GenerateAssembly(AssemblyFile, RealBytecodeOutput, llc, envp);
 236         if (Verbose) std::cout << "Generating Native Code\n";
 237         GenerateNative(OutputFilename, AssemblyFile, Libraries, LibPaths,
 238                        gcc, envp);
 239
 240         // Remove the assembly language file.
 241         removeFile (AssemblyFile);
 242       } else if (NativeCBE) {
 243         std::string CFile = OutputFilename + ".cbe.c";
 244
 245         // Mark the output files for removal if we get an interrupt.
 246         sys::RemoveFileOnSignal(sys::Path(CFile));
 247         sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 248
 249         // Determine the locations of the llc and gcc programs.
 250         std::string llc = FindExecutable("llc", argv[0]);
 251         std::string gcc = FindExecutable("gcc", argv[0]);
 252         if (llc.empty())
 253           return PrintAndReturn(argv[0], "Failed to find llc");
 254         if (gcc.empty())
 255           return PrintAndReturn(argv[0], "Failed to find gcc");
 256
 257         // Generate an assembly language file for the bytecode.
 258         if (Verbose) std::cout << "Generating Assembly Code\n";
 259         GenerateCFile(CFile, RealBytecodeOutput, llc, envp);
 260         if (Verbose) std::cout << "Generating Native Code\n";
 261         GenerateNative(OutputFilename, CFile, Libraries, LibPaths, gcc, envp);
 262
 263         // Remove the assembly language file.
 264         removeFile(CFile);
 265
 266       } else {
 267         EmitShellScript(argv);
 268       }
 269
 270       // Make the script executable...
 271       MakeFileExecutable(OutputFilename);
 272
 273       // Make the bytecode file readable and directly executable in LLEE as well
 274       MakeFileExecutable(RealBytecodeOutput);
 275       MakeFileReadable(RealBytecodeOutput);
 276     }
 277   } catch (const char*msg) {
 278     std::cerr << argv[0] << ": " << msg << "\n";
 279     exitCode = 1;
 280   } catch (const std::string& msg) {
 281     std::cerr << argv[0] << ": " << msg << "\n";
 282     exitCode = 2;
 283   } catch (...) {
 284     // This really shouldn't happen, but just in case ....
 285     std::cerr << argv[0] << ": An nexpected unknown exception occurred.\n";
 286     exitCode = 3;
 287   }
 288
 289   return exitCode;
 290 }