//===- lib/Linker/LinkItems.cpp - Link LLVM objects and libraries ---------===//
-//
+//
// The LLVM Compiler Infrastructure
//
-// This file was developed by Reid Spencer 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 file contains routines to handle linking together LLVM bytecode files,
+// This file contains routines to handle linking together LLVM bitcode files,
// and to handle annoying things like static libraries.
//
//===----------------------------------------------------------------------===//
#include "llvm/Linker.h"
#include "llvm/Module.h"
-#include "llvm/ModuleProvider.h"
-#include "llvm/PassManager.h"
-#include "llvm/ADT/SetOperations.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Bytecode/Archive.h"
-#include "llvm/Bytecode/WriteBytecodePass.h"
-#include "llvm/Target/TargetData.h"
-#include "llvm/Transforms/IPO.h"
-#include "llvm/Transforms/Scalar.h"
-#include "llvm/Config/config.h"
-#include "llvm/Support/CommandLine.h"
-#include "llvm/Support/FileUtilities.h"
-#include "llvm/Support/Timer.h"
-#include "llvm/System/Signals.h"
-#include "llvm/Support/SystemUtils.h"
-#include <algorithm>
-#include <fstream>
-#include <memory>
-#include <set>
+#include "llvm/Bitcode/ReaderWriter.h"
+#include "llvm/System/Path.h"
+#include "llvm/Support/ErrorHandling.h"
+#include "llvm/Support/MemoryBuffer.h"
using namespace llvm;
-static bool
-LinkOneLibrary(const char*progname, Module* HeadModule,
- const std::string& Lib,
- const std::vector<std::string>& LibPaths,
- bool Verbose, bool Native) {
-
- // String in which to receive error messages.
- std::string ErrorMessage;
+// LinkItems - This function is the main entry point into linking. It takes a
+// list of LinkItem which indicates the order the files should be linked and
+// how each file should be treated (plain file or with library search). The
+// function only links bitcode and produces a result list of items that are
+// native objects.
+bool
+Linker::LinkInItems(const ItemList& Items, ItemList& NativeItems) {
+ // Clear the NativeItems just in case
+ NativeItems.clear();
- // Determine where this library lives.
- std::string Pathname = FindLib(Lib, LibPaths);
- if (Pathname.empty()) {
- // If the pathname does not exist, then simply return if we're doing a
- // native link and give a warning if we're doing a bytecode link.
- if (!Native) {
- std::cerr << progname << ": error: Cannot find library '"
- << Lib << "'\n";
- return true;
+ // For each linkage item ...
+ for (ItemList::const_iterator I = Items.begin(), E = Items.end();
+ I != E; ++I) {
+ if (I->second) {
+ // Link in the library suggested.
+ bool is_native = false;
+ if (LinkInLibrary(I->first, is_native))
+ return true;
+ if (is_native)
+ NativeItems.push_back(*I);
+ } else {
+ // Link in the file suggested
+ bool is_native = false;
+ if (LinkInFile(sys::Path(I->first), is_native))
+ return true;
+ if (is_native)
+ NativeItems.push_back(*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(Pathname)) {
- if (Verbose)
- std::cerr << "Trying to link archive '" << Pathname << "' (-l"
- << Lib << ")\n";
-
- if (LinkInArchive(HeadModule, Pathname, &ErrorMessage, Verbose)) {
- std::cerr << progname << ": " << ErrorMessage
- << ": Error linking in archive '" << Pathname << "' (-l"
- << Lib << ")\n";
+ // At this point we have processed all the link items provided to us. Since
+ // we have an aggregated module at this point, the dependent libraries in
+ // that module should also be aggregated with duplicates eliminated. This is
+ // now the time to process the dependent libraries to resolve any remaining
+ // symbols.
+ bool is_native;
+ for (Module::lib_iterator I = Composite->lib_begin(),
+ E = Composite->lib_end(); I != E; ++I) {
+ if(LinkInLibrary(*I, is_native))
return true;
- }
- } else {
- std::cerr << progname << ": WARNING: Supposed library -l"
- << Lib << " isn't a library.\n";
+ if (is_native)
+ NativeItems.push_back(std::make_pair(*I, true));
}
+
return false;
}
-// LinkItems - preserve link order for an arbitrary set of linkage items.
-Module*
-llvm::LinkItems(const char *progname, const LinkItemList& Items,
- const std::vector<std::string>& LibPaths,
- bool Verbose, bool Native) {
- // Construct the HeadModule to contain the result of the linkage
- std::auto_ptr<Module> HeadModule(new Module(progname));
-
- // Construct a mutable path list we can add paths to. This list will always
- // have LLVM_LIB_SEARCH_PATH at the end so we place it there now.
- std::vector<std::string> MyLibPaths(LibPaths);
- MyLibPaths.insert(MyLibPaths.begin(),".");
- char* SearchPath = getenv("LLVM_LIB_SEARCH_PATH");
- if (SearchPath)
- MyLibPaths.push_back(SearchPath);
-
- // For each linkage item ...
- for (LinkItemList::const_iterator I = Items.begin(), E = Items.end();
- I != E; ++I) {
- if (I->second) {
- // Link in the library suggested.
- if (LinkOneLibrary(progname,HeadModule.get(),I->first,MyLibPaths,
- Verbose,Native))
- return 0;
- } else {
- std::vector<std::string> Files;
- Files.push_back(I->first);
- if (LinkFiles(progname,HeadModule.get(),Files,Verbose))
- return 0;
- }
+/// LinkInLibrary - links one library into the HeadModule.
+///
+bool Linker::LinkInLibrary(StringRef Lib, bool& is_native) {
+ is_native = false;
+ // Determine where this library lives.
+ sys::Path Pathname = FindLib(Lib);
+ if (Pathname.isEmpty())
+ return error("Cannot find library '" + Lib.str() + "'");
+
+ // If its an archive, try to link it in
+ std::string Magic;
+ Pathname.getMagicNumber(Magic, 64);
+ switch (sys::IdentifyFileType(Magic.c_str(), 64)) {
+ default: llvm_unreachable("Bad file type identification");
+ case sys::Unknown_FileType:
+ return warning("Supposed library '" + Lib.str() + "' isn't a library.");
+
+ case sys::Bitcode_FileType:
+ // LLVM ".so" file.
+ if (LinkInFile(Pathname, is_native))
+ return true;
+ break;
+
+ case sys::Archive_FileType:
+ if (LinkInArchive(Pathname, is_native))
+ return error("Cannot link archive '" + Pathname.str() + "'");
+ break;
+
+ case sys::ELF_Relocatable_FileType:
+ case sys::ELF_SharedObject_FileType:
+ case sys::Mach_O_Object_FileType:
+ case sys::Mach_O_FixedVirtualMemorySharedLib_FileType:
+ case sys::Mach_O_DynamicallyLinkedSharedLib_FileType:
+ case sys::Mach_O_DynamicallyLinkedSharedLibStub_FileType:
+ case sys::COFF_FileType:
+ is_native = true;
+ break;
}
+ return false;
+}
- // At this point we have processed all the link items provided to us. Since
+/// LinkLibraries - takes the specified library files and links them into the
+/// main bitcode object file.
+///
+/// Inputs:
+/// Libraries - The list of libraries to link into the module.
+///
+/// Return value:
+/// FALSE - No error.
+/// TRUE - Error.
+///
+bool Linker::LinkInLibraries(const std::vector<std::string> &Libraries) {
+
+ // Process the set of libraries we've been provided.
+ bool is_native = false;
+ for (unsigned i = 0; i < Libraries.size(); ++i)
+ if (LinkInLibrary(Libraries[i], is_native))
+ return true;
+
+ // At this point we have processed all the libraries provided to us. Since
// we have an aggregated module at this point, the dependent libraries in
// that module should also be aggregated with duplicates eliminated. This is
// now the time to process the dependent libraries to resolve any remaining
// symbols.
- const Module::LibraryListType& DepLibs = HeadModule->getLibraries();
- for (Module::LibraryListType::const_iterator I = DepLibs.begin(),
- E = DepLibs.end(); I != E; ++I) {
- if(LinkOneLibrary(progname,HeadModule.get(),*I,MyLibPaths,Verbose,Native))
- return 0;
- }
+ const Module::LibraryListType& DepLibs = Composite->getLibraries();
+ for (Module::LibraryListType::const_iterator I = DepLibs.begin(),
+ E = DepLibs.end(); I != E; ++I)
+ if (LinkInLibrary(*I, is_native))
+ return true;
- return HeadModule.release();
+ return false;
}
-// BuildLinkItems -- This function
-void llvm::BuildLinkItems(
- LinkItemList& Items,
- const cl::list<std::string>& Files,
- const cl::list<std::string>& Libraries) {
-
- // 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 libPos = -1, filePos = -1;
- while ( 1 ) {
- if (libIt != Libraries.end())
- libPos = Libraries.getPosition(libIt - Libraries.begin());
- else
- libPos = -1;
- if (fileIt != Files.end())
- filePos = Files.getPosition(fileIt - Files.begin());
- else
- filePos = -1;
-
- if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
- // Add a source file
- Items.push_back(std::make_pair(*fileIt++, false));
- } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
- // Add a library
- Items.push_back(std::make_pair(*libIt++, true));
- } else {
- break; // we're done with the list
+/// LinkInFile - opens a bitcode file and links in all objects which
+/// provide symbols that are currently undefined.
+///
+/// Inputs:
+/// File - The pathname of the bitcode file.
+///
+/// Outputs:
+/// ErrorMessage - A C++ string detailing what error occurred, if any.
+///
+/// Return Value:
+/// TRUE - An error occurred.
+/// FALSE - No errors.
+///
+bool Linker::LinkInFile(const sys::Path &File, bool &is_native) {
+ is_native = false;
+
+ // Check for a file of name "-", which means "read standard input"
+ if (File.str() == "-") {
+ std::auto_ptr<Module> M;
+ if (MemoryBuffer *Buffer = MemoryBuffer::getSTDIN(&Error)) {
+ if (!Buffer->getBufferSize()) {
+ delete Buffer;
+ Error = "standard input is empty";
+ } else {
+ M.reset(ParseBitcodeFile(Buffer, Context, &Error));
+ delete Buffer;
+ if (M.get())
+ if (!LinkInModule(M.get(), &Error))
+ return false;
+ }
+ }
+ return error("Cannot link stdin: " + Error);
+ }
+
+ // Determine what variety of file it is.
+ std::string Magic;
+ if (!File.getMagicNumber(Magic, 64))
+ return error("Cannot find linker input '" + File.str() + "'");
+
+ switch (sys::IdentifyFileType(Magic.c_str(), 64)) {
+ default: llvm_unreachable("Bad file type identification");
+ case sys::Unknown_FileType:
+ return warning("Ignoring file '" + File.str() +
+ "' because does not contain bitcode.");
+
+ case sys::Archive_FileType:
+ // A user may specify an ar archive without -l, perhaps because it
+ // is not installed as a library. Detect that and link the archive.
+ if (LinkInArchive(File, is_native))
+ return true;
+ break;
+
+ case sys::Bitcode_FileType: {
+ verbose("Linking bitcode file '" + File.str() + "'");
+ std::auto_ptr<Module> M(LoadObject(File));
+ if (M.get() == 0)
+ return error("Cannot load file '" + File.str() + "': " + Error);
+ if (LinkInModule(M.get(), &Error))
+ return error("Cannot link file '" + File.str() + "': " + Error);
+
+ verbose("Linked in file '" + File.str() + "'");
+ break;
}
+
+ case sys::ELF_Relocatable_FileType:
+ case sys::ELF_SharedObject_FileType:
+ case sys::Mach_O_Object_FileType:
+ case sys::Mach_O_FixedVirtualMemorySharedLib_FileType:
+ case sys::Mach_O_DynamicallyLinkedSharedLib_FileType:
+ case sys::Mach_O_DynamicallyLinkedSharedLibStub_FileType:
+ case sys::COFF_FileType:
+ is_native = true;
+ break;
}
+ return false;
+}
+
+/// LinkFiles - takes a module and a list of files and links them all together.
+/// It locates the file either in the current directory, as its absolute
+/// or relative pathname, or as a file somewhere in LLVM_LIB_SEARCH_PATH.
+///
+/// Inputs:
+/// Files - A vector of sys::Path indicating the LLVM bitcode filenames
+/// to be linked. The names can refer to a mixture of pure LLVM
+/// bitcode files and archive (ar) formatted files.
+///
+/// Return value:
+/// FALSE - No errors.
+/// TRUE - Some error occurred.
+///
+bool Linker::LinkInFiles(const std::vector<sys::Path> &Files) {
+ bool is_native;
+ for (unsigned i = 0; i < Files.size(); ++i)
+ if (LinkInFile(Files[i], is_native))
+ return true;
+ return false;
}
projects / oota-llvm.git / blobdiff