blob: ce52b59f0d26742a669db4d6a2acdbfbec200fee [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"
Dan Gohman132a9942010-03-30 19:56:41 +000033#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
Dan Gohman132a9942010-03-30 19:56:41 +0000128/// FileRemover objects to clean up output files in the event of an error.
129static FileRemover OutputRemover;
130static FileRemover BitcodeOutputRemover;
131
Reid Spencer708585a2007-02-09 03:08:06 +0000132/// PrintAndExit - Prints a message to standard error and exits with error code
Reid Spencerc0af3f02004-09-13 01:27:53 +0000133///
134/// Inputs:
Reid Spencerc0af3f02004-09-13 01:27:53 +0000135/// Message - The message to print to standard error.
136///
Chris Lattner25c54c02010-03-23 21:59:43 +0000137static void PrintAndExit(const std::string &Message, Module *M, int errcode = 1) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000138 errs() << progname << ": " << Message << "\n";
Chris Lattner25c54c02010-03-23 21:59:43 +0000139 delete M;
Reid Spencer708585a2007-02-09 03:08:06 +0000140 llvm_shutdown();
141 exit(errcode);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000142}
143
Reid Spencer3b726392007-04-29 23:59:47 +0000144static void PrintCommand(const std::vector<const char*> &args) {
145 std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
146 for (; I != E; ++I)
147 if (*I)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000148 outs() << "'" << *I << "'" << " ";
149 outs() << "\n"; outs().flush();
Reid Spencer3b726392007-04-29 23:59:47 +0000150}
151
Reid Spencer445564a2004-11-20 20:02:56 +0000152/// CopyEnv - This function takes an array of environment variables and makes a
153/// copy of it. This copy can then be manipulated any way the caller likes
154/// without affecting the process's real environment.
155///
156/// Inputs:
157/// envp - An array of C strings containing an environment.
158///
159/// Return value:
160/// NULL - An error occurred.
161///
162/// Otherwise, a pointer to a new array of C strings is returned. Every string
163/// in the array is a duplicate of the one in the original array (i.e. we do
164/// not copy the char *'s from one array to another).
165///
166static char ** CopyEnv(char ** const envp) {
167 // Count the number of entries in the old list;
168 unsigned entries; // The number of entries in the old environment list
169 for (entries = 0; envp[entries] != NULL; entries++)
170 /*empty*/;
171
172 // Add one more entry for the NULL pointer that ends the list.
173 ++entries;
174
175 // If there are no entries at all, just return NULL.
176 if (entries == 0)
177 return NULL;
178
179 // Allocate a new environment list.
180 char **newenv = new char* [entries];
181 if ((newenv = new char* [entries]) == NULL)
182 return NULL;
183
184 // Make a copy of the list. Don't forget the NULL that ends the list.
185 entries = 0;
186 while (envp[entries] != NULL) {
Benjamin Kramer12ea66a2010-01-28 18:04:38 +0000187 size_t len = strlen(envp[entries]) + 1;
188 newenv[entries] = new char[len];
189 memcpy(newenv[entries], envp[entries], len);
Reid Spencer445564a2004-11-20 20:02:56 +0000190 ++entries;
191 }
192 newenv[entries] = NULL;
193
194 return newenv;
195}
196
197
198/// RemoveEnv - Remove the specified environment variable from the environment
199/// array.
200///
201/// Inputs:
202/// name - The name of the variable to remove. It cannot be NULL.
203/// envp - The array of environment variables. It cannot be NULL.
204///
205/// Notes:
206/// This is mainly done because functions to remove items from the environment
207/// are not available across all platforms. In particular, Solaris does not
208/// seem to have an unsetenv() function or a setenv() function (or they are
209/// undocumented if they do exist).
210///
211static void RemoveEnv(const char * name, char ** const envp) {
212 for (unsigned index=0; envp[index] != NULL; index++) {
213 // Find the first equals sign in the array and make it an EOS character.
214 char *p = strchr (envp[index], '=');
215 if (p == NULL)
216 continue;
217 else
218 *p = '\0';
219
220 // Compare the two strings. If they are equal, zap this string.
221 // Otherwise, restore it.
222 if (!strcmp(name, envp[index]))
223 *envp[index] = '\0';
224 else
225 *p = '=';
226 }
227
228 return;
229}
230
Gabor Greifa99be512007-07-05 17:07:56 +0000231/// GenerateBitcode - generates a bitcode file from the module provided
232void GenerateBitcode(Module* M, const std::string& FileName) {
Reid Spencer445564a2004-11-20 20:02:56 +0000233
Reid Spencer3b726392007-04-29 23:59:47 +0000234 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000235 outs() << "Generating Bitcode To " << FileName << '\n';
Reid Spencer3b726392007-04-29 23:59:47 +0000236
Reid Spencer445564a2004-11-20 20:02:56 +0000237 // Create the output file.
Dan Gohmanac95cc72009-07-16 15:30:09 +0000238 std::string ErrorInfo;
Chris Lattner17e9edc2009-08-23 02:51:22 +0000239 raw_fd_ostream Out(FileName.c_str(), ErrorInfo,
Dan Gohmanbaa26392009-08-25 15:34:52 +0000240 raw_fd_ostream::F_Binary);
Dan Gohmanac95cc72009-07-16 15:30:09 +0000241 if (!ErrorInfo.empty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000242 PrintAndExit(ErrorInfo, M);
Reid Spencer445564a2004-11-20 20:02:56 +0000243
Reid Spencer445564a2004-11-20 20:02:56 +0000244 // Write it out
Chris Lattner44dadff2007-05-06 09:29:57 +0000245 WriteBitcodeToFile(M, Out);
Reid Spencer445564a2004-11-20 20:02:56 +0000246}
247
248/// GenerateAssembly - generates a native assembly language source file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000249/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000250///
251/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000252/// InputFilename - The name of the input bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000253/// OutputFilename - The name of the file to generate.
254/// llc - The pathname to use for LLC.
255/// envp - The environment to use when running LLC.
256///
257/// Return non-zero value on error.
258///
259static int GenerateAssembly(const std::string &OutputFilename,
260 const std::string &InputFilename,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000261 const sys::Path &llc,
262 std::string &ErrMsg ) {
Gabor Greifa99be512007-07-05 17:07:56 +0000263 // Run LLC to convert the bitcode file into assembly code.
Reid Spencerf6358c72004-12-19 18:00:56 +0000264 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000265 args.push_back(llc.c_str());
Argyrios Kyrtzidisca29dff2008-06-27 15:08:59 +0000266 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
267 // regardless of what the target in the bitcode file is.
268 args.push_back("-x86-asm-syntax=att");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000269 args.push_back("-f");
270 args.push_back("-o");
271 args.push_back(OutputFilename.c_str());
272 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000273 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000274
Reid Spencer3b726392007-04-29 23:59:47 +0000275 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000276 outs() << "Generating Assembly With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000277 PrintCommand(args);
278 }
279
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000280 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000281}
282
Gabor Greifa99be512007-07-05 17:07:56 +0000283/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000284static int GenerateCFile(const std::string &OutputFile,
285 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000286 const sys::Path &llc,
287 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000288 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000289 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000290 args.push_back(llc.c_str());
291 args.push_back("-march=c");
292 args.push_back("-f");
293 args.push_back("-o");
294 args.push_back(OutputFile.c_str());
295 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000296 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000297
298 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000299 outs() << "Generating C Source With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000300 PrintCommand(args);
301 }
302
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000303 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000304}
305
Devang Patele2f8ad82006-06-27 18:07:29 +0000306/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000307/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000308///
309/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000310/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000311/// OutputFilename - The name of the file to generate.
312/// NativeLinkItems - The native libraries, files, code with which to link
313/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000314/// FrameworksPaths - The list of directories in which to find frameworks.
315/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000316/// gcc - The pathname to use for GGC.
317/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000318///
319/// Outputs:
320/// None.
321///
322/// Returns non-zero value on error.
323///
324static int GenerateNative(const std::string &OutputFilename,
325 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000326 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000327 const sys::Path &gcc, char ** const envp,
328 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000329 // Remove these environment variables from the environment of the
330 // programs that we will execute. It appears that GCC sets these
331 // environment variables so that the programs it uses can configure
332 // themselves identically.
333 //
334 // However, when we invoke GCC below, we want it to use its normal
335 // configuration. Hence, we must sanitize its environment.
336 char ** clean_env = CopyEnv(envp);
337 if (clean_env == NULL)
338 return 1;
339 RemoveEnv("LIBRARY_PATH", clean_env);
340 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
341 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
342 RemoveEnv("COMPILER_PATH", clean_env);
343 RemoveEnv("COLLECT_GCC", clean_env);
344
Reid Spencer445564a2004-11-20 20:02:56 +0000345
346 // Run GCC to assemble and link the program into native code.
347 //
348 // Note:
349 // We can't just assemble and link the file with the system assembler
350 // and linker because we don't know where to put the _start symbol.
351 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000352 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000353 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000354 args.push_back("-fno-strict-aliasing");
355 args.push_back("-O3");
356 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000357 args.push_back(OutputFilename);
358 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000359
Chris Lattner3992f522008-01-27 22:58:59 +0000360 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000361 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000362 args.push_back("-L" + LibPaths[index]);
363 }
364 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
365 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000366 }
367
368 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000369 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000370 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000371
Reid Spencer445564a2004-11-20 20:02:56 +0000372 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000373 for (unsigned index = 0; index < LinkItems.size(); index++)
374 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000375 if (LinkItems[index].second)
376 args.push_back("-l" + LinkItems[index].first);
377 else
378 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000379 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000380
Chris Lattner3992f522008-01-27 22:58:59 +0000381 // Add in frameworks to link.
382 for (unsigned index = 0; index < Frameworks.size(); index++) {
383 args.push_back("-framework");
384 args.push_back(Frameworks[index]);
385 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000386
387 // Now that "args" owns all the std::strings for the arguments, call the c_str
388 // method to get the underlying string array. We do this game so that the
389 // std::string array is guaranteed to outlive the const char* array.
390 std::vector<const char *> Args;
391 for (unsigned i = 0, e = args.size(); i != e; ++i)
392 Args.push_back(args[i].c_str());
393 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000394
Reid Spencer3b726392007-04-29 23:59:47 +0000395 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000396 outs() << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000397 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000398 }
399
Reid Spencer445564a2004-11-20 20:02:56 +0000400 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000401 int R = sys::Program::ExecuteAndWait(
Dan Gohman43bc70e2010-04-17 17:44:03 +0000402 gcc, &Args[0], const_cast<const char **>(clean_env), 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000403 delete [] clean_env;
404 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000405}
406
Reid Spencerc0af3f02004-09-13 01:27:53 +0000407/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000408/// bitcode file for the program.
Chris Lattner25c54c02010-03-23 21:59:43 +0000409static void EmitShellScript(char **argv, Module *M) {
Reid Spencer3b726392007-04-29 23:59:47 +0000410 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000411 outs() << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000412#if defined(_WIN32) || defined(__CYGWIN__)
413 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
414 // support windows systems, we copy the llvm-stub.exe executable from the
415 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000416 std::string ErrMsg;
Dan Gohman197f7282009-08-05 20:21:17 +0000417 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0],
Dan Gohman8608cf22009-08-05 21:03:39 +0000418 (void *)(intptr_t)&Optimize);
Reid Spencer708585a2007-02-09 03:08:06 +0000419 if (llvmstub.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000420 PrintAndExit("Could not find llvm-stub.exe executable!", M);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000421
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000422 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000423 PrintAndExit(ErrMsg, M);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000424
Reid Spencerc0af3f02004-09-13 01:27:53 +0000425 return;
426#endif
427
428 // Output the script to start the program...
Dan Gohmanac95cc72009-07-16 15:30:09 +0000429 std::string ErrorInfo;
Dan Gohmanbaa26392009-08-25 15:34:52 +0000430 raw_fd_ostream Out2(OutputFilename.c_str(), ErrorInfo);
Dan Gohmanac95cc72009-07-16 15:30:09 +0000431 if (!ErrorInfo.empty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000432 PrintAndExit(ErrorInfo, M);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000433
434 Out2 << "#!/bin/sh\n";
435 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
436 Out2 << "lli=${LLVMINTERP-lli}\n";
437 Out2 << "exec $lli \\\n";
438 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
439 LibPaths.push_back("/lib");
440 LibPaths.push_back("/usr/lib");
441 LibPaths.push_back("/usr/X11R6/lib");
442 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
443 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000444 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000445 std::find(Libraries.begin(), Libraries.end(), "c");
446 if (libc != Libraries.end()) Libraries.erase(libc);
447 // List all the shared object (native) libraries this executable will need
448 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000449 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000450 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000451 // try explicit -L arguments first:
452 sys::Path FullLibraryPath;
453 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
454 E = LibPaths.end(); P != E; ++P) {
455 FullLibraryPath = *P;
456 FullLibraryPath.appendComponent("lib" + *i);
457 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
458 if (!FullLibraryPath.isEmpty()) {
459 if (!FullLibraryPath.isDynamicLibrary()) {
460 // Not a native shared library; mark as invalid
461 FullLibraryPath = sys::Path();
462 } else break;
463 }
464 }
465 if (FullLibraryPath.isEmpty())
466 FullLibraryPath = sys::Path::FindLibrary(*i);
467 if (!FullLibraryPath.isEmpty())
Chris Lattner74382b72009-08-23 22:45:37 +0000468 Out2 << " -load=" << FullLibraryPath.str() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000469 }
Sanjiv Guptad7de7bc2009-07-22 18:41:45 +0000470 Out2 << " " << BitcodeOutputFilename << " ${1+\"$@\"}\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000471}
472
Reid Spencerc4064132004-12-13 03:01:14 +0000473// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
474// linker function by combining the Files and Libraries in the order they were
475// declared on the command line.
476static void BuildLinkItems(
477 Linker::ItemList& Items,
478 const cl::list<std::string>& Files,
479 const cl::list<std::string>& Libraries) {
480
Misha Brukman3da94ae2005-04-22 00:00:37 +0000481 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000482
483 cl::list<std::string>::const_iterator fileIt = Files.begin();
484 cl::list<std::string>::const_iterator libIt = Libraries.begin();
485
486 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000487 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000488 if (libIt != Libraries.end())
489 libPos = Libraries.getPosition(libIt - Libraries.begin());
490 else
491 libPos = -1;
492 if (fileIt != Files.end())
493 filePos = Files.getPosition(fileIt - Files.begin());
494 else
495 filePos = -1;
496
497 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
498 // Add a source file
499 Items.push_back(std::make_pair(*fileIt++, false));
500 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
501 // Add a library
502 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000503 }
504 }
505}
506
Reid Spencerc0af3f02004-09-13 01:27:53 +0000507int main(int argc, char **argv, char **envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000508 // Print a stack trace if we signal out.
509 sys::PrintStackTraceOnErrorSignal();
510 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000511
Owen Anderson0d7c6952009-07-15 22:16:10 +0000512 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +0000513 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattner316e3262009-10-22 00:52:28 +0000514
515 // Initial global variable above for convenience printing of program name.
516 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000517
Chris Lattner316e3262009-10-22 00:52:28 +0000518 // Parse the command line options
519 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000520
Dan Gohman132a9942010-03-30 19:56:41 +0000521#if defined(_WIN32) || defined(__CYGWIN__)
522 if (!LinkAsLibrary) {
523 // Default to "a.exe" instead of "a.out".
524 if (OutputFilename.getNumOccurrences() == 0)
525 OutputFilename = "a.exe";
526
527 // If there is no suffix add an "exe" one.
528 sys::Path ExeFile( OutputFilename );
529 if (ExeFile.getSuffix() == "") {
530 ExeFile.appendSuffix("exe");
531 OutputFilename = ExeFile.str();
532 }
533 }
534#endif
535
536 // Generate the bitcode for the optimized module.
537 // If -b wasn't specified, use the name specified
538 // with -o to construct BitcodeOutputFilename.
539 if (BitcodeOutputFilename.empty()) {
540 BitcodeOutputFilename = OutputFilename;
541 if (!LinkAsLibrary) BitcodeOutputFilename += ".bc";
542 }
543
544 // Arrange for the bitcode output file to be deleted on any errors.
545 BitcodeOutputRemover.setFile(sys::Path(BitcodeOutputFilename));
546 sys::RemoveFileOnSignal(sys::Path(BitcodeOutputFilename));
547
548 // Arrange for the output file to be deleted on any errors.
549 if (!LinkAsLibrary) {
550 OutputRemover.setFile(sys::Path(OutputFilename));
551 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
552 }
553
Chris Lattner316e3262009-10-22 00:52:28 +0000554 // Construct a Linker (now that Verbose is set)
555 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000556
Chris Lattner316e3262009-10-22 00:52:28 +0000557 // Keep track of the native link items (versus the bitcode items)
558 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000559
Chris Lattner316e3262009-10-22 00:52:28 +0000560 // Add library paths to the linker
561 TheLinker.addPaths(LibPaths);
562 TheLinker.addSystemPaths();
Reid Spencer78df5c32006-03-06 06:38:19 +0000563
Chris Lattner316e3262009-10-22 00:52:28 +0000564 // Remove any consecutive duplicates of the same library...
565 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
566 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000567
Chris Lattner316e3262009-10-22 00:52:28 +0000568 if (LinkAsLibrary) {
569 std::vector<sys::Path> Files;
570 for (unsigned i = 0; i < InputFilenames.size(); ++i )
571 Files.push_back(sys::Path(InputFilenames[i]));
572 if (TheLinker.LinkInFiles(Files))
573 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000574
Chris Lattner316e3262009-10-22 00:52:28 +0000575 // The libraries aren't linked in but are noted as "dependent" in the
576 // module.
577 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
578 E = Libraries.end(); I != E ; ++I) {
579 TheLinker.getModule()->addLibrary(*I);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000580 }
Chris Lattner316e3262009-10-22 00:52:28 +0000581 } else {
582 // Build a list of the items from our command line
583 Linker::ItemList Items;
584 BuildLinkItems(Items, InputFilenames, Libraries);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000585
Chris Lattner316e3262009-10-22 00:52:28 +0000586 // Link all the items together
587 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
588 return 1; // Error already printed
589 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000590
Chris Lattner316e3262009-10-22 00:52:28 +0000591 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
592
593 // Optimize the module
594 Optimize(Composite.get());
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000595
Dan Gohman132a9942010-03-30 19:56:41 +0000596 // Generate the bitcode output.
Chris Lattner316e3262009-10-22 00:52:28 +0000597 GenerateBitcode(Composite.get(), BitcodeOutputFilename);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000598
Chris Lattner316e3262009-10-22 00:52:28 +0000599 // If we are not linking a library, generate either a native executable
600 // or a JIT shell script, depending upon what the user wants.
601 if (!LinkAsLibrary) {
602 // If the user wants to run a post-link optimization, run it now.
603 if (!PostLinkOpts.empty()) {
604 std::vector<std::string> opts = PostLinkOpts;
605 for (std::vector<std::string>::iterator I = opts.begin(),
606 E = opts.end(); I != E; ++I) {
607 sys::Path prog(*I);
608 if (!prog.canExecute()) {
609 prog = sys::Program::FindProgramByName(*I);
610 if (prog.isEmpty())
611 PrintAndExit(std::string("Optimization program '") + *I +
Chris Lattner25c54c02010-03-23 21:59:43 +0000612 "' is not found or not executable.", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000613 }
614 // Get the program arguments
615 sys::Path tmp_output("opt_result");
616 std::string ErrMsg;
617 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000618 PrintAndExit(ErrMsg, Composite.get());
Reid Spencer708585a2007-02-09 03:08:06 +0000619
Chris Lattner316e3262009-10-22 00:52:28 +0000620 const char* args[4];
621 args[0] = I->c_str();
622 args[1] = BitcodeOutputFilename.c_str();
623 args[2] = tmp_output.c_str();
624 args[3] = 0;
625 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
Dan Gohman92f5fcc2010-03-27 16:36:08 +0000626 if (tmp_output.isBitcodeFile()) {
Chris Lattner316e3262009-10-22 00:52:28 +0000627 sys::Path target(BitcodeOutputFilename);
628 target.eraseFromDisk();
629 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000630 PrintAndExit(ErrMsg, Composite.get(), 2);
Chris Lattner316e3262009-10-22 00:52:28 +0000631 } else
Chris Lattner25c54c02010-03-23 21:59:43 +0000632 PrintAndExit("Post-link optimization output is not bitcode",
633 Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000634 } else {
Chris Lattner25c54c02010-03-23 21:59:43 +0000635 PrintAndExit(ErrMsg, Composite.get());
Reid Spencer73a74be2005-12-21 05:03:23 +0000636 }
637 }
Reid Spencer708585a2007-02-09 03:08:06 +0000638 }
Chris Lattner316e3262009-10-22 00:52:28 +0000639
640 // If the user wants to generate a native executable, compile it from the
641 // bitcode file.
642 //
643 // Otherwise, create a script that will run the bitcode through the JIT.
644 if (Native) {
645 // Name of the Assembly Language output file
646 sys::Path AssemblyFile ( OutputFilename);
647 AssemblyFile.appendSuffix("s");
648
Dan Gohman132a9942010-03-30 19:56:41 +0000649 // Mark the output files for removal.
650 FileRemover AssemblyFileRemover(AssemblyFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000651 sys::RemoveFileOnSignal(AssemblyFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000652
653 // Determine the locations of the llc and gcc programs.
654 sys::Path llc = FindExecutable("llc", argv[0],
655 (void *)(intptr_t)&Optimize);
656 if (llc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000657 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000658
659 sys::Path gcc = sys::Program::FindProgramByName("gcc");
660 if (gcc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000661 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000662
663 // Generate an assembly language file for the bitcode.
664 std::string ErrMsg;
665 if (0 != GenerateAssembly(AssemblyFile.str(), BitcodeOutputFilename,
666 llc, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000667 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000668
669 if (0 != GenerateNative(OutputFilename, AssemblyFile.str(),
670 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000671 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000672 } else if (NativeCBE) {
673 sys::Path CFile (OutputFilename);
674 CFile.appendSuffix("cbe.c");
675
Dan Gohman132a9942010-03-30 19:56:41 +0000676 // Mark the output files for removal.
677 FileRemover CFileRemover(CFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000678 sys::RemoveFileOnSignal(CFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000679
680 // Determine the locations of the llc and gcc programs.
681 sys::Path llc = FindExecutable("llc", argv[0],
682 (void *)(intptr_t)&Optimize);
683 if (llc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000684 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000685
686 sys::Path gcc = sys::Program::FindProgramByName("gcc");
687 if (gcc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000688 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000689
690 // Generate an assembly language file for the bitcode.
691 std::string ErrMsg;
692 if (GenerateCFile(CFile.str(), BitcodeOutputFilename, llc, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000693 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000694
695 if (GenerateNative(OutputFilename, CFile.str(),
696 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000697 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000698 } else {
Chris Lattner25c54c02010-03-23 21:59:43 +0000699 EmitShellScript(argv, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000700 }
701
702 // Make the script executable...
703 std::string ErrMsg;
704 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000705 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000706
707 // Make the bitcode file readable and directly executable in LLEE as well
708 if (sys::Path(BitcodeOutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000709 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000710
711 if (sys::Path(BitcodeOutputFilename).makeReadableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000712 PrintAndExit(ErrMsg, Composite.get());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000713 }
Reid Spencer708585a2007-02-09 03:08:06 +0000714
Dan Gohman132a9942010-03-30 19:56:41 +0000715 // Operations which may fail are now complete.
716 BitcodeOutputRemover.releaseFile();
717 if (!LinkAsLibrary)
718 OutputRemover.releaseFile();
719
Reid Spencer708585a2007-02-09 03:08:06 +0000720 // Graceful exit
721 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000722}