blob: 86c06c1e8f8a584e104286867a7f0b14e0afc4f9 [file] [log] [blame]
Reid Spencerc0af3f02004-09-13 01:27:53 +00001//===- llvm-ld.cpp - LLVM 'ld' compatible linker --------------------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
Reid Spencerc0af3f02004-09-13 01:27:53 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner21c62da2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
Reid Spencerc0af3f02004-09-13 01:27:53 +00008//===----------------------------------------------------------------------===//
9//
10// This utility is intended to be compatible with GCC, and follows standard
11// system 'ld' conventions. As such, the default output file is ./a.out.
12// Additionally, this program outputs a shell script that is used to invoke LLI
13// to execute the program. In this manner, the generated executable (a.out for
Gabor Greifa99be512007-07-05 17:07:56 +000014// example), is directly executable, whereas the bitcode file actually lives in
Dan Gohmanbaa26392009-08-25 15:34:52 +000015// the a.out.bc file generated by this program.
Reid Spencerc0af3f02004-09-13 01:27:53 +000016//
17// Note that if someone (or a script) deletes the executable program generated,
18// the .bc file will be left around. Considering that this is a temporary hack,
19// I'm not too worried about this.
20//
21//===----------------------------------------------------------------------===//
22
Reid Spenceraf303d52006-06-07 23:03:13 +000023#include "llvm/LinkAllVMCore.h"
Reid Spencer605b9e22004-11-14 23:00:08 +000024#include "llvm/Linker.h"
Owen Anderson8b477ed2009-07-01 16:58:40 +000025#include "llvm/LLVMContext.h"
Reid Spencer6da1e0d2004-12-14 04:20:08 +000026#include "llvm/System/Program.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000027#include "llvm/Module.h"
28#include "llvm/PassManager.h"
Chris Lattnerbb3f3d32007-05-06 05:56:58 +000029#include "llvm/Bitcode/ReaderWriter.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000030#include "llvm/Target/TargetData.h"
Reid Spenceraefd04b2004-09-25 16:00:07 +000031#include "llvm/Target/TargetMachine.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000032#include "llvm/Support/CommandLine.h"
Chris Lattnerc30598b2006-12-06 01:18:01 +000033#include "llvm/Support/ManagedStatic.h"
Chris Lattnerbb3f3d32007-05-06 05:56:58 +000034#include "llvm/Support/MemoryBuffer.h"
Chris Lattnercc14d252009-03-06 05:34:10 +000035#include "llvm/Support/PrettyStackTrace.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000036#include "llvm/Support/SystemUtils.h"
Chris Lattner74382b72009-08-23 22:45:37 +000037#include "llvm/Support/raw_ostream.h"
Reid Spencer445564a2004-11-20 20:02:56 +000038#include "llvm/System/Signals.h"
Chris Lattner5d5a8972009-01-05 19:01:32 +000039#include "llvm/Config/config.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000040#include <memory>
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000041#include <cstring>
Reid Spencerc0af3f02004-09-13 01:27:53 +000042using namespace llvm;
43
Dan Gohman197f7282009-08-05 20:21:17 +000044// Rightly this should go in a header file but it just seems such a waste.
45namespace llvm {
46extern void Optimize(Module*);
47}
48
Reid Spencer445564a2004-11-20 20:02:56 +000049// Input/Output Options
50static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
Gabor Greifa99be512007-07-05 17:07:56 +000051 cl::desc("<input bitcode files>"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000052
Reid Spencer445564a2004-11-20 20:02:56 +000053static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
Misha Brukman3da94ae2005-04-22 00:00:37 +000054 cl::desc("Override output filename"),
Reid Spencer445564a2004-11-20 20:02:56 +000055 cl::value_desc("filename"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000056
Sanjiv Guptad7de7bc2009-07-22 18:41:45 +000057static cl::opt<std::string> BitcodeOutputFilename("b", cl::init(""),
58 cl::desc("Override bitcode output filename"),
59 cl::value_desc("filename"));
60
Misha Brukman3da94ae2005-04-22 00:00:37 +000061static cl::opt<bool> Verbose("v",
Reid Spencer445564a2004-11-20 20:02:56 +000062 cl::desc("Print information about actions taken"));
Misha Brukman3da94ae2005-04-22 00:00:37 +000063
Reid Spencer445564a2004-11-20 20:02:56 +000064static cl::list<std::string> LibPaths("L", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000065 cl::desc("Specify a library search path"),
Reid Spencer445564a2004-11-20 20:02:56 +000066 cl::value_desc("directory"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000067
Chris Lattner3992f522008-01-27 22:58:59 +000068static cl::list<std::string> FrameworkPaths("F", cl::Prefix,
69 cl::desc("Specify a framework search path"),
70 cl::value_desc("directory"));
71
Reid Spencer445564a2004-11-20 20:02:56 +000072static cl::list<std::string> Libraries("l", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000073 cl::desc("Specify libraries to link to"),
Reid Spencer445564a2004-11-20 20:02:56 +000074 cl::value_desc("library prefix"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000075
Chris Lattner3992f522008-01-27 22:58:59 +000076static cl::list<std::string> Frameworks("framework",
77 cl::desc("Specify frameworks to link to"),
78 cl::value_desc("framework"));
79
Reid Spencer708585a2007-02-09 03:08:06 +000080// Options to control the linking, optimization, and code gen processes
Misha Brukman3da94ae2005-04-22 00:00:37 +000081static cl::opt<bool> LinkAsLibrary("link-as-library",
Reid Spencer445564a2004-11-20 20:02:56 +000082 cl::desc("Link the .bc files together as a library, not an executable"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000083
Reid Spencer445564a2004-11-20 20:02:56 +000084static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
85 cl::desc("Alias for -link-as-library"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000086
Reid Spencer445564a2004-11-20 20:02:56 +000087static cl::opt<bool> Native("native",
88 cl::desc("Generate a native binary instead of a shell script"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000089
Reid Spencer445564a2004-11-20 20:02:56 +000090static cl::opt<bool>NativeCBE("native-cbe",
91 cl::desc("Generate a native binary with the C backend and GCC"));
92
Reid Spencer73a74be2005-12-21 05:03:23 +000093static cl::list<std::string> PostLinkOpts("post-link-opts",
Reid Spenceraf303d52006-06-07 23:03:13 +000094 cl::value_desc("path"),
Reid Spencer73a74be2005-12-21 05:03:23 +000095 cl::desc("Run one or more optimization programs after linking"));
96
Reid Spenceraf303d52006-06-07 23:03:13 +000097static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
98 cl::desc("Pass options to the system linker"));
99
Reid Spencer708585a2007-02-09 03:08:06 +0000100// Compatibility options that llvm-ld ignores but are supported for
101// compatibility with LD
Misha Brukman3da94ae2005-04-22 00:00:37 +0000102static cl::opt<std::string> CO3("soname", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000103 cl::desc("Compatibility option: ignored"));
104
Misha Brukman3da94ae2005-04-22 00:00:37 +0000105static cl::opt<std::string> CO4("version-script", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000106 cl::desc("Compatibility option: ignored"));
107
Misha Brukman3da94ae2005-04-22 00:00:37 +0000108static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000109 cl::desc("Compatibility option: ignored"));
110
Misha Brukman3da94ae2005-04-22 00:00:37 +0000111static cl::opt<std::string> CO6("h", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000112 cl::desc("Compatibility option: ignored"));
113
Reid Spencer98a030c2007-02-08 19:03:11 +0000114static cl::opt<bool> CO7("start-group", cl::Hidden,
115 cl::desc("Compatibility option: ignored"));
116
117static cl::opt<bool> CO8("end-group", cl::Hidden,
118 cl::desc("Compatibility option: ignored"));
Reid Spenceraf303d52006-06-07 23:03:13 +0000119
Andrew Lenharth0c6ba442008-11-19 17:00:08 +0000120static cl::opt<std::string> CO9("m", cl::Hidden,
121 cl::desc("Compatibility option: ignored"));
122
Reid Spencer445564a2004-11-20 20:02:56 +0000123/// This is just for convenience so it doesn't have to be passed around
124/// everywhere.
Reid Spencerc4064132004-12-13 03:01:14 +0000125static std::string progname;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000126
Reid Spencer708585a2007-02-09 03:08:06 +0000127/// PrintAndExit - Prints a message to standard error and exits with error code
Reid Spencerc0af3f02004-09-13 01:27:53 +0000128///
129/// Inputs:
Reid Spencerc0af3f02004-09-13 01:27:53 +0000130/// Message - The message to print to standard error.
131///
Chris Lattner25c54c02010-03-23 21:59:43 +0000132static void PrintAndExit(const std::string &Message, Module *M, int errcode = 1) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000133 errs() << progname << ": " << Message << "\n";
Chris Lattner25c54c02010-03-23 21:59:43 +0000134 delete M;
Reid Spencer708585a2007-02-09 03:08:06 +0000135 llvm_shutdown();
136 exit(errcode);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000137}
138
Reid Spencer3b726392007-04-29 23:59:47 +0000139static void PrintCommand(const std::vector<const char*> &args) {
140 std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
141 for (; I != E; ++I)
142 if (*I)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000143 outs() << "'" << *I << "'" << " ";
144 outs() << "\n"; outs().flush();
Reid Spencer3b726392007-04-29 23:59:47 +0000145}
146
Reid Spencer445564a2004-11-20 20:02:56 +0000147/// CopyEnv - This function takes an array of environment variables and makes a
148/// copy of it. This copy can then be manipulated any way the caller likes
149/// without affecting the process's real environment.
150///
151/// Inputs:
152/// envp - An array of C strings containing an environment.
153///
154/// Return value:
155/// NULL - An error occurred.
156///
157/// Otherwise, a pointer to a new array of C strings is returned. Every string
158/// in the array is a duplicate of the one in the original array (i.e. we do
159/// not copy the char *'s from one array to another).
160///
161static char ** CopyEnv(char ** const envp) {
162 // Count the number of entries in the old list;
163 unsigned entries; // The number of entries in the old environment list
164 for (entries = 0; envp[entries] != NULL; entries++)
165 /*empty*/;
166
167 // Add one more entry for the NULL pointer that ends the list.
168 ++entries;
169
170 // If there are no entries at all, just return NULL.
171 if (entries == 0)
172 return NULL;
173
174 // Allocate a new environment list.
175 char **newenv = new char* [entries];
176 if ((newenv = new char* [entries]) == NULL)
177 return NULL;
178
179 // Make a copy of the list. Don't forget the NULL that ends the list.
180 entries = 0;
181 while (envp[entries] != NULL) {
Benjamin Kramer12ea66a2010-01-28 18:04:38 +0000182 size_t len = strlen(envp[entries]) + 1;
183 newenv[entries] = new char[len];
184 memcpy(newenv[entries], envp[entries], len);
Reid Spencer445564a2004-11-20 20:02:56 +0000185 ++entries;
186 }
187 newenv[entries] = NULL;
188
189 return newenv;
190}
191
192
193/// RemoveEnv - Remove the specified environment variable from the environment
194/// array.
195///
196/// Inputs:
197/// name - The name of the variable to remove. It cannot be NULL.
198/// envp - The array of environment variables. It cannot be NULL.
199///
200/// Notes:
201/// This is mainly done because functions to remove items from the environment
202/// are not available across all platforms. In particular, Solaris does not
203/// seem to have an unsetenv() function or a setenv() function (or they are
204/// undocumented if they do exist).
205///
206static void RemoveEnv(const char * name, char ** const envp) {
207 for (unsigned index=0; envp[index] != NULL; index++) {
208 // Find the first equals sign in the array and make it an EOS character.
209 char *p = strchr (envp[index], '=');
210 if (p == NULL)
211 continue;
212 else
213 *p = '\0';
214
215 // Compare the two strings. If they are equal, zap this string.
216 // Otherwise, restore it.
217 if (!strcmp(name, envp[index]))
218 *envp[index] = '\0';
219 else
220 *p = '=';
221 }
222
223 return;
224}
225
Gabor Greifa99be512007-07-05 17:07:56 +0000226/// GenerateBitcode - generates a bitcode file from the module provided
227void GenerateBitcode(Module* M, const std::string& FileName) {
Reid Spencer445564a2004-11-20 20:02:56 +0000228
Reid Spencer3b726392007-04-29 23:59:47 +0000229 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000230 outs() << "Generating Bitcode To " << FileName << '\n';
Reid Spencer3b726392007-04-29 23:59:47 +0000231
Reid Spencer445564a2004-11-20 20:02:56 +0000232 // Create the output file.
Dan Gohmanac95cc72009-07-16 15:30:09 +0000233 std::string ErrorInfo;
Chris Lattner17e9edc2009-08-23 02:51:22 +0000234 raw_fd_ostream Out(FileName.c_str(), ErrorInfo,
Dan Gohmanbaa26392009-08-25 15:34:52 +0000235 raw_fd_ostream::F_Binary);
Dan Gohmanac95cc72009-07-16 15:30:09 +0000236 if (!ErrorInfo.empty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000237 PrintAndExit(ErrorInfo, M);
Reid Spencer445564a2004-11-20 20:02:56 +0000238
Gabor Greifa99be512007-07-05 17:07:56 +0000239 // Ensure that the bitcode file gets removed from the disk if we get a
Reid Spencer445564a2004-11-20 20:02:56 +0000240 // terminating signal.
241 sys::RemoveFileOnSignal(sys::Path(FileName));
242
243 // Write it out
Chris Lattner44dadff2007-05-06 09:29:57 +0000244 WriteBitcodeToFile(M, Out);
Reid Spencer445564a2004-11-20 20:02:56 +0000245}
246
247/// GenerateAssembly - generates a native assembly language source file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000248/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000249///
250/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000251/// InputFilename - The name of the input bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000252/// OutputFilename - The name of the file to generate.
253/// llc - The pathname to use for LLC.
254/// envp - The environment to use when running LLC.
255///
256/// Return non-zero value on error.
257///
258static int GenerateAssembly(const std::string &OutputFilename,
259 const std::string &InputFilename,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000260 const sys::Path &llc,
261 std::string &ErrMsg ) {
Gabor Greifa99be512007-07-05 17:07:56 +0000262 // Run LLC to convert the bitcode file into assembly code.
Reid Spencerf6358c72004-12-19 18:00:56 +0000263 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000264 args.push_back(llc.c_str());
Argyrios Kyrtzidisca29dff2008-06-27 15:08:59 +0000265 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
266 // regardless of what the target in the bitcode file is.
267 args.push_back("-x86-asm-syntax=att");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000268 args.push_back("-f");
269 args.push_back("-o");
270 args.push_back(OutputFilename.c_str());
271 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000272 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000273
Reid Spencer3b726392007-04-29 23:59:47 +0000274 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000275 outs() << "Generating Assembly With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000276 PrintCommand(args);
277 }
278
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000279 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000280}
281
Gabor Greifa99be512007-07-05 17:07:56 +0000282/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000283static int GenerateCFile(const std::string &OutputFile,
284 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000285 const sys::Path &llc,
286 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000287 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000288 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000289 args.push_back(llc.c_str());
290 args.push_back("-march=c");
291 args.push_back("-f");
292 args.push_back("-o");
293 args.push_back(OutputFile.c_str());
294 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000295 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000296
297 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000298 outs() << "Generating C Source With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000299 PrintCommand(args);
300 }
301
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000302 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000303}
304
Devang Patele2f8ad82006-06-27 18:07:29 +0000305/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000306/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000307///
308/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000309/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000310/// OutputFilename - The name of the file to generate.
311/// NativeLinkItems - The native libraries, files, code with which to link
312/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000313/// FrameworksPaths - The list of directories in which to find frameworks.
314/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000315/// gcc - The pathname to use for GGC.
316/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000317///
318/// Outputs:
319/// None.
320///
321/// Returns non-zero value on error.
322///
323static int GenerateNative(const std::string &OutputFilename,
324 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000325 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000326 const sys::Path &gcc, char ** const envp,
327 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000328 // Remove these environment variables from the environment of the
329 // programs that we will execute. It appears that GCC sets these
330 // environment variables so that the programs it uses can configure
331 // themselves identically.
332 //
333 // However, when we invoke GCC below, we want it to use its normal
334 // configuration. Hence, we must sanitize its environment.
335 char ** clean_env = CopyEnv(envp);
336 if (clean_env == NULL)
337 return 1;
338 RemoveEnv("LIBRARY_PATH", clean_env);
339 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
340 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
341 RemoveEnv("COMPILER_PATH", clean_env);
342 RemoveEnv("COLLECT_GCC", clean_env);
343
Reid Spencer445564a2004-11-20 20:02:56 +0000344
345 // Run GCC to assemble and link the program into native code.
346 //
347 // Note:
348 // We can't just assemble and link the file with the system assembler
349 // and linker because we don't know where to put the _start symbol.
350 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000351 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000352 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000353 args.push_back("-fno-strict-aliasing");
354 args.push_back("-O3");
355 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000356 args.push_back(OutputFilename);
357 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000358
Chris Lattner3992f522008-01-27 22:58:59 +0000359 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000360 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000361 args.push_back("-L" + LibPaths[index]);
362 }
363 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
364 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000365 }
366
367 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000368 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000369 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000370
Reid Spencer445564a2004-11-20 20:02:56 +0000371 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000372 for (unsigned index = 0; index < LinkItems.size(); index++)
373 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000374 if (LinkItems[index].second)
375 args.push_back("-l" + LinkItems[index].first);
376 else
377 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000378 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000379
Chris Lattner3992f522008-01-27 22:58:59 +0000380 // Add in frameworks to link.
381 for (unsigned index = 0; index < Frameworks.size(); index++) {
382 args.push_back("-framework");
383 args.push_back(Frameworks[index]);
384 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000385
386 // Now that "args" owns all the std::strings for the arguments, call the c_str
387 // method to get the underlying string array. We do this game so that the
388 // std::string array is guaranteed to outlive the const char* array.
389 std::vector<const char *> Args;
390 for (unsigned i = 0, e = args.size(); i != e; ++i)
391 Args.push_back(args[i].c_str());
392 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000393
Reid Spencer3b726392007-04-29 23:59:47 +0000394 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000395 outs() << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000396 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000397 }
398
Reid Spencer445564a2004-11-20 20:02:56 +0000399 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000400 int R = sys::Program::ExecuteAndWait(
Chris Lattner3f931b82007-06-19 16:46:48 +0000401 gcc, &Args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000402 delete [] clean_env;
403 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000404}
405
Reid Spencerc0af3f02004-09-13 01:27:53 +0000406/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000407/// bitcode file for the program.
Chris Lattner25c54c02010-03-23 21:59:43 +0000408static void EmitShellScript(char **argv, Module *M) {
Reid Spencer3b726392007-04-29 23:59:47 +0000409 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000410 outs() << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000411#if defined(_WIN32) || defined(__CYGWIN__)
412 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
413 // support windows systems, we copy the llvm-stub.exe executable from the
414 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000415 std::string ErrMsg;
Dan Gohman197f7282009-08-05 20:21:17 +0000416 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0],
Dan Gohman8608cf22009-08-05 21:03:39 +0000417 (void *)(intptr_t)&Optimize);
Reid Spencer708585a2007-02-09 03:08:06 +0000418 if (llvmstub.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000419 PrintAndExit("Could not find llvm-stub.exe executable!", M);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000420
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000421 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000422 PrintAndExit(ErrMsg, M);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000423
Reid Spencerc0af3f02004-09-13 01:27:53 +0000424 return;
425#endif
426
427 // Output the script to start the program...
Dan Gohmanac95cc72009-07-16 15:30:09 +0000428 std::string ErrorInfo;
Dan Gohmanbaa26392009-08-25 15:34:52 +0000429 raw_fd_ostream Out2(OutputFilename.c_str(), ErrorInfo);
Dan Gohmanac95cc72009-07-16 15:30:09 +0000430 if (!ErrorInfo.empty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000431 PrintAndExit(ErrorInfo, M);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000432
433 Out2 << "#!/bin/sh\n";
434 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
435 Out2 << "lli=${LLVMINTERP-lli}\n";
436 Out2 << "exec $lli \\\n";
437 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
438 LibPaths.push_back("/lib");
439 LibPaths.push_back("/usr/lib");
440 LibPaths.push_back("/usr/X11R6/lib");
441 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
442 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000443 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000444 std::find(Libraries.begin(), Libraries.end(), "c");
445 if (libc != Libraries.end()) Libraries.erase(libc);
446 // List all the shared object (native) libraries this executable will need
447 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000448 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000449 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000450 // try explicit -L arguments first:
451 sys::Path FullLibraryPath;
452 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
453 E = LibPaths.end(); P != E; ++P) {
454 FullLibraryPath = *P;
455 FullLibraryPath.appendComponent("lib" + *i);
456 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
457 if (!FullLibraryPath.isEmpty()) {
458 if (!FullLibraryPath.isDynamicLibrary()) {
459 // Not a native shared library; mark as invalid
460 FullLibraryPath = sys::Path();
461 } else break;
462 }
463 }
464 if (FullLibraryPath.isEmpty())
465 FullLibraryPath = sys::Path::FindLibrary(*i);
466 if (!FullLibraryPath.isEmpty())
Chris Lattner74382b72009-08-23 22:45:37 +0000467 Out2 << " -load=" << FullLibraryPath.str() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000468 }
Sanjiv Guptad7de7bc2009-07-22 18:41:45 +0000469 Out2 << " " << BitcodeOutputFilename << " ${1+\"$@\"}\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000470}
471
Reid Spencerc4064132004-12-13 03:01:14 +0000472// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
473// linker function by combining the Files and Libraries in the order they were
474// declared on the command line.
475static void BuildLinkItems(
476 Linker::ItemList& Items,
477 const cl::list<std::string>& Files,
478 const cl::list<std::string>& Libraries) {
479
Misha Brukman3da94ae2005-04-22 00:00:37 +0000480 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000481
482 cl::list<std::string>::const_iterator fileIt = Files.begin();
483 cl::list<std::string>::const_iterator libIt = Libraries.begin();
484
485 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000486 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000487 if (libIt != Libraries.end())
488 libPos = Libraries.getPosition(libIt - Libraries.begin());
489 else
490 libPos = -1;
491 if (fileIt != Files.end())
492 filePos = Files.getPosition(fileIt - Files.begin());
493 else
494 filePos = -1;
495
496 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
497 // Add a source file
498 Items.push_back(std::make_pair(*fileIt++, false));
499 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
500 // Add a library
501 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000502 }
503 }
504}
505
Reid Spencerc0af3f02004-09-13 01:27:53 +0000506int main(int argc, char **argv, char **envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000507 // Print a stack trace if we signal out.
508 sys::PrintStackTraceOnErrorSignal();
509 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000510
Owen Anderson0d7c6952009-07-15 22:16:10 +0000511 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +0000512 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattner316e3262009-10-22 00:52:28 +0000513
514 // Initial global variable above for convenience printing of program name.
515 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000516
Chris Lattner316e3262009-10-22 00:52:28 +0000517 // Parse the command line options
518 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000519
Chris Lattner316e3262009-10-22 00:52:28 +0000520 // Construct a Linker (now that Verbose is set)
521 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000522
Chris Lattner316e3262009-10-22 00:52:28 +0000523 // Keep track of the native link items (versus the bitcode items)
524 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000525
Chris Lattner316e3262009-10-22 00:52:28 +0000526 // Add library paths to the linker
527 TheLinker.addPaths(LibPaths);
528 TheLinker.addSystemPaths();
Reid Spencer78df5c32006-03-06 06:38:19 +0000529
Chris Lattner316e3262009-10-22 00:52:28 +0000530 // Remove any consecutive duplicates of the same library...
531 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
532 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000533
Chris Lattner316e3262009-10-22 00:52:28 +0000534 if (LinkAsLibrary) {
535 std::vector<sys::Path> Files;
536 for (unsigned i = 0; i < InputFilenames.size(); ++i )
537 Files.push_back(sys::Path(InputFilenames[i]));
538 if (TheLinker.LinkInFiles(Files))
539 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000540
Chris Lattner316e3262009-10-22 00:52:28 +0000541 // The libraries aren't linked in but are noted as "dependent" in the
542 // module.
543 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
544 E = Libraries.end(); I != E ; ++I) {
545 TheLinker.getModule()->addLibrary(*I);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000546 }
Chris Lattner316e3262009-10-22 00:52:28 +0000547 } else {
548 // Build a list of the items from our command line
549 Linker::ItemList Items;
550 BuildLinkItems(Items, InputFilenames, Libraries);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000551
Chris Lattner316e3262009-10-22 00:52:28 +0000552 // Link all the items together
553 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
554 return 1; // Error already printed
555 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000556
Chris Lattner316e3262009-10-22 00:52:28 +0000557 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
558
559 // Optimize the module
560 Optimize(Composite.get());
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000561
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000562#if defined(_WIN32) || defined(__CYGWIN__)
Chris Lattner316e3262009-10-22 00:52:28 +0000563 if (!LinkAsLibrary) {
564 // Default to "a.exe" instead of "a.out".
565 if (OutputFilename.getNumOccurrences() == 0)
566 OutputFilename = "a.exe";
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000567
Chris Lattner316e3262009-10-22 00:52:28 +0000568 // If there is no suffix add an "exe" one.
569 sys::Path ExeFile( OutputFilename );
570 if (ExeFile.getSuffix() == "") {
571 ExeFile.appendSuffix("exe");
572 OutputFilename = ExeFile.str();
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000573 }
Chris Lattner316e3262009-10-22 00:52:28 +0000574 }
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000575#endif
576
Chris Lattner316e3262009-10-22 00:52:28 +0000577 // Generate the bitcode for the optimized module.
578 // If -b wasn't specified, use the name specified
579 // with -o to construct BitcodeOutputFilename.
580 if (BitcodeOutputFilename.empty()) {
581 BitcodeOutputFilename = OutputFilename;
582 if (!LinkAsLibrary) BitcodeOutputFilename += ".bc";
583 }
Argyrios Kyrtzidis5b90a722008-06-15 12:01:16 +0000584
Chris Lattner316e3262009-10-22 00:52:28 +0000585 GenerateBitcode(Composite.get(), BitcodeOutputFilename);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000586
Chris Lattner316e3262009-10-22 00:52:28 +0000587 // If we are not linking a library, generate either a native executable
588 // or a JIT shell script, depending upon what the user wants.
589 if (!LinkAsLibrary) {
590 // If the user wants to run a post-link optimization, run it now.
591 if (!PostLinkOpts.empty()) {
592 std::vector<std::string> opts = PostLinkOpts;
593 for (std::vector<std::string>::iterator I = opts.begin(),
594 E = opts.end(); I != E; ++I) {
595 sys::Path prog(*I);
596 if (!prog.canExecute()) {
597 prog = sys::Program::FindProgramByName(*I);
598 if (prog.isEmpty())
599 PrintAndExit(std::string("Optimization program '") + *I +
Chris Lattner25c54c02010-03-23 21:59:43 +0000600 "' is not found or not executable.", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000601 }
602 // Get the program arguments
603 sys::Path tmp_output("opt_result");
604 std::string ErrMsg;
605 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000606 PrintAndExit(ErrMsg, Composite.get());
Reid Spencer708585a2007-02-09 03:08:06 +0000607
Chris Lattner316e3262009-10-22 00:52:28 +0000608 const char* args[4];
609 args[0] = I->c_str();
610 args[1] = BitcodeOutputFilename.c_str();
611 args[2] = tmp_output.c_str();
612 args[3] = 0;
613 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
614 if (tmp_output.isBitcodeFile() || tmp_output.isBitcodeFile()) {
615 sys::Path target(BitcodeOutputFilename);
616 target.eraseFromDisk();
617 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000618 PrintAndExit(ErrMsg, Composite.get(), 2);
Chris Lattner316e3262009-10-22 00:52:28 +0000619 } else
Chris Lattner25c54c02010-03-23 21:59:43 +0000620 PrintAndExit("Post-link optimization output is not bitcode",
621 Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000622 } else {
Chris Lattner25c54c02010-03-23 21:59:43 +0000623 PrintAndExit(ErrMsg, Composite.get());
Reid Spencer73a74be2005-12-21 05:03:23 +0000624 }
625 }
Reid Spencer708585a2007-02-09 03:08:06 +0000626 }
Chris Lattner316e3262009-10-22 00:52:28 +0000627
628 // If the user wants to generate a native executable, compile it from the
629 // bitcode file.
630 //
631 // Otherwise, create a script that will run the bitcode through the JIT.
632 if (Native) {
633 // Name of the Assembly Language output file
634 sys::Path AssemblyFile ( OutputFilename);
635 AssemblyFile.appendSuffix("s");
636
637 // Mark the output files for removal if we get an interrupt.
638 sys::RemoveFileOnSignal(AssemblyFile);
639 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
640
641 // Determine the locations of the llc and gcc programs.
642 sys::Path llc = FindExecutable("llc", argv[0],
643 (void *)(intptr_t)&Optimize);
644 if (llc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000645 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000646
647 sys::Path gcc = sys::Program::FindProgramByName("gcc");
648 if (gcc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000649 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000650
651 // Generate an assembly language file for the bitcode.
652 std::string ErrMsg;
653 if (0 != GenerateAssembly(AssemblyFile.str(), BitcodeOutputFilename,
654 llc, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000655 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000656
657 if (0 != GenerateNative(OutputFilename, AssemblyFile.str(),
658 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000659 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000660
661 // Remove the assembly language file.
662 AssemblyFile.eraseFromDisk();
663 } else if (NativeCBE) {
664 sys::Path CFile (OutputFilename);
665 CFile.appendSuffix("cbe.c");
666
667 // Mark the output files for removal if we get an interrupt.
668 sys::RemoveFileOnSignal(CFile);
669 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
670
671 // Determine the locations of the llc and gcc programs.
672 sys::Path llc = FindExecutable("llc", argv[0],
673 (void *)(intptr_t)&Optimize);
674 if (llc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000675 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000676
677 sys::Path gcc = sys::Program::FindProgramByName("gcc");
678 if (gcc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000679 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000680
681 // Generate an assembly language file for the bitcode.
682 std::string ErrMsg;
683 if (GenerateCFile(CFile.str(), BitcodeOutputFilename, llc, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000684 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000685
686 if (GenerateNative(OutputFilename, CFile.str(),
687 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000688 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000689
690 // Remove the assembly language file.
691 CFile.eraseFromDisk();
692
693 } else {
Chris Lattner25c54c02010-03-23 21:59:43 +0000694 EmitShellScript(argv, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000695 }
696
697 // Make the script executable...
698 std::string ErrMsg;
699 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000700 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000701
702 // Make the bitcode file readable and directly executable in LLEE as well
703 if (sys::Path(BitcodeOutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000704 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000705
706 if (sys::Path(BitcodeOutputFilename).makeReadableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000707 PrintAndExit(ErrMsg, Composite.get());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000708 }
Reid Spencer708585a2007-02-09 03:08:06 +0000709
710 // Graceful exit
711 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000712}