This file contains basic Linker facilities needed by all tools
[oota-llvm.git] / lib / Linker / Linker.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 #include "llvm/Bytecode/Reader.h"
18 #include <iostream>
19
20 using namespace llvm;
21
22 Linker::Linker(const std::string& progname, unsigned flags)
23   : Composite(0)
24   , LibPaths()
25   , Flags(flags)
26   , Error()
27   , ProgramName(progname)
28 {
29   Composite = new Module(progname);
30 }
31
32 Linker::Linker(const std::string& progname, Module* aModule, unsigned flags)
33   : Composite(aModule)
34   , LibPaths()
35   , Flags(flags)
36   , Error()
37   , ProgramName(progname)
38 {
39 }
40
41 Linker::~Linker() {
42   delete Composite;
43 }
44
45 bool 
46 Linker::error(const std::string& message) {
47   Error = message;
48   if (!(Flags&QuietErrors)) {
49     std::cerr << ProgramName << ": error: " << message << "\n";
50   }
51   return true;
52 }
53
54 bool
55 Linker::warning(const std::string& message) {
56   Error = message;
57   if (!(Flags&QuietErrors)) {
58     std::cerr << ProgramName << ": warning: " << message << "\n";
59   }
60   return false;
61 }
62
63 void
64 Linker::verbose(const std::string& message) {
65   if (Flags&Verbose) {
66     std::cerr << "  " << message << "\n";
67   }
68 }
69
70 void
71 Linker::addPath(const sys::Path& path) {
72   assert(path.isDirectory() && "Can only insert directories into the path");
73   LibPaths.push_back(path);
74 }
75
76 void
77 Linker::addPaths(const std::vector<std::string>& paths) {
78   for (unsigned i = 0; i < paths.size(); i++) {
79     sys::Path aPath;
80     aPath.setDirectory(paths[i]);
81     LibPaths.push_back(aPath);
82   }
83 }
84
85 void
86 Linker::addSystemPaths() {
87   sys::Path::GetBytecodeLibraryPaths(LibPaths);
88   LibPaths.insert(LibPaths.begin(),sys::Path("./"));
89 }
90
91 Module*
92 Linker::releaseModule() {
93   Module* result = Composite;
94   Composite = new Module(ProgramName);
95   LibPaths.clear();
96   Error.clear();
97   Flags = 0;
98   return result;
99 }
100
101 // LoadObject - Read in and parse the bytecode file named by FN and return the
102 // module it contains (wrapped in an auto_ptr), or auto_ptr<Module>() and set 
103 // Error if an error occurs.
104 std::auto_ptr<Module> 
105 Linker::LoadObject(const sys::Path &FN) {
106   std::string ParseErrorMessage;
107   Module *Result = ParseBytecodeFile(FN.toString(), &ParseErrorMessage);
108   if (Result) 
109     return std::auto_ptr<Module>(Result);
110   Error = "Bytecode file '" + FN.toString() + "' could not be loaded";
111   if (ParseErrorMessage.size()) 
112     Error += ": " + ParseErrorMessage;
113   return std::auto_ptr<Module>();
114 }
115
116 static inline sys::Path IsLibrary(const std::string& Name, 
117                                   const sys::Path& Directory) {
118
119   assert(Directory.isDirectory() && "Need to specify a directory");
120   sys::Path FullPath(Directory);
121   FullPath.appendFile("lib" + Name);
122
123   FullPath.appendSuffix("a");
124   if (FullPath.isArchive())
125     return FullPath;
126
127   FullPath.elideSuffix();
128   FullPath.appendSuffix("bca");
129   if (FullPath.isArchive())
130     return FullPath;
131
132   FullPath.elideSuffix();
133   FullPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
134   if (FullPath.isDynamicLibrary())
135     return FullPath;
136
137   FullPath.clear();
138   return FullPath;
139 }
140
141 /// FindLib - Try to convert Filename into the name of a file that we can open,
142 /// if it does not already name a file we can open, by first trying to open
143 /// Filename, then libFilename.[suffix] for each of a set of several common
144 /// library suffixes, in each of the directories in Paths and the directory
145 /// named by the value of the environment variable LLVM_LIB_SEARCH_PATH. Returns
146 /// an empty string if no matching file can be found.
147 ///
148 sys::Path 
149 Linker::FindLib(const std::string &Filename) 
150 {
151   // Determine if the pathname can be found as it stands.
152   sys::Path FilePath(Filename);
153   if (FilePath.readable() && 
154       (FilePath.isArchive() || FilePath.isDynamicLibrary()))
155     return FilePath;
156
157   // Iterate over the directories in Paths to see if we can find the library
158   // there.
159   for (unsigned Index = 0; Index != LibPaths.size(); ++Index) {
160     sys::Path Directory(LibPaths[Index]);
161     sys::Path FullPath = IsLibrary(Filename,Directory);
162     if (!FullPath.isEmpty())
163       return FullPath;
164   }
165   return sys::Path();
166 }