1 //===- llvm-ld.cpp - LLVM 'ld' compatible linker --------------------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
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.
21 //===----------------------------------------------------------------------===//
23 #include "llvm/LinkAllVMCore.h"
24 #include "llvm/Linker.h"
25 #include "llvm/System/Program.h"
26 #include "llvm/Module.h"
27 #include "llvm/PassManager.h"
28 #include "llvm/Bytecode/Reader.h"
29 #include "llvm/Bytecode/Writer.h"
30 #include "llvm/Target/TargetData.h"
31 #include "llvm/Target/TargetMachine.h"
32 #include "llvm/Target/TargetMachineRegistry.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/FileUtilities.h"
35 #include "llvm/Support/ManagedStatic.h"
36 #include "llvm/Support/Streams.h"
37 #include "llvm/Support/SystemUtils.h"
38 #include "llvm/System/Signals.h"
43 // Input/Output Options
44 static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
45 cl::desc("<input bytecode files>"));
47 static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
48 cl::desc("Override output filename"),
49 cl::value_desc("filename"));
51 static cl::opt<bool> Verbose("v",
52 cl::desc("Print information about actions taken"));
54 static cl::list<std::string> LibPaths("L", cl::Prefix,
55 cl::desc("Specify a library search path"),
56 cl::value_desc("directory"));
58 static cl::list<std::string> Libraries("l", cl::Prefix,
59 cl::desc("Specify libraries to link to"),
60 cl::value_desc("library prefix"));
62 // Options to control the linking, optimization, and code gen processes
63 static cl::opt<bool> LinkAsLibrary("link-as-library",
64 cl::desc("Link the .bc files together as a library, not an executable"));
66 static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
67 cl::desc("Alias for -link-as-library"));
69 static cl::opt<const TargetMachineRegistry::Entry*, false, TargetNameParser>
70 MachineArch("march", cl::desc("Architecture to generate assembly for:"));
72 static cl::opt<bool> Native("native",
73 cl::desc("Generate a native binary instead of a shell script"));
75 static cl::opt<bool>NativeCBE("native-cbe",
76 cl::desc("Generate a native binary with the C backend and GCC"));
78 static cl::opt<bool>DisableCompression("disable-compression", cl::init(true),
79 cl::desc("Disable writing of compressed bytecode files"));
81 static cl::list<std::string> PostLinkOpts("post-link-opts",
82 cl::value_desc("path"),
83 cl::desc("Run one or more optimization programs after linking"));
85 static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
86 cl::desc("Pass options to the system linker"));
88 // Compatibility options that llvm-ld ignores but are supported for
89 // compatibility with LD
90 static cl::opt<std::string> CO3("soname", cl::Hidden,
91 cl::desc("Compatibility option: ignored"));
93 static cl::opt<std::string> CO4("version-script", cl::Hidden,
94 cl::desc("Compatibility option: ignored"));
96 static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
97 cl::desc("Compatibility option: ignored"));
99 static cl::opt<std::string> CO6("h", cl::Hidden,
100 cl::desc("Compatibility option: ignored"));
102 static cl::opt<bool> CO7("start-group", cl::Hidden,
103 cl::desc("Compatibility option: ignored"));
105 static cl::opt<bool> CO8("end-group", cl::Hidden,
106 cl::desc("Compatibility option: ignored"));
108 /// This is just for convenience so it doesn't have to be passed around
110 static std::string progname;
112 /// PrintAndExit - Prints a message to standard error and exits with error code
115 /// Message - The message to print to standard error.
117 static void PrintAndExit(const std::string &Message, int errcode = 1) {
118 cerr << progname << ": " << Message << "\n";
123 static void PrintCommand(const std::vector<const char*> &args) {
124 std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
127 cout << "'" << *I << "'" << " ";
128 cout << "\n" << std::flush;
131 /// CopyEnv - This function takes an array of environment variables and makes a
132 /// copy of it. This copy can then be manipulated any way the caller likes
133 /// without affecting the process's real environment.
136 /// envp - An array of C strings containing an environment.
139 /// NULL - An error occurred.
141 /// Otherwise, a pointer to a new array of C strings is returned. Every string
142 /// in the array is a duplicate of the one in the original array (i.e. we do
143 /// not copy the char *'s from one array to another).
145 static char ** CopyEnv(char ** const envp) {
146 // Count the number of entries in the old list;
147 unsigned entries; // The number of entries in the old environment list
148 for (entries = 0; envp[entries] != NULL; entries++)
151 // Add one more entry for the NULL pointer that ends the list.
154 // If there are no entries at all, just return NULL.
158 // Allocate a new environment list.
159 char **newenv = new char* [entries];
160 if ((newenv = new char* [entries]) == NULL)
163 // Make a copy of the list. Don't forget the NULL that ends the list.
165 while (envp[entries] != NULL) {
166 newenv[entries] = new char[strlen (envp[entries]) + 1];
167 strcpy (newenv[entries], envp[entries]);
170 newenv[entries] = NULL;
176 /// RemoveEnv - Remove the specified environment variable from the environment
180 /// name - The name of the variable to remove. It cannot be NULL.
181 /// envp - The array of environment variables. It cannot be NULL.
184 /// This is mainly done because functions to remove items from the environment
185 /// are not available across all platforms. In particular, Solaris does not
186 /// seem to have an unsetenv() function or a setenv() function (or they are
187 /// undocumented if they do exist).
189 static void RemoveEnv(const char * name, char ** const envp) {
190 for (unsigned index=0; envp[index] != NULL; index++) {
191 // Find the first equals sign in the array and make it an EOS character.
192 char *p = strchr (envp[index], '=');
198 // Compare the two strings. If they are equal, zap this string.
199 // Otherwise, restore it.
200 if (!strcmp(name, envp[index]))
209 /// GenerateBytecode - generates a bytecode file from the module provided
210 void GenerateBytecode(Module* M, const std::string& FileName) {
213 cout << "Generating Bytecode To " << FileName << '\n';
215 // Create the output file.
216 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
218 std::ofstream Out(FileName.c_str(), io_mode);
220 PrintAndExit("error opening '" + FileName + "' for writing!");
222 // Ensure that the bytecode file gets removed from the disk if we get a
223 // terminating signal.
224 sys::RemoveFileOnSignal(sys::Path(FileName));
228 WriteBytecodeToFile(M, L, !DisableCompression);
230 // Close the bytecode file.
234 /// GenerateAssembly - generates a native assembly language source file from the
235 /// specified bytecode file.
238 /// InputFilename - The name of the input bytecode file.
239 /// OutputFilename - The name of the file to generate.
240 /// llc - The pathname to use for LLC.
241 /// envp - The environment to use when running LLC.
243 /// Return non-zero value on error.
245 static int GenerateAssembly(const std::string &OutputFilename,
246 const std::string &InputFilename,
247 const sys::Path &llc,
248 std::string &ErrMsg ) {
249 // Run LLC to convert the bytecode file into assembly code.
250 std::vector<const char*> args;
251 args.push_back(llc.c_str());
252 args.push_back("-f");
253 args.push_back("-o");
254 args.push_back(OutputFilename.c_str());
255 args.push_back(InputFilename.c_str());
259 cout << "Generating Assembly With: \n";
263 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
266 /// GenerateCFile - generates a C source file from the specified bytecode file.
267 static int GenerateCFile(const std::string &OutputFile,
268 const std::string &InputFile,
269 const sys::Path &llc,
270 std::string& ErrMsg) {
271 // Run LLC to convert the bytecode file into C.
272 std::vector<const char*> args;
273 args.push_back(llc.c_str());
274 args.push_back("-march=c");
275 args.push_back("-f");
276 args.push_back("-o");
277 args.push_back(OutputFile.c_str());
278 args.push_back(InputFile.c_str());
282 cout << "Generating C Source With: \n";
286 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
289 /// GenerateNative - generates a native object file from the
290 /// specified bytecode file.
293 /// InputFilename - The name of the input bytecode file.
294 /// OutputFilename - The name of the file to generate.
295 /// NativeLinkItems - The native libraries, files, code with which to link
296 /// LibPaths - The list of directories in which to find libraries.
297 /// gcc - The pathname to use for GGC.
298 /// envp - A copy of the process's current environment.
303 /// Returns non-zero value on error.
305 static int GenerateNative(const std::string &OutputFilename,
306 const std::string &InputFilename,
307 const Linker::ItemList &LinkItems,
308 const sys::Path &gcc, char ** const envp,
309 std::string& ErrMsg) {
310 // Remove these environment variables from the environment of the
311 // programs that we will execute. It appears that GCC sets these
312 // environment variables so that the programs it uses can configure
313 // themselves identically.
315 // However, when we invoke GCC below, we want it to use its normal
316 // configuration. Hence, we must sanitize its environment.
317 char ** clean_env = CopyEnv(envp);
318 if (clean_env == NULL)
320 RemoveEnv("LIBRARY_PATH", clean_env);
321 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
322 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
323 RemoveEnv("COMPILER_PATH", clean_env);
324 RemoveEnv("COLLECT_GCC", clean_env);
327 // Run GCC to assemble and link the program into native code.
330 // We can't just assemble and link the file with the system assembler
331 // and linker because we don't know where to put the _start symbol.
332 // GCC mysteriously knows how to do it.
333 std::vector<const char*> args;
334 args.push_back(gcc.c_str());
335 args.push_back("-fno-strict-aliasing");
336 args.push_back("-O3");
337 args.push_back("-o");
338 args.push_back(OutputFilename.c_str());
339 args.push_back(InputFilename.c_str());
341 // Add in the library paths
342 for (unsigned index = 0; index < LibPaths.size(); index++) {
343 args.push_back("-L");
344 args.push_back(LibPaths[index].c_str());
347 // Add the requested options
348 for (unsigned index = 0; index < XLinker.size(); index++) {
349 args.push_back(XLinker[index].c_str());
350 args.push_back(Libraries[index].c_str());
353 // Add in the libraries to link.
354 for (unsigned index = 0; index < LinkItems.size(); index++)
355 if (LinkItems[index].first != "crtend") {
356 if (LinkItems[index].second) {
357 std::string lib_name = "-l" + LinkItems[index].first;
358 args.push_back(lib_name.c_str());
360 args.push_back(LinkItems[index].first.c_str());
366 cout << "Generating Native Executable With:\n";
370 // Run the compiler to assembly and link together the program.
371 int R = sys::Program::ExecuteAndWait(
372 gcc, &args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
377 /// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
378 /// bytecode file for the program.
379 static void EmitShellScript(char **argv) {
381 cout << "Emitting Shell Script\n";
382 #if defined(_WIN32) || defined(__CYGWIN__)
383 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
384 // support windows systems, we copy the llvm-stub.exe executable from the
385 // build tree to the destination file.
387 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
388 if (llvmstub.isEmpty())
389 PrintAndExit("Could not find llvm-stub.exe executable!");
391 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
392 PrintAndExit(ErrMsg);
397 // Output the script to start the program...
398 std::ofstream Out2(OutputFilename.c_str());
400 PrintAndExit("error opening '" + OutputFilename + "' for writing!");
402 Out2 << "#!/bin/sh\n";
403 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
404 Out2 << "lli=${LLVMINTERP-lli}\n";
405 Out2 << "exec $lli \\\n";
406 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
407 LibPaths.push_back("/lib");
408 LibPaths.push_back("/usr/lib");
409 LibPaths.push_back("/usr/X11R6/lib");
410 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
411 // shared object at all! See RH 8: plain text.
412 std::vector<std::string>::iterator libc =
413 std::find(Libraries.begin(), Libraries.end(), "c");
414 if (libc != Libraries.end()) Libraries.erase(libc);
415 // List all the shared object (native) libraries this executable will need
416 // on the command line, so that we don't have to do this manually!
417 for (std::vector<std::string>::iterator i = Libraries.begin(),
418 e = Libraries.end(); i != e; ++i) {
419 sys::Path FullLibraryPath = sys::Path::FindLibrary(*i);
420 if (!FullLibraryPath.isEmpty() && FullLibraryPath.isDynamicLibrary())
421 Out2 << " -load=" << FullLibraryPath.toString() << " \\\n";
423 Out2 << " $0.bc ${1+\"$@\"}\n";
427 // BuildLinkItems -- This function generates a LinkItemList for the LinkItems
428 // linker function by combining the Files and Libraries in the order they were
429 // declared on the command line.
430 static void BuildLinkItems(
431 Linker::ItemList& Items,
432 const cl::list<std::string>& Files,
433 const cl::list<std::string>& Libraries) {
435 // Build the list of linkage items for LinkItems.
437 cl::list<std::string>::const_iterator fileIt = Files.begin();
438 cl::list<std::string>::const_iterator libIt = Libraries.begin();
440 int libPos = -1, filePos = -1;
441 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
442 if (libIt != Libraries.end())
443 libPos = Libraries.getPosition(libIt - Libraries.begin());
446 if (fileIt != Files.end())
447 filePos = Files.getPosition(fileIt - Files.begin());
451 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
453 Items.push_back(std::make_pair(*fileIt++, false));
454 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
456 Items.push_back(std::make_pair(*libIt++, true));
461 // Rightly this should go in a header file but it just seems such a waste.
463 extern void Optimize(Module*);
466 int main(int argc, char **argv, char **envp) {
467 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
469 // Initial global variable above for convenience printing of program name.
470 progname = sys::Path(argv[0]).getBasename();
472 // Parse the command line options
473 cl::ParseCommandLineOptions(argc, argv, " llvm linker\n");
474 sys::PrintStackTraceOnErrorSignal();
476 // Construct a Linker (now that Verbose is set)
477 Linker TheLinker(progname, OutputFilename, Verbose);
479 // Keep track of the native link items (versus the bytecode items)
480 Linker::ItemList NativeLinkItems;
482 // Add library paths to the linker
483 TheLinker.addPaths(LibPaths);
484 TheLinker.addSystemPaths();
486 // Remove any consecutive duplicates of the same library...
487 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
491 std::vector<sys::Path> Files;
492 for (unsigned i = 0; i < InputFilenames.size(); ++i )
493 Files.push_back(sys::Path(InputFilenames[i]));
494 if (TheLinker.LinkInFiles(Files))
495 return 1; // Error already printed
497 // The libraries aren't linked in but are noted as "dependent" in the
499 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
500 E = Libraries.end(); I != E ; ++I) {
501 TheLinker.getModule()->addLibrary(*I);
504 // Build a list of the items from our command line
505 Linker::ItemList Items;
506 BuildLinkItems(Items, InputFilenames, Libraries);
508 // Link all the items together
509 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
510 return 1; // Error already printed
513 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
515 // Optimize the module
516 Optimize(Composite.get());
518 // Generate the bytecode for the optimized module.
519 std::string RealBytecodeOutput = OutputFilename;
520 if (!LinkAsLibrary) RealBytecodeOutput += ".bc";
521 GenerateBytecode(Composite.get(), RealBytecodeOutput);
523 // If we are not linking a library, generate either a native executable
524 // or a JIT shell script, depending upon what the user wants.
525 if (!LinkAsLibrary) {
526 // If the user wants to run a post-link optimization, run it now.
527 if (!PostLinkOpts.empty()) {
528 std::vector<std::string> opts = PostLinkOpts;
529 for (std::vector<std::string>::iterator I = opts.begin(),
530 E = opts.end(); I != E; ++I) {
532 if (!prog.canExecute()) {
533 prog = sys::Program::FindProgramByName(*I);
535 PrintAndExit(std::string("Optimization program '") + *I +
536 "' is not found or not executable.");
538 // Get the program arguments
539 sys::Path tmp_output("opt_result");
541 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
542 PrintAndExit(ErrMsg);
545 args[0] = I->c_str();
546 args[1] = RealBytecodeOutput.c_str();
547 args[2] = tmp_output.c_str();
549 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
550 if (tmp_output.isBytecodeFile()) {
551 sys::Path target(RealBytecodeOutput);
552 target.eraseFromDisk();
553 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
554 PrintAndExit(ErrMsg, 2);
556 PrintAndExit("Post-link optimization output is not bytecode");
558 PrintAndExit(ErrMsg);
563 // If the user wants to generate a native executable, compile it from the
566 // Otherwise, create a script that will run the bytecode through the JIT.
568 // Name of the Assembly Language output file
569 sys::Path AssemblyFile ( OutputFilename);
570 AssemblyFile.appendSuffix("s");
572 // Mark the output files for removal if we get an interrupt.
573 sys::RemoveFileOnSignal(AssemblyFile);
574 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
576 // Determine the locations of the llc and gcc programs.
577 sys::Path llc = FindExecutable("llc", argv[0]);
579 PrintAndExit("Failed to find llc");
581 sys::Path gcc = FindExecutable("gcc", argv[0]);
583 PrintAndExit("Failed to find gcc");
585 // Generate an assembly language file for the bytecode.
587 if (0 != GenerateAssembly(AssemblyFile.toString(), RealBytecodeOutput,
589 PrintAndExit(ErrMsg);
591 if (0 != GenerateNative(OutputFilename, AssemblyFile.toString(),
592 NativeLinkItems, gcc, envp, ErrMsg))
593 PrintAndExit(ErrMsg);
595 // Remove the assembly language file.
596 AssemblyFile.eraseFromDisk();
597 } else if (NativeCBE) {
598 sys::Path CFile (OutputFilename);
599 CFile.appendSuffix("cbe.c");
601 // Mark the output files for removal if we get an interrupt.
602 sys::RemoveFileOnSignal(CFile);
603 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
605 // Determine the locations of the llc and gcc programs.
606 sys::Path llc = FindExecutable("llc", argv[0]);
608 PrintAndExit("Failed to find llc");
610 sys::Path gcc = FindExecutable("gcc", argv[0]);
612 PrintAndExit("Failed to find gcc");
614 // Generate an assembly language file for the bytecode.
616 if (0 != GenerateCFile(
617 CFile.toString(), RealBytecodeOutput, llc, ErrMsg))
618 PrintAndExit(ErrMsg);
620 if (0 != GenerateNative(OutputFilename, CFile.toString(),
621 NativeLinkItems, gcc, envp, ErrMsg))
622 PrintAndExit(ErrMsg);
624 // Remove the assembly language file.
625 CFile.eraseFromDisk();
628 EmitShellScript(argv);
631 // Make the script executable...
633 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
634 PrintAndExit(ErrMsg);
636 // Make the bytecode file readable and directly executable in LLEE as well
637 if (sys::Path(RealBytecodeOutput).makeExecutableOnDisk(&ErrMsg))
638 PrintAndExit(ErrMsg);
640 if (sys::Path(RealBytecodeOutput).makeReadableOnDisk(&ErrMsg))
641 PrintAndExit(ErrMsg);
643 } catch (const std::string& msg) {
646 PrintAndExit("Unexpected unknown exception occurred.", 2);