blob: 118f6b720c6e9c466215f2101604bfa3a3e9929b [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"
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"
Chris Lattner74382b72009-08-23 22:45:37 +000038#include "llvm/Support/raw_ostream.h"
Reid Spencer445564a2004-11-20 20:02:56 +000039#include "llvm/System/Signals.h"
Chris Lattner5d5a8972009-01-05 19:01:32 +000040#include "llvm/Config/config.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000041#include <memory>
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000042#include <cstring>
Reid Spencerc0af3f02004-09-13 01:27:53 +000043using namespace llvm;
44
Dan Gohman197f7282009-08-05 20:21:17 +000045// Rightly this should go in a header file but it just seems such a waste.
46namespace llvm {
47extern void Optimize(Module*);
48}
49
Reid Spencer445564a2004-11-20 20:02:56 +000050// Input/Output Options
51static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
Gabor Greifa99be512007-07-05 17:07:56 +000052 cl::desc("<input bitcode files>"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000053
Reid Spencer445564a2004-11-20 20:02:56 +000054static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
Misha Brukman3da94ae2005-04-22 00:00:37 +000055 cl::desc("Override output filename"),
Reid Spencer445564a2004-11-20 20:02:56 +000056 cl::value_desc("filename"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000057
Sanjiv Guptad7de7bc2009-07-22 18:41:45 +000058static cl::opt<std::string> BitcodeOutputFilename("b", cl::init(""),
59 cl::desc("Override bitcode output filename"),
60 cl::value_desc("filename"));
61
Misha Brukman3da94ae2005-04-22 00:00:37 +000062static cl::opt<bool> Verbose("v",
Reid Spencer445564a2004-11-20 20:02:56 +000063 cl::desc("Print information about actions taken"));
Misha Brukman3da94ae2005-04-22 00:00:37 +000064
Reid Spencer445564a2004-11-20 20:02:56 +000065static cl::list<std::string> LibPaths("L", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000066 cl::desc("Specify a library search path"),
Reid Spencer445564a2004-11-20 20:02:56 +000067 cl::value_desc("directory"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000068
Chris Lattner3992f522008-01-27 22:58:59 +000069static cl::list<std::string> FrameworkPaths("F", cl::Prefix,
70 cl::desc("Specify a framework search path"),
71 cl::value_desc("directory"));
72
Reid Spencer445564a2004-11-20 20:02:56 +000073static cl::list<std::string> Libraries("l", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000074 cl::desc("Specify libraries to link to"),
Reid Spencer445564a2004-11-20 20:02:56 +000075 cl::value_desc("library prefix"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000076
Chris Lattner3992f522008-01-27 22:58:59 +000077static cl::list<std::string> Frameworks("framework",
78 cl::desc("Specify frameworks to link to"),
79 cl::value_desc("framework"));
80
Reid Spencer708585a2007-02-09 03:08:06 +000081// Options to control the linking, optimization, and code gen processes
Misha Brukman3da94ae2005-04-22 00:00:37 +000082static cl::opt<bool> LinkAsLibrary("link-as-library",
Reid Spencer445564a2004-11-20 20:02:56 +000083 cl::desc("Link the .bc files together as a library, not an executable"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000084
Reid Spencer445564a2004-11-20 20:02:56 +000085static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
86 cl::desc("Alias for -link-as-library"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000087
Reid Spencer445564a2004-11-20 20:02:56 +000088static cl::opt<bool> Native("native",
89 cl::desc("Generate a native binary instead of a shell script"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000090
Reid Spencer445564a2004-11-20 20:02:56 +000091static cl::opt<bool>NativeCBE("native-cbe",
92 cl::desc("Generate a native binary with the C backend and GCC"));
93
Reid Spencer73a74be2005-12-21 05:03:23 +000094static cl::list<std::string> PostLinkOpts("post-link-opts",
Reid Spenceraf303d52006-06-07 23:03:13 +000095 cl::value_desc("path"),
Reid Spencer73a74be2005-12-21 05:03:23 +000096 cl::desc("Run one or more optimization programs after linking"));
97
Reid Spenceraf303d52006-06-07 23:03:13 +000098static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
99 cl::desc("Pass options to the system linker"));
100
Reid Spencer708585a2007-02-09 03:08:06 +0000101// Compatibility options that llvm-ld ignores but are supported for
102// compatibility with LD
Misha Brukman3da94ae2005-04-22 00:00:37 +0000103static cl::opt<std::string> CO3("soname", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000104 cl::desc("Compatibility option: ignored"));
105
Misha Brukman3da94ae2005-04-22 00:00:37 +0000106static cl::opt<std::string> CO4("version-script", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000107 cl::desc("Compatibility option: ignored"));
108
Misha Brukman3da94ae2005-04-22 00:00:37 +0000109static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000110 cl::desc("Compatibility option: ignored"));
111
Misha Brukman3da94ae2005-04-22 00:00:37 +0000112static cl::opt<std::string> CO6("h", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000113 cl::desc("Compatibility option: ignored"));
114
Reid Spencer98a030c2007-02-08 19:03:11 +0000115static cl::opt<bool> CO7("start-group", cl::Hidden,
116 cl::desc("Compatibility option: ignored"));
117
118static cl::opt<bool> CO8("end-group", cl::Hidden,
119 cl::desc("Compatibility option: ignored"));
Reid Spenceraf303d52006-06-07 23:03:13 +0000120
Andrew Lenharth0c6ba442008-11-19 17:00:08 +0000121static cl::opt<std::string> CO9("m", cl::Hidden,
122 cl::desc("Compatibility option: ignored"));
123
Reid Spencer445564a2004-11-20 20:02:56 +0000124/// This is just for convenience so it doesn't have to be passed around
125/// everywhere.
Reid Spencerc4064132004-12-13 03:01:14 +0000126static std::string progname;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000127
Reid Spencer708585a2007-02-09 03:08:06 +0000128/// PrintAndExit - Prints a message to standard error and exits with error code
Reid Spencerc0af3f02004-09-13 01:27:53 +0000129///
130/// Inputs:
Reid Spencerc0af3f02004-09-13 01:27:53 +0000131/// Message - The message to print to standard error.
132///
Reid Spencer708585a2007-02-09 03:08:06 +0000133static void PrintAndExit(const std::string &Message, int errcode = 1) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000134 errs() << progname << ": " << Message << "\n";
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())
237 PrintAndExit(ErrorInfo);
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
Gabor Greifa99be512007-07-05 17:07:56 +0000246 // Close the bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000247 Out.close();
248}
249
250/// GenerateAssembly - generates a native assembly language source file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000251/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000252///
253/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000254/// InputFilename - The name of the input bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000255/// OutputFilename - The name of the file to generate.
256/// llc - The pathname to use for LLC.
257/// envp - The environment to use when running LLC.
258///
259/// Return non-zero value on error.
260///
261static int GenerateAssembly(const std::string &OutputFilename,
262 const std::string &InputFilename,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000263 const sys::Path &llc,
264 std::string &ErrMsg ) {
Gabor Greifa99be512007-07-05 17:07:56 +0000265 // Run LLC to convert the bitcode file into assembly code.
Reid Spencerf6358c72004-12-19 18:00:56 +0000266 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000267 args.push_back(llc.c_str());
Argyrios Kyrtzidisca29dff2008-06-27 15:08:59 +0000268 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
269 // regardless of what the target in the bitcode file is.
270 args.push_back("-x86-asm-syntax=att");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000271 args.push_back("-f");
272 args.push_back("-o");
273 args.push_back(OutputFilename.c_str());
274 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000275 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000276
Reid Spencer3b726392007-04-29 23:59:47 +0000277 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000278 outs() << "Generating Assembly With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000279 PrintCommand(args);
280 }
281
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000282 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000283}
284
Gabor Greifa99be512007-07-05 17:07:56 +0000285/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000286static int GenerateCFile(const std::string &OutputFile,
287 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000288 const sys::Path &llc,
289 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000290 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000291 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000292 args.push_back(llc.c_str());
293 args.push_back("-march=c");
294 args.push_back("-f");
295 args.push_back("-o");
296 args.push_back(OutputFile.c_str());
297 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000298 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000299
300 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000301 outs() << "Generating C Source With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000302 PrintCommand(args);
303 }
304
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000305 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000306}
307
Devang Patele2f8ad82006-06-27 18:07:29 +0000308/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000309/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000310///
311/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000312/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000313/// OutputFilename - The name of the file to generate.
314/// NativeLinkItems - The native libraries, files, code with which to link
315/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000316/// FrameworksPaths - The list of directories in which to find frameworks.
317/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000318/// gcc - The pathname to use for GGC.
319/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000320///
321/// Outputs:
322/// None.
323///
324/// Returns non-zero value on error.
325///
326static int GenerateNative(const std::string &OutputFilename,
327 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000328 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000329 const sys::Path &gcc, char ** const envp,
330 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000331 // Remove these environment variables from the environment of the
332 // programs that we will execute. It appears that GCC sets these
333 // environment variables so that the programs it uses can configure
334 // themselves identically.
335 //
336 // However, when we invoke GCC below, we want it to use its normal
337 // configuration. Hence, we must sanitize its environment.
338 char ** clean_env = CopyEnv(envp);
339 if (clean_env == NULL)
340 return 1;
341 RemoveEnv("LIBRARY_PATH", clean_env);
342 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
343 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
344 RemoveEnv("COMPILER_PATH", clean_env);
345 RemoveEnv("COLLECT_GCC", clean_env);
346
Reid Spencer445564a2004-11-20 20:02:56 +0000347
348 // Run GCC to assemble and link the program into native code.
349 //
350 // Note:
351 // We can't just assemble and link the file with the system assembler
352 // and linker because we don't know where to put the _start symbol.
353 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000354 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000355 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000356 args.push_back("-fno-strict-aliasing");
357 args.push_back("-O3");
358 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000359 args.push_back(OutputFilename);
360 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000361
Chris Lattner3992f522008-01-27 22:58:59 +0000362 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000363 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000364 args.push_back("-L" + LibPaths[index]);
365 }
366 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
367 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000368 }
369
370 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000371 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000372 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000373
Reid Spencer445564a2004-11-20 20:02:56 +0000374 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000375 for (unsigned index = 0; index < LinkItems.size(); index++)
376 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000377 if (LinkItems[index].second)
378 args.push_back("-l" + LinkItems[index].first);
379 else
380 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000381 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000382
Chris Lattner3992f522008-01-27 22:58:59 +0000383 // Add in frameworks to link.
384 for (unsigned index = 0; index < Frameworks.size(); index++) {
385 args.push_back("-framework");
386 args.push_back(Frameworks[index]);
387 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000388
389 // Now that "args" owns all the std::strings for the arguments, call the c_str
390 // method to get the underlying string array. We do this game so that the
391 // std::string array is guaranteed to outlive the const char* array.
392 std::vector<const char *> Args;
393 for (unsigned i = 0, e = args.size(); i != e; ++i)
394 Args.push_back(args[i].c_str());
395 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000396
Reid Spencer3b726392007-04-29 23:59:47 +0000397 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000398 outs() << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000399 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000400 }
401
Reid Spencer445564a2004-11-20 20:02:56 +0000402 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000403 int R = sys::Program::ExecuteAndWait(
Chris Lattner3f931b82007-06-19 16:46:48 +0000404 gcc, &Args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000405 delete [] clean_env;
406 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000407}
408
Reid Spencerc0af3f02004-09-13 01:27:53 +0000409/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000410/// bitcode file for the program.
Reid Spencerc0af3f02004-09-13 01:27:53 +0000411static void EmitShellScript(char **argv) {
Reid Spencer3b726392007-04-29 23:59:47 +0000412 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000413 outs() << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000414#if defined(_WIN32) || defined(__CYGWIN__)
415 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
416 // support windows systems, we copy the llvm-stub.exe executable from the
417 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000418 std::string ErrMsg;
Dan Gohman197f7282009-08-05 20:21:17 +0000419 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0],
Dan Gohman8608cf22009-08-05 21:03:39 +0000420 (void *)(intptr_t)&Optimize);
Reid Spencer708585a2007-02-09 03:08:06 +0000421 if (llvmstub.isEmpty())
422 PrintAndExit("Could not find llvm-stub.exe executable!");
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000423
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000424 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000425 PrintAndExit(ErrMsg);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000426
Reid Spencerc0af3f02004-09-13 01:27:53 +0000427 return;
428#endif
429
430 // Output the script to start the program...
Dan Gohmanac95cc72009-07-16 15:30:09 +0000431 std::string ErrorInfo;
Dan Gohmanbaa26392009-08-25 15:34:52 +0000432 raw_fd_ostream Out2(OutputFilename.c_str(), ErrorInfo);
Dan Gohmanac95cc72009-07-16 15:30:09 +0000433 if (!ErrorInfo.empty())
434 PrintAndExit(ErrorInfo);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000435
436 Out2 << "#!/bin/sh\n";
437 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
438 Out2 << "lli=${LLVMINTERP-lli}\n";
439 Out2 << "exec $lli \\\n";
440 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
441 LibPaths.push_back("/lib");
442 LibPaths.push_back("/usr/lib");
443 LibPaths.push_back("/usr/X11R6/lib");
444 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
445 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000446 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000447 std::find(Libraries.begin(), Libraries.end(), "c");
448 if (libc != Libraries.end()) Libraries.erase(libc);
449 // List all the shared object (native) libraries this executable will need
450 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000451 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000452 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000453 // try explicit -L arguments first:
454 sys::Path FullLibraryPath;
455 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
456 E = LibPaths.end(); P != E; ++P) {
457 FullLibraryPath = *P;
458 FullLibraryPath.appendComponent("lib" + *i);
459 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
460 if (!FullLibraryPath.isEmpty()) {
461 if (!FullLibraryPath.isDynamicLibrary()) {
462 // Not a native shared library; mark as invalid
463 FullLibraryPath = sys::Path();
464 } else break;
465 }
466 }
467 if (FullLibraryPath.isEmpty())
468 FullLibraryPath = sys::Path::FindLibrary(*i);
469 if (!FullLibraryPath.isEmpty())
Chris Lattner74382b72009-08-23 22:45:37 +0000470 Out2 << " -load=" << FullLibraryPath.str() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000471 }
Sanjiv Guptad7de7bc2009-07-22 18:41:45 +0000472 Out2 << " " << BitcodeOutputFilename << " ${1+\"$@\"}\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000473 Out2.close();
474}
475
Reid Spencerc4064132004-12-13 03:01:14 +0000476// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
477// linker function by combining the Files and Libraries in the order they were
478// declared on the command line.
479static void BuildLinkItems(
480 Linker::ItemList& Items,
481 const cl::list<std::string>& Files,
482 const cl::list<std::string>& Libraries) {
483
Misha Brukman3da94ae2005-04-22 00:00:37 +0000484 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000485
486 cl::list<std::string>::const_iterator fileIt = Files.begin();
487 cl::list<std::string>::const_iterator libIt = Libraries.begin();
488
489 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000490 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000491 if (libIt != Libraries.end())
492 libPos = Libraries.getPosition(libIt - Libraries.begin());
493 else
494 libPos = -1;
495 if (fileIt != Files.end())
496 filePos = Files.getPosition(fileIt - Files.begin());
497 else
498 filePos = -1;
499
500 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
501 // Add a source file
502 Items.push_back(std::make_pair(*fileIt++, false));
503 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
504 // Add a library
505 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000506 }
507 }
508}
509
Reid Spencerc0af3f02004-09-13 01:27:53 +0000510int main(int argc, char **argv, char **envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000511 // Print a stack trace if we signal out.
512 sys::PrintStackTraceOnErrorSignal();
513 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000514
Owen Anderson0d7c6952009-07-15 22:16:10 +0000515 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +0000516 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattner316e3262009-10-22 00:52:28 +0000517
518 // Initial global variable above for convenience printing of program name.
519 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000520
Chris Lattner316e3262009-10-22 00:52:28 +0000521 // Parse the command line options
522 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000523
Chris Lattner316e3262009-10-22 00:52:28 +0000524 // Construct a Linker (now that Verbose is set)
525 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000526
Chris Lattner316e3262009-10-22 00:52:28 +0000527 // Keep track of the native link items (versus the bitcode items)
528 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000529
Chris Lattner316e3262009-10-22 00:52:28 +0000530 // Add library paths to the linker
531 TheLinker.addPaths(LibPaths);
532 TheLinker.addSystemPaths();
Reid Spencer78df5c32006-03-06 06:38:19 +0000533
Chris Lattner316e3262009-10-22 00:52:28 +0000534 // Remove any consecutive duplicates of the same library...
535 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
536 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000537
Chris Lattner316e3262009-10-22 00:52:28 +0000538 if (LinkAsLibrary) {
539 std::vector<sys::Path> Files;
540 for (unsigned i = 0; i < InputFilenames.size(); ++i )
541 Files.push_back(sys::Path(InputFilenames[i]));
542 if (TheLinker.LinkInFiles(Files))
543 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000544
Chris Lattner316e3262009-10-22 00:52:28 +0000545 // The libraries aren't linked in but are noted as "dependent" in the
546 // module.
547 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
548 E = Libraries.end(); I != E ; ++I) {
549 TheLinker.getModule()->addLibrary(*I);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000550 }
Chris Lattner316e3262009-10-22 00:52:28 +0000551 } else {
552 // Build a list of the items from our command line
553 Linker::ItemList Items;
554 BuildLinkItems(Items, InputFilenames, Libraries);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000555
Chris Lattner316e3262009-10-22 00:52:28 +0000556 // Link all the items together
557 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
558 return 1; // Error already printed
559 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000560
Chris Lattner316e3262009-10-22 00:52:28 +0000561 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
562
563 // Optimize the module
564 Optimize(Composite.get());
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000565
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000566#if defined(_WIN32) || defined(__CYGWIN__)
Chris Lattner316e3262009-10-22 00:52:28 +0000567 if (!LinkAsLibrary) {
568 // Default to "a.exe" instead of "a.out".
569 if (OutputFilename.getNumOccurrences() == 0)
570 OutputFilename = "a.exe";
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000571
Chris Lattner316e3262009-10-22 00:52:28 +0000572 // If there is no suffix add an "exe" one.
573 sys::Path ExeFile( OutputFilename );
574 if (ExeFile.getSuffix() == "") {
575 ExeFile.appendSuffix("exe");
576 OutputFilename = ExeFile.str();
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000577 }
Chris Lattner316e3262009-10-22 00:52:28 +0000578 }
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000579#endif
580
Chris Lattner316e3262009-10-22 00:52:28 +0000581 // Generate the bitcode for the optimized module.
582 // If -b wasn't specified, use the name specified
583 // with -o to construct BitcodeOutputFilename.
584 if (BitcodeOutputFilename.empty()) {
585 BitcodeOutputFilename = OutputFilename;
586 if (!LinkAsLibrary) BitcodeOutputFilename += ".bc";
587 }
Argyrios Kyrtzidis5b90a722008-06-15 12:01:16 +0000588
Chris Lattner316e3262009-10-22 00:52:28 +0000589 GenerateBitcode(Composite.get(), BitcodeOutputFilename);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000590
Chris Lattner316e3262009-10-22 00:52:28 +0000591 // If we are not linking a library, generate either a native executable
592 // or a JIT shell script, depending upon what the user wants.
593 if (!LinkAsLibrary) {
594 // If the user wants to run a post-link optimization, run it now.
595 if (!PostLinkOpts.empty()) {
596 std::vector<std::string> opts = PostLinkOpts;
597 for (std::vector<std::string>::iterator I = opts.begin(),
598 E = opts.end(); I != E; ++I) {
599 sys::Path prog(*I);
600 if (!prog.canExecute()) {
601 prog = sys::Program::FindProgramByName(*I);
602 if (prog.isEmpty())
603 PrintAndExit(std::string("Optimization program '") + *I +
604 "' is not found or not executable.");
605 }
606 // Get the program arguments
607 sys::Path tmp_output("opt_result");
608 std::string ErrMsg;
609 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
610 PrintAndExit(ErrMsg);
Reid Spencer708585a2007-02-09 03:08:06 +0000611
Chris Lattner316e3262009-10-22 00:52:28 +0000612 const char* args[4];
613 args[0] = I->c_str();
614 args[1] = BitcodeOutputFilename.c_str();
615 args[2] = tmp_output.c_str();
616 args[3] = 0;
617 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
618 if (tmp_output.isBitcodeFile() || tmp_output.isBitcodeFile()) {
619 sys::Path target(BitcodeOutputFilename);
620 target.eraseFromDisk();
621 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
622 PrintAndExit(ErrMsg, 2);
623 } else
624 PrintAndExit("Post-link optimization output is not bitcode");
625 } else {
626 PrintAndExit(ErrMsg);
Reid Spencer73a74be2005-12-21 05:03:23 +0000627 }
628 }
Reid Spencer708585a2007-02-09 03:08:06 +0000629 }
Chris Lattner316e3262009-10-22 00:52:28 +0000630
631 // If the user wants to generate a native executable, compile it from the
632 // bitcode file.
633 //
634 // Otherwise, create a script that will run the bitcode through the JIT.
635 if (Native) {
636 // Name of the Assembly Language output file
637 sys::Path AssemblyFile ( OutputFilename);
638 AssemblyFile.appendSuffix("s");
639
640 // Mark the output files for removal if we get an interrupt.
641 sys::RemoveFileOnSignal(AssemblyFile);
642 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
643
644 // Determine the locations of the llc and gcc programs.
645 sys::Path llc = FindExecutable("llc", argv[0],
646 (void *)(intptr_t)&Optimize);
647 if (llc.isEmpty())
648 PrintAndExit("Failed to find llc");
649
650 sys::Path gcc = sys::Program::FindProgramByName("gcc");
651 if (gcc.isEmpty())
652 PrintAndExit("Failed to find gcc");
653
654 // Generate an assembly language file for the bitcode.
655 std::string ErrMsg;
656 if (0 != GenerateAssembly(AssemblyFile.str(), BitcodeOutputFilename,
657 llc, ErrMsg))
658 PrintAndExit(ErrMsg);
659
660 if (0 != GenerateNative(OutputFilename, AssemblyFile.str(),
661 NativeLinkItems, gcc, envp, ErrMsg))
662 PrintAndExit(ErrMsg);
663
664 // Remove the assembly language file.
665 AssemblyFile.eraseFromDisk();
666 } else if (NativeCBE) {
667 sys::Path CFile (OutputFilename);
668 CFile.appendSuffix("cbe.c");
669
670 // Mark the output files for removal if we get an interrupt.
671 sys::RemoveFileOnSignal(CFile);
672 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
673
674 // Determine the locations of the llc and gcc programs.
675 sys::Path llc = FindExecutable("llc", argv[0],
676 (void *)(intptr_t)&Optimize);
677 if (llc.isEmpty())
678 PrintAndExit("Failed to find llc");
679
680 sys::Path gcc = sys::Program::FindProgramByName("gcc");
681 if (gcc.isEmpty())
682 PrintAndExit("Failed to find gcc");
683
684 // Generate an assembly language file for the bitcode.
685 std::string ErrMsg;
686 if (GenerateCFile(CFile.str(), BitcodeOutputFilename, llc, ErrMsg))
687 PrintAndExit(ErrMsg);
688
689 if (GenerateNative(OutputFilename, CFile.str(),
690 NativeLinkItems, gcc, envp, ErrMsg))
691 PrintAndExit(ErrMsg);
692
693 // Remove the assembly language file.
694 CFile.eraseFromDisk();
695
696 } else {
697 EmitShellScript(argv);
698 }
699
700 // Make the script executable...
701 std::string ErrMsg;
702 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
703 PrintAndExit(ErrMsg);
704
705 // Make the bitcode file readable and directly executable in LLEE as well
706 if (sys::Path(BitcodeOutputFilename).makeExecutableOnDisk(&ErrMsg))
707 PrintAndExit(ErrMsg);
708
709 if (sys::Path(BitcodeOutputFilename).makeReadableOnDisk(&ErrMsg))
710 PrintAndExit(ErrMsg);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000711 }
Reid Spencer708585a2007-02-09 03:08:06 +0000712
713 // Graceful exit
714 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000715}