tools/llvm-ld/llvm-ld.cpp

   1 //===- llvm-ld.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 "llvm/Linker.h"
  24 #include "llvm/System/Program.h"
  25 #include "llvm/Module.h"
  26 #include "llvm/PassManager.h"
  27 #include "llvm/Bytecode/Reader.h"
  28 #include "llvm/Bytecode/Writer.h"
  29 #include "llvm/Target/TargetData.h"
  30 #include "llvm/Target/TargetMachine.h"
  31 #include "llvm/Target/TargetMachineRegistry.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/FileUtilities.h"
  34 #include "llvm/Support/SystemUtils.h"
  35 #include "llvm/System/Signals.h"
  36 #include <fstream>
  37 #include <iostream>
  38 #include <memory>
  39
  40 using namespace llvm;
  41
  42 // Input/Output Options
  43 static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
  44   cl::desc("<input bytecode files>"));
  45
  46 static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
  47   cl::desc("Override output filename"),
  48   cl::value_desc("filename"));
  49
  50 static cl::opt<bool> Verbose("v",
  51   cl::desc("Print information about actions taken"));
  52
  53 static cl::list<std::string> LibPaths("L", cl::Prefix,
  54   cl::desc("Specify a library search path"),
  55   cl::value_desc("directory"));
  56
  57 static cl::list<std::string> Libraries("l", cl::Prefix,
  58   cl::desc("Specify libraries to link to"),
  59   cl::value_desc("library prefix"));
  60
  61 static cl::opt<bool> LinkAsLibrary("link-as-library",
  62   cl::desc("Link the .bc files together as a library, not an executable"));
  63
  64 static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
  65   cl::desc("Alias for -link-as-library"));
  66
  67 static cl::opt<const TargetMachineRegistry::Entry*, false, TargetNameParser>
  68   MachineArch("march", cl::desc("Architecture to generate assembly for:"));
  69
  70 static cl::opt<bool> Native("native",
  71   cl::desc("Generate a native binary instead of a shell script"));
  72
  73 static cl::opt<bool>NativeCBE("native-cbe",
  74   cl::desc("Generate a native binary with the C backend and GCC"));
  75
  76 static cl::opt<bool>DisableCompression("disable-compression",cl::init(false),
  77   cl::desc("Disable writing of compressed bytecode files"));
  78
  79 // Compatibility options that are ignored but supported by LD
  80 static cl::opt<std::string> CO3("soname", cl::Hidden,
  81   cl::desc("Compatibility option: ignored"));
  82
  83 static cl::opt<std::string> CO4("version-script", cl::Hidden,
  84   cl::desc("Compatibility option: ignored"));
  85
  86 static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
  87   cl::desc("Compatibility option: ignored"));
  88
  89 static  cl::opt<std::string> CO6("h", cl::Hidden,
  90   cl::desc("Compatibility option: ignored"));
  91
  92 /// This is just for convenience so it doesn't have to be passed around
  93 /// everywhere.
  94 static std::string progname;
  95
  96 /// PrintAndReturn - Prints a message to standard error and returns true.
  97 ///
  98 /// Inputs:
  99 ///  progname - The name of the program (i.e. argv[0]).
 100 ///  Message  - The message to print to standard error.
 101 ///
 102 static int PrintAndReturn(const std::string &Message) {
 103   std::cerr << progname << ": " << Message << "\n";
 104   return 1;
 105 }
 106
 107 /// CopyEnv - This function takes an array of environment variables and makes a
 108 /// copy of it.  This copy can then be manipulated any way the caller likes
 109 /// without affecting the process's real environment.
 110 ///
 111 /// Inputs:
 112 ///  envp - An array of C strings containing an environment.
 113 ///
 114 /// Return value:
 115 ///  NULL - An error occurred.
 116 ///
 117 ///  Otherwise, a pointer to a new array of C strings is returned.  Every string
 118 ///  in the array is a duplicate of the one in the original array (i.e. we do
 119 ///  not copy the char *'s from one array to another).
 120 ///
 121 static char ** CopyEnv(char ** const envp) {
 122   // Count the number of entries in the old list;
 123   unsigned entries;   // The number of entries in the old environment list
 124   for (entries = 0; envp[entries] != NULL; entries++)
 125     /*empty*/;
 126
 127   // Add one more entry for the NULL pointer that ends the list.
 128   ++entries;
 129
 130   // If there are no entries at all, just return NULL.
 131   if (entries == 0)
 132     return NULL;
 133
 134   // Allocate a new environment list.
 135   char **newenv = new char* [entries];
 136   if ((newenv = new char* [entries]) == NULL)
 137     return NULL;
 138
 139   // Make a copy of the list.  Don't forget the NULL that ends the list.
 140   entries = 0;
 141   while (envp[entries] != NULL) {
 142     newenv[entries] = new char[strlen (envp[entries]) + 1];
 143     strcpy (newenv[entries], envp[entries]);
 144     ++entries;
 145   }
 146   newenv[entries] = NULL;
 147
 148   return newenv;
 149 }
 150
 151
 152 /// RemoveEnv - Remove the specified environment variable from the environment
 153 /// array.
 154 ///
 155 /// Inputs:
 156 ///  name - The name of the variable to remove.  It cannot be NULL.
 157 ///  envp - The array of environment variables.  It cannot be NULL.
 158 ///
 159 /// Notes:
 160 ///  This is mainly done because functions to remove items from the environment
 161 ///  are not available across all platforms.  In particular, Solaris does not
 162 ///  seem to have an unsetenv() function or a setenv() function (or they are
 163 ///  undocumented if they do exist).
 164 ///
 165 static void RemoveEnv(const char * name, char ** const envp) {
 166   for (unsigned index=0; envp[index] != NULL; index++) {
 167     // Find the first equals sign in the array and make it an EOS character.
 168     char *p = strchr (envp[index], '=');
 169     if (p == NULL)
 170       continue;
 171     else
 172       *p = '\0';
 173
 174     // Compare the two strings.  If they are equal, zap this string.
 175     // Otherwise, restore it.
 176     if (!strcmp(name, envp[index]))
 177       *envp[index] = '\0';
 178     else
 179       *p = '=';
 180   }
 181
 182   return;
 183 }
 184
 185 /// GenerateBytecode - generates a bytecode file from the module provided
 186 void GenerateBytecode(Module* M, const std::string& FileName) {
 187
 188   // Create the output file.
 189   std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 190                                std::ios::binary;
 191   std::ofstream Out(FileName.c_str(), io_mode);
 192   if (!Out.good()) {
 193     PrintAndReturn("error opening '" + FileName + "' for writing!");
 194     return;
 195   }
 196
 197   // Ensure that the bytecode file gets removed from the disk if we get a
 198   // terminating signal.
 199   sys::RemoveFileOnSignal(sys::Path(FileName));
 200
 201   // Write it out
 202   WriteBytecodeToFile(M, Out, !DisableCompression);
 203
 204   // Close the bytecode file.
 205   Out.close();
 206 }
 207
 208 /// GenerateAssembly - generates a native assembly language source file from the
 209 /// specified bytecode file.
 210 ///
 211 /// Inputs:
 212 ///  InputFilename  - The name of the output bytecode file.
 213 ///  OutputFilename - The name of the file to generate.
 214 ///  llc            - The pathname to use for LLC.
 215 ///  envp           - The environment to use when running LLC.
 216 ///
 217 /// Return non-zero value on error.
 218 ///
 219 static int GenerateAssembly(const std::string &OutputFilename,
 220                             const std::string &InputFilename,
 221                             const sys::Path &llc) {
 222   // Run LLC to convert the bytecode file into assembly code.
 223   std::vector<const char*> args;
 224   args.push_back( "-f");
 225   args.push_back( "-o");
 226   args.push_back( OutputFilename.c_str() );
 227   args.push_back( InputFilename.c_str() );
 228   args.push_back(0);
 229
 230   return sys::Program::ExecuteAndWait(llc,&args[0]);
 231 }
 232
 233 /// GenerateAssembly - generates a native assembly language source file from the
 234 /// specified bytecode file.
 235 static int GenerateCFile(const std::string &OutputFile,
 236                          const std::string &InputFile,
 237                          const sys::Path &llc) {
 238   // Run LLC to convert the bytecode file into C.
 239   std::vector<const char*> args;
 240   args.push_back( "-march=c");
 241   args.push_back( "-f");
 242   args.push_back( "-o");
 243   args.push_back( OutputFile.c_str() );
 244   args.push_back( InputFile.c_str() );
 245   args.push_back(0);
 246   return sys::Program::ExecuteAndWait(llc, &args[0]);
 247 }
 248
 249 /// GenerateNative - generates a native assembly language source file from the
 250 /// specified assembly source file.
 251 ///
 252 /// Inputs:
 253 ///  InputFilename  - The name of the output bytecode file.
 254 ///  OutputFilename - The name of the file to generate.
 255 ///  Libraries      - The list of libraries with which to link.
 256 ///  LibPaths       - The list of directories in which to find libraries.
 257 ///  gcc            - The pathname to use for GGC.
 258 ///  envp           - A copy of the process's current environment.
 259 ///
 260 /// Outputs:
 261 ///  None.
 262 ///
 263 /// Returns non-zero value on error.
 264 ///
 265 static int GenerateNative(const std::string &OutputFilename,
 266                           const std::string &InputFilename,
 267                           const std::vector<std::string> &Libraries,
 268                           const sys::Path &gcc, char ** const envp) {
 269   // Remove these environment variables from the environment of the
 270   // programs that we will execute.  It appears that GCC sets these
 271   // environment variables so that the programs it uses can configure
 272   // themselves identically.
 273   //
 274   // However, when we invoke GCC below, we want it to use its normal
 275   // configuration.  Hence, we must sanitize its environment.
 276   char ** clean_env = CopyEnv(envp);
 277   if (clean_env == NULL)
 278     return 1;
 279   RemoveEnv("LIBRARY_PATH", clean_env);
 280   RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
 281   RemoveEnv("GCC_EXEC_PREFIX", clean_env);
 282   RemoveEnv("COMPILER_PATH", clean_env);
 283   RemoveEnv("COLLECT_GCC", clean_env);
 284
 285
 286   // Run GCC to assemble and link the program into native code.
 287   //
 288   // Note:
 289   //  We can't just assemble and link the file with the system assembler
 290   //  and linker because we don't know where to put the _start symbol.
 291   //  GCC mysteriously knows how to do it.
 292   std::vector<const char*> args;
 293   args.push_back("-fno-strict-aliasing");
 294   args.push_back("-O3");
 295   args.push_back("-o");
 296   args.push_back(OutputFilename.c_str());
 297   args.push_back(InputFilename.c_str());
 298
 299   // Add in the libraries to link.
 300   for (unsigned index = 0; index < Libraries.size(); index++)
 301     if (Libraries[index] != "crtend") {
 302       args.push_back("-l");
 303       args.push_back(Libraries[index].c_str());
 304     }
 305   args.push_back(0);
 306
 307   // Run the compiler to assembly and link together the program.
 308   return sys::Program::ExecuteAndWait(gcc, &args[0], (const char**)clean_env);
 309 }
 310
 311 /// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
 312 /// bytecode file for the program.
 313 static void EmitShellScript(char **argv) {
 314 #if defined(_WIN32) || defined(__CYGWIN__)
 315   // Windows doesn't support #!/bin/sh style shell scripts in .exe files.  To
 316   // support windows systems, we copy the llvm-stub.exe executable from the
 317   // build tree to the destination file.
 318   sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
 319   if (llvmstub.isEmpty()) {
 320     std::cerr << "Could not find llvm-stub.exe executable!\n";
 321     exit(1);
 322   }
 323   sys::CopyFile(sys::Path(OutputFilename), llvmstub);
 324   return;
 325 #endif
 326
 327   // Output the script to start the program...
 328   std::ofstream Out2(OutputFilename.c_str());
 329   if (!Out2.good())
 330     exit(PrintAndReturn("error opening '" + OutputFilename + "' for writing!"));
 331
 332   Out2 << "#!/bin/sh\n";
 333   // Allow user to setenv LLVMINTERP if lli is not in their PATH.
 334   Out2 << "lli=${LLVMINTERP-lli}\n";
 335   Out2 << "exec $lli \\\n";
 336   // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
 337   LibPaths.push_back("/lib");
 338   LibPaths.push_back("/usr/lib");
 339   LibPaths.push_back("/usr/X11R6/lib");
 340   // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
 341   // shared object at all! See RH 8: plain text.
 342   std::vector<std::string>::iterator libc =
 343     std::find(Libraries.begin(), Libraries.end(), "c");
 344   if (libc != Libraries.end()) Libraries.erase(libc);
 345   // List all the shared object (native) libraries this executable will need
 346   // on the command line, so that we don't have to do this manually!
 347   for (std::vector<std::string>::iterator i = Libraries.begin(),
 348          e = Libraries.end(); i != e; ++i) {
 349     sys::Path FullLibraryPath = sys::Path::FindLibrary(*i);
 350     if (!FullLibraryPath.isEmpty() && FullLibraryPath.isDynamicLibrary())
 351       Out2 << "    -load=" << FullLibraryPath.toString() << " \\\n";
 352   }
 353   Out2 << "    $0.bc ${1+\"$@\"}\n";
 354   Out2.close();
 355 }
 356
 357 // BuildLinkItems -- This function generates a LinkItemList for the LinkItems
 358 // linker function by combining the Files and Libraries in the order they were
 359 // declared on the command line.
 360 static void BuildLinkItems(
 361   Linker::ItemList& Items,
 362   const cl::list<std::string>& Files,
 363   const cl::list<std::string>& Libraries) {
 364
 365   // Build the list of linkage items for LinkItems.
 366
 367   cl::list<std::string>::const_iterator fileIt = Files.begin();
 368   cl::list<std::string>::const_iterator libIt  = Libraries.begin();
 369
 370   int libPos = -1, filePos = -1;
 371   while ( libIt != Libraries.end() || fileIt != Files.end() ) {
 372     if (libIt != Libraries.end())
 373       libPos = Libraries.getPosition(libIt - Libraries.begin());
 374     else
 375       libPos = -1;
 376     if (fileIt != Files.end())
 377       filePos = Files.getPosition(fileIt - Files.begin());
 378     else
 379       filePos = -1;
 380
 381     if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
 382       // Add a source file
 383       Items.push_back(std::make_pair(*fileIt++, false));
 384     } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
 385       // Add a library
 386       Items.push_back(std::make_pair(*libIt++, true));
 387     }
 388   }
 389 }
 390
 391 // Rightly this should go in a header file but it just seems such a waste.
 392 namespace llvm {
 393 extern void Optimize(Module*);
 394 }
 395
 396 int main(int argc, char **argv, char **envp) {
 397   try {
 398     // Initial global variable above for convenience printing of program name.
 399     progname = sys::Path(argv[0]).getBasename();
 400     Linker TheLinker(progname, Verbose);
 401
 402     // Set up the library paths for the Linker
 403     TheLinker.addPaths(LibPaths);
 404     TheLinker.addSystemPaths();
 405
 406     // Parse the command line options
 407     cl::ParseCommandLineOptions(argc, argv, " llvm linker\n");
 408     sys::PrintStackTraceOnErrorSignal();
 409
 410     // Remove any consecutive duplicates of the same library...
 411     Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
 412                     Libraries.end());
 413
 414     if (LinkAsLibrary) {
 415       std::vector<sys::Path> Files;
 416       for (unsigned i = 0; i < InputFilenames.size(); ++i )
 417         Files.push_back(sys::Path(InputFilenames[i]));
 418       if (TheLinker.LinkInFiles(Files))
 419         return 1; // Error already printed
 420
 421       // The libraries aren't linked in but are noted as "dependent" in the
 422       // module.
 423       for (cl::list<std::string>::const_iterator I = Libraries.begin(),
 424            E = Libraries.end(); I != E ; ++I) {
 425         TheLinker.getModule()->addLibrary(*I);
 426       }
 427     } else {
 428       // Build a list of the items from our command line
 429       Linker::ItemList Items;
 430       BuildLinkItems(Items, InputFilenames, Libraries);
 431
 432       // Link all the items together
 433       if (TheLinker.LinkInItems(Items) )
 434         return 1;
 435     }
 436
 437     std::auto_ptr<Module> Composite(TheLinker.releaseModule());
 438
 439     // Optimize the module
 440     Optimize(Composite.get());
 441
 442     // Generate the bytecode for the optimized module.
 443     std::string RealBytecodeOutput = OutputFilename;
 444     if (!LinkAsLibrary) RealBytecodeOutput += ".bc";
 445     GenerateBytecode(Composite.get(), RealBytecodeOutput);
 446
 447     // If we are not linking a library, generate either a native executable
 448     // or a JIT shell script, depending upon what the user wants.
 449     if (!LinkAsLibrary) {
 450       // If the user wants to generate a native executable, compile it from the
 451       // bytecode file.
 452       //
 453       // Otherwise, create a script that will run the bytecode through the JIT.
 454       if (Native) {
 455         // Name of the Assembly Language output file
 456         sys::Path AssemblyFile ( OutputFilename);
 457         AssemblyFile.appendSuffix("s");
 458
 459         // Mark the output files for removal if we get an interrupt.
 460         sys::RemoveFileOnSignal(AssemblyFile);
 461         sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 462
 463         // Determine the locations of the llc and gcc programs.
 464         sys::Path llc = FindExecutable("llc", argv[0]);
 465         if (llc.isEmpty())
 466           return PrintAndReturn("Failed to find llc");
 467
 468         sys::Path gcc = FindExecutable("gcc", argv[0]);
 469         if (gcc.isEmpty())
 470           return PrintAndReturn("Failed to find gcc");
 471
 472         // Generate an assembly language file for the bytecode.
 473         if (Verbose) std::cout << "Generating Assembly Code\n";
 474         GenerateAssembly(AssemblyFile.toString(), RealBytecodeOutput, llc);
 475         if (Verbose) std::cout << "Generating Native Code\n";
 476         GenerateNative(OutputFilename, AssemblyFile.toString(), Libraries,
 477                        gcc, envp);
 478
 479         // Remove the assembly language file.
 480         AssemblyFile.destroyFile();
 481       } else if (NativeCBE) {
 482         sys::Path CFile (OutputFilename);
 483         CFile.appendSuffix("cbe.c");
 484
 485         // Mark the output files for removal if we get an interrupt.
 486         sys::RemoveFileOnSignal(CFile);
 487         sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 488
 489         // Determine the locations of the llc and gcc programs.
 490         sys::Path llc = FindExecutable("llc", argv[0]);
 491         if (llc.isEmpty())
 492           return PrintAndReturn("Failed to find llc");
 493
 494         sys::Path gcc = FindExecutable("gcc", argv[0]);
 495         if (gcc.isEmpty())
 496           return PrintAndReturn("Failed to find gcc");
 497
 498         // Generate an assembly language file for the bytecode.
 499         if (Verbose) std::cout << "Generating Assembly Code\n";
 500         GenerateCFile(CFile.toString(), RealBytecodeOutput, llc);
 501         if (Verbose) std::cout << "Generating Native Code\n";
 502         GenerateNative(OutputFilename, CFile.toString(), Libraries, gcc, envp);
 503
 504         // Remove the assembly language file.
 505         CFile.destroyFile();
 506
 507       } else {
 508         EmitShellScript(argv);
 509       }
 510
 511       // Make the script executable...
 512       sys::Path(OutputFilename).makeExecutable();
 513
 514       // Make the bytecode file readable and directly executable in LLEE as well
 515       sys::Path(RealBytecodeOutput).makeExecutable();
 516       sys::Path(RealBytecodeOutput).makeReadable();
 517     }
 518
 519     return 0;
 520   } catch (const std::string& msg) {
 521     std::cerr << argv[0] << ": " << msg << "\n";
 522   } catch (...) {
 523     std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
 524   }
 525   return 1;
 526 }