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::ofstream Out(FileName.c_str());
 190   if (!Out.good()) {
 191     PrintAndReturn("error opening '" + FileName + "' for writing!");
 192     return;
 193   }
 194
 195   // Ensure that the bytecode file gets removed from the disk if we get a
 196   // terminating signal.
 197   sys::RemoveFileOnSignal(sys::Path(FileName));
 198
 199   // Write it out
 200   WriteBytecodeToFile(M, Out, !DisableCompression);
 201
 202   // Close the bytecode file.
 203   Out.close();
 204 }
 205
 206 /// GenerateAssembly - generates a native assembly language source file from the
 207 /// specified bytecode file.
 208 ///
 209 /// Inputs:
 210 ///  InputFilename  - The name of the output bytecode file.
 211 ///  OutputFilename - The name of the file to generate.
 212 ///  llc            - The pathname to use for LLC.
 213 ///  envp           - The environment to use when running LLC.
 214 ///
 215 /// Return non-zero value on error.
 216 ///
 217 static int GenerateAssembly(const std::string &OutputFilename,
 218                             const std::string &InputFilename,
 219                             const sys::Path &llc) {
 220   // Run LLC to convert the bytecode file into assembly code.
 221   std::vector<std::string> args;
 222   args.push_back( "-f");
 223   args.push_back( "-o");
 224   args.push_back( OutputFilename);
 225   args.push_back( InputFilename);
 226
 227   return sys::Program::ExecuteAndWait(llc,args);
 228 }
 229
 230 /// GenerateAssembly - generates a native assembly language source file from the
 231 /// specified bytecode file.
 232 static int GenerateCFile(const std::string &OutputFile,
 233                          const std::string &InputFile,
 234                          const sys::Path &llc) {
 235   // Run LLC to convert the bytecode file into C.
 236   std::vector<std::string> args;
 237   args.push_back( "-march=c");
 238   args.push_back( "-f");
 239   args.push_back( "-o");
 240   args.push_back( OutputFile);
 241   args.push_back( InputFile);
 242   return sys::Program::ExecuteAndWait(llc, args);
 243 }
 244
 245 /// GenerateNative - generates a native assembly language source file from the
 246 /// specified assembly source file.
 247 ///
 248 /// Inputs:
 249 ///  InputFilename  - The name of the output bytecode file.
 250 ///  OutputFilename - The name of the file to generate.
 251 ///  Libraries      - The list of libraries with which to link.
 252 ///  LibPaths       - The list of directories in which to find libraries.
 253 ///  gcc            - The pathname to use for GGC.
 254 ///  envp           - A copy of the process's current environment.
 255 ///
 256 /// Outputs:
 257 ///  None.
 258 ///
 259 /// Returns non-zero value on error.
 260 ///
 261 static int GenerateNative(const std::string &OutputFilename,
 262                           const std::string &InputFilename,
 263                           const std::vector<std::string> &Libraries,
 264                           const sys::Path &gcc, char ** const envp) {
 265   // Remove these environment variables from the environment of the
 266   // programs that we will execute.  It appears that GCC sets these
 267   // environment variables so that the programs it uses can configure
 268   // themselves identically.
 269   //
 270   // However, when we invoke GCC below, we want it to use its normal
 271   // configuration.  Hence, we must sanitize its environment.
 272   char ** clean_env = CopyEnv(envp);
 273   if (clean_env == NULL)
 274     return 1;
 275   RemoveEnv("LIBRARY_PATH", clean_env);
 276   RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
 277   RemoveEnv("GCC_EXEC_PREFIX", clean_env);
 278   RemoveEnv("COMPILER_PATH", clean_env);
 279   RemoveEnv("COLLECT_GCC", clean_env);
 280
 281
 282   // Run GCC to assemble and link the program into native code.
 283   //
 284   // Note:
 285   //  We can't just assemble and link the file with the system assembler
 286   //  and linker because we don't know where to put the _start symbol.
 287   //  GCC mysteriously knows how to do it.
 288   std::vector<std::string> args;
 289   args.push_back("-fno-strict-aliasing");
 290   args.push_back("-O3");
 291   args.push_back("-o");
 292   args.push_back(OutputFilename);
 293   args.push_back(InputFilename);
 294
 295   // Add in the libraries to link.
 296   for (unsigned index = 0; index < Libraries.size(); index++)
 297     if (Libraries[index] != "crtend")
 298       args.push_back("-l" + Libraries[index]);
 299
 300   // Run the compiler to assembly and link together the program.
 301   return sys::Program::ExecuteAndWait(gcc, args, (const char**)clean_env);
 302 }
 303
 304 /// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
 305 /// bytecode file for the program.
 306 static void EmitShellScript(char **argv) {
 307 #if defined(_WIN32) || defined(__CYGWIN__)
 308   // Windows doesn't support #!/bin/sh style shell scripts in .exe files.  To
 309   // support windows systems, we copy the llvm-stub.exe executable from the
 310   // build tree to the destination file.
 311   std::string llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
 312   if (llvmstub.empty()) {
 313     std::cerr << "Could not find llvm-stub.exe executable!\n";
 314     exit(1);
 315   }
 316   if (CopyFile(OutputFilename, llvmstub)) {
 317     std::cerr << "Could not copy the llvm-stub.exe executable!\n";
 318     exit(1);
 319   }
 320   return;
 321 #endif
 322
 323   // Output the script to start the program...
 324   std::ofstream Out2(OutputFilename.c_str());
 325   if (!Out2.good())
 326     exit(PrintAndReturn("error opening '" + OutputFilename + "' for writing!"));
 327
 328   Out2 << "#!/bin/sh\n";
 329   // Allow user to setenv LLVMINTERP if lli is not in their PATH.
 330   Out2 << "lli=${LLVMINTERP-lli}\n";
 331   Out2 << "exec $lli \\\n";
 332   // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
 333   LibPaths.push_back("/lib");
 334   LibPaths.push_back("/usr/lib");
 335   LibPaths.push_back("/usr/X11R6/lib");
 336   // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
 337   // shared object at all! See RH 8: plain text.
 338   std::vector<std::string>::iterator libc =
 339     std::find(Libraries.begin(), Libraries.end(), "c");
 340   if (libc != Libraries.end()) Libraries.erase(libc);
 341   // List all the shared object (native) libraries this executable will need
 342   // on the command line, so that we don't have to do this manually!
 343   for (std::vector<std::string>::iterator i = Libraries.begin(),
 344          e = Libraries.end(); i != e; ++i) {
 345     sys::Path FullLibraryPath = sys::Path::FindLibrary(*i);
 346     if (!FullLibraryPath.isEmpty() && FullLibraryPath.isDynamicLibrary())
 347       Out2 << "    -load=" << FullLibraryPath.toString() << " \\\n";
 348   }
 349   Out2 << "    $0.bc ${1+\"$@\"}\n";
 350   Out2.close();
 351 }
 352
 353 // BuildLinkItems -- This function generates a LinkItemList for the LinkItems
 354 // linker function by combining the Files and Libraries in the order they were
 355 // declared on the command line.
 356 static void BuildLinkItems(
 357   Linker::ItemList& Items,
 358   const cl::list<std::string>& Files,
 359   const cl::list<std::string>& Libraries) {
 360
 361   // Build the list of linkage items for LinkItems.
 362
 363   cl::list<std::string>::const_iterator fileIt = Files.begin();
 364   cl::list<std::string>::const_iterator libIt  = Libraries.begin();
 365
 366   int libPos = -1, filePos = -1;
 367   while ( libIt != Libraries.end() || fileIt != Files.end() ) {
 368     if (libIt != Libraries.end())
 369       libPos = Libraries.getPosition(libIt - Libraries.begin());
 370     else
 371       libPos = -1;
 372     if (fileIt != Files.end())
 373       filePos = Files.getPosition(fileIt - Files.begin());
 374     else
 375       filePos = -1;
 376
 377     if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
 378       // Add a source file
 379       Items.push_back(std::make_pair(*fileIt++, false));
 380     } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
 381       // Add a library
 382       Items.push_back(std::make_pair(*libIt++, true));
 383     }
 384   }
 385 }
 386
 387 // Rightly this should go in a header file but it just seems such a waste.
 388 namespace llvm {
 389 extern void Optimize(Module*);
 390 }
 391
 392 int main(int argc, char **argv, char **envp) {
 393   // Initial global variable above for convenience printing of program name.
 394   progname = sys::Path(argv[0]).getBasename();
 395   Linker TheLinker(progname, Verbose);
 396
 397   // Set up the library paths for the Linker
 398   TheLinker.addPaths(LibPaths);
 399   TheLinker.addSystemPaths();
 400
 401   // Parse the command line options
 402   cl::ParseCommandLineOptions(argc, argv, " llvm linker\n");
 403   sys::PrintStackTraceOnErrorSignal();
 404
 405   // Remove any consecutive duplicates of the same library...
 406   Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
 407                   Libraries.end());
 408
 409   if (LinkAsLibrary) {
 410     std::vector<sys::Path> Files;
 411     for (unsigned i = 0; i < InputFilenames.size(); ++i )
 412       Files.push_back(sys::Path(InputFilenames[i]));
 413     if (TheLinker.LinkInFiles(Files))
 414       return 1; // Error already printed
 415
 416     // The libraries aren't linked in but are noted as "dependent" in the
 417     // module.
 418     for (cl::list<std::string>::const_iterator I = Libraries.begin(),
 419          E = Libraries.end(); I != E ; ++I) {
 420       TheLinker.getModule()->addLibrary(*I);
 421     }
 422   } else {
 423     // Build a list of the items from our command line
 424     Linker::ItemList Items;
 425     BuildLinkItems(Items, InputFilenames, Libraries);
 426
 427     // Link all the items together
 428     if (TheLinker.LinkInItems(Items) )
 429       return 1;
 430   }
 431
 432   std::auto_ptr<Module> Composite(TheLinker.releaseModule());
 433
 434   // Optimize the module
 435   Optimize(Composite.get());
 436
 437   // Generate the bytecode for the optimized module.
 438   std::string RealBytecodeOutput = OutputFilename;
 439   if (!LinkAsLibrary) RealBytecodeOutput += ".bc";
 440   GenerateBytecode(Composite.get(), RealBytecodeOutput);
 441
 442   // If we are not linking a library, generate either a native executable
 443   // or a JIT shell script, depending upon what the user wants.
 444   if (!LinkAsLibrary) {
 445     // If the user wants to generate a native executable, compile it from the
 446     // bytecode file.
 447     //
 448     // Otherwise, create a script that will run the bytecode through the JIT.
 449     if (Native) {
 450       // Name of the Assembly Language output file
 451       sys::Path AssemblyFile ( OutputFilename);
 452       AssemblyFile.appendSuffix("s");
 453
 454       // Mark the output files for removal if we get an interrupt.
 455       sys::RemoveFileOnSignal(AssemblyFile);
 456       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 457
 458       // Determine the locations of the llc and gcc programs.
 459       sys::Path llc = FindExecutable("llc", argv[0]);
 460       if (llc.isEmpty())
 461         return PrintAndReturn("Failed to find llc");
 462
 463       sys::Path gcc = FindExecutable("gcc", argv[0]);
 464       if (gcc.isEmpty())
 465         return PrintAndReturn("Failed to find gcc");
 466
 467       // Generate an assembly language file for the bytecode.
 468       if (Verbose) std::cout << "Generating Assembly Code\n";
 469       GenerateAssembly(AssemblyFile.toString(), RealBytecodeOutput, llc);
 470       if (Verbose) std::cout << "Generating Native Code\n";
 471       GenerateNative(OutputFilename, AssemblyFile.toString(), Libraries,
 472                      gcc, envp);
 473
 474       // Remove the assembly language file.
 475       AssemblyFile.destroyFile();
 476     } else if (NativeCBE) {
 477       sys::Path CFile (OutputFilename);
 478       CFile.appendSuffix("cbe.c");
 479
 480       // Mark the output files for removal if we get an interrupt.
 481       sys::RemoveFileOnSignal(CFile);
 482       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 483
 484       // Determine the locations of the llc and gcc programs.
 485       sys::Path llc = FindExecutable("llc", argv[0]);
 486       if (llc.isEmpty())
 487         return PrintAndReturn("Failed to find llc");
 488
 489       sys::Path gcc = FindExecutable("gcc", argv[0]);
 490       if (gcc.isEmpty())
 491         return PrintAndReturn("Failed to find gcc");
 492
 493       // Generate an assembly language file for the bytecode.
 494       if (Verbose) std::cout << "Generating Assembly Code\n";
 495       GenerateCFile(CFile.toString(), RealBytecodeOutput, llc);
 496       if (Verbose) std::cout << "Generating Native Code\n";
 497       GenerateNative(OutputFilename, CFile.toString(), Libraries, gcc, envp);
 498
 499       // Remove the assembly language file.
 500       CFile.destroyFile();
 501
 502     } else {
 503       EmitShellScript(argv);
 504     }
 505
 506     // Make the script executable...
 507     sys::Path(OutputFilename).makeExecutable();
 508
 509     // Make the bytecode file readable and directly executable in LLEE as well
 510     sys::Path(RealBytecodeOutput).makeExecutable();
 511     sys::Path(RealBytecodeOutput).makeReadable();
 512   }
 513
 514   return 0;
 515 }