//===- llvm-ld.cpp - LLVM 'ld' compatible linker --------------------------===//
-//
+//
// The LLVM Compiler Infrastructure
//
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
//===----------------------------------------------------------------------===//
//
// This utility is intended to be compatible with GCC, and follows standard
// system 'ld' conventions. As such, the default output file is ./a.out.
// Additionally, this program outputs a shell script that is used to invoke LLI
// to execute the program. In this manner, the generated executable (a.out for
-// example), is directly executable, whereas the bytecode file actually lives in
+// example), is directly executable, whereas the bitcode file actually lives in
// the a.out.bc file generated by this program. Also, Force is on by default.
//
// Note that if someone (or a script) deletes the executable program generated,
//
//===----------------------------------------------------------------------===//
+#include "llvm/LinkAllVMCore.h"
#include "llvm/Linker.h"
#include "llvm/System/Program.h"
#include "llvm/Module.h"
#include "llvm/PassManager.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Bytecode/Writer.h"
+#include "llvm/Bitcode/ReaderWriter.h"
#include "llvm/Target/TargetData.h"
#include "llvm/Target/TargetMachine.h"
#include "llvm/Target/TargetMachineRegistry.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileUtilities.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/Streams.h"
#include "llvm/Support/SystemUtils.h"
#include "llvm/System/Signals.h"
#include <fstream>
-#include <iostream>
#include <memory>
-
+#include <cstring>
using namespace llvm;
// Input/Output Options
static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
- cl::desc("<input bytecode files>"));
+ cl::desc("<input bitcode files>"));
static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
- cl::desc("Override output filename"),
+ cl::desc("Override output filename"),
cl::value_desc("filename"));
-static cl::opt<bool> Verbose("v",
+static cl::opt<bool> Verbose("v",
cl::desc("Print information about actions taken"));
-
+
static cl::list<std::string> LibPaths("L", cl::Prefix,
- cl::desc("Specify a library search path"),
+ cl::desc("Specify a library search path"),
+ cl::value_desc("directory"));
+
+static cl::list<std::string> FrameworkPaths("F", cl::Prefix,
+ cl::desc("Specify a framework search path"),
cl::value_desc("directory"));
static cl::list<std::string> Libraries("l", cl::Prefix,
- cl::desc("Specify libraries to link to"),
+ cl::desc("Specify libraries to link to"),
cl::value_desc("library prefix"));
-static cl::opt<bool> LinkAsLibrary("link-as-library",
+static cl::list<std::string> Frameworks("framework",
+ cl::desc("Specify frameworks to link to"),
+ cl::value_desc("framework"));
+
+// Options to control the linking, optimization, and code gen processes
+static cl::opt<bool> LinkAsLibrary("link-as-library",
cl::desc("Link the .bc files together as a library, not an executable"));
static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
cl::desc("Alias for -link-as-library"));
-static cl::opt<const TargetMachineRegistry::Entry*, false, TargetNameParser>
- MachineArch("march", cl::desc("Architecture to generate assembly for:"));
-
static cl::opt<bool> Native("native",
cl::desc("Generate a native binary instead of a shell script"));
static cl::opt<bool>NativeCBE("native-cbe",
cl::desc("Generate a native binary with the C backend and GCC"));
-static cl::opt<bool>DisableCompression("disable-compression",cl::init(false),
- cl::desc("Disable writing of compressed bytecode files"));
-
-// Compatibility options that are ignored but supported by LD
-static cl::opt<std::string> CO3("soname", cl::Hidden,
+static cl::list<std::string> PostLinkOpts("post-link-opts",
+ cl::value_desc("path"),
+ cl::desc("Run one or more optimization programs after linking"));
+
+static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
+ cl::desc("Pass options to the system linker"));
+
+// Compatibility options that llvm-ld ignores but are supported for
+// compatibility with LD
+static cl::opt<std::string> CO3("soname", cl::Hidden,
+ cl::desc("Compatibility option: ignored"));
+
+static cl::opt<std::string> CO4("version-script", cl::Hidden,
+ cl::desc("Compatibility option: ignored"));
+
+static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
cl::desc("Compatibility option: ignored"));
-static cl::opt<std::string> CO4("version-script", cl::Hidden,
+static cl::opt<std::string> CO6("h", cl::Hidden,
cl::desc("Compatibility option: ignored"));
-static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
+static cl::opt<bool> CO7("start-group", cl::Hidden,
cl::desc("Compatibility option: ignored"));
-static cl::opt<std::string> CO6("h", cl::Hidden,
+static cl::opt<bool> CO8("end-group", cl::Hidden,
cl::desc("Compatibility option: ignored"));
/// This is just for convenience so it doesn't have to be passed around
/// everywhere.
static std::string progname;
-/// PrintAndReturn - Prints a message to standard error and returns true.
+/// PrintAndExit - Prints a message to standard error and exits with error code
///
/// Inputs:
-/// progname - The name of the program (i.e. argv[0]).
/// Message - The message to print to standard error.
///
-static int PrintAndReturn(const std::string &Message) {
- std::cerr << progname << ": " << Message << "\n";
- return 1;
+static void PrintAndExit(const std::string &Message, int errcode = 1) {
+ cerr << progname << ": " << Message << "\n";
+ llvm_shutdown();
+ exit(errcode);
+}
+
+static void PrintCommand(const std::vector<const char*> &args) {
+ std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
+ for (; I != E; ++I)
+ if (*I)
+ cout << "'" << *I << "'" << " ";
+ cout << "\n" << std::flush;
}
/// CopyEnv - This function takes an array of environment variables and makes a
return;
}
-/// GenerateBytecode - generates a bytecode file from the module provided
-void GenerateBytecode(Module* M, const std::string& FileName) {
+/// GenerateBitcode - generates a bitcode file from the module provided
+void GenerateBitcode(Module* M, const std::string& FileName) {
+
+ if (Verbose)
+ cout << "Generating Bitcode To " << FileName << '\n';
// Create the output file.
std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
std::ios::binary;
std::ofstream Out(FileName.c_str(), io_mode);
- if (!Out.good()) {
- PrintAndReturn("error opening '" + FileName + "' for writing!");
- return;
- }
+ if (!Out.good())
+ PrintAndExit("error opening '" + FileName + "' for writing!");
- // Ensure that the bytecode file gets removed from the disk if we get a
+ // Ensure that the bitcode file gets removed from the disk if we get a
// terminating signal.
sys::RemoveFileOnSignal(sys::Path(FileName));
// Write it out
- WriteBytecodeToFile(M, Out, !DisableCompression);
+ WriteBitcodeToFile(M, Out);
- // Close the bytecode file.
+ // Close the bitcode file.
Out.close();
}
/// GenerateAssembly - generates a native assembly language source file from the
-/// specified bytecode file.
+/// specified bitcode file.
///
/// Inputs:
-/// InputFilename - The name of the output bytecode file.
+/// InputFilename - The name of the input bitcode file.
/// OutputFilename - The name of the file to generate.
/// llc - The pathname to use for LLC.
/// envp - The environment to use when running LLC.
///
static int GenerateAssembly(const std::string &OutputFilename,
const std::string &InputFilename,
- const sys::Path &llc) {
- // Run LLC to convert the bytecode file into assembly code.
+ const sys::Path &llc,
+ std::string &ErrMsg ) {
+ // Run LLC to convert the bitcode file into assembly code.
std::vector<const char*> args;
args.push_back(llc.c_str());
args.push_back("-f");
args.push_back(InputFilename.c_str());
args.push_back(0);
- return sys::Program::ExecuteAndWait(llc,&args[0]);
+ if (Verbose) {
+ cout << "Generating Assembly With: \n";
+ PrintCommand(args);
+ }
+
+ return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
}
-/// GenerateAssembly - generates a native assembly language source file from the
-/// specified bytecode file.
+/// GenerateCFile - generates a C source file from the specified bitcode file.
static int GenerateCFile(const std::string &OutputFile,
const std::string &InputFile,
- const sys::Path &llc) {
- // Run LLC to convert the bytecode file into C.
+ const sys::Path &llc,
+ std::string& ErrMsg) {
+ // Run LLC to convert the bitcode file into C.
std::vector<const char*> args;
args.push_back(llc.c_str());
args.push_back("-march=c");
args.push_back(OutputFile.c_str());
args.push_back(InputFile.c_str());
args.push_back(0);
- return sys::Program::ExecuteAndWait(llc, &args[0]);
+
+ if (Verbose) {
+ cout << "Generating C Source With: \n";
+ PrintCommand(args);
+ }
+
+ return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
}
-/// GenerateNative - generates a native assembly language source file from the
-/// specified assembly source file.
+/// GenerateNative - generates a native object file from the
+/// specified bitcode file.
///
/// Inputs:
-/// InputFilename - The name of the output bytecode file.
-/// OutputFilename - The name of the file to generate.
-/// Libraries - The list of libraries with which to link.
-/// LibPaths - The list of directories in which to find libraries.
-/// gcc - The pathname to use for GGC.
-/// envp - A copy of the process's current environment.
+/// InputFilename - The name of the input bitcode file.
+/// OutputFilename - The name of the file to generate.
+/// NativeLinkItems - The native libraries, files, code with which to link
+/// LibPaths - The list of directories in which to find libraries.
+/// FrameworksPaths - The list of directories in which to find frameworks.
+/// Frameworks - The list of frameworks (dynamic libraries)
+/// gcc - The pathname to use for GGC.
+/// envp - A copy of the process's current environment.
///
/// Outputs:
/// None.
///
static int GenerateNative(const std::string &OutputFilename,
const std::string &InputFilename,
- const std::vector<std::string> &Libraries,
- const sys::Path &gcc, char ** const envp) {
+ const Linker::ItemList &LinkItems,
+ const sys::Path &gcc, char ** const envp,
+ std::string& ErrMsg) {
// Remove these environment variables from the environment of the
// programs that we will execute. It appears that GCC sets these
// environment variables so that the programs it uses can configure
// We can't just assemble and link the file with the system assembler
// and linker because we don't know where to put the _start symbol.
// GCC mysteriously knows how to do it.
- std::vector<const char*> args;
+ std::vector<std::string> args;
args.push_back(gcc.c_str());
args.push_back("-fno-strict-aliasing");
args.push_back("-O3");
args.push_back("-o");
- args.push_back(OutputFilename.c_str());
- args.push_back(InputFilename.c_str());
+ args.push_back(OutputFilename);
+ args.push_back(InputFilename);
+
+ // Add in the library and framework paths
+ for (unsigned index = 0; index < LibPaths.size(); index++) {
+ args.push_back("-L" + LibPaths[index]);
+ }
+ for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
+ args.push_back("-F" + FrameworkPaths[index]);
+ }
+
+ // Add the requested options
+ for (unsigned index = 0; index < XLinker.size(); index++)
+ args.push_back(XLinker[index]);
// Add in the libraries to link.
- for (unsigned index = 0; index < Libraries.size(); index++)
- if (Libraries[index] != "crtend") {
- args.push_back("-l");
- args.push_back(Libraries[index].c_str());
+ for (unsigned index = 0; index < LinkItems.size(); index++)
+ if (LinkItems[index].first != "crtend") {
+ if (LinkItems[index].second)
+ args.push_back("-l" + LinkItems[index].first);
+ else
+ args.push_back(LinkItems[index].first);
}
- args.push_back(0);
+
+ // Add in frameworks to link.
+ for (unsigned index = 0; index < Frameworks.size(); index++) {
+ args.push_back("-framework");
+ args.push_back(Frameworks[index]);
+ }
+
+ // Now that "args" owns all the std::strings for the arguments, call the c_str
+ // method to get the underlying string array. We do this game so that the
+ // std::string array is guaranteed to outlive the const char* array.
+ std::vector<const char *> Args;
+ for (unsigned i = 0, e = args.size(); i != e; ++i)
+ Args.push_back(args[i].c_str());
+ Args.push_back(0);
+
+ if (Verbose) {
+ cout << "Generating Native Executable With:\n";
+ PrintCommand(Args);
+ }
// Run the compiler to assembly and link together the program.
- return sys::Program::ExecuteAndWait(gcc, &args[0], (const char**)clean_env);
+ int R = sys::Program::ExecuteAndWait(
+ gcc, &Args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
+ delete [] clean_env;
+ return R;
}
/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
-/// bytecode file for the program.
+/// bitcode file for the program.
static void EmitShellScript(char **argv) {
+ if (Verbose)
+ cout << "Emitting Shell Script\n";
#if defined(_WIN32) || defined(__CYGWIN__)
// Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
// support windows systems, we copy the llvm-stub.exe executable from the
// build tree to the destination file.
+ std::string ErrMsg;
sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
- if (llvmstub.isEmpty()) {
- std::cerr << "Could not find llvm-stub.exe executable!\n";
- exit(1);
- }
- sys::CopyFile(sys::Path(OutputFilename), llvmstub);
+ if (llvmstub.isEmpty())
+ PrintAndExit("Could not find llvm-stub.exe executable!");
+
+ if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
+ PrintAndExit(ErrMsg);
+
return;
#endif
// Output the script to start the program...
std::ofstream Out2(OutputFilename.c_str());
if (!Out2.good())
- exit(PrintAndReturn("error opening '" + OutputFilename + "' for writing!"));
+ PrintAndExit("error opening '" + OutputFilename + "' for writing!");
Out2 << "#!/bin/sh\n";
// Allow user to setenv LLVMINTERP if lli is not in their PATH.
LibPaths.push_back("/usr/X11R6/lib");
// We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
// shared object at all! See RH 8: plain text.
- std::vector<std::string>::iterator libc =
+ std::vector<std::string>::iterator libc =
std::find(Libraries.begin(), Libraries.end(), "c");
if (libc != Libraries.end()) Libraries.erase(libc);
// List all the shared object (native) libraries this executable will need
// on the command line, so that we don't have to do this manually!
- for (std::vector<std::string>::iterator i = Libraries.begin(),
+ for (std::vector<std::string>::iterator i = Libraries.begin(),
e = Libraries.end(); i != e; ++i) {
sys::Path FullLibraryPath = sys::Path::FindLibrary(*i);
if (!FullLibraryPath.isEmpty() && FullLibraryPath.isDynamicLibrary())
const cl::list<std::string>& Files,
const cl::list<std::string>& Libraries) {
- // Build the list of linkage items for LinkItems.
+ // Build the list of linkage items for LinkItems.
cl::list<std::string>::const_iterator fileIt = Files.begin();
cl::list<std::string>::const_iterator libIt = Libraries.begin();
}
int main(int argc, char **argv, char **envp) {
+ llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
try {
// Initial global variable above for convenience printing of program name.
progname = sys::Path(argv[0]).getBasename();
- Linker TheLinker(progname, Verbose);
-
- // Set up the library paths for the Linker
- TheLinker.addPaths(LibPaths);
- TheLinker.addSystemPaths();
// Parse the command line options
- cl::ParseCommandLineOptions(argc, argv, " llvm linker\n");
+ cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
sys::PrintStackTraceOnErrorSignal();
+ // Construct a Linker (now that Verbose is set)
+ Linker TheLinker(progname, OutputFilename, Verbose);
+
+ // Keep track of the native link items (versus the bitcode items)
+ Linker::ItemList NativeLinkItems;
+
+ // Add library paths to the linker
+ TheLinker.addPaths(LibPaths);
+ TheLinker.addSystemPaths();
+
// Remove any consecutive duplicates of the same library...
Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
Libraries.end());
// The libraries aren't linked in but are noted as "dependent" in the
// module.
- for (cl::list<std::string>::const_iterator I = Libraries.begin(),
+ for (cl::list<std::string>::const_iterator I = Libraries.begin(),
E = Libraries.end(); I != E ; ++I) {
TheLinker.getModule()->addLibrary(*I);
}
BuildLinkItems(Items, InputFilenames, Libraries);
// Link all the items together
- if (TheLinker.LinkInItems(Items) )
- return 1;
+ if (TheLinker.LinkInItems(Items, NativeLinkItems) )
+ return 1; // Error already printed
}
std::auto_ptr<Module> Composite(TheLinker.releaseModule());
// Optimize the module
Optimize(Composite.get());
- // Generate the bytecode for the optimized module.
- std::string RealBytecodeOutput = OutputFilename;
- if (!LinkAsLibrary) RealBytecodeOutput += ".bc";
- GenerateBytecode(Composite.get(), RealBytecodeOutput);
+ // Generate the bitcode for the optimized module.
+ std::string RealBitcodeOutput = OutputFilename;
+ if (!LinkAsLibrary) RealBitcodeOutput += ".bc";
+ GenerateBitcode(Composite.get(), RealBitcodeOutput);
// If we are not linking a library, generate either a native executable
// or a JIT shell script, depending upon what the user wants.
if (!LinkAsLibrary) {
+ // If the user wants to run a post-link optimization, run it now.
+ if (!PostLinkOpts.empty()) {
+ std::vector<std::string> opts = PostLinkOpts;
+ for (std::vector<std::string>::iterator I = opts.begin(),
+ E = opts.end(); I != E; ++I) {
+ sys::Path prog(*I);
+ if (!prog.canExecute()) {
+ prog = sys::Program::FindProgramByName(*I);
+ if (prog.isEmpty())
+ PrintAndExit(std::string("Optimization program '") + *I +
+ "' is not found or not executable.");
+ }
+ // Get the program arguments
+ sys::Path tmp_output("opt_result");
+ std::string ErrMsg;
+ if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
+ PrintAndExit(ErrMsg);
+
+ const char* args[4];
+ args[0] = I->c_str();
+ args[1] = RealBitcodeOutput.c_str();
+ args[2] = tmp_output.c_str();
+ args[3] = 0;
+ if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
+ if (tmp_output.isBitcodeFile() || tmp_output.isBitcodeFile()) {
+ sys::Path target(RealBitcodeOutput);
+ target.eraseFromDisk();
+ if (tmp_output.renamePathOnDisk(target, &ErrMsg))
+ PrintAndExit(ErrMsg, 2);
+ } else
+ PrintAndExit("Post-link optimization output is not bitcode");
+ } else {
+ PrintAndExit(ErrMsg);
+ }
+ }
+ }
+
// If the user wants to generate a native executable, compile it from the
- // bytecode file.
+ // bitcode file.
//
- // Otherwise, create a script that will run the bytecode through the JIT.
+ // Otherwise, create a script that will run the bitcode through the JIT.
if (Native) {
// Name of the Assembly Language output file
sys::Path AssemblyFile ( OutputFilename);
// Determine the locations of the llc and gcc programs.
sys::Path llc = FindExecutable("llc", argv[0]);
if (llc.isEmpty())
- return PrintAndReturn("Failed to find llc");
+ PrintAndExit("Failed to find llc");
sys::Path gcc = FindExecutable("gcc", argv[0]);
if (gcc.isEmpty())
- return PrintAndReturn("Failed to find gcc");
+ PrintAndExit("Failed to find gcc");
- // Generate an assembly language file for the bytecode.
- if (Verbose) std::cout << "Generating Assembly Code\n";
- GenerateAssembly(AssemblyFile.toString(), RealBytecodeOutput, llc);
- if (Verbose) std::cout << "Generating Native Code\n";
- GenerateNative(OutputFilename, AssemblyFile.toString(), Libraries,
- gcc, envp);
+ // Generate an assembly language file for the bitcode.
+ std::string ErrMsg;
+ if (0 != GenerateAssembly(AssemblyFile.toString(), RealBitcodeOutput,
+ llc, ErrMsg))
+ PrintAndExit(ErrMsg);
+
+ if (0 != GenerateNative(OutputFilename, AssemblyFile.toString(),
+ NativeLinkItems, gcc, envp, ErrMsg))
+ PrintAndExit(ErrMsg);
// Remove the assembly language file.
- AssemblyFile.destroyFile();
+ AssemblyFile.eraseFromDisk();
} else if (NativeCBE) {
sys::Path CFile (OutputFilename);
CFile.appendSuffix("cbe.c");
// Determine the locations of the llc and gcc programs.
sys::Path llc = FindExecutable("llc", argv[0]);
if (llc.isEmpty())
- return PrintAndReturn("Failed to find llc");
+ PrintAndExit("Failed to find llc");
sys::Path gcc = FindExecutable("gcc", argv[0]);
if (gcc.isEmpty())
- return PrintAndReturn("Failed to find gcc");
+ PrintAndExit("Failed to find gcc");
+
+ // Generate an assembly language file for the bitcode.
+ std::string ErrMsg;
+ if (0 != GenerateCFile(
+ CFile.toString(), RealBitcodeOutput, llc, ErrMsg))
+ PrintAndExit(ErrMsg);
- // Generate an assembly language file for the bytecode.
- if (Verbose) std::cout << "Generating Assembly Code\n";
- GenerateCFile(CFile.toString(), RealBytecodeOutput, llc);
- if (Verbose) std::cout << "Generating Native Code\n";
- GenerateNative(OutputFilename, CFile.toString(), Libraries, gcc, envp);
+ if (0 != GenerateNative(OutputFilename, CFile.toString(),
+ NativeLinkItems, gcc, envp, ErrMsg))
+ PrintAndExit(ErrMsg);
// Remove the assembly language file.
- CFile.destroyFile();
+ CFile.eraseFromDisk();
} else {
EmitShellScript(argv);
}
-
+
// Make the script executable...
- sys::Path(OutputFilename).makeExecutable();
+ std::string ErrMsg;
+ if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
+ PrintAndExit(ErrMsg);
- // Make the bytecode file readable and directly executable in LLEE as well
- sys::Path(RealBytecodeOutput).makeExecutable();
- sys::Path(RealBytecodeOutput).makeReadable();
- }
+ // Make the bitcode file readable and directly executable in LLEE as well
+ if (sys::Path(RealBitcodeOutput).makeExecutableOnDisk(&ErrMsg))
+ PrintAndExit(ErrMsg);
- return 0;
+ if (sys::Path(RealBitcodeOutput).makeReadableOnDisk(&ErrMsg))
+ PrintAndExit(ErrMsg);
+ }
} catch (const std::string& msg) {
- std::cerr << argv[0] << ": " << msg << "\n";
+ PrintAndExit(msg,2);
} catch (...) {
- std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
+ PrintAndExit("Unexpected unknown exception occurred.", 2);
}
- return 1;
+
+ // Graceful exit
+ return 0;
}
projects / oota-llvm.git / blobdiff