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