blob: ad6956cabd2442db1a477e20611b5d0969e0c1ab [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("-o");
270 args.push_back(OutputFilename.c_str());
271 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000272 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000273
Reid Spencer3b726392007-04-29 23:59:47 +0000274 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000275 outs() << "Generating Assembly With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000276 PrintCommand(args);
277 }
278
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000279 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000280}
281
Gabor Greifa99be512007-07-05 17:07:56 +0000282/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000283static int GenerateCFile(const std::string &OutputFile,
284 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000285 const sys::Path &llc,
286 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000287 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000288 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000289 args.push_back(llc.c_str());
290 args.push_back("-march=c");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000291 args.push_back("-o");
292 args.push_back(OutputFile.c_str());
293 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000294 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000295
296 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000297 outs() << "Generating C Source With: \n";
Reid Spencer3b726392007-04-29 23:59:47 +0000298 PrintCommand(args);
299 }
300
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000301 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000302}
303
Devang Patele2f8ad82006-06-27 18:07:29 +0000304/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000305/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000306///
307/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000308/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000309/// OutputFilename - The name of the file to generate.
310/// NativeLinkItems - The native libraries, files, code with which to link
311/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000312/// FrameworksPaths - The list of directories in which to find frameworks.
313/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000314/// gcc - The pathname to use for GGC.
315/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000316///
317/// Outputs:
318/// None.
319///
320/// Returns non-zero value on error.
321///
322static int GenerateNative(const std::string &OutputFilename,
323 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000324 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000325 const sys::Path &gcc, char ** const envp,
326 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000327 // Remove these environment variables from the environment of the
328 // programs that we will execute. It appears that GCC sets these
329 // environment variables so that the programs it uses can configure
330 // themselves identically.
331 //
332 // However, when we invoke GCC below, we want it to use its normal
333 // configuration. Hence, we must sanitize its environment.
334 char ** clean_env = CopyEnv(envp);
335 if (clean_env == NULL)
336 return 1;
337 RemoveEnv("LIBRARY_PATH", clean_env);
338 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
339 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
340 RemoveEnv("COMPILER_PATH", clean_env);
341 RemoveEnv("COLLECT_GCC", clean_env);
342
Reid Spencer445564a2004-11-20 20:02:56 +0000343
344 // Run GCC to assemble and link the program into native code.
345 //
346 // Note:
347 // We can't just assemble and link the file with the system assembler
348 // and linker because we don't know where to put the _start symbol.
349 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000350 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000351 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000352 args.push_back("-fno-strict-aliasing");
353 args.push_back("-O3");
354 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000355 args.push_back(OutputFilename);
356 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000357
Chris Lattner3992f522008-01-27 22:58:59 +0000358 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000359 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000360 args.push_back("-L" + LibPaths[index]);
361 }
362 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
363 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000364 }
365
366 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000367 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000368 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000369
Reid Spencer445564a2004-11-20 20:02:56 +0000370 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000371 for (unsigned index = 0; index < LinkItems.size(); index++)
372 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000373 if (LinkItems[index].second)
374 args.push_back("-l" + LinkItems[index].first);
375 else
376 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000377 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000378
Chris Lattner3992f522008-01-27 22:58:59 +0000379 // Add in frameworks to link.
380 for (unsigned index = 0; index < Frameworks.size(); index++) {
381 args.push_back("-framework");
382 args.push_back(Frameworks[index]);
383 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000384
385 // Now that "args" owns all the std::strings for the arguments, call the c_str
386 // method to get the underlying string array. We do this game so that the
387 // std::string array is guaranteed to outlive the const char* array.
388 std::vector<const char *> Args;
389 for (unsigned i = 0, e = args.size(); i != e; ++i)
390 Args.push_back(args[i].c_str());
391 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000392
Reid Spencer3b726392007-04-29 23:59:47 +0000393 if (Verbose) {
Dan Gohmanac95cc72009-07-16 15:30:09 +0000394 outs() << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000395 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000396 }
397
Reid Spencer445564a2004-11-20 20:02:56 +0000398 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000399 int R = sys::Program::ExecuteAndWait(
Dan Gohman43bc70e2010-04-17 17:44:03 +0000400 gcc, &Args[0], const_cast<const char **>(clean_env), 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000401 delete [] clean_env;
402 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000403}
404
Reid Spencerc0af3f02004-09-13 01:27:53 +0000405/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000406/// bitcode file for the program.
Chris Lattner25c54c02010-03-23 21:59:43 +0000407static void EmitShellScript(char **argv, Module *M) {
Reid Spencer3b726392007-04-29 23:59:47 +0000408 if (Verbose)
Dan Gohmanac95cc72009-07-16 15:30:09 +0000409 outs() << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000410#if defined(_WIN32) || defined(__CYGWIN__)
411 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
412 // support windows systems, we copy the llvm-stub.exe executable from the
413 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000414 std::string ErrMsg;
Dan Gohman197f7282009-08-05 20:21:17 +0000415 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0],
Dan Gohman8608cf22009-08-05 21:03:39 +0000416 (void *)(intptr_t)&Optimize);
Reid Spencer708585a2007-02-09 03:08:06 +0000417 if (llvmstub.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000418 PrintAndExit("Could not find llvm-stub.exe executable!", M);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000419
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000420 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000421 PrintAndExit(ErrMsg, M);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000422
Reid Spencerc0af3f02004-09-13 01:27:53 +0000423 return;
424#endif
425
426 // Output the script to start the program...
Dan Gohmanac95cc72009-07-16 15:30:09 +0000427 std::string ErrorInfo;
Dan Gohmanbaa26392009-08-25 15:34:52 +0000428 raw_fd_ostream Out2(OutputFilename.c_str(), ErrorInfo);
Dan Gohmanac95cc72009-07-16 15:30:09 +0000429 if (!ErrorInfo.empty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000430 PrintAndExit(ErrorInfo, M);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000431
432 Out2 << "#!/bin/sh\n";
433 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
434 Out2 << "lli=${LLVMINTERP-lli}\n";
435 Out2 << "exec $lli \\\n";
436 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
437 LibPaths.push_back("/lib");
438 LibPaths.push_back("/usr/lib");
439 LibPaths.push_back("/usr/X11R6/lib");
440 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
441 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000442 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000443 std::find(Libraries.begin(), Libraries.end(), "c");
444 if (libc != Libraries.end()) Libraries.erase(libc);
445 // List all the shared object (native) libraries this executable will need
446 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000447 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000448 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000449 // try explicit -L arguments first:
450 sys::Path FullLibraryPath;
451 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
452 E = LibPaths.end(); P != E; ++P) {
453 FullLibraryPath = *P;
454 FullLibraryPath.appendComponent("lib" + *i);
455 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
456 if (!FullLibraryPath.isEmpty()) {
457 if (!FullLibraryPath.isDynamicLibrary()) {
458 // Not a native shared library; mark as invalid
459 FullLibraryPath = sys::Path();
460 } else break;
461 }
462 }
463 if (FullLibraryPath.isEmpty())
464 FullLibraryPath = sys::Path::FindLibrary(*i);
465 if (!FullLibraryPath.isEmpty())
Chris Lattner74382b72009-08-23 22:45:37 +0000466 Out2 << " -load=" << FullLibraryPath.str() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000467 }
Sanjiv Guptad7de7bc2009-07-22 18:41:45 +0000468 Out2 << " " << BitcodeOutputFilename << " ${1+\"$@\"}\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000469}
470
Reid Spencerc4064132004-12-13 03:01:14 +0000471// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
472// linker function by combining the Files and Libraries in the order they were
473// declared on the command line.
474static void BuildLinkItems(
475 Linker::ItemList& Items,
476 const cl::list<std::string>& Files,
477 const cl::list<std::string>& Libraries) {
478
Misha Brukman3da94ae2005-04-22 00:00:37 +0000479 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000480
481 cl::list<std::string>::const_iterator fileIt = Files.begin();
482 cl::list<std::string>::const_iterator libIt = Libraries.begin();
483
484 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000485 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000486 if (libIt != Libraries.end())
487 libPos = Libraries.getPosition(libIt - Libraries.begin());
488 else
489 libPos = -1;
490 if (fileIt != Files.end())
491 filePos = Files.getPosition(fileIt - Files.begin());
492 else
493 filePos = -1;
494
495 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
496 // Add a source file
497 Items.push_back(std::make_pair(*fileIt++, false));
498 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
499 // Add a library
500 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000501 }
502 }
503}
504
Reid Spencerc0af3f02004-09-13 01:27:53 +0000505int main(int argc, char **argv, char **envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000506 // Print a stack trace if we signal out.
507 sys::PrintStackTraceOnErrorSignal();
508 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000509
Owen Anderson0d7c6952009-07-15 22:16:10 +0000510 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +0000511 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattner316e3262009-10-22 00:52:28 +0000512
513 // Initial global variable above for convenience printing of program name.
514 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000515
Chris Lattner316e3262009-10-22 00:52:28 +0000516 // Parse the command line options
517 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000518
Dan Gohman132a9942010-03-30 19:56:41 +0000519#if defined(_WIN32) || defined(__CYGWIN__)
520 if (!LinkAsLibrary) {
521 // Default to "a.exe" instead of "a.out".
522 if (OutputFilename.getNumOccurrences() == 0)
523 OutputFilename = "a.exe";
524
525 // If there is no suffix add an "exe" one.
526 sys::Path ExeFile( OutputFilename );
527 if (ExeFile.getSuffix() == "") {
528 ExeFile.appendSuffix("exe");
529 OutputFilename = ExeFile.str();
530 }
531 }
532#endif
533
534 // Generate the bitcode for the optimized module.
535 // If -b wasn't specified, use the name specified
536 // with -o to construct BitcodeOutputFilename.
537 if (BitcodeOutputFilename.empty()) {
538 BitcodeOutputFilename = OutputFilename;
539 if (!LinkAsLibrary) BitcodeOutputFilename += ".bc";
540 }
541
542 // Arrange for the bitcode output file to be deleted on any errors.
543 BitcodeOutputRemover.setFile(sys::Path(BitcodeOutputFilename));
544 sys::RemoveFileOnSignal(sys::Path(BitcodeOutputFilename));
545
546 // Arrange for the output file to be deleted on any errors.
547 if (!LinkAsLibrary) {
548 OutputRemover.setFile(sys::Path(OutputFilename));
549 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
550 }
551
Chris Lattner316e3262009-10-22 00:52:28 +0000552 // Construct a Linker (now that Verbose is set)
553 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000554
Chris Lattner316e3262009-10-22 00:52:28 +0000555 // Keep track of the native link items (versus the bitcode items)
556 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000557
Chris Lattner316e3262009-10-22 00:52:28 +0000558 // Add library paths to the linker
559 TheLinker.addPaths(LibPaths);
560 TheLinker.addSystemPaths();
Reid Spencer78df5c32006-03-06 06:38:19 +0000561
Chris Lattner316e3262009-10-22 00:52:28 +0000562 // Remove any consecutive duplicates of the same library...
563 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
564 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000565
Chris Lattner316e3262009-10-22 00:52:28 +0000566 if (LinkAsLibrary) {
567 std::vector<sys::Path> Files;
568 for (unsigned i = 0; i < InputFilenames.size(); ++i )
569 Files.push_back(sys::Path(InputFilenames[i]));
570 if (TheLinker.LinkInFiles(Files))
571 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000572
Chris Lattner316e3262009-10-22 00:52:28 +0000573 // The libraries aren't linked in but are noted as "dependent" in the
574 // module.
575 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
576 E = Libraries.end(); I != E ; ++I) {
577 TheLinker.getModule()->addLibrary(*I);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000578 }
Chris Lattner316e3262009-10-22 00:52:28 +0000579 } else {
580 // Build a list of the items from our command line
581 Linker::ItemList Items;
582 BuildLinkItems(Items, InputFilenames, Libraries);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000583
Chris Lattner316e3262009-10-22 00:52:28 +0000584 // Link all the items together
585 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
586 return 1; // Error already printed
587 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000588
Chris Lattner316e3262009-10-22 00:52:28 +0000589 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
590
591 // Optimize the module
592 Optimize(Composite.get());
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000593
Dan Gohman132a9942010-03-30 19:56:41 +0000594 // Generate the bitcode output.
Chris Lattner316e3262009-10-22 00:52:28 +0000595 GenerateBitcode(Composite.get(), BitcodeOutputFilename);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000596
Chris Lattner316e3262009-10-22 00:52:28 +0000597 // If we are not linking a library, generate either a native executable
598 // or a JIT shell script, depending upon what the user wants.
599 if (!LinkAsLibrary) {
600 // If the user wants to run a post-link optimization, run it now.
601 if (!PostLinkOpts.empty()) {
602 std::vector<std::string> opts = PostLinkOpts;
603 for (std::vector<std::string>::iterator I = opts.begin(),
604 E = opts.end(); I != E; ++I) {
605 sys::Path prog(*I);
606 if (!prog.canExecute()) {
607 prog = sys::Program::FindProgramByName(*I);
608 if (prog.isEmpty())
609 PrintAndExit(std::string("Optimization program '") + *I +
Chris Lattner25c54c02010-03-23 21:59:43 +0000610 "' is not found or not executable.", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000611 }
612 // Get the program arguments
613 sys::Path tmp_output("opt_result");
614 std::string ErrMsg;
615 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000616 PrintAndExit(ErrMsg, Composite.get());
Reid Spencer708585a2007-02-09 03:08:06 +0000617
Chris Lattner316e3262009-10-22 00:52:28 +0000618 const char* args[4];
619 args[0] = I->c_str();
620 args[1] = BitcodeOutputFilename.c_str();
621 args[2] = tmp_output.c_str();
622 args[3] = 0;
623 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
Dan Gohman92f5fcc2010-03-27 16:36:08 +0000624 if (tmp_output.isBitcodeFile()) {
Chris Lattner316e3262009-10-22 00:52:28 +0000625 sys::Path target(BitcodeOutputFilename);
626 target.eraseFromDisk();
627 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000628 PrintAndExit(ErrMsg, Composite.get(), 2);
Chris Lattner316e3262009-10-22 00:52:28 +0000629 } else
Chris Lattner25c54c02010-03-23 21:59:43 +0000630 PrintAndExit("Post-link optimization output is not bitcode",
631 Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000632 } else {
Chris Lattner25c54c02010-03-23 21:59:43 +0000633 PrintAndExit(ErrMsg, Composite.get());
Reid Spencer73a74be2005-12-21 05:03:23 +0000634 }
635 }
Reid Spencer708585a2007-02-09 03:08:06 +0000636 }
Chris Lattner316e3262009-10-22 00:52:28 +0000637
638 // If the user wants to generate a native executable, compile it from the
639 // bitcode file.
640 //
641 // Otherwise, create a script that will run the bitcode through the JIT.
642 if (Native) {
643 // Name of the Assembly Language output file
644 sys::Path AssemblyFile ( OutputFilename);
645 AssemblyFile.appendSuffix("s");
646
Dan Gohman132a9942010-03-30 19:56:41 +0000647 // Mark the output files for removal.
648 FileRemover AssemblyFileRemover(AssemblyFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000649 sys::RemoveFileOnSignal(AssemblyFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000650
651 // Determine the locations of the llc and gcc programs.
652 sys::Path llc = FindExecutable("llc", argv[0],
653 (void *)(intptr_t)&Optimize);
654 if (llc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000655 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000656
657 sys::Path gcc = sys::Program::FindProgramByName("gcc");
658 if (gcc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000659 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000660
661 // Generate an assembly language file for the bitcode.
662 std::string ErrMsg;
663 if (0 != GenerateAssembly(AssemblyFile.str(), BitcodeOutputFilename,
664 llc, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000665 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000666
667 if (0 != GenerateNative(OutputFilename, AssemblyFile.str(),
668 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000669 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000670 } else if (NativeCBE) {
671 sys::Path CFile (OutputFilename);
672 CFile.appendSuffix("cbe.c");
673
Dan Gohman132a9942010-03-30 19:56:41 +0000674 // Mark the output files for removal.
675 FileRemover CFileRemover(CFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000676 sys::RemoveFileOnSignal(CFile);
Chris Lattner316e3262009-10-22 00:52:28 +0000677
678 // Determine the locations of the llc and gcc programs.
679 sys::Path llc = FindExecutable("llc", argv[0],
680 (void *)(intptr_t)&Optimize);
681 if (llc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000682 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000683
684 sys::Path gcc = sys::Program::FindProgramByName("gcc");
685 if (gcc.isEmpty())
Chris Lattner25c54c02010-03-23 21:59:43 +0000686 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000687
688 // Generate an assembly language file for the bitcode.
689 std::string ErrMsg;
690 if (GenerateCFile(CFile.str(), BitcodeOutputFilename, llc, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000691 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000692
693 if (GenerateNative(OutputFilename, CFile.str(),
694 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000695 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000696 } else {
Chris Lattner25c54c02010-03-23 21:59:43 +0000697 EmitShellScript(argv, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000698 }
699
700 // Make the script executable...
701 std::string ErrMsg;
702 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000703 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000704
705 // Make the bitcode file readable and directly executable in LLEE as well
706 if (sys::Path(BitcodeOutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000707 PrintAndExit(ErrMsg, Composite.get());
Chris Lattner316e3262009-10-22 00:52:28 +0000708
709 if (sys::Path(BitcodeOutputFilename).makeReadableOnDisk(&ErrMsg))
Chris Lattner25c54c02010-03-23 21:59:43 +0000710 PrintAndExit(ErrMsg, Composite.get());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000711 }
Reid Spencer708585a2007-02-09 03:08:06 +0000712
Dan Gohman132a9942010-03-30 19:56:41 +0000713 // Operations which may fail are now complete.
714 BitcodeOutputRemover.releaseFile();
715 if (!LinkAsLibrary)
716 OutputRemover.releaseFile();
717
Reid Spencer708585a2007-02-09 03:08:06 +0000718 // Graceful exit
719 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000720}