blob: d461fef8fec9c5697eb4599195954d960eb52826 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- llvm-ld.cpp - LLVM 'ld' compatible linker --------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5f5a5732007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
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
14// example), is directly executable, whereas the bitcode file actually lives in
Dan Gohman176426d2009-08-25 15:34:52 +000015// the a.out.bc file generated by this program.
Dan Gohmanf17a25c2007-07-18 16:29:46 +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
23#include "llvm/LinkAllVMCore.h"
24#include "llvm/Linker.h"
Owen Anderson25209b42009-07-01 16:58:40 +000025#include "llvm/LLVMContext.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026#include "llvm/System/Program.h"
27#include "llvm/Module.h"
28#include "llvm/PassManager.h"
29#include "llvm/Bitcode/ReaderWriter.h"
30#include "llvm/Target/TargetData.h"
31#include "llvm/Target/TargetMachine.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000032#include "llvm/Support/CommandLine.h"
Dan Gohmane24c8d22010-03-30 19:56:41 +000033#include "llvm/Support/FileUtilities.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000034#include "llvm/Support/ManagedStatic.h"
35#include "llvm/Support/MemoryBuffer.h"
Chris Lattnere6012df2009-03-06 05:34:10 +000036#include "llvm/Support/PrettyStackTrace.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000037#include "llvm/Support/SystemUtils.h"
Dan Gohman5d610b12010-10-07 20:32:40 +000038#include "llvm/Support/ToolOutputFile.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000039#include "llvm/System/Signals.h"
Chris Lattner2587bd92009-01-05 19:01:32 +000040#include "llvm/Config/config.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000041#include <memory>
Anton Korobeynikov357a27d2008-02-20 11:08:44 +000042#include <cstring>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000043using namespace llvm;
44
Dan Gohman8e0b7b9d2009-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +000050// Input/Output Options
51static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
52 cl::desc("<input bitcode files>"));
53
54static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
55 cl::desc("Override output filename"),
56 cl::value_desc("filename"));
57
Sanjiv Guptad5b21d62009-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +000062static cl::opt<bool> Verbose("v",
63 cl::desc("Print information about actions taken"));
64
65static cl::list<std::string> LibPaths("L", cl::Prefix,
66 cl::desc("Specify a library search path"),
67 cl::value_desc("directory"));
68
Chris Lattner5247f172008-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +000073static cl::list<std::string> Libraries("l", cl::Prefix,
74 cl::desc("Specify libraries to link to"),
75 cl::value_desc("library prefix"));
76
Chris Lattner5247f172008-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +000081// Options to control the linking, optimization, and code gen processes
82static cl::opt<bool> LinkAsLibrary("link-as-library",
83 cl::desc("Link the .bc files together as a library, not an executable"));
84
85static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
86 cl::desc("Alias for -link-as-library"));
87
Dan Gohmanf17a25c2007-07-18 16:29:46 +000088static cl::opt<bool> Native("native",
89 cl::desc("Generate a native binary instead of a shell script"));
90
91static cl::opt<bool>NativeCBE("native-cbe",
92 cl::desc("Generate a native binary with the C backend and GCC"));
93
94static cl::list<std::string> PostLinkOpts("post-link-opts",
95 cl::value_desc("path"),
96 cl::desc("Run one or more optimization programs after linking"));
97
98static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
99 cl::desc("Pass options to the system linker"));
100
101// Compatibility options that llvm-ld ignores but are supported for
102// compatibility with LD
103static cl::opt<std::string> CO3("soname", cl::Hidden,
104 cl::desc("Compatibility option: ignored"));
105
106static cl::opt<std::string> CO4("version-script", cl::Hidden,
107 cl::desc("Compatibility option: ignored"));
108
109static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
110 cl::desc("Compatibility option: ignored"));
111
112static cl::opt<std::string> CO6("h", cl::Hidden,
113 cl::desc("Compatibility option: ignored"));
114
115static 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"));
120
Andrew Lenharth45d0e162008-11-19 17:00:08 +0000121static cl::opt<std::string> CO9("m", cl::Hidden,
122 cl::desc("Compatibility option: ignored"));
123
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000124/// This is just for convenience so it doesn't have to be passed around
125/// everywhere.
126static std::string progname;
127
Dan Gohmane24c8d22010-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000132/// PrintAndExit - Prints a message to standard error and exits with error code
133///
134/// Inputs:
135/// Message - The message to print to standard error.
136///
Chris Lattner7f4c1532010-03-23 21:59:43 +0000137static void PrintAndExit(const std::string &Message, Module *M, int errcode = 1) {
Dan Gohmanb714fab2009-07-16 15:30:09 +0000138 errs() << progname << ": " << Message << "\n";
Chris Lattner7f4c1532010-03-23 21:59:43 +0000139 delete M;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000140 llvm_shutdown();
141 exit(errcode);
142}
143
144static 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 Gohman38bd1f72010-08-20 01:02:14 +0000148 errs() << "'" << *I << "'" << " ";
149 errs() << "\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000150}
151
152/// 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 Kramerd65ad3c62010-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);
Dan Gohmanf17a25c2007-07-18 16:29:46 +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
231/// GenerateBitcode - generates a bitcode file from the module provided
232void GenerateBitcode(Module* M, const std::string& FileName) {
233
234 if (Verbose)
Dan Gohman38bd1f72010-08-20 01:02:14 +0000235 errs() << "Generating Bitcode To " << FileName << '\n';
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000236
237 // Create the output file.
Dan Gohmanb714fab2009-07-16 15:30:09 +0000238 std::string ErrorInfo;
Dan Gohmanea0c5112010-08-20 16:59:15 +0000239 tool_output_file Out(FileName.c_str(), ErrorInfo,
240 raw_fd_ostream::F_Binary);
241 if (!ErrorInfo.empty()) {
Chris Lattner7f4c1532010-03-23 21:59:43 +0000242 PrintAndExit(ErrorInfo, M);
Dan Gohmanea0c5112010-08-20 16:59:15 +0000243 return;
244 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000245
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000246 // Write it out
Dan Gohman9812a162010-09-01 14:20:41 +0000247 WriteBitcodeToFile(M, Out.os());
Dan Gohmanea0c5112010-08-20 16:59:15 +0000248 Out.keep();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000249}
250
251/// GenerateAssembly - generates a native assembly language source file from the
252/// specified bitcode file.
253///
254/// Inputs:
255/// InputFilename - The name of the input bitcode file.
256/// OutputFilename - The name of the file to generate.
257/// llc - The pathname to use for LLC.
258/// envp - The environment to use when running LLC.
259///
260/// Return non-zero value on error.
261///
262static int GenerateAssembly(const std::string &OutputFilename,
263 const std::string &InputFilename,
264 const sys::Path &llc,
265 std::string &ErrMsg ) {
266 // Run LLC to convert the bitcode file into assembly code.
267 std::vector<const char*> args;
268 args.push_back(llc.c_str());
Argiris Kirtzidisbbef6c22008-06-27 15:08:59 +0000269 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
270 // regardless of what the target in the bitcode file is.
271 args.push_back("-x86-asm-syntax=att");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000272 args.push_back("-o");
273 args.push_back(OutputFilename.c_str());
274 args.push_back(InputFilename.c_str());
275 args.push_back(0);
276
277 if (Verbose) {
Dan Gohman38bd1f72010-08-20 01:02:14 +0000278 errs() << "Generating Assembly With: \n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000279 PrintCommand(args);
280 }
281
282 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
283}
284
285/// GenerateCFile - generates a C source file from the specified bitcode file.
286static int GenerateCFile(const std::string &OutputFile,
287 const std::string &InputFile,
288 const sys::Path &llc,
289 std::string& ErrMsg) {
290 // Run LLC to convert the bitcode file into C.
291 std::vector<const char*> args;
292 args.push_back(llc.c_str());
293 args.push_back("-march=c");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000294 args.push_back("-o");
295 args.push_back(OutputFile.c_str());
296 args.push_back(InputFile.c_str());
297 args.push_back(0);
298
299 if (Verbose) {
Dan Gohman38bd1f72010-08-20 01:02:14 +0000300 errs() << "Generating C Source With: \n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000301 PrintCommand(args);
302 }
303
304 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
305}
306
307/// GenerateNative - generates a native object file from the
308/// specified bitcode file.
309///
310/// Inputs:
311/// InputFilename - The name of the input bitcode file.
312/// OutputFilename - The name of the file to generate.
313/// NativeLinkItems - The native libraries, files, code with which to link
314/// LibPaths - The list of directories in which to find libraries.
Chris Lattner5247f172008-01-27 22:58:59 +0000315/// FrameworksPaths - The list of directories in which to find frameworks.
316/// Frameworks - The list of frameworks (dynamic libraries)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000317/// gcc - The pathname to use for GGC.
318/// envp - A copy of the process's current environment.
319///
320/// Outputs:
321/// None.
322///
323/// Returns non-zero value on error.
324///
325static int GenerateNative(const std::string &OutputFilename,
326 const std::string &InputFilename,
327 const Linker::ItemList &LinkItems,
328 const sys::Path &gcc, char ** const envp,
329 std::string& ErrMsg) {
330 // Remove these environment variables from the environment of the
331 // programs that we will execute. It appears that GCC sets these
332 // environment variables so that the programs it uses can configure
333 // themselves identically.
334 //
335 // However, when we invoke GCC below, we want it to use its normal
336 // configuration. Hence, we must sanitize its environment.
337 char ** clean_env = CopyEnv(envp);
338 if (clean_env == NULL)
339 return 1;
340 RemoveEnv("LIBRARY_PATH", clean_env);
341 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
342 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
343 RemoveEnv("COMPILER_PATH", clean_env);
344 RemoveEnv("COLLECT_GCC", clean_env);
345
346
347 // Run GCC to assemble and link the program into native code.
348 //
349 // Note:
350 // We can't just assemble and link the file with the system assembler
351 // and linker because we don't know where to put the _start symbol.
352 // GCC mysteriously knows how to do it.
353 std::vector<std::string> args;
354 args.push_back(gcc.c_str());
355 args.push_back("-fno-strict-aliasing");
356 args.push_back("-O3");
357 args.push_back("-o");
358 args.push_back(OutputFilename);
359 args.push_back(InputFilename);
360
Chris Lattner5247f172008-01-27 22:58:59 +0000361 // Add in the library and framework paths
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000362 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner5247f172008-01-27 22:58:59 +0000363 args.push_back("-L" + LibPaths[index]);
364 }
365 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
366 args.push_back("-F" + FrameworkPaths[index]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000367 }
368
369 // Add the requested options
Chris Lattner890df602008-01-09 01:01:17 +0000370 for (unsigned index = 0; index < XLinker.size(); index++)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000371 args.push_back(XLinker[index]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000372
373 // Add in the libraries to link.
374 for (unsigned index = 0; index < LinkItems.size(); index++)
375 if (LinkItems[index].first != "crtend") {
376 if (LinkItems[index].second)
377 args.push_back("-l" + LinkItems[index].first);
378 else
379 args.push_back(LinkItems[index].first);
380 }
381
Chris Lattner5247f172008-01-27 22:58:59 +0000382 // Add in frameworks to link.
383 for (unsigned index = 0; index < Frameworks.size(); index++) {
384 args.push_back("-framework");
385 args.push_back(Frameworks[index]);
386 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000387
388 // Now that "args" owns all the std::strings for the arguments, call the c_str
389 // method to get the underlying string array. We do this game so that the
390 // std::string array is guaranteed to outlive the const char* array.
391 std::vector<const char *> Args;
392 for (unsigned i = 0, e = args.size(); i != e; ++i)
393 Args.push_back(args[i].c_str());
394 Args.push_back(0);
395
396 if (Verbose) {
Dan Gohman38bd1f72010-08-20 01:02:14 +0000397 errs() << "Generating Native Executable With:\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000398 PrintCommand(Args);
399 }
400
401 // Run the compiler to assembly and link together the program.
402 int R = sys::Program::ExecuteAndWait(
Dan Gohmanbf091b22010-04-17 17:44:03 +0000403 gcc, &Args[0], const_cast<const char **>(clean_env), 0, 0, 0, &ErrMsg);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000404 delete [] clean_env;
405 return R;
406}
407
408/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
409/// bitcode file for the program.
Chris Lattner7f4c1532010-03-23 21:59:43 +0000410static void EmitShellScript(char **argv, Module *M) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000411 if (Verbose)
Dan Gohman38bd1f72010-08-20 01:02:14 +0000412 errs() << "Emitting Shell Script\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000413#if defined(_WIN32) || defined(__CYGWIN__)
414 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
415 // support windows systems, we copy the llvm-stub.exe executable from the
416 // build tree to the destination file.
417 std::string ErrMsg;
Dan Gohman8e0b7b9d2009-08-05 20:21:17 +0000418 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0],
Dan Gohman108e0ed2009-08-05 21:03:39 +0000419 (void *)(intptr_t)&Optimize);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000420 if (llvmstub.isEmpty())
Chris Lattner7f4c1532010-03-23 21:59:43 +0000421 PrintAndExit("Could not find llvm-stub.exe executable!", M);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000422
Argiris Kirtzidis68c84262008-06-15 13:48:12 +0000423 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000424 PrintAndExit(ErrMsg, M);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000425
426 return;
427#endif
428
429 // Output the script to start the program...
Dan Gohmanb714fab2009-07-16 15:30:09 +0000430 std::string ErrorInfo;
Dan Gohmanea0c5112010-08-20 16:59:15 +0000431 tool_output_file Out2(OutputFilename.c_str(), ErrorInfo);
Dan Gohmanb714fab2009-07-16 15:30:09 +0000432 if (!ErrorInfo.empty())
Chris Lattner7f4c1532010-03-23 21:59:43 +0000433 PrintAndExit(ErrorInfo, M);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000434
Dan Gohman9812a162010-09-01 14:20:41 +0000435 Out2.os() << "#!/bin/sh\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000436 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
Dan Gohman9812a162010-09-01 14:20:41 +0000437 Out2.os() << "lli=${LLVMINTERP-lli}\n";
438 Out2.os() << "exec $lli \\\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000439 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
440 LibPaths.push_back("/lib");
441 LibPaths.push_back("/usr/lib");
442 LibPaths.push_back("/usr/X11R6/lib");
443 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
444 // shared object at all! See RH 8: plain text.
445 std::vector<std::string>::iterator libc =
446 std::find(Libraries.begin(), Libraries.end(), "c");
447 if (libc != Libraries.end()) Libraries.erase(libc);
448 // List all the shared object (native) libraries this executable will need
449 // on the command line, so that we don't have to do this manually!
450 for (std::vector<std::string>::iterator i = Libraries.begin(),
451 e = Libraries.end(); i != e; ++i) {
Chris Lattner2587bd92009-01-05 19:01:32 +0000452 // try explicit -L arguments first:
453 sys::Path FullLibraryPath;
454 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
455 E = LibPaths.end(); P != E; ++P) {
456 FullLibraryPath = *P;
457 FullLibraryPath.appendComponent("lib" + *i);
458 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
459 if (!FullLibraryPath.isEmpty()) {
460 if (!FullLibraryPath.isDynamicLibrary()) {
461 // Not a native shared library; mark as invalid
462 FullLibraryPath = sys::Path();
463 } else break;
464 }
465 }
466 if (FullLibraryPath.isEmpty())
467 FullLibraryPath = sys::Path::FindLibrary(*i);
468 if (!FullLibraryPath.isEmpty())
Dan Gohman9812a162010-09-01 14:20:41 +0000469 Out2.os() << " -load=" << FullLibraryPath.str() << " \\\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000470 }
Dan Gohman9812a162010-09-01 14:20:41 +0000471 Out2.os() << " " << BitcodeOutputFilename << " ${1+\"$@\"}\n";
Dan Gohmanea0c5112010-08-20 16:59:15 +0000472 Out2.keep();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000473}
474
475// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
476// linker function by combining the Files and Libraries in the order they were
477// declared on the command line.
478static void BuildLinkItems(
479 Linker::ItemList& Items,
480 const cl::list<std::string>& Files,
481 const cl::list<std::string>& Libraries) {
482
483 // Build the list of linkage items for LinkItems.
484
485 cl::list<std::string>::const_iterator fileIt = Files.begin();
486 cl::list<std::string>::const_iterator libIt = Libraries.begin();
487
488 int libPos = -1, filePos = -1;
489 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
490 if (libIt != Libraries.end())
491 libPos = Libraries.getPosition(libIt - Libraries.begin());
492 else
493 libPos = -1;
494 if (fileIt != Files.end())
495 filePos = Files.getPosition(fileIt - Files.begin());
496 else
497 filePos = -1;
498
499 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
500 // Add a source file
501 Items.push_back(std::make_pair(*fileIt++, false));
502 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
503 // Add a library
504 Items.push_back(std::make_pair(*libIt++, true));
505 }
506 }
507}
508
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000509int main(int argc, char **argv, char **envp) {
Chris Lattnere6012df2009-03-06 05:34:10 +0000510 // Print a stack trace if we signal out.
511 sys::PrintStackTraceOnErrorSignal();
512 PrettyStackTraceProgram X(argc, argv);
Owen Anderson25209b42009-07-01 16:58:40 +0000513
Owen Andersone84b8b32009-07-15 22:16:10 +0000514 LLVMContext &Context = getGlobalContext();
Chris Lattnere6012df2009-03-06 05:34:10 +0000515 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000516
Owen Andersona65d6a62010-10-19 17:21:58 +0000517 // Initialize passes
518 PassRegistry &Registry = *PassRegistry::getPassRegistry();
519 initializeCore(Registry);
520 initializeScalarOpts(Registry);
521 initializeIPO(Registry);
522 initializeAnalysis(Registry);
523 initializeIPA(Registry);
524 initializeTransformUtils(Registry);
525 initializeInstCombine(Registry);
526 initializeTarget(Registry);
527
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000528 // Initial global variable above for convenience printing of program name.
529 progname = sys::Path(argv[0]).getBasename();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000530
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000531 // Parse the command line options
532 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000533
Dan Gohmane24c8d22010-03-30 19:56:41 +0000534#if defined(_WIN32) || defined(__CYGWIN__)
535 if (!LinkAsLibrary) {
536 // Default to "a.exe" instead of "a.out".
537 if (OutputFilename.getNumOccurrences() == 0)
538 OutputFilename = "a.exe";
539
540 // If there is no suffix add an "exe" one.
541 sys::Path ExeFile( OutputFilename );
542 if (ExeFile.getSuffix() == "") {
543 ExeFile.appendSuffix("exe");
544 OutputFilename = ExeFile.str();
545 }
546 }
547#endif
548
549 // Generate the bitcode for the optimized module.
550 // If -b wasn't specified, use the name specified
551 // with -o to construct BitcodeOutputFilename.
552 if (BitcodeOutputFilename.empty()) {
553 BitcodeOutputFilename = OutputFilename;
554 if (!LinkAsLibrary) BitcodeOutputFilename += ".bc";
555 }
556
557 // Arrange for the bitcode output file to be deleted on any errors.
558 BitcodeOutputRemover.setFile(sys::Path(BitcodeOutputFilename));
559 sys::RemoveFileOnSignal(sys::Path(BitcodeOutputFilename));
560
561 // Arrange for the output file to be deleted on any errors.
562 if (!LinkAsLibrary) {
563 OutputRemover.setFile(sys::Path(OutputFilename));
564 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
565 }
566
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000567 // Construct a Linker (now that Verbose is set)
568 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000569
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000570 // Keep track of the native link items (versus the bitcode items)
571 Linker::ItemList NativeLinkItems;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000572
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000573 // Add library paths to the linker
574 TheLinker.addPaths(LibPaths);
575 TheLinker.addSystemPaths();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000576
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000577 // Remove any consecutive duplicates of the same library...
578 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
579 Libraries.end());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000580
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000581 if (LinkAsLibrary) {
582 std::vector<sys::Path> Files;
583 for (unsigned i = 0; i < InputFilenames.size(); ++i )
584 Files.push_back(sys::Path(InputFilenames[i]));
585 if (TheLinker.LinkInFiles(Files))
586 return 1; // Error already printed
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000587
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000588 // The libraries aren't linked in but are noted as "dependent" in the
589 // module.
590 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
591 E = Libraries.end(); I != E ; ++I) {
592 TheLinker.getModule()->addLibrary(*I);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000593 }
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000594 } else {
595 // Build a list of the items from our command line
596 Linker::ItemList Items;
597 BuildLinkItems(Items, InputFilenames, Libraries);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000598
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000599 // Link all the items together
600 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
601 return 1; // Error already printed
602 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000603
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000604 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
605
606 // Optimize the module
607 Optimize(Composite.get());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000608
Dan Gohmane24c8d22010-03-30 19:56:41 +0000609 // Generate the bitcode output.
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000610 GenerateBitcode(Composite.get(), BitcodeOutputFilename);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000611
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000612 // If we are not linking a library, generate either a native executable
613 // or a JIT shell script, depending upon what the user wants.
614 if (!LinkAsLibrary) {
615 // If the user wants to run a post-link optimization, run it now.
616 if (!PostLinkOpts.empty()) {
617 std::vector<std::string> opts = PostLinkOpts;
618 for (std::vector<std::string>::iterator I = opts.begin(),
619 E = opts.end(); I != E; ++I) {
620 sys::Path prog(*I);
621 if (!prog.canExecute()) {
622 prog = sys::Program::FindProgramByName(*I);
623 if (prog.isEmpty())
624 PrintAndExit(std::string("Optimization program '") + *I +
Chris Lattner7f4c1532010-03-23 21:59:43 +0000625 "' is not found or not executable.", Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000626 }
627 // Get the program arguments
628 sys::Path tmp_output("opt_result");
629 std::string ErrMsg;
630 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000631 PrintAndExit(ErrMsg, Composite.get());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000632
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000633 const char* args[4];
634 args[0] = I->c_str();
635 args[1] = BitcodeOutputFilename.c_str();
636 args[2] = tmp_output.c_str();
637 args[3] = 0;
638 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
Dan Gohman3122eb22010-03-27 16:36:08 +0000639 if (tmp_output.isBitcodeFile()) {
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000640 sys::Path target(BitcodeOutputFilename);
641 target.eraseFromDisk();
642 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000643 PrintAndExit(ErrMsg, Composite.get(), 2);
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000644 } else
Chris Lattner7f4c1532010-03-23 21:59:43 +0000645 PrintAndExit("Post-link optimization output is not bitcode",
646 Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000647 } else {
Chris Lattner7f4c1532010-03-23 21:59:43 +0000648 PrintAndExit(ErrMsg, Composite.get());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000649 }
650 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000651 }
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000652
653 // If the user wants to generate a native executable, compile it from the
654 // bitcode file.
655 //
656 // Otherwise, create a script that will run the bitcode through the JIT.
657 if (Native) {
658 // Name of the Assembly Language output file
659 sys::Path AssemblyFile ( OutputFilename);
660 AssemblyFile.appendSuffix("s");
661
Dan Gohmane24c8d22010-03-30 19:56:41 +0000662 // Mark the output files for removal.
663 FileRemover AssemblyFileRemover(AssemblyFile);
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000664 sys::RemoveFileOnSignal(AssemblyFile);
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000665
666 // Determine the locations of the llc and gcc programs.
667 sys::Path llc = FindExecutable("llc", argv[0],
668 (void *)(intptr_t)&Optimize);
669 if (llc.isEmpty())
Chris Lattner7f4c1532010-03-23 21:59:43 +0000670 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000671
672 sys::Path gcc = sys::Program::FindProgramByName("gcc");
673 if (gcc.isEmpty())
Chris Lattner7f4c1532010-03-23 21:59:43 +0000674 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000675
676 // Generate an assembly language file for the bitcode.
677 std::string ErrMsg;
678 if (0 != GenerateAssembly(AssemblyFile.str(), BitcodeOutputFilename,
679 llc, ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000680 PrintAndExit(ErrMsg, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000681
682 if (0 != GenerateNative(OutputFilename, AssemblyFile.str(),
683 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000684 PrintAndExit(ErrMsg, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000685 } else if (NativeCBE) {
686 sys::Path CFile (OutputFilename);
687 CFile.appendSuffix("cbe.c");
688
Dan Gohmane24c8d22010-03-30 19:56:41 +0000689 // Mark the output files for removal.
690 FileRemover CFileRemover(CFile);
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000691 sys::RemoveFileOnSignal(CFile);
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000692
693 // Determine the locations of the llc and gcc programs.
694 sys::Path llc = FindExecutable("llc", argv[0],
695 (void *)(intptr_t)&Optimize);
696 if (llc.isEmpty())
Chris Lattner7f4c1532010-03-23 21:59:43 +0000697 PrintAndExit("Failed to find llc", Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000698
699 sys::Path gcc = sys::Program::FindProgramByName("gcc");
700 if (gcc.isEmpty())
Chris Lattner7f4c1532010-03-23 21:59:43 +0000701 PrintAndExit("Failed to find gcc", Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000702
703 // Generate an assembly language file for the bitcode.
704 std::string ErrMsg;
705 if (GenerateCFile(CFile.str(), BitcodeOutputFilename, llc, ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000706 PrintAndExit(ErrMsg, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000707
708 if (GenerateNative(OutputFilename, CFile.str(),
709 NativeLinkItems, gcc, envp, ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000710 PrintAndExit(ErrMsg, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000711 } else {
Chris Lattner7f4c1532010-03-23 21:59:43 +0000712 EmitShellScript(argv, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000713 }
714
715 // Make the script executable...
716 std::string ErrMsg;
717 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000718 PrintAndExit(ErrMsg, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000719
720 // Make the bitcode file readable and directly executable in LLEE as well
721 if (sys::Path(BitcodeOutputFilename).makeExecutableOnDisk(&ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000722 PrintAndExit(ErrMsg, Composite.get());
Chris Lattnerc1a226d2009-10-22 00:52:28 +0000723
724 if (sys::Path(BitcodeOutputFilename).makeReadableOnDisk(&ErrMsg))
Chris Lattner7f4c1532010-03-23 21:59:43 +0000725 PrintAndExit(ErrMsg, Composite.get());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000726 }
727
Dan Gohmane24c8d22010-03-30 19:56:41 +0000728 // Operations which may fail are now complete.
729 BitcodeOutputRemover.releaseFile();
730 if (!LinkAsLibrary)
731 OutputRemover.releaseFile();
732
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000733 // Graceful exit
734 return 0;
735}