lib/Linker/LinkArchives.cpp

   1 //===- lib/Linker/LinkArchives.cpp - Link LLVM objects and libraries ------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   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 #include "llvm/ModuleProvider.h"
  18 #include "llvm/PassManager.h"
  19 #include "llvm/Bytecode/Reader.h"
  20 #include "llvm/Bytecode/Archive.h"
  21 #include "llvm/Bytecode/WriteBytecodePass.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "llvm/Transforms/IPO.h"
  24 #include "llvm/Transforms/Scalar.h"
  25 #include "llvm/Config/config.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/FileUtilities.h"
  28 #include "llvm/System/Signals.h"
  29 #include "llvm/Support/SystemUtils.h"
  30 #include <algorithm>
  31 #include <fstream>
  32 #include <memory>
  33 #include <set>
  34 using namespace llvm;
  35
  36 /// FindLib - Try to convert Filename into the name of a file that we can open,
  37 /// if it does not already name a file we can open, by first trying to open
  38 /// Filename, then libFilename.[suffix] for each of a set of several common
  39 /// library suffixes, in each of the directories in Paths and the directory
  40 /// named by the value of the environment variable LLVM_LIB_SEARCH_PATH. Returns
  41 /// an empty string if no matching file can be found.
  42 ///
  43 std::string llvm::FindLib(const std::string &Filename,
  44                           const std::vector<std::string> &Paths,
  45                           bool SharedObjectOnly) {
  46   // Determine if the pathname can be found as it stands.
  47   if (FileOpenable(Filename))
  48     return Filename;
  49
  50   // If that doesn't work, convert the name into a library name.
  51   std::string LibName = "lib" + Filename;
  52
  53   // Iterate over the directories in Paths to see if we can find the library
  54   // there.
  55   for (unsigned Index = 0; Index != Paths.size(); ++Index) {
  56     std::string Directory = Paths[Index] + "/";
  57
  58     if (!SharedObjectOnly && FileOpenable(Directory + LibName + ".bc"))
  59       return Directory + LibName + ".bc";
  60
  61     if (FileOpenable(Directory + LibName + SHLIBEXT))
  62       return Directory + LibName + SHLIBEXT;
  63
  64     if (!SharedObjectOnly && FileOpenable(Directory + LibName + ".a"))
  65       return Directory + LibName + ".a";
  66   }
  67
  68   // One last hope: Check LLVM_LIB_SEARCH_PATH.
  69   char *SearchPath = getenv("LLVM_LIB_SEARCH_PATH");
  70   if (SearchPath == NULL)
  71     return std::string();
  72
  73   LibName = std::string(SearchPath) + "/" + LibName;
  74   if (FileOpenable(LibName))
  75     return LibName;
  76
  77   return std::string();
  78 }
  79
  80 /// GetAllDefinedSymbols - Modifies its parameter DefinedSymbols to contain the
  81 /// name of each externally-visible symbol defined in M.
  82 ///
  83 void llvm::GetAllDefinedSymbols(Module *M,
  84                                 std::set<std::string> &DefinedSymbols) {
  85   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
  86     if (I->hasName() && !I->isExternal() && !I->hasInternalLinkage())
  87       DefinedSymbols.insert(I->getName());
  88   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
  89     if (I->hasName() && !I->isExternal() && !I->hasInternalLinkage())
  90       DefinedSymbols.insert(I->getName());
  91 }
  92
  93 /// GetAllUndefinedSymbols - calculates the set of undefined symbols that still
  94 /// exist in an LLVM module. This is a bit tricky because there may be two
  95 /// symbols with the same name but different LLVM types that will be resolved to
  96 /// each other but aren't currently (thus we need to treat it as resolved).
  97 ///
  98 /// Inputs:
  99 ///  M - The module in which to find undefined symbols.
 100 ///
 101 /// Outputs:
 102 ///  UndefinedSymbols - A set of C++ strings containing the name of all
 103 ///                     undefined symbols.
 104 ///
 105 void
 106 llvm::GetAllUndefinedSymbols(Module *M,
 107                              std::set<std::string> &UndefinedSymbols) {
 108   std::set<std::string> DefinedSymbols;
 109   UndefinedSymbols.clear();   // Start out empty
 110
 111   for (Module::iterator I = M->begin(), E = M->end(); I != E; ++I)
 112     if (I->hasName()) {
 113       if (I->isExternal())
 114         UndefinedSymbols.insert(I->getName());
 115       else if (!I->hasInternalLinkage())
 116         DefinedSymbols.insert(I->getName());
 117     }
 118   for (Module::giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
 119     if (I->hasName()) {
 120       if (I->isExternal())
 121         UndefinedSymbols.insert(I->getName());
 122       else if (!I->hasInternalLinkage())
 123         DefinedSymbols.insert(I->getName());
 124     }
 125
 126   // Prune out any defined symbols from the undefined symbols set...
 127   for (std::set<std::string>::iterator I = UndefinedSymbols.begin();
 128        I != UndefinedSymbols.end(); )
 129     if (DefinedSymbols.count(*I))
 130       UndefinedSymbols.erase(I++);  // This symbol really is defined!
 131     else
 132       ++I; // Keep this symbol in the undefined symbols list
 133 }
 134
 135
 136 /// LoadObject - Read in and parse the bytecode file named by FN and return the
 137 /// module it contains (wrapped in an auto_ptr), or 0 and set ErrorMessage if an
 138 /// error occurs.
 139 ///
 140 static std::auto_ptr<Module> LoadObject(const std::string &FN,
 141                                        std::string &ErrorMessage) {
 142   std::string ParserErrorMessage;
 143   Module *Result = ParseBytecodeFile(FN, &ParserErrorMessage);
 144   if (Result) return std::auto_ptr<Module>(Result);
 145   ErrorMessage = "Bytecode file '" + FN + "' could not be loaded";
 146   if (ParserErrorMessage.size()) ErrorMessage += ": " + ParserErrorMessage;
 147   return std::auto_ptr<Module>();
 148 }
 149
 150 /// LinkInArchive - opens an archive library and link in all objects which
 151 /// provide symbols that are currently undefined.
 152 ///
 153 /// Inputs:
 154 ///  M        - The module in which to link the archives.
 155 ///  Filename - The pathname of the archive.
 156 ///  Verbose  - Flags whether verbose messages should be printed.
 157 ///
 158 /// Outputs:
 159 ///  ErrorMessage - A C++ string detailing what error occurred, if any.
 160 ///
 161 /// Return Value:
 162 ///  TRUE  - An error occurred.
 163 ///  FALSE - No errors.
 164 ///
 165 bool llvm::LinkInArchive(Module *M,
 166                           const std::string &Filename,
 167                           std::string* ErrorMessage,
 168                           bool Verbose)
 169 {
 170   // Find all of the symbols currently undefined in the bytecode program.
 171   // If all the symbols are defined, the program is complete, and there is
 172   // no reason to link in any archive files.
 173   std::set<std::string> UndefinedSymbols;
 174   GetAllUndefinedSymbols(M, UndefinedSymbols);
 175   if (UndefinedSymbols.empty()) {
 176     if (Verbose) std::cerr << "  No symbols undefined, don't link library!\n";
 177     return false;  // No need to link anything in!
 178   }
 179
 180   // Open the archive file
 181   if (Verbose) std::cerr << "  Loading archive file '" << Filename << "'\n";
 182   Archive* arch = Archive::OpenAndLoadSymbols(sys::Path(Filename));
 183
 184   // While we are linking in object files, loop.
 185   while (true) {
 186     std::set<ModuleProvider*> Modules;
 187     // Find the modules we need to link
 188     arch->findModulesDefiningSymbols(UndefinedSymbols,Modules);
 189
 190     // If we didn't find any more modules to link this time, we are done.
 191     if (Modules.empty())
 192       break;
 193
 194     // Loop over all the ModuleProviders that we got back from the archive
 195     for (std::set<ModuleProvider*>::iterator I=Modules.begin(), E=Modules.end();
 196          I != E; ++I) {
 197       // Get the module we must link in.
 198       std::auto_ptr<Module> aModule((*I)->releaseModule());
 199
 200       // Link it in.
 201       if (LinkModules(M, aModule.get(), ErrorMessage)) {
 202         // don't create a memory leak
 203         delete arch;
 204         return true;   // Couldn't link in the right object file...
 205       }
 206     }
 207
 208     // We have linked in a set of modules determined by the archive to satisfy
 209     // our missing symbols. Linking in the new modules will have satisfied some
 210     // symbols but may introduce additional missing symbols. We need to update
 211     // the list of undefined symbols and try again until the archive doesn't
 212     // have any modules that satisfy our symbols.
 213     GetAllUndefinedSymbols(M, UndefinedSymbols);
 214   }
 215
 216   return false;
 217 }
 218
 219 /// LinkInFile - opens a bytecode file and links in all objects which
 220 /// provide symbols that are currently undefined.
 221 ///
 222 /// Inputs:
 223 ///  HeadModule - The module in which to link the bytecode file.
 224 ///  Filename   - The pathname of the bytecode file.
 225 ///  Verbose    - Flags whether verbose messages should be printed.
 226 ///
 227 /// Outputs:
 228 ///  ErrorMessage - A C++ string detailing what error occurred, if any.
 229 ///
 230 /// Return Value:
 231 ///  TRUE  - An error occurred.
 232 ///  FALSE - No errors.
 233 ///
 234 static bool LinkInFile(Module *HeadModule,
 235                        const std::string &Filename,
 236                        std::string &ErrorMessage,
 237                        bool Verbose)
 238 {
 239   std::auto_ptr<Module> M(LoadObject(Filename, ErrorMessage));
 240   if (M.get() == 0) return true;
 241   bool Result = LinkModules(HeadModule, M.get(), &ErrorMessage);
 242   if (Verbose) std::cerr << "Linked in bytecode file '" << Filename << "'\n";
 243   return Result;
 244 }
 245
 246 /// LinkFiles - takes a module and a list of files and links them all together.
 247 /// It locates the file either in the current directory, as its absolute
 248 /// or relative pathname, or as a file somewhere in LLVM_LIB_SEARCH_PATH.
 249 ///
 250 /// Inputs:
 251 ///  progname   - The name of the program (infamous argv[0]).
 252 ///  HeadModule - The module under which all files will be linked.
 253 ///  Files      - A vector of C++ strings indicating the LLVM bytecode filenames
 254 ///               to be linked.  The names can refer to a mixture of pure LLVM
 255 ///               bytecode files and archive (ar) formatted files.
 256 ///  Verbose    - Flags whether verbose output should be printed while linking.
 257 ///
 258 /// Outputs:
 259 ///  HeadModule - The module will have the specified LLVM bytecode files linked
 260 ///               in.
 261 ///
 262 /// Return value:
 263 ///  FALSE - No errors.
 264 ///  TRUE  - Some error occurred.
 265 ///
 266 bool llvm::LinkFiles(const char *progname, Module *HeadModule,
 267                      const std::vector<std::string> &Files, bool Verbose) {
 268   // String in which to receive error messages.
 269   std::string ErrorMessage;
 270
 271   // Full pathname of the file
 272   std::string Pathname;
 273
 274   // Get the library search path from the environment
 275   char *SearchPath = getenv("LLVM_LIB_SEARCH_PATH");
 276
 277   for (unsigned i = 0; i < Files.size(); ++i) {
 278     // Determine where this file lives.
 279     if (FileOpenable(Files[i])) {
 280       Pathname = Files[i];
 281     } else {
 282       if (SearchPath == NULL) {
 283         std::cerr << progname << ": Cannot find linker input file '"
 284                   << Files[i] << "'\n";
 285         std::cerr << progname
 286                   << ": Warning: Your LLVM_LIB_SEARCH_PATH is unset.\n";
 287         return true;
 288       }
 289
 290       Pathname = std::string(SearchPath)+"/"+Files[i];
 291       if (!FileOpenable(Pathname)) {
 292         std::cerr << progname << ": Cannot find linker input file '"
 293                   << Files[i] << "'\n";
 294         return true;
 295       }
 296     }
 297
 298     // A user may specify an ar archive without -l, perhaps because it
 299     // is not installed as a library. Detect that and link the library.
 300     if (IsArchive(Pathname)) {
 301       if (Verbose)
 302         std::cerr << "Trying to link archive '" << Pathname << "'\n";
 303
 304       if (LinkInArchive(HeadModule, Pathname, &ErrorMessage, Verbose)) {
 305         std::cerr << progname << ": Error linking in archive '" << Pathname
 306                   << "': " << ErrorMessage << "\n";
 307         return true;
 308       }
 309     } else if (IsBytecode(Pathname)) {
 310       if (Verbose)
 311         std::cerr << "Trying to link bytecode file '" << Pathname << "'\n";
 312
 313       if (LinkInFile(HeadModule, Pathname, ErrorMessage, Verbose)) {
 314         std::cerr << progname << ": Error linking in bytecode file '"
 315                   << Pathname << "': " << ErrorMessage << "\n";
 316         return true;
 317       }
 318     } else {
 319       std::cerr << progname << ": Warning: invalid file `" << Pathname
 320                 << "' ignored.\n";
 321     }
 322   }
 323
 324   return false;
 325 }
 326
 327 /// LinkLibraries - takes the specified library files and links them into the
 328 /// main bytecode object file.
 329 ///
 330 /// Inputs:
 331 ///  progname   - The name of the program (infamous argv[0]).
 332 ///  HeadModule - The module into which all necessary libraries will be linked.
 333 ///  Libraries  - The list of libraries to link into the module.
 334 ///  LibPaths   - The list of library paths in which to find libraries.
 335 ///  Verbose    - Flags whether verbose messages should be printed.
 336 ///  Native     - Flags whether native code is being generated.
 337 ///
 338 /// Outputs:
 339 ///  HeadModule - The module will have all necessary libraries linked in.
 340 ///
 341 /// Return value:
 342 ///  FALSE - No error.
 343 ///  TRUE  - Error.
 344 ///
 345 void llvm::LinkLibraries(const char *progname, Module *HeadModule,
 346                          const std::vector<std::string> &Libraries,
 347                          const std::vector<std::string> &LibPaths,
 348                          bool Verbose, bool Native) {
 349   // String in which to receive error messages.
 350   std::string ErrorMessage;
 351
 352   for (unsigned i = 0; i < Libraries.size(); ++i) {
 353     // Determine where this library lives.
 354     std::string Pathname = FindLib(Libraries[i], LibPaths);
 355     if (Pathname.empty()) {
 356       // If the pathname does not exist, then continue to the next one if
 357       // we're doing a native link and give an error if we're doing a bytecode
 358       // link.
 359       if (!Native) {
 360         std::cerr << progname << ": WARNING: Cannot find library -l"
 361                   << Libraries[i] << "\n";
 362         continue;
 363       }
 364     }
 365
 366     // A user may specify an ar archive without -l, perhaps because it
 367     // is not installed as a library. Detect that and link the library.
 368     if (IsArchive(Pathname)) {
 369       if (Verbose)
 370         std::cerr << "Trying to link archive '" << Pathname << "' (-l"
 371                   << Libraries[i] << ")\n";
 372
 373       if (LinkInArchive(HeadModule, Pathname, &ErrorMessage, Verbose)) {
 374         std::cerr << progname << ": " << ErrorMessage
 375                   << ": Error linking in archive '" << Pathname << "' (-l"
 376                   << Libraries[i] << ")\n";
 377         exit(1);
 378       }
 379     } else if (IsBytecode(Pathname)) {
 380       if (Verbose)
 381         std::cerr << "Trying to link bytecode file '" << Pathname
 382                   << "' (-l" << Libraries[i] << ")\n";
 383
 384       if (LinkInFile(HeadModule, Pathname, ErrorMessage, Verbose)) {
 385         std::cerr << progname << ": " << ErrorMessage
 386                   << ": error linking in bytecode file '" << Pathname << "' (-l"
 387                   << Libraries[i] << ")\n";
 388         exit(1);
 389       }
 390     }
 391   }
 392 }