blob: a4bd1108375925b3b7f647cfdddafedb4fcfa9dc [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
Reid Spencerc0af3f02004-09-13 01:27:53 +000015// the a.out.bc file generated by this program. Also, Force is on by default.
16//
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"
33#include "llvm/Support/FileUtilities.h"
Chris Lattnerc30598b2006-12-06 01:18:01 +000034#include "llvm/Support/ManagedStatic.h"
Chris Lattnerbb3f3d32007-05-06 05:56:58 +000035#include "llvm/Support/MemoryBuffer.h"
Chris Lattnercc14d252009-03-06 05:34:10 +000036#include "llvm/Support/PrettyStackTrace.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000037#include "llvm/Support/SystemUtils.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
Reid Spencer445564a2004-11-20 20:02:56 +000044// Input/Output Options
45static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
Gabor Greifa99be512007-07-05 17:07:56 +000046 cl::desc("<input bitcode files>"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000047
Reid Spencer445564a2004-11-20 20:02:56 +000048static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
Misha Brukman3da94ae2005-04-22 00:00:37 +000049 cl::desc("Override output filename"),
Reid Spencer445564a2004-11-20 20:02:56 +000050 cl::value_desc("filename"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000051
Misha Brukman3da94ae2005-04-22 00:00:37 +000052static cl::opt<bool> Verbose("v",
Reid Spencer445564a2004-11-20 20:02:56 +000053 cl::desc("Print information about actions taken"));
Misha Brukman3da94ae2005-04-22 00:00:37 +000054
Reid Spencer445564a2004-11-20 20:02:56 +000055static cl::list<std::string> LibPaths("L", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000056 cl::desc("Specify a library search path"),
Reid Spencer445564a2004-11-20 20:02:56 +000057 cl::value_desc("directory"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000058
Chris Lattner3992f522008-01-27 22:58:59 +000059static cl::list<std::string> FrameworkPaths("F", cl::Prefix,
60 cl::desc("Specify a framework search path"),
61 cl::value_desc("directory"));
62
Reid Spencer445564a2004-11-20 20:02:56 +000063static cl::list<std::string> Libraries("l", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000064 cl::desc("Specify libraries to link to"),
Reid Spencer445564a2004-11-20 20:02:56 +000065 cl::value_desc("library prefix"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000066
Chris Lattner3992f522008-01-27 22:58:59 +000067static cl::list<std::string> Frameworks("framework",
68 cl::desc("Specify frameworks to link to"),
69 cl::value_desc("framework"));
70
Reid Spencer708585a2007-02-09 03:08:06 +000071// Options to control the linking, optimization, and code gen processes
Misha Brukman3da94ae2005-04-22 00:00:37 +000072static cl::opt<bool> LinkAsLibrary("link-as-library",
Reid Spencer445564a2004-11-20 20:02:56 +000073 cl::desc("Link the .bc files together as a library, not an executable"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000074
Reid Spencer445564a2004-11-20 20:02:56 +000075static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
76 cl::desc("Alias for -link-as-library"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000077
Reid Spencer445564a2004-11-20 20:02:56 +000078static cl::opt<bool> Native("native",
79 cl::desc("Generate a native binary instead of a shell script"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000080
Reid Spencer445564a2004-11-20 20:02:56 +000081static cl::opt<bool>NativeCBE("native-cbe",
82 cl::desc("Generate a native binary with the C backend and GCC"));
83
Reid Spencer73a74be2005-12-21 05:03:23 +000084static cl::list<std::string> PostLinkOpts("post-link-opts",
Reid Spenceraf303d52006-06-07 23:03:13 +000085 cl::value_desc("path"),
Reid Spencer73a74be2005-12-21 05:03:23 +000086 cl::desc("Run one or more optimization programs after linking"));
87
Reid Spenceraf303d52006-06-07 23:03:13 +000088static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
89 cl::desc("Pass options to the system linker"));
90
Reid Spencer708585a2007-02-09 03:08:06 +000091// Compatibility options that llvm-ld ignores but are supported for
92// compatibility with LD
Misha Brukman3da94ae2005-04-22 00:00:37 +000093static cl::opt<std::string> CO3("soname", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +000094 cl::desc("Compatibility option: ignored"));
95
Misha Brukman3da94ae2005-04-22 00:00:37 +000096static cl::opt<std::string> CO4("version-script", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +000097 cl::desc("Compatibility option: ignored"));
98
Misha Brukman3da94ae2005-04-22 00:00:37 +000099static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000100 cl::desc("Compatibility option: ignored"));
101
Misha Brukman3da94ae2005-04-22 00:00:37 +0000102static cl::opt<std::string> CO6("h", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000103 cl::desc("Compatibility option: ignored"));
104
Reid Spencer98a030c2007-02-08 19:03:11 +0000105static cl::opt<bool> CO7("start-group", cl::Hidden,
106 cl::desc("Compatibility option: ignored"));
107
108static cl::opt<bool> CO8("end-group", cl::Hidden,
109 cl::desc("Compatibility option: ignored"));
Reid Spenceraf303d52006-06-07 23:03:13 +0000110
Andrew Lenharth0c6ba442008-11-19 17:00:08 +0000111static cl::opt<std::string> CO9("m", cl::Hidden,
112 cl::desc("Compatibility option: ignored"));
113
Reid Spencer445564a2004-11-20 20:02:56 +0000114/// This is just for convenience so it doesn't have to be passed around
115/// everywhere.
Reid Spencerc4064132004-12-13 03:01:14 +0000116static std::string progname;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000117
Reid Spencer708585a2007-02-09 03:08:06 +0000118/// PrintAndExit - Prints a message to standard error and exits with error code
Reid Spencerc0af3f02004-09-13 01:27:53 +0000119///
120/// Inputs:
Reid Spencerc0af3f02004-09-13 01:27:53 +0000121/// Message - The message to print to standard error.
122///
Reid Spencer708585a2007-02-09 03:08:06 +0000123static void PrintAndExit(const std::string &Message, int errcode = 1) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000124 errs() << progname << ": " << Message << "\n";
Reid Spencer708585a2007-02-09 03:08:06 +0000125 llvm_shutdown();
126 exit(errcode);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000127}
128
Reid Spencer3b726392007-04-29 23:59:47 +0000129static void PrintCommand(const std::vector<const char*> &args) {
130 std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
131 for (; I != E; ++I)
132 if (*I)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000133 outs() << "'" << *I << "'" << " ";
134 outs() << "\n"; outs().flush();
Reid Spencer3b726392007-04-29 23:59:47 +0000135}
136
Reid Spencer445564a2004-11-20 20:02:56 +0000137/// CopyEnv - This function takes an array of environment variables and makes a
138/// copy of it. This copy can then be manipulated any way the caller likes
139/// without affecting the process's real environment.
140///
141/// Inputs:
142/// envp - An array of C strings containing an environment.
143///
144/// Return value:
145/// NULL - An error occurred.
146///
147/// Otherwise, a pointer to a new array of C strings is returned. Every string
148/// in the array is a duplicate of the one in the original array (i.e. we do
149/// not copy the char *'s from one array to another).
150///
151static char ** CopyEnv(char ** const envp) {
152 // Count the number of entries in the old list;
153 unsigned entries; // The number of entries in the old environment list
154 for (entries = 0; envp[entries] != NULL; entries++)
155 /*empty*/;
156
157 // Add one more entry for the NULL pointer that ends the list.
158 ++entries;
159
160 // If there are no entries at all, just return NULL.
161 if (entries == 0)
162 return NULL;
163
164 // Allocate a new environment list.
165 char **newenv = new char* [entries];
166 if ((newenv = new char* [entries]) == NULL)
167 return NULL;
168
169 // Make a copy of the list. Don't forget the NULL that ends the list.
170 entries = 0;
171 while (envp[entries] != NULL) {
172 newenv[entries] = new char[strlen (envp[entries]) + 1];
173 strcpy (newenv[entries], envp[entries]);
174 ++entries;
175 }
176 newenv[entries] = NULL;
177
178 return newenv;
179}
180
181
182/// RemoveEnv - Remove the specified environment variable from the environment
183/// array.
184///
185/// Inputs:
186/// name - The name of the variable to remove. It cannot be NULL.
187/// envp - The array of environment variables. It cannot be NULL.
188///
189/// Notes:
190/// This is mainly done because functions to remove items from the environment
191/// are not available across all platforms. In particular, Solaris does not
192/// seem to have an unsetenv() function or a setenv() function (or they are
193/// undocumented if they do exist).
194///
195static void RemoveEnv(const char * name, char ** const envp) {
196 for (unsigned index=0; envp[index] != NULL; index++) {
197 // Find the first equals sign in the array and make it an EOS character.
198 char *p = strchr (envp[index], '=');
199 if (p == NULL)
200 continue;
201 else
202 *p = '\0';
203
204 // Compare the two strings. If they are equal, zap this string.
205 // Otherwise, restore it.
206 if (!strcmp(name, envp[index]))
207 *envp[index] = '\0';
208 else
209 *p = '=';
210 }
211
212 return;
213}
214
Gabor Greifa99be512007-07-05 17:07:56 +0000215/// GenerateBitcode - generates a bitcode file from the module provided
216void GenerateBitcode(Module* M, const std::string& FileName) {
Reid Spencer445564a2004-11-20 20:02:56 +0000217
Reid Spencer3b726392007-04-29 23:59:47 +0000218 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000219 outs() << "Generating Bitcode To " << FileName << '\n';
Reid Spencer3b726392007-04-29 23:59:47 +0000220
Reid Spencer445564a2004-11-20 20:02:56 +0000221 // Create the output file.
Dan Gohmanac95cc72009-07-16 15:30:09 +0000222 std::string ErrorInfo;
223 raw_fd_ostream Out(FileName.c_str(), /*Binary=*/true, /*Force=*/true,
224 ErrorInfo);
225 if (!ErrorInfo.empty())
226 PrintAndExit(ErrorInfo);
Reid Spencer445564a2004-11-20 20:02:56 +0000227
Gabor Greifa99be512007-07-05 17:07:56 +0000228 // Ensure that the bitcode file gets removed from the disk if we get a
Reid Spencer445564a2004-11-20 20:02:56 +0000229 // terminating signal.
230 sys::RemoveFileOnSignal(sys::Path(FileName));
231
232 // Write it out
Chris Lattner44dadff2007-05-06 09:29:57 +0000233 WriteBitcodeToFile(M, Out);
Reid Spencer445564a2004-11-20 20:02:56 +0000234
Gabor Greifa99be512007-07-05 17:07:56 +0000235 // Close the bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000236 Out.close();
237}
238
239/// GenerateAssembly - generates a native assembly language source file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000240/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000241///
242/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000243/// InputFilename - The name of the input bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000244/// OutputFilename - The name of the file to generate.
245/// llc - The pathname to use for LLC.
246/// envp - The environment to use when running LLC.
247///
248/// Return non-zero value on error.
249///
250static int GenerateAssembly(const std::string &OutputFilename,
251 const std::string &InputFilename,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000252 const sys::Path &llc,
253 std::string &ErrMsg ) {
Gabor Greifa99be512007-07-05 17:07:56 +0000254 // Run LLC to convert the bitcode file into assembly code.
Reid Spencerf6358c72004-12-19 18:00:56 +0000255 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000256 args.push_back(llc.c_str());
Argyrios Kyrtzidisca29dff2008-06-27 15:08:59 +0000257 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
258 // regardless of what the target in the bitcode file is.
259 args.push_back("-x86-asm-syntax=att");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000260 args.push_back("-f");
261 args.push_back("-o");
262 args.push_back(OutputFilename.c_str());
263 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000264 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000265
Reid Spencer3b726392007-04-29 23:59:47 +0000266 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000267 outs() << "Generating Assembly With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000268 PrintCommand(args);
269 }
270
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000271 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000272}
273
Gabor Greifa99be512007-07-05 17:07:56 +0000274/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000275static int GenerateCFile(const std::string &OutputFile,
276 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000277 const sys::Path &llc,
278 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000279 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000280 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000281 args.push_back(llc.c_str());
282 args.push_back("-march=c");
283 args.push_back("-f");
284 args.push_back("-o");
285 args.push_back(OutputFile.c_str());
286 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000287 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000288
289 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000290 outs() << "Generating C Source With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000291 PrintCommand(args);
292 }
293
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000294 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000295}
296
Devang Patele2f8ad82006-06-27 18:07:29 +0000297/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000298/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000299///
300/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000301/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000302/// OutputFilename - The name of the file to generate.
303/// NativeLinkItems - The native libraries, files, code with which to link
304/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000305/// FrameworksPaths - The list of directories in which to find frameworks.
306/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000307/// gcc - The pathname to use for GGC.
308/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000309///
310/// Outputs:
311/// None.
312///
313/// Returns non-zero value on error.
314///
315static int GenerateNative(const std::string &OutputFilename,
316 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000317 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000318 const sys::Path &gcc, char ** const envp,
319 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000320 // Remove these environment variables from the environment of the
321 // programs that we will execute. It appears that GCC sets these
322 // environment variables so that the programs it uses can configure
323 // themselves identically.
324 //
325 // However, when we invoke GCC below, we want it to use its normal
326 // configuration. Hence, we must sanitize its environment.
327 char ** clean_env = CopyEnv(envp);
328 if (clean_env == NULL)
329 return 1;
330 RemoveEnv("LIBRARY_PATH", clean_env);
331 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
332 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
333 RemoveEnv("COMPILER_PATH", clean_env);
334 RemoveEnv("COLLECT_GCC", clean_env);
335
Reid Spencer445564a2004-11-20 20:02:56 +0000336
337 // Run GCC to assemble and link the program into native code.
338 //
339 // Note:
340 // We can't just assemble and link the file with the system assembler
341 // and linker because we don't know where to put the _start symbol.
342 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000343 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000344 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000345 args.push_back("-fno-strict-aliasing");
346 args.push_back("-O3");
347 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000348 args.push_back(OutputFilename);
349 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000350
Chris Lattner3992f522008-01-27 22:58:59 +0000351 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000352 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000353 args.push_back("-L" + LibPaths[index]);
354 }
355 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
356 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000357 }
358
359 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000360 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000361 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000362
Reid Spencer445564a2004-11-20 20:02:56 +0000363 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000364 for (unsigned index = 0; index < LinkItems.size(); index++)
365 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000366 if (LinkItems[index].second)
367 args.push_back("-l" + LinkItems[index].first);
368 else
369 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000370 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000371
Chris Lattner3992f522008-01-27 22:58:59 +0000372 // Add in frameworks to link.
373 for (unsigned index = 0; index < Frameworks.size(); index++) {
374 args.push_back("-framework");
375 args.push_back(Frameworks[index]);
376 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000377
378 // Now that "args" owns all the std::strings for the arguments, call the c_str
379 // method to get the underlying string array. We do this game so that the
380 // std::string array is guaranteed to outlive the const char* array.
381 std::vector<const char *> Args;
382 for (unsigned i = 0, e = args.size(); i != e; ++i)
383 Args.push_back(args[i].c_str());
384 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000385
Reid Spencer3b726392007-04-29 23:59:47 +0000386 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000387 outs() << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000388 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000389 }
390
Reid Spencer445564a2004-11-20 20:02:56 +0000391 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000392 int R = sys::Program::ExecuteAndWait(
Chris Lattner3f931b82007-06-19 16:46:48 +0000393 gcc, &Args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000394 delete [] clean_env;
395 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000396}
397
Reid Spencerc0af3f02004-09-13 01:27:53 +0000398/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000399/// bitcode file for the program.
Reid Spencerc0af3f02004-09-13 01:27:53 +0000400static void EmitShellScript(char **argv) {
Reid Spencer3b726392007-04-29 23:59:47 +0000401 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000402 outs() << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000403#if defined(_WIN32) || defined(__CYGWIN__)
404 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
405 // support windows systems, we copy the llvm-stub.exe executable from the
406 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000407 std::string ErrMsg;
Reid Spencer8d8b41d2004-12-22 13:50:17 +0000408 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
Reid Spencer708585a2007-02-09 03:08:06 +0000409 if (llvmstub.isEmpty())
410 PrintAndExit("Could not find llvm-stub.exe executable!");
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000411
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000412 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000413 PrintAndExit(ErrMsg);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000414
Reid Spencerc0af3f02004-09-13 01:27:53 +0000415 return;
416#endif
417
418 // Output the script to start the program...
Dan Gohmanac95cc72009-07-16 15:30:09 +0000419 std::string ErrorInfo;
420 raw_fd_ostream Out2(OutputFilename.c_str(), /*Binary=*/false, /*Force=*/true,
421 ErrorInfo);
422 if (!ErrorInfo.empty())
423 PrintAndExit(ErrorInfo);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000424
425 Out2 << "#!/bin/sh\n";
426 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
427 Out2 << "lli=${LLVMINTERP-lli}\n";
428 Out2 << "exec $lli \\\n";
429 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
430 LibPaths.push_back("/lib");
431 LibPaths.push_back("/usr/lib");
432 LibPaths.push_back("/usr/X11R6/lib");
433 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
434 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000435 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000436 std::find(Libraries.begin(), Libraries.end(), "c");
437 if (libc != Libraries.end()) Libraries.erase(libc);
438 // List all the shared object (native) libraries this executable will need
439 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000440 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000441 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000442 // try explicit -L arguments first:
443 sys::Path FullLibraryPath;
444 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
445 E = LibPaths.end(); P != E; ++P) {
446 FullLibraryPath = *P;
447 FullLibraryPath.appendComponent("lib" + *i);
448 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
449 if (!FullLibraryPath.isEmpty()) {
450 if (!FullLibraryPath.isDynamicLibrary()) {
451 // Not a native shared library; mark as invalid
452 FullLibraryPath = sys::Path();
453 } else break;
454 }
455 }
456 if (FullLibraryPath.isEmpty())
457 FullLibraryPath = sys::Path::FindLibrary(*i);
458 if (!FullLibraryPath.isEmpty())
Reid Spencerc4064132004-12-13 03:01:14 +0000459 Out2 << " -load=" << FullLibraryPath.toString() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000460 }
461 Out2 << " $0.bc ${1+\"$@\"}\n";
462 Out2.close();
463}
464
Reid Spencerc4064132004-12-13 03:01:14 +0000465// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
466// linker function by combining the Files and Libraries in the order they were
467// declared on the command line.
468static void BuildLinkItems(
469 Linker::ItemList& Items,
470 const cl::list<std::string>& Files,
471 const cl::list<std::string>& Libraries) {
472
Misha Brukman3da94ae2005-04-22 00:00:37 +0000473 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000474
475 cl::list<std::string>::const_iterator fileIt = Files.begin();
476 cl::list<std::string>::const_iterator libIt = Libraries.begin();
477
478 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000479 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000480 if (libIt != Libraries.end())
481 libPos = Libraries.getPosition(libIt - Libraries.begin());
482 else
483 libPos = -1;
484 if (fileIt != Files.end())
485 filePos = Files.getPosition(fileIt - Files.begin());
486 else
487 filePos = -1;
488
489 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
490 // Add a source file
491 Items.push_back(std::make_pair(*fileIt++, false));
492 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
493 // Add a library
494 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000495 }
496 }
497}
498
Reid Spencer445564a2004-11-20 20:02:56 +0000499// Rightly this should go in a header file but it just seems such a waste.
500namespace llvm {
501extern void Optimize(Module*);
502}
503
Reid Spencerc0af3f02004-09-13 01:27:53 +0000504int main(int argc, char **argv, char **envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000505 // Print a stack trace if we signal out.
506 sys::PrintStackTraceOnErrorSignal();
507 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000508
Owen Anderson0d7c6952009-07-15 22:16:10 +0000509 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +0000510 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000511 try {
512 // Initial global variable above for convenience printing of program name.
513 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000514
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000515 // Parse the command line options
Dan Gohman82a13c92007-10-08 15:45:12 +0000516 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000517
Reid Spencer49521432006-11-11 11:54:25 +0000518 // Construct a Linker (now that Verbose is set)
Owen Anderson31895e72009-07-01 21:22:36 +0000519 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000520
Gabor Greifa99be512007-07-05 17:07:56 +0000521 // Keep track of the native link items (versus the bitcode items)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000522 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000523
524 // Add library paths to the linker
Reid Spencer78df5c32006-03-06 06:38:19 +0000525 TheLinker.addPaths(LibPaths);
526 TheLinker.addSystemPaths();
527
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000528 // Remove any consecutive duplicates of the same library...
529 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
530 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000531
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000532 if (LinkAsLibrary) {
533 std::vector<sys::Path> Files;
534 for (unsigned i = 0; i < InputFilenames.size(); ++i )
535 Files.push_back(sys::Path(InputFilenames[i]));
536 if (TheLinker.LinkInFiles(Files))
537 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000538
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000539 // The libraries aren't linked in but are noted as "dependent" in the
540 // module.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000541 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000542 E = Libraries.end(); I != E ; ++I) {
543 TheLinker.getModule()->addLibrary(*I);
544 }
Reid Spencerc0af3f02004-09-13 01:27:53 +0000545 } else {
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000546 // Build a list of the items from our command line
547 Linker::ItemList Items;
548 BuildLinkItems(Items, InputFilenames, Libraries);
549
550 // Link all the items together
Reid Spencerc82a5da2007-04-04 06:34:22 +0000551 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
Reid Spencer708585a2007-02-09 03:08:06 +0000552 return 1; // Error already printed
Reid Spencerc0af3f02004-09-13 01:27:53 +0000553 }
Reid Spencerc0af3f02004-09-13 01:27:53 +0000554
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000555 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
556
557 // Optimize the module
558 Optimize(Composite.get());
559
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000560#if defined(_WIN32) || defined(__CYGWIN__)
561 if (!LinkAsLibrary) {
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000562 // Default to "a.exe" instead of "a.out".
563 if (OutputFilename.getNumOccurrences() == 0)
564 OutputFilename = "a.exe";
565
566 // If there is no suffix add an "exe" one.
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000567 sys::Path ExeFile( OutputFilename );
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000568 if (ExeFile.getSuffix() == "") {
569 ExeFile.appendSuffix("exe");
570 OutputFilename = ExeFile.toString();
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000571 }
572 }
573#endif
574
Gabor Greifa99be512007-07-05 17:07:56 +0000575 // Generate the bitcode for the optimized module.
576 std::string RealBitcodeOutput = OutputFilename;
Argyrios Kyrtzidis5b90a722008-06-15 12:01:16 +0000577
Gabor Greifa99be512007-07-05 17:07:56 +0000578 if (!LinkAsLibrary) RealBitcodeOutput += ".bc";
579 GenerateBitcode(Composite.get(), RealBitcodeOutput);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000580
581 // If we are not linking a library, generate either a native executable
582 // or a JIT shell script, depending upon what the user wants.
583 if (!LinkAsLibrary) {
Reid Spencer73a74be2005-12-21 05:03:23 +0000584 // If the user wants to run a post-link optimization, run it now.
585 if (!PostLinkOpts.empty()) {
586 std::vector<std::string> opts = PostLinkOpts;
587 for (std::vector<std::string>::iterator I = opts.begin(),
588 E = opts.end(); I != E; ++I) {
589 sys::Path prog(*I);
590 if (!prog.canExecute()) {
591 prog = sys::Program::FindProgramByName(*I);
592 if (prog.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000593 PrintAndExit(std::string("Optimization program '") + *I +
Reid Spencer73a74be2005-12-21 05:03:23 +0000594 "' is not found or not executable.");
595 }
596 // Get the program arguments
597 sys::Path tmp_output("opt_result");
Reid Spencere5c9cb52006-08-23 00:39:35 +0000598 std::string ErrMsg;
Reid Spencer708585a2007-02-09 03:08:06 +0000599 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
600 PrintAndExit(ErrMsg);
601
Reid Spencer73a74be2005-12-21 05:03:23 +0000602 const char* args[4];
603 args[0] = I->c_str();
Gabor Greifa99be512007-07-05 17:07:56 +0000604 args[1] = RealBitcodeOutput.c_str();
Reid Spencer73a74be2005-12-21 05:03:23 +0000605 args[2] = tmp_output.c_str();
606 args[3] = 0;
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000607 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
Gabor Greifa99be512007-07-05 17:07:56 +0000608 if (tmp_output.isBitcodeFile() || tmp_output.isBitcodeFile()) {
609 sys::Path target(RealBitcodeOutput);
Reid Spencer73a74be2005-12-21 05:03:23 +0000610 target.eraseFromDisk();
Reid Spencer708585a2007-02-09 03:08:06 +0000611 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
612 PrintAndExit(ErrMsg, 2);
Reid Spencer73a74be2005-12-21 05:03:23 +0000613 } else
Gabor Greifa99be512007-07-05 17:07:56 +0000614 PrintAndExit("Post-link optimization output is not bitcode");
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000615 } else {
Reid Spencer708585a2007-02-09 03:08:06 +0000616 PrintAndExit(ErrMsg);
Reid Spencer73a74be2005-12-21 05:03:23 +0000617 }
618 }
619 }
620
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000621 // If the user wants to generate a native executable, compile it from the
Gabor Greifa99be512007-07-05 17:07:56 +0000622 // bitcode file.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000623 //
Gabor Greifa99be512007-07-05 17:07:56 +0000624 // Otherwise, create a script that will run the bitcode through the JIT.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000625 if (Native) {
626 // Name of the Assembly Language output file
627 sys::Path AssemblyFile ( OutputFilename);
628 AssemblyFile.appendSuffix("s");
629
630 // Mark the output files for removal if we get an interrupt.
631 sys::RemoveFileOnSignal(AssemblyFile);
632 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
633
634 // Determine the locations of the llc and gcc programs.
635 sys::Path llc = FindExecutable("llc", argv[0]);
636 if (llc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000637 PrintAndExit("Failed to find llc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000638
639 sys::Path gcc = FindExecutable("gcc", argv[0]);
640 if (gcc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000641 PrintAndExit("Failed to find gcc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000642
Gabor Greifa99be512007-07-05 17:07:56 +0000643 // Generate an assembly language file for the bitcode.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000644 std::string ErrMsg;
Gabor Greifa99be512007-07-05 17:07:56 +0000645 if (0 != GenerateAssembly(AssemblyFile.toString(), RealBitcodeOutput,
Reid Spencer708585a2007-02-09 03:08:06 +0000646 llc, ErrMsg))
647 PrintAndExit(ErrMsg);
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000648
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000649 if (0 != GenerateNative(OutputFilename, AssemblyFile.toString(),
Reid Spencerc82a5da2007-04-04 06:34:22 +0000650 NativeLinkItems, gcc, envp, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000651 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000652
653 // Remove the assembly language file.
Reid Spencera229c5c2005-07-08 03:08:58 +0000654 AssemblyFile.eraseFromDisk();
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000655 } else if (NativeCBE) {
656 sys::Path CFile (OutputFilename);
657 CFile.appendSuffix("cbe.c");
658
659 // Mark the output files for removal if we get an interrupt.
660 sys::RemoveFileOnSignal(CFile);
661 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
662
663 // Determine the locations of the llc and gcc programs.
664 sys::Path llc = FindExecutable("llc", argv[0]);
665 if (llc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000666 PrintAndExit("Failed to find llc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000667
668 sys::Path gcc = FindExecutable("gcc", argv[0]);
669 if (gcc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000670 PrintAndExit("Failed to find gcc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000671
Gabor Greifa99be512007-07-05 17:07:56 +0000672 // Generate an assembly language file for the bitcode.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000673 std::string ErrMsg;
674 if (0 != GenerateCFile(
Gabor Greifa99be512007-07-05 17:07:56 +0000675 CFile.toString(), RealBitcodeOutput, llc, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000676 PrintAndExit(ErrMsg);
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000677
Reid Spencerc82a5da2007-04-04 06:34:22 +0000678 if (0 != GenerateNative(OutputFilename, CFile.toString(),
679 NativeLinkItems, gcc, envp, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000680 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000681
682 // Remove the assembly language file.
Reid Spencera229c5c2005-07-08 03:08:58 +0000683 CFile.eraseFromDisk();
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000684
685 } else {
686 EmitShellScript(argv);
687 }
Misha Brukman3da94ae2005-04-22 00:00:37 +0000688
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000689 // Make the script executable...
Reid Spencere1647f42006-08-22 23:27:23 +0000690 std::string ErrMsg;
Reid Spencer708585a2007-02-09 03:08:06 +0000691 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
692 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000693
Gabor Greifa99be512007-07-05 17:07:56 +0000694 // Make the bitcode file readable and directly executable in LLEE as well
695 if (sys::Path(RealBitcodeOutput).makeExecutableOnDisk(&ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000696 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000697
Gabor Greifa99be512007-07-05 17:07:56 +0000698 if (sys::Path(RealBitcodeOutput).makeReadableOnDisk(&ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000699 PrintAndExit(ErrMsg);
700 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000701 } catch (const std::string& msg) {
Reid Spencer708585a2007-02-09 03:08:06 +0000702 PrintAndExit(msg,2);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000703 } catch (...) {
Reid Spencer708585a2007-02-09 03:08:06 +0000704 PrintAndExit("Unexpected unknown exception occurred.", 2);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000705 }
Reid Spencer708585a2007-02-09 03:08:06 +0000706
707 // Graceful exit
708 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000709}