lib/Linker/LinkItems.cpp

   1 //===- lib/Linker/LinkItems.cpp - Link LLVM objects and libraries ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains routines to handle linking together LLVM bytecode files,
  11 // and to handle annoying things like static libraries.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Linker.h"
  16 #include "llvm/Module.h"
  17
  18 using namespace llvm;
  19
  20 // LinkItems - This function is the main entry point into linking. It takes a
  21 // list of LinkItem which indicates the order the files should be linked and
  22 // how each file should be treated (plain file or with library search). The
  23 // function only links bytecode and produces a result list of items that are
  24 // native objects.
  25 bool
  26 Linker::LinkInItems(const ItemList& Items, ItemList& NativeItems) {
  27   // Clear the NativeItems just in case
  28   NativeItems.clear();
  29
  30   // For each linkage item ...
  31   for (ItemList::const_iterator I = Items.begin(), E = Items.end();
  32        I != E; ++I) {
  33     if (I->second) {
  34       // Link in the library suggested.
  35       bool is_native = false;
  36       if (LinkInLibrary(I->first, is_native))
  37         return true;
  38       if (is_native)
  39         NativeItems.push_back(*I);
  40     } else {
  41       // Link in the file suggested
  42       bool is_native = false;
  43       if (LinkInFile(sys::Path(I->first), is_native))
  44         return true;
  45       if (is_native)
  46         NativeItems.push_back(*I);
  47     }
  48   }
  49
  50   // At this point we have processed all the link items provided to us. Since
  51   // we have an aggregated module at this point, the dependent libraries in
  52   // that module should also be aggregated with duplicates eliminated. This is
  53   // now the time to process the dependent libraries to resolve any remaining
  54   // symbols.
  55   bool is_native;
  56   for (Module::lib_iterator I = Composite->lib_begin(),
  57          E = Composite->lib_end(); I != E; ++I)
  58     if(LinkInLibrary(*I, is_native))
  59       return true;
  60
  61   return false;
  62 }
  63
  64
  65 /// LinkInLibrary - links one library into the HeadModule.
  66 ///
  67 bool Linker::LinkInLibrary(const std::string& Lib, bool& is_native) {
  68   is_native = false;
  69   // Determine where this library lives.
  70   sys::Path Pathname = FindLib(Lib);
  71   if (Pathname.isEmpty())
  72     return warning("Cannot find library '" + Lib + "'");
  73
  74   // If its an archive, try to link it in
  75   std::string Magic;
  76   Pathname.getMagicNumber(Magic, 64);
  77   switch (sys::IdentifyFileType(Magic.c_str(), 64)) {
  78     default: assert(0 && "Bad file type identification");
  79     case sys::Unknown_FileType:
  80       return warning("Supposed library '" + Lib + "' isn't a library.");
  81
  82     case sys::Bytecode_FileType:
  83     case sys::CompressedBytecode_FileType:
  84       // LLVM ".so" file.
  85       if (LinkInFile(Pathname, is_native))
  86         return error("Cannot link file '" + Pathname.toString() + "'");
  87       break;
  88
  89     case sys::Archive_FileType:
  90       if (LinkInArchive(Pathname))
  91         return error("Cannot link archive '" + Pathname.toString() + "'");
  92       break;
  93
  94     case sys::ELF_Relocatable_FileType:
  95     case sys::ELF_SharedObject_FileType:
  96     case sys::Mach_O_Object_FileType:
  97     case sys::Mach_O_FixedVirtualMemorySharedLib_FileType:
  98     case sys::Mach_O_DynamicallyLinkedSharedLib_FileType:
  99     case sys::Mach_O_DynamicallyLinkedSharedLibStub_FileType:
 100     case sys::COFF_FileType:
 101       is_native = true;
 102       break;
 103   }
 104   return false;
 105 }
 106
 107 /// LinkLibraries - takes the specified library files and links them into the
 108 /// main bytecode object file.
 109 ///
 110 /// Inputs:
 111 ///  Libraries  - The list of libraries to link into the module.
 112 ///
 113 /// Return value:
 114 ///  FALSE - No error.
 115 ///  TRUE  - Error.
 116 ///
 117 bool Linker::LinkInLibraries(const std::vector<std::string> &Libraries) {
 118
 119   // Process the set of libraries we've been provided.
 120   bool is_native = false;
 121   for (unsigned i = 0; i < Libraries.size(); ++i)
 122     if (LinkInLibrary(Libraries[i], is_native))
 123       return true;
 124
 125   // At this point we have processed all the libraries provided to us. Since
 126   // we have an aggregated module at this point, the dependent libraries in
 127   // that module should also be aggregated with duplicates eliminated. This is
 128   // now the time to process the dependent libraries to resolve any remaining
 129   // symbols.
 130   const Module::LibraryListType& DepLibs = Composite->getLibraries();
 131   for (Module::LibraryListType::const_iterator I = DepLibs.begin(),
 132          E = DepLibs.end(); I != E; ++I)
 133     if (LinkInLibrary(*I, is_native))
 134       return true;
 135
 136   return false;
 137 }
 138
 139 /// LinkInFile - opens a bytecode file and links in all objects which
 140 /// provide symbols that are currently undefined.
 141 ///
 142 /// Inputs:
 143 ///  File - The pathname of the bytecode file.
 144 ///
 145 /// Outputs:
 146 ///  ErrorMessage - A C++ string detailing what error occurred, if any.
 147 ///
 148 /// Return Value:
 149 ///  TRUE  - An error occurred.
 150 ///  FALSE - No errors.
 151 ///
 152 bool Linker::LinkInFile(const sys::Path &File, bool &is_native) {
 153   is_native = false;
 154   // Make sure we can at least read the file
 155   if (!File.canRead())
 156     return error("Cannot find linker input '" + File.toString() + "'");
 157
 158   // If its an archive, try to link it in
 159   std::string Magic;
 160   File.getMagicNumber(Magic, 64);
 161   switch (sys::IdentifyFileType(Magic.c_str(), 64)) {
 162     default: assert(0 && "Bad file type identification");
 163     case sys::Unknown_FileType:
 164       return warning("Supposed object file '" + File.toString() +
 165                      "' not recognized as such");
 166
 167     case sys::Archive_FileType:
 168       // A user may specify an ar archive without -l, perhaps because it
 169       // is not installed as a library. Detect that and link the archive.
 170       verbose("Linking archive file '" + File.toString() + "'");
 171       if (LinkInArchive(File))
 172         return error("Cannot link archive '" + File.toString() + "'");
 173       break;
 174
 175     case sys::Bytecode_FileType:
 176     case sys::CompressedBytecode_FileType: {
 177       verbose("Linking bytecode file '" + File.toString() + "'");
 178       std::auto_ptr<Module> M(LoadObject(File));
 179       if (M.get() == 0)
 180         return error("Cannot load file '" + File.toString() + "'" + Error);
 181       if (LinkInModule(M.get()))
 182         return error("Cannot link file '" + File.toString() + "'" + Error);
 183
 184       verbose("Linked in file '" + File.toString() + "'");
 185       break;
 186     }
 187
 188     case sys::ELF_Relocatable_FileType:
 189     case sys::ELF_SharedObject_FileType:
 190     case sys::Mach_O_Object_FileType:
 191     case sys::Mach_O_FixedVirtualMemorySharedLib_FileType:
 192     case sys::Mach_O_DynamicallyLinkedSharedLib_FileType:
 193     case sys::Mach_O_DynamicallyLinkedSharedLibStub_FileType:
 194     case sys::COFF_FileType:
 195       is_native = true;
 196       break;
 197   }
 198   return false;
 199 }
 200
 201 /// LinkFiles - takes a module and a list of files and links them all together.
 202 /// It locates the file either in the current directory, as its absolute
 203 /// or relative pathname, or as a file somewhere in LLVM_LIB_SEARCH_PATH.
 204 ///
 205 /// Inputs:
 206 ///  Files      - A vector of sys::Path indicating the LLVM bytecode filenames
 207 ///               to be linked.  The names can refer to a mixture of pure LLVM
 208 ///               bytecode files and archive (ar) formatted files.
 209 ///
 210 /// Return value:
 211 ///  FALSE - No errors.
 212 ///  TRUE  - Some error occurred.
 213 ///
 214 bool Linker::LinkInFiles(const std::vector<sys::Path> &Files) {
 215   bool is_native;
 216   for (unsigned i = 0; i < Files.size(); ++i)
 217     if (LinkInFile(Files[i], is_native))
 218       return true;
 219   return false;
 220 }