1 //===- lib/Linker/LinkItems.cpp - Link LLVM objects and libraries ---------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file contains routines to handle linking together LLVM bytecode files,
11 // and to handle annoying things like static libraries.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Linker.h"
16 #include "llvm/Module.h"
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
26 Linker::LinkInItems(const ItemList& Items, ItemList& NativeItems) {
27 // Clear the NativeItems just in case
30 // For each linkage item ...
31 for (ItemList::const_iterator I = Items.begin(), E = Items.end();
34 // Link in the library suggested.
35 bool is_bytecode = true;
36 if (LinkInLibrary(I->first,is_bytecode))
39 NativeItems.push_back(*I);
41 // Link in the file suggested
42 if (LinkInFile(sys::Path(I->first)))
47 // At this point we have processed all the link items provided to us. Since
48 // we have an aggregated module at this point, the dependent libraries in
49 // that module should also be aggregated with duplicates eliminated. This is
50 // now the time to process the dependent libraries to resolve any remaining
53 for (Module::lib_iterator I = Composite->lib_begin(),
54 E = Composite->lib_end(); I != E; ++I)
55 if(LinkInLibrary(*I, is_bytecode))
62 /// LinkInLibrary - links one library into the HeadModule.
64 bool Linker::LinkInLibrary(const std::string& Lib, bool& is_bytecode) {
66 // Determine where this library lives.
67 sys::Path Pathname = FindLib(Lib);
68 if (Pathname.isEmpty())
69 return warning("Cannot find library '" + Lib + "'");
71 // If its an archive, try to link it in
73 Pathname.getMagicNumber(Magic, 64);
74 switch (sys::IdentifyFileType(Magic.c_str(), 64)) {
75 case sys::BytecodeFileType:
76 case sys::CompressedBytecodeFileType:
78 if (LinkInFile(Pathname))
79 return error("Cannot link file '" + Pathname.toString() + "'");
82 case sys::ArchiveFileType:
83 if (LinkInArchive(Pathname))
84 return error("Cannot link archive '" + Pathname.toString() + "'");
88 return warning("Supposed library '" + Lib + "' isn't a library.");
93 /// LinkLibraries - takes the specified library files and links them into the
94 /// main bytecode object file.
97 /// Libraries - The list of libraries to link into the module.
100 /// FALSE - No error.
103 bool Linker::LinkInLibraries(const std::vector<std::string> &Libraries) {
105 // Process the set of libraries we've been provided.
107 for (unsigned i = 0; i < Libraries.size(); ++i)
108 if (LinkInLibrary(Libraries[i], is_bytecode))
111 // At this point we have processed all the libraries provided to us. Since
112 // we have an aggregated module at this point, the dependent libraries in
113 // that module should also be aggregated with duplicates eliminated. This is
114 // now the time to process the dependent libraries to resolve any remaining
116 const Module::LibraryListType& DepLibs = Composite->getLibraries();
117 for (Module::LibraryListType::const_iterator I = DepLibs.begin(),
118 E = DepLibs.end(); I != E; ++I)
119 if (LinkInLibrary(*I, is_bytecode))
125 /// LinkInFile - opens a bytecode file and links in all objects which
126 /// provide symbols that are currently undefined.
129 /// File - The pathname of the bytecode file.
132 /// ErrorMessage - A C++ string detailing what error occurred, if any.
135 /// TRUE - An error occurred.
136 /// FALSE - No errors.
138 bool Linker::LinkInFile(const sys::Path &File) {
139 // Make sure we can at least read the file
141 return error("Cannot find linker input '" + File.toString() + "'");
143 // A user may specify an ar archive without -l, perhaps because it
144 // is not installed as a library. Detect that and link the library.
145 if (File.isArchive()) {
146 if (LinkInArchive(File))
147 return error("Cannot link archive '" + File.toString() + "'");
148 } else if (File.isBytecodeFile()) {
149 verbose("Linking bytecode file '" + File.toString() + "'");
151 std::auto_ptr<Module> M(LoadObject(File));
153 return error("Cannot load file '" + File.toString() + "'" + Error);
154 if (LinkInModule(M.get()))
155 return error("Cannot link file '" + File.toString() + "'" + Error);
157 verbose("Linked in file '" + File.toString() + "'");
159 return warning("File of unknown type '" + File.toString() + "' ignored.");
164 /// LinkFiles - takes a module and a list of files and links them all together.
165 /// It locates the file either in the current directory, as its absolute
166 /// or relative pathname, or as a file somewhere in LLVM_LIB_SEARCH_PATH.
169 /// Files - A vector of sys::Path indicating the LLVM bytecode filenames
170 /// to be linked. The names can refer to a mixture of pure LLVM
171 /// bytecode files and archive (ar) formatted files.
174 /// FALSE - No errors.
175 /// TRUE - Some error occurred.
177 bool Linker::LinkInFiles(const std::vector<sys::Path> &Files) {
178 for (unsigned i = 0; i < Files.size(); ++i)
179 if (LinkInFile(Files[i]))