//===- gccld.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 utility is intended to be compatible with GCC, and follows standard
// system 'ld' conventions. As such, the default output file is ./a.out.
//
//===----------------------------------------------------------------------===//
-#include "llvm/Transforms/Utils/Linker.h"
+#include "gccld.h"
#include "llvm/Module.h"
#include "llvm/PassManager.h"
#include "llvm/Bytecode/Reader.h"
#include "llvm/Target/TargetData.h"
#include "llvm/Transforms/IPO.h"
#include "llvm/Transforms/Scalar.h"
+#include "llvm/Transforms/Utils/Linker.h"
#include "Support/CommandLine.h"
+#include "Support/FileUtilities.h"
#include "Support/Signals.h"
+#include "Support/SystemUtils.h"
#include <fstream>
#include <memory>
-#include <set>
-#include <algorithm>
-#include <sys/types.h> // For FileExists
-#include <sys/stat.h>
namespace {
cl::list<std::string>
cl::opt<bool>
NoInternalize("disable-internalize",
cl::desc("Do not mark all symbols as internal"));
+ static cl::alias
+ ExportDynamic("export-dynamic", cl::desc("Alias for -disable-internalize"),
+ cl::aliasopt(NoInternalize));
cl::opt<bool>
LinkAsLibrary("link-as-library", cl::desc("Link the .bc files together as a"
" library, not an executable"));
- // Compatibility options that are ignored, but support by LD
+ cl::opt<bool>
+ Native("native",
+ cl::desc("Generate a native binary instead of a shell script"));
+
+ // Compatibility options that are ignored but supported by LD
cl::opt<std::string>
CO3("soname", cl::Hidden, cl::desc("Compatibility option: ignored"));
cl::opt<std::string>
CO6("r", cl::Hidden, cl::desc("Compatibility option: ignored"));
}
-// FileExists - Return true if the specified string is an openable file...
-static inline bool FileExists(const std::string &FN) {
- struct stat StatBuf;
- return stat(FN.c_str(), &StatBuf) != -1;
+//
+// Function: PrintAndReturn ()
+//
+// Description:
+// Prints a message (usually error message) to standard error (stderr) and
+// returns a value usable for an exit status.
+//
+// Inputs:
+// progname - The name of the program (i.e. argv[0]).
+// Message - The message to print to standard error.
+// Extra - Extra information to print between the program name and thei
+// message. It is optional.
+//
+// Outputs:
+// None.
+//
+// Return value:
+// Returns a value that can be used as the exit status (i.e. for exit()).
+//
+int
+PrintAndReturn (const char *progname,
+ const std::string &Message,
+ const std::string &Extra)
+{
+ std::cerr << progname << Extra << ": " << Message << "\n";
+ return 1;
}
-
-// LoadObject - Read the specified "object file", which should not search the
-// library path to find it.
-static inline std::auto_ptr<Module> LoadObject(std::string FN,
- std::string &OutErrorMessage) {
- if (Verbose) std::cerr << "Loading '" << FN << "'\n";
- if (!FileExists(FN)) {
- // Attempt to load from the LLVM_LIB_SEARCH_PATH directory... if we would
- // otherwise fail. This is used to locate objects like crtend.o.
- //
- char *SearchPath = getenv("LLVM_LIB_SEARCH_PATH");
- if (SearchPath && FileExists(std::string(SearchPath)+"/"+FN))
- FN = std::string(SearchPath)+"/"+FN;
- else {
- OutErrorMessage = "could not find input file '" + FN + "'!";
- return std::auto_ptr<Module>();
- }
+//
+//
+// Function: CopyEnv()
+//
+// Description:
+// This function takes an array of environment variables and makes a
+// copy of it. This copy can then be manipulated any way the caller likes
+// without affecting the process's real environment.
+//
+// Inputs:
+// envp - An array of C strings containing an environment.
+//
+// Outputs:
+// None.
+//
+// Return value:
+// NULL - An error occurred.
+//
+// Otherwise, a pointer to a new array of C strings is returned. Every string
+// in the array is a duplicate of the one in the original array (i.e. we do
+// not copy the char *'s from one array to another).
+//
+char ** CopyEnv(char ** const envp) {
+ // Count the number of entries in the old list;
+ unsigned entries; // The number of entries in the old environment list
+ for (entries = 0; envp[entries] != NULL; entries++)
+ {
+ ;
}
- std::string ErrorMessage;
- Module *Result = ParseBytecodeFile(FN, &ErrorMessage);
- if (Result) return std::auto_ptr<Module>(Result);
+ // Add one more entry for the NULL pointer that ends the list.
+ ++entries;
- OutErrorMessage = "Bytecode file '" + FN + "' corrupt!";
- if (ErrorMessage.size()) OutErrorMessage += ": " + ErrorMessage;
- return std::auto_ptr<Module>();
-}
+ // If there are no entries at all, just return NULL.
+ if (entries == 0)
+ return NULL;
+ // Allocate a new environment list.
+ char **newenv;
+ if ((newenv = new (char *) [entries]) == NULL)
+ return NULL;
-static Module *LoadSingleLibraryObject(const std::string &Filename) {
- std::string ErrorMessage;
- std::auto_ptr<Module> M = LoadObject(Filename, ErrorMessage);
- if (M.get() == 0 && Verbose) {
- std::cerr << "Error loading '" + Filename + "'";
- if (!ErrorMessage.empty()) std::cerr << ": " << ErrorMessage;
- std::cerr << "\n";
+ // Make a copy of the list. Don't forget the NULL that ends the list.
+ entries = 0;
+ while (envp[entries] != NULL) {
+ newenv[entries] = new char[strlen (envp[entries]) + 1];
+ strcpy (newenv[entries], envp[entries]);
+ ++entries;
}
-
- return M.release();
-}
+ newenv[entries] = NULL;
-// IsArchive - Returns true iff FILENAME appears to be the name of an ar
-// archive file. It determines this by checking the magic string at the
-// beginning of the file.
-static bool IsArchive (const std::string &filename) {
- static const std::string ArchiveMagic ("!<arch>\012");
- char buf[1 + ArchiveMagic.size ()];
- std::ifstream f (filename.c_str ());
- f.read (buf, ArchiveMagic.size ());
- buf[ArchiveMagic.size ()] = '\0';
- return (ArchiveMagic == buf);
+ return newenv;
}
-// LoadLibraryExactName - This looks for a file with a known name and tries to
-// load it, similarly to LoadLibraryFromDirectory().
-static inline bool LoadLibraryExactName (const std::string &FileName,
- std::vector<Module*> &Objects, bool &isArchive) {
- if (Verbose) std::cerr << " Considering '" << FileName << "'\n";
- if (FileExists(FileName)) {
- if (IsArchive (FileName)) {
- std::string ErrorMessage;
- if (Verbose) std::cerr << " Loading '" << FileName << "'\n";
- if (!ReadArchiveFile(FileName, Objects, &ErrorMessage)) {
- isArchive = true;
- return false; // Success!
- }
- if (Verbose) {
- std::cerr << " Error loading archive '" + FileName + "'";
- if (!ErrorMessage.empty()) std::cerr << ": " << ErrorMessage;
- std::cerr << "\n";
- }
- } else {
- if (Module *M = LoadSingleLibraryObject(FileName)) {
- isArchive = false;
- Objects.push_back(M);
- return false;
- }
- }
- }
- return true;
-}
-// LoadLibrary - Try to load a library named LIBNAME that contains
-// LLVM bytecode. If SEARCH is true, then search for a file named
-// libLIBNAME.{a,so,bc} in the current library search path. Otherwise,
-// assume LIBNAME is the real name of the library file. This method puts
-// the loaded modules into the Objects list, and sets isArchive to true if
-// a .a file was loaded. It returns true if no library is found or if an
-// error occurs; otherwise it returns false.
//
-static inline bool LoadLibrary(const std::string &LibName,
- std::vector<Module*> &Objects, bool &isArchive,
- bool search, std::string &ErrorMessage) {
- if (search) {
- // First, try the current directory. Then, iterate over the
- // directories in LibPaths, looking for a suitable match for LibName
- // in each one.
- for (unsigned NextLibPathIdx = 0; NextLibPathIdx != LibPaths.size();
- ++NextLibPathIdx) {
- std::string Directory = LibPaths[NextLibPathIdx] + "/";
- if (!LoadLibraryExactName(Directory + "lib" + LibName + ".a",
- Objects, isArchive))
- return false;
- if (!LoadLibraryExactName(Directory + "lib" + LibName + ".so",
- Objects, isArchive))
- return false;
- if (!LoadLibraryExactName(Directory + "lib" + LibName + ".bc",
- Objects, isArchive))
- return false;
- }
- } else {
- // If they said no searching, then assume LibName is the real name.
- if (!LoadLibraryExactName(LibName, Objects, isArchive))
- return false;
- }
- ErrorMessage = "error linking library '-l" + LibName+ "': library not found!";
- return true;
-}
-
-static void GetAllDefinedSymbols(Module *M,
- std::set<std::string> &DefinedSymbols) {
- for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
- if (I->hasName() && !I->isExternal() && !I->hasInternalLinkage())
- DefinedSymbols.insert(I->getName());
- for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
- if (I->hasName() && !I->isExternal() && !I->hasInternalLinkage())
- DefinedSymbols.insert(I->getName());
-}
-
-// GetAllUndefinedSymbols - This calculates the set of undefined symbols that
-// still exist in an LLVM module. This is a bit tricky because there may be two
-// symbols with the same name, but different LLVM types that will be resolved to
-// each other, but aren't currently (thus we need to treat it as resolved).
+// Function: RemoveEnv()
//
-static void GetAllUndefinedSymbols(Module *M,
- std::set<std::string> &UndefinedSymbols) {
- std::set<std::string> DefinedSymbols;
- UndefinedSymbols.clear(); // Start out empty
-
- for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
- if (I->hasName()) {
- if (I->isExternal())
- UndefinedSymbols.insert(I->getName());
- else if (!I->hasInternalLinkage())
- DefinedSymbols.insert(I->getName());
- }
- for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
- if (I->hasName()) {
- if (I->isExternal())
- UndefinedSymbols.insert(I->getName());
- else if (!I->hasInternalLinkage())
- DefinedSymbols.insert(I->getName());
- }
-
- // Prune out any defined symbols from the undefined symbols set...
- for (std::set<std::string>::iterator I = UndefinedSymbols.begin();
- I != UndefinedSymbols.end(); )
- if (DefinedSymbols.count(*I))
- UndefinedSymbols.erase(I++); // This symbol really is defined!
+// Description:
+// Remove the specified environment variable from the environment array.
+//
+// Inputs:
+// name - The name of the variable to remove. It cannot be NULL.
+// envp - The array of environment variables. It cannot be NULL.
+//
+// Outputs:
+// envp - The pointer to the specified variable name is removed.
+//
+// Return value:
+// None.
+//
+// Notes:
+// This is mainly done because functions to remove items from the environment
+// are not available across all platforms. In particular, Solaris does not
+// seem to have an unsetenv() function or a setenv() function (or they are
+// undocumented if they do exist).
+//
+void RemoveEnv(const char * name, char ** const envp) {
+ for (unsigned index=0; envp[index] != NULL; index++) {
+ // Find the first equals sign in the array and make it an EOS character.
+ char *p = strchr (envp[index], '=');
+ if (p == NULL)
+ continue;
else
- ++I; // Keep this symbol in the undefined symbols list
-}
-
+ *p = '\0';
-static bool LinkLibrary(Module *M, const std::string &LibName,
- bool search, std::string &ErrorMessage) {
- std::set<std::string> UndefinedSymbols;
- GetAllUndefinedSymbols(M, UndefinedSymbols);
- if (UndefinedSymbols.empty()) {
- if (Verbose) std::cerr << " No symbols undefined, don't link library!\n";
- return false; // No need to link anything in!
- }
-
- std::vector<Module*> Objects;
- bool isArchive;
- if (LoadLibrary(LibName, Objects, isArchive, search, ErrorMessage))
- return true;
-
- // Figure out which symbols are defined by all of the modules in the .a file
- std::vector<std::set<std::string> > DefinedSymbols;
- DefinedSymbols.resize(Objects.size());
- for (unsigned i = 0; i != Objects.size(); ++i)
- GetAllDefinedSymbols(Objects[i], DefinedSymbols[i]);
-
- bool Linked = true;
- while (Linked) { // While we are linking in object files, loop.
- Linked = false;
-
- for (unsigned i = 0; i != Objects.size(); ++i) {
- // Consider whether we need to link in this module... we only need to
- // link it in if it defines some symbol which is so far undefined.
- //
- const std::set<std::string> &DefSymbols = DefinedSymbols[i];
-
- bool ObjectRequired = false;
- for (std::set<std::string>::iterator I = UndefinedSymbols.begin(),
- E = UndefinedSymbols.end(); I != E; ++I)
- if (DefSymbols.count(*I)) {
- if (Verbose)
- std::cerr << " Found object providing symbol '" << *I << "'...\n";
- ObjectRequired = true;
- break;
- }
-
- // We DO need to link this object into the program...
- if (ObjectRequired) {
- if (LinkModules(M, Objects[i], &ErrorMessage))
- return true; // Couldn't link in the right object file...
-
- // Since we have linked in this object, delete it from the list of
- // objects to consider in this archive file.
- std::swap(Objects[i], Objects.back());
- std::swap(DefinedSymbols[i], DefinedSymbols.back());
- Objects.pop_back();
- DefinedSymbols.pop_back();
- --i; // Do not skip an entry
-
- // The undefined symbols set should have shrunk.
- GetAllUndefinedSymbols(M, UndefinedSymbols);
- Linked = true; // We have linked something in!
- }
- }
+ // Compare the two strings. If they are equal, zap this string.
+ // Otherwise, restore it.
+ if (!strcmp(name, envp[index]))
+ *envp[index] = '\0';
+ else
+ *p = '=';
}
-
- return false;
-}
-static int PrintAndReturn(const char *progname, const std::string &Message,
- const std::string &Extra = "") {
- std::cerr << progname << Extra << ": " << Message << "\n";
- return 1;
+ return;
}
-int main(int argc, char **argv) {
+int main(int argc, char **argv, char **envp) {
cl::ParseCommandLineOptions(argc, argv, " llvm linker for GCC\n");
std::string ErrorMessage;
// We always look first in the current directory when searching for libraries.
LibPaths.insert(LibPaths.begin(), ".");
- // If the user specied an extra search path in their environment, respect it.
+ // If the user specified an extra search path in their environment, respect
+ // it.
if (char *SearchPath = getenv("LLVM_LIB_SEARCH_PATH"))
LibPaths.push_back(SearchPath);
- for (unsigned i = 1; i < InputFilenames.size(); ++i) {
- // A user may specify an ar archive without -l, perhaps because it
- // is not installed as a library. Detect that and link the library.
- if (IsArchive (InputFilenames[i])) {
- if (Verbose) std::cerr << "Linking archive '" << InputFilenames[i]
- << "'\n";
- if (LinkLibrary (Composite.get(), InputFilenames[i], false, ErrorMessage))
- return PrintAndReturn(argv[0], ErrorMessage,
- ": error linking in '" + InputFilenames[i] + "'");
- continue;
- }
-
- std::auto_ptr<Module> M(LoadObject(InputFilenames[i], ErrorMessage));
- if (M.get() == 0)
- return PrintAndReturn(argv[0], ErrorMessage);
-
- if (Verbose) std::cerr << "Linking in '" << InputFilenames[i] << "'\n";
-
- if (LinkModules(Composite.get(), M.get(), &ErrorMessage))
- return PrintAndReturn(argv[0], ErrorMessage,
- ": error linking in '" + InputFilenames[i] + "'");
- }
-
// Remove any consecutive duplicates of the same library...
Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
Libraries.end());
- // Link in all of the libraries next...
- for (unsigned i = 0; i != Libraries.size(); ++i) {
- if (Verbose) std::cerr << "Linking in library: -l" << Libraries[i] << "\n";
- if (LinkLibrary(Composite.get(), Libraries[i], true, ErrorMessage))
- return PrintAndReturn(argv[0], ErrorMessage);
- }
+ // Link in all of the files
+ if (LinkFiles(argv[0], Composite.get(), InputFilenames, Verbose))
+ return 1; // Error already printed
+ LinkLibraries(argv[0], Composite.get(), Libraries, LibPaths, Verbose, Native);
- // In addition to just linking the input from GCC, we also want to spiff it up
- // a little bit. Do this now.
- //
- PassManager Passes;
-
- // Add an appropriate TargetData instance for this module...
- Passes.add(new TargetData("gccas", Composite.get()));
-
- // Linking modules together can lead to duplicated global constants, only keep
- // one copy of each constant...
- //
- Passes.add(createConstantMergePass());
-
- // If the -s command line option was specified, strip the symbols out of the
- // resulting program to make it smaller. -s is a GCC option that we are
- // supporting.
- //
- if (Strip)
- Passes.add(createSymbolStrippingPass());
-
- // Often if the programmer does not specify proper prototypes for the
- // functions they are calling, they end up calling a vararg version of the
- // function that does not get a body filled in (the real function has typed
- // arguments). This pass merges the two functions.
- //
- Passes.add(createFunctionResolvingPass());
-
- if (!NoInternalize) {
- // Now that composite has been compiled, scan through the module, looking
- // for a main function. If main is defined, mark all other functions
- // internal.
- //
- Passes.add(createInternalizePass());
- }
-
- // Now that we have optimized the program, discard unreachable functions...
- //
- Passes.add(createGlobalDCEPass());
+ // Link in all of the libraries next...
- // Add the pass that writes bytecode to the output file...
+ // Create the output file.
std::string RealBytecodeOutput = OutputFilename;
if (!LinkAsLibrary) RealBytecodeOutput += ".bc";
std::ofstream Out(RealBytecodeOutput.c_str());
if (!Out.good())
return PrintAndReturn(argv[0], "error opening '" + RealBytecodeOutput +
"' for writing!");
- Passes.add(new WriteBytecodePass(&Out)); // Write bytecode to file...
- // Make sure that the Out file gets unlink'd from the disk if we get a SIGINT
+ // Ensure that the bytecode file gets removed from the disk if we get a
+ // SIGINT signal.
RemoveFileOnSignal(RealBytecodeOutput);
- // Run our queue of passes all at once now, efficiently.
- Passes.run(*Composite.get());
+ // Generate the bytecode file.
+ if (GenerateBytecode(Composite.get(), Strip, !NoInternalize, &Out)) {
+ Out.close();
+ return PrintAndReturn(argv[0], "error generating bytcode");
+ }
+
+ // Close the bytecode file.
Out.close();
+ // 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) {
- // Output the script to start the program...
- std::ofstream Out2(OutputFilename.c_str());
- if (!Out2.good())
- return PrintAndReturn(argv[0], "error opening '" + OutputFilename +
- "' for writing!");
- Out2 << "#!/bin/sh\nlli -q -abort-on-exception $0.bc $*\n";
- Out2.close();
+ // If the user wants to generate a native executable, compile it from the
+ // bytecode file.
+ //
+ // Otherwise, create a script that will run the bytecode through the JIT.
+ if (Native) {
+ // Name of the Assembly Language output file
+ std::string AssemblyFile = OutputFilename + ".s";
+
+ // Mark the output files for removal if we get an interrupt.
+ RemoveFileOnSignal(AssemblyFile);
+ RemoveFileOnSignal(OutputFilename);
+
+ // Determine the locations of the llc and gcc programs.
+ std::string llc = FindExecutable("llc", argv[0]);
+ std::string gcc = FindExecutable("gcc", argv[0]);
+ if (llc.empty())
+ return PrintAndReturn(argv[0], "Failed to find llc");
+
+ if (gcc.empty())
+ return PrintAndReturn(argv[0], "Failed to find gcc");
+
+ // Generate an assembly language file for the bytecode.
+ if (Verbose) std::cout << "Generating Assembly Code\n";
+ GenerateAssembly(AssemblyFile, RealBytecodeOutput, llc, envp);
+ if (Verbose) std::cout << "Generating Native Code\n";
+ GenerateNative(OutputFilename, AssemblyFile, Libraries, LibPaths,
+ gcc, envp);
+
+ // Remove the assembly language file.
+ removeFile (AssemblyFile);
+ } else {
+ // Output the script to start the program...
+ std::ofstream Out2(OutputFilename.c_str());
+ if (!Out2.good())
+ return PrintAndReturn(argv[0], "error opening '" + OutputFilename +
+ "' for writing!");
+ Out2 << "#!/bin/sh\nlli $0.bc $*\n";
+ Out2.close();
+ }
// Make the script executable...
- chmod(OutputFilename.c_str(), 0755);
+ MakeFileExecutable(OutputFilename);
+
+ // Make the bytecode file readable and directly executable in LLEE as well
+ MakeFileExecutable(RealBytecodeOutput);
+ MakeFileReadable(RealBytecodeOutput);
}
return 0;
projects / oota-llvm.git / blobdiff