blob: ba517300b19181df265c39d0e8cd7835dd053745 [file] [log] [blame]
Reid Spencerc0af3f02004-09-13 01:27:53 +00001//===- llvm-ld.cpp - LLVM 'ld' compatible linker --------------------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
Reid Spencerc0af3f02004-09-13 01:27:53 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner21c62da2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
Reid Spencerc0af3f02004-09-13 01:27:53 +00008//===----------------------------------------------------------------------===//
9//
10// This utility is intended to be compatible with GCC, and follows standard
11// system 'ld' conventions. As such, the default output file is ./a.out.
12// Additionally, this program outputs a shell script that is used to invoke LLI
13// to execute the program. In this manner, the generated executable (a.out for
Gabor Greifa99be512007-07-05 17:07:56 +000014// example), is directly executable, whereas the bitcode file actually lives in
Reid Spencerc0af3f02004-09-13 01:27:53 +000015// the a.out.bc file generated by this program. Also, Force is on by default.
16//
17// Note that if someone (or a script) deletes the executable program generated,
18// the .bc file will be left around. Considering that this is a temporary hack,
19// I'm not too worried about this.
20//
21//===----------------------------------------------------------------------===//
22
Reid Spenceraf303d52006-06-07 23:03:13 +000023#include "llvm/LinkAllVMCore.h"
Reid Spencer605b9e22004-11-14 23:00:08 +000024#include "llvm/Linker.h"
Owen Anderson8b477ed2009-07-01 16:58:40 +000025#include "llvm/LLVMContext.h"
Reid Spencer6da1e0d2004-12-14 04:20:08 +000026#include "llvm/System/Program.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000027#include "llvm/Module.h"
28#include "llvm/PassManager.h"
Chris Lattnerbb3f3d32007-05-06 05:56:58 +000029#include "llvm/Bitcode/ReaderWriter.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000030#include "llvm/Target/TargetData.h"
Reid Spenceraefd04b2004-09-25 16:00:07 +000031#include "llvm/Target/TargetMachine.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000032#include "llvm/Support/CommandLine.h"
33#include "llvm/Support/FileUtilities.h"
Chris Lattnerc30598b2006-12-06 01:18:01 +000034#include "llvm/Support/ManagedStatic.h"
Chris Lattnerbb3f3d32007-05-06 05:56:58 +000035#include "llvm/Support/MemoryBuffer.h"
Chris Lattnercc14d252009-03-06 05:34:10 +000036#include "llvm/Support/PrettyStackTrace.h"
Bill Wendling68fe61d2006-11-29 00:19:40 +000037#include "llvm/Support/Streams.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000038#include "llvm/Support/SystemUtils.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 <fstream>
42#include <memory>
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000043#include <cstring>
Reid Spencerc0af3f02004-09-13 01:27:53 +000044using namespace llvm;
45
Reid Spencer445564a2004-11-20 20:02:56 +000046// Input/Output Options
47static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
Gabor Greifa99be512007-07-05 17:07:56 +000048 cl::desc("<input bitcode files>"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000049
Reid Spencer445564a2004-11-20 20:02:56 +000050static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
Misha Brukman3da94ae2005-04-22 00:00:37 +000051 cl::desc("Override output filename"),
Reid Spencer445564a2004-11-20 20:02:56 +000052 cl::value_desc("filename"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000053
Misha Brukman3da94ae2005-04-22 00:00:37 +000054static cl::opt<bool> Verbose("v",
Reid Spencer445564a2004-11-20 20:02:56 +000055 cl::desc("Print information about actions taken"));
Misha Brukman3da94ae2005-04-22 00:00:37 +000056
Reid Spencer445564a2004-11-20 20:02:56 +000057static cl::list<std::string> LibPaths("L", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000058 cl::desc("Specify a library search path"),
Reid Spencer445564a2004-11-20 20:02:56 +000059 cl::value_desc("directory"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000060
Chris Lattner3992f522008-01-27 22:58:59 +000061static cl::list<std::string> FrameworkPaths("F", cl::Prefix,
62 cl::desc("Specify a framework search path"),
63 cl::value_desc("directory"));
64
Reid Spencer445564a2004-11-20 20:02:56 +000065static cl::list<std::string> Libraries("l", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000066 cl::desc("Specify libraries to link to"),
Reid Spencer445564a2004-11-20 20:02:56 +000067 cl::value_desc("library prefix"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000068
Chris Lattner3992f522008-01-27 22:58:59 +000069static cl::list<std::string> Frameworks("framework",
70 cl::desc("Specify frameworks to link to"),
71 cl::value_desc("framework"));
72
Reid Spencer708585a2007-02-09 03:08:06 +000073// Options to control the linking, optimization, and code gen processes
Misha Brukman3da94ae2005-04-22 00:00:37 +000074static cl::opt<bool> LinkAsLibrary("link-as-library",
Reid Spencer445564a2004-11-20 20:02:56 +000075 cl::desc("Link the .bc files together as a library, not an executable"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000076
Reid Spencer445564a2004-11-20 20:02:56 +000077static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
78 cl::desc("Alias for -link-as-library"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000079
Reid Spencer445564a2004-11-20 20:02:56 +000080static cl::opt<bool> Native("native",
81 cl::desc("Generate a native binary instead of a shell script"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000082
Reid Spencer445564a2004-11-20 20:02:56 +000083static cl::opt<bool>NativeCBE("native-cbe",
84 cl::desc("Generate a native binary with the C backend and GCC"));
85
Reid Spencer73a74be2005-12-21 05:03:23 +000086static cl::list<std::string> PostLinkOpts("post-link-opts",
Reid Spenceraf303d52006-06-07 23:03:13 +000087 cl::value_desc("path"),
Reid Spencer73a74be2005-12-21 05:03:23 +000088 cl::desc("Run one or more optimization programs after linking"));
89
Reid Spenceraf303d52006-06-07 23:03:13 +000090static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
91 cl::desc("Pass options to the system linker"));
92
Reid Spencer708585a2007-02-09 03:08:06 +000093// Compatibility options that llvm-ld ignores but are supported for
94// compatibility with LD
Misha Brukman3da94ae2005-04-22 00:00:37 +000095static cl::opt<std::string> CO3("soname", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +000096 cl::desc("Compatibility option: ignored"));
97
Misha Brukman3da94ae2005-04-22 00:00:37 +000098static cl::opt<std::string> CO4("version-script", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +000099 cl::desc("Compatibility option: ignored"));
100
Misha Brukman3da94ae2005-04-22 00:00:37 +0000101static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000102 cl::desc("Compatibility option: ignored"));
103
Misha Brukman3da94ae2005-04-22 00:00:37 +0000104static cl::opt<std::string> CO6("h", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000105 cl::desc("Compatibility option: ignored"));
106
Reid Spencer98a030c2007-02-08 19:03:11 +0000107static cl::opt<bool> CO7("start-group", cl::Hidden,
108 cl::desc("Compatibility option: ignored"));
109
110static cl::opt<bool> CO8("end-group", cl::Hidden,
111 cl::desc("Compatibility option: ignored"));
Reid Spenceraf303d52006-06-07 23:03:13 +0000112
Andrew Lenharth0c6ba442008-11-19 17:00:08 +0000113static cl::opt<std::string> CO9("m", cl::Hidden,
114 cl::desc("Compatibility option: ignored"));
115
Reid Spencer445564a2004-11-20 20:02:56 +0000116/// This is just for convenience so it doesn't have to be passed around
117/// everywhere.
Reid Spencerc4064132004-12-13 03:01:14 +0000118static std::string progname;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000119
Reid Spencer708585a2007-02-09 03:08:06 +0000120/// PrintAndExit - Prints a message to standard error and exits with error code
Reid Spencerc0af3f02004-09-13 01:27:53 +0000121///
122/// Inputs:
Reid Spencerc0af3f02004-09-13 01:27:53 +0000123/// Message - The message to print to standard error.
124///
Reid Spencer708585a2007-02-09 03:08:06 +0000125static void PrintAndExit(const std::string &Message, int errcode = 1) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000126 cerr << progname << ": " << Message << "\n";
Reid Spencer708585a2007-02-09 03:08:06 +0000127 llvm_shutdown();
128 exit(errcode);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000129}
130
Reid Spencer3b726392007-04-29 23:59:47 +0000131static void PrintCommand(const std::vector<const char*> &args) {
132 std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
133 for (; I != E; ++I)
134 if (*I)
135 cout << "'" << *I << "'" << " ";
136 cout << "\n" << std::flush;
137}
138
Reid Spencer445564a2004-11-20 20:02:56 +0000139/// CopyEnv - This function takes an array of environment variables and makes a
140/// copy of it. This copy can then be manipulated any way the caller likes
141/// without affecting the process's real environment.
142///
143/// Inputs:
144/// envp - An array of C strings containing an environment.
145///
146/// Return value:
147/// NULL - An error occurred.
148///
149/// Otherwise, a pointer to a new array of C strings is returned. Every string
150/// in the array is a duplicate of the one in the original array (i.e. we do
151/// not copy the char *'s from one array to another).
152///
153static char ** CopyEnv(char ** const envp) {
154 // Count the number of entries in the old list;
155 unsigned entries; // The number of entries in the old environment list
156 for (entries = 0; envp[entries] != NULL; entries++)
157 /*empty*/;
158
159 // Add one more entry for the NULL pointer that ends the list.
160 ++entries;
161
162 // If there are no entries at all, just return NULL.
163 if (entries == 0)
164 return NULL;
165
166 // Allocate a new environment list.
167 char **newenv = new char* [entries];
168 if ((newenv = new char* [entries]) == NULL)
169 return NULL;
170
171 // Make a copy of the list. Don't forget the NULL that ends the list.
172 entries = 0;
173 while (envp[entries] != NULL) {
174 newenv[entries] = new char[strlen (envp[entries]) + 1];
175 strcpy (newenv[entries], envp[entries]);
176 ++entries;
177 }
178 newenv[entries] = NULL;
179
180 return newenv;
181}
182
183
184/// RemoveEnv - Remove the specified environment variable from the environment
185/// array.
186///
187/// Inputs:
188/// name - The name of the variable to remove. It cannot be NULL.
189/// envp - The array of environment variables. It cannot be NULL.
190///
191/// Notes:
192/// This is mainly done because functions to remove items from the environment
193/// are not available across all platforms. In particular, Solaris does not
194/// seem to have an unsetenv() function or a setenv() function (or they are
195/// undocumented if they do exist).
196///
197static void RemoveEnv(const char * name, char ** const envp) {
198 for (unsigned index=0; envp[index] != NULL; index++) {
199 // Find the first equals sign in the array and make it an EOS character.
200 char *p = strchr (envp[index], '=');
201 if (p == NULL)
202 continue;
203 else
204 *p = '\0';
205
206 // Compare the two strings. If they are equal, zap this string.
207 // Otherwise, restore it.
208 if (!strcmp(name, envp[index]))
209 *envp[index] = '\0';
210 else
211 *p = '=';
212 }
213
214 return;
215}
216
Gabor Greifa99be512007-07-05 17:07:56 +0000217/// GenerateBitcode - generates a bitcode file from the module provided
218void GenerateBitcode(Module* M, const std::string& FileName) {
Reid Spencer445564a2004-11-20 20:02:56 +0000219
Reid Spencer3b726392007-04-29 23:59:47 +0000220 if (Verbose)
Gabor Greifa99be512007-07-05 17:07:56 +0000221 cout << "Generating Bitcode To " << FileName << '\n';
Reid Spencer3b726392007-04-29 23:59:47 +0000222
Reid Spencer445564a2004-11-20 20:02:56 +0000223 // Create the output file.
Jeff Cohen5fb6ed42005-01-22 17:36:17 +0000224 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
225 std::ios::binary;
226 std::ofstream Out(FileName.c_str(), io_mode);
Reid Spencer708585a2007-02-09 03:08:06 +0000227 if (!Out.good())
228 PrintAndExit("error opening '" + FileName + "' for writing!");
Reid Spencer445564a2004-11-20 20:02:56 +0000229
Gabor Greifa99be512007-07-05 17:07:56 +0000230 // Ensure that the bitcode file gets removed from the disk if we get a
Reid Spencer445564a2004-11-20 20:02:56 +0000231 // terminating signal.
232 sys::RemoveFileOnSignal(sys::Path(FileName));
233
234 // Write it out
Chris Lattner44dadff2007-05-06 09:29:57 +0000235 WriteBitcodeToFile(M, Out);
Reid Spencer445564a2004-11-20 20:02:56 +0000236
Gabor Greifa99be512007-07-05 17:07:56 +0000237 // Close the bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000238 Out.close();
239}
240
241/// GenerateAssembly - generates a native assembly language source file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000242/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000243///
244/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000245/// InputFilename - The name of the input bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000246/// OutputFilename - The name of the file to generate.
247/// llc - The pathname to use for LLC.
248/// envp - The environment to use when running LLC.
249///
250/// Return non-zero value on error.
251///
252static int GenerateAssembly(const std::string &OutputFilename,
253 const std::string &InputFilename,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000254 const sys::Path &llc,
255 std::string &ErrMsg ) {
Gabor Greifa99be512007-07-05 17:07:56 +0000256 // Run LLC to convert the bitcode file into assembly code.
Reid Spencerf6358c72004-12-19 18:00:56 +0000257 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000258 args.push_back(llc.c_str());
Argyrios Kyrtzidisca29dff2008-06-27 15:08:59 +0000259 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
260 // regardless of what the target in the bitcode file is.
261 args.push_back("-x86-asm-syntax=att");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000262 args.push_back("-f");
263 args.push_back("-o");
264 args.push_back(OutputFilename.c_str());
265 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000266 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000267
Reid Spencer3b726392007-04-29 23:59:47 +0000268 if (Verbose) {
269 cout << "Generating Assembly With: \n";
270 PrintCommand(args);
271 }
272
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000273 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000274}
275
Gabor Greifa99be512007-07-05 17:07:56 +0000276/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000277static int GenerateCFile(const std::string &OutputFile,
278 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000279 const sys::Path &llc,
280 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000281 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000282 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000283 args.push_back(llc.c_str());
284 args.push_back("-march=c");
285 args.push_back("-f");
286 args.push_back("-o");
287 args.push_back(OutputFile.c_str());
288 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000289 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000290
291 if (Verbose) {
292 cout << "Generating C Source With: \n";
293 PrintCommand(args);
294 }
295
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000296 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000297}
298
Devang Patele2f8ad82006-06-27 18:07:29 +0000299/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000300/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000301///
302/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000303/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000304/// OutputFilename - The name of the file to generate.
305/// NativeLinkItems - The native libraries, files, code with which to link
306/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000307/// FrameworksPaths - The list of directories in which to find frameworks.
308/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000309/// gcc - The pathname to use for GGC.
310/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000311///
312/// Outputs:
313/// None.
314///
315/// Returns non-zero value on error.
316///
317static int GenerateNative(const std::string &OutputFilename,
318 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000319 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000320 const sys::Path &gcc, char ** const envp,
321 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000322 // Remove these environment variables from the environment of the
323 // programs that we will execute. It appears that GCC sets these
324 // environment variables so that the programs it uses can configure
325 // themselves identically.
326 //
327 // However, when we invoke GCC below, we want it to use its normal
328 // configuration. Hence, we must sanitize its environment.
329 char ** clean_env = CopyEnv(envp);
330 if (clean_env == NULL)
331 return 1;
332 RemoveEnv("LIBRARY_PATH", clean_env);
333 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
334 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
335 RemoveEnv("COMPILER_PATH", clean_env);
336 RemoveEnv("COLLECT_GCC", clean_env);
337
Reid Spencer445564a2004-11-20 20:02:56 +0000338
339 // Run GCC to assemble and link the program into native code.
340 //
341 // Note:
342 // We can't just assemble and link the file with the system assembler
343 // and linker because we don't know where to put the _start symbol.
344 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000345 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000346 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000347 args.push_back("-fno-strict-aliasing");
348 args.push_back("-O3");
349 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000350 args.push_back(OutputFilename);
351 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000352
Chris Lattner3992f522008-01-27 22:58:59 +0000353 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000354 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000355 args.push_back("-L" + LibPaths[index]);
356 }
357 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
358 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000359 }
360
361 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000362 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000363 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000364
Reid Spencer445564a2004-11-20 20:02:56 +0000365 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000366 for (unsigned index = 0; index < LinkItems.size(); index++)
367 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000368 if (LinkItems[index].second)
369 args.push_back("-l" + LinkItems[index].first);
370 else
371 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000372 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000373
Chris Lattner3992f522008-01-27 22:58:59 +0000374 // Add in frameworks to link.
375 for (unsigned index = 0; index < Frameworks.size(); index++) {
376 args.push_back("-framework");
377 args.push_back(Frameworks[index]);
378 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000379
380 // Now that "args" owns all the std::strings for the arguments, call the c_str
381 // method to get the underlying string array. We do this game so that the
382 // std::string array is guaranteed to outlive the const char* array.
383 std::vector<const char *> Args;
384 for (unsigned i = 0, e = args.size(); i != e; ++i)
385 Args.push_back(args[i].c_str());
386 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000387
Reid Spencer3b726392007-04-29 23:59:47 +0000388 if (Verbose) {
389 cout << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000390 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000391 }
392
Reid Spencer445564a2004-11-20 20:02:56 +0000393 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000394 int R = sys::Program::ExecuteAndWait(
Chris Lattner3f931b82007-06-19 16:46:48 +0000395 gcc, &Args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000396 delete [] clean_env;
397 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000398}
399
Reid Spencerc0af3f02004-09-13 01:27:53 +0000400/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000401/// bitcode file for the program.
Reid Spencerc0af3f02004-09-13 01:27:53 +0000402static void EmitShellScript(char **argv) {
Reid Spencer3b726392007-04-29 23:59:47 +0000403 if (Verbose)
404 cout << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000405#if defined(_WIN32) || defined(__CYGWIN__)
406 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
407 // support windows systems, we copy the llvm-stub.exe executable from the
408 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000409 std::string ErrMsg;
Reid Spencer8d8b41d2004-12-22 13:50:17 +0000410 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
Reid Spencer708585a2007-02-09 03:08:06 +0000411 if (llvmstub.isEmpty())
412 PrintAndExit("Could not find llvm-stub.exe executable!");
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000413
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000414 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000415 PrintAndExit(ErrMsg);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000416
Reid Spencerc0af3f02004-09-13 01:27:53 +0000417 return;
418#endif
419
420 // Output the script to start the program...
421 std::ofstream Out2(OutputFilename.c_str());
422 if (!Out2.good())
Reid Spencer708585a2007-02-09 03:08:06 +0000423 PrintAndExit("error opening '" + OutputFilename + "' for writing!");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000424
425 Out2 << "#!/bin/sh\n";
426 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
427 Out2 << "lli=${LLVMINTERP-lli}\n";
428 Out2 << "exec $lli \\\n";
429 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
430 LibPaths.push_back("/lib");
431 LibPaths.push_back("/usr/lib");
432 LibPaths.push_back("/usr/X11R6/lib");
433 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
434 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000435 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000436 std::find(Libraries.begin(), Libraries.end(), "c");
437 if (libc != Libraries.end()) Libraries.erase(libc);
438 // List all the shared object (native) libraries this executable will need
439 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000440 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000441 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000442 // try explicit -L arguments first:
443 sys::Path FullLibraryPath;
444 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
445 E = LibPaths.end(); P != E; ++P) {
446 FullLibraryPath = *P;
447 FullLibraryPath.appendComponent("lib" + *i);
448 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
449 if (!FullLibraryPath.isEmpty()) {
450 if (!FullLibraryPath.isDynamicLibrary()) {
451 // Not a native shared library; mark as invalid
452 FullLibraryPath = sys::Path();
453 } else break;
454 }
455 }
456 if (FullLibraryPath.isEmpty())
457 FullLibraryPath = sys::Path::FindLibrary(*i);
458 if (!FullLibraryPath.isEmpty())
Reid Spencerc4064132004-12-13 03:01:14 +0000459 Out2 << " -load=" << FullLibraryPath.toString() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000460 }
461 Out2 << " $0.bc ${1+\"$@\"}\n";
462 Out2.close();
463}
464
Reid Spencerc4064132004-12-13 03:01:14 +0000465// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
466// linker function by combining the Files and Libraries in the order they were
467// declared on the command line.
468static void BuildLinkItems(
469 Linker::ItemList& Items,
470 const cl::list<std::string>& Files,
471 const cl::list<std::string>& Libraries) {
472
Misha Brukman3da94ae2005-04-22 00:00:37 +0000473 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000474
475 cl::list<std::string>::const_iterator fileIt = Files.begin();
476 cl::list<std::string>::const_iterator libIt = Libraries.begin();
477
478 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000479 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000480 if (libIt != Libraries.end())
481 libPos = Libraries.getPosition(libIt - Libraries.begin());
482 else
483 libPos = -1;
484 if (fileIt != Files.end())
485 filePos = Files.getPosition(fileIt - Files.begin());
486 else
487 filePos = -1;
488
489 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
490 // Add a source file
491 Items.push_back(std::make_pair(*fileIt++, false));
492 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
493 // Add a library
494 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000495 }
496 }
497}
498
Reid Spencer445564a2004-11-20 20:02:56 +0000499// Rightly this should go in a header file but it just seems such a waste.
500namespace llvm {
501extern void Optimize(Module*);
502}
503
Reid Spencerc0af3f02004-09-13 01:27:53 +0000504int main(int argc, char **argv, char **envp) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000505 // Print a stack trace if we signal out.
506 sys::PrintStackTraceOnErrorSignal();
507 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +0000508
Owen Anderson0d7c6952009-07-15 22:16:10 +0000509 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +0000510 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000511 try {
512 // Initial global variable above for convenience printing of program name.
513 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000514
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000515 // Parse the command line options
Dan Gohman82a13c92007-10-08 15:45:12 +0000516 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000517
Reid Spencer49521432006-11-11 11:54:25 +0000518 // Construct a Linker (now that Verbose is set)
Owen Anderson31895e72009-07-01 21:22:36 +0000519 Linker TheLinker(progname, OutputFilename, Context, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000520
Gabor Greifa99be512007-07-05 17:07:56 +0000521 // Keep track of the native link items (versus the bitcode items)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000522 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000523
524 // Add library paths to the linker
Reid Spencer78df5c32006-03-06 06:38:19 +0000525 TheLinker.addPaths(LibPaths);
526 TheLinker.addSystemPaths();
527
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000528 // Remove any consecutive duplicates of the same library...
529 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
530 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000531
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000532 if (LinkAsLibrary) {
533 std::vector<sys::Path> Files;
534 for (unsigned i = 0; i < InputFilenames.size(); ++i )
535 Files.push_back(sys::Path(InputFilenames[i]));
536 if (TheLinker.LinkInFiles(Files))
537 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000538
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000539 // The libraries aren't linked in but are noted as "dependent" in the
540 // module.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000541 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000542 E = Libraries.end(); I != E ; ++I) {
543 TheLinker.getModule()->addLibrary(*I);
544 }
Reid Spencerc0af3f02004-09-13 01:27:53 +0000545 } else {
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000546 // Build a list of the items from our command line
547 Linker::ItemList Items;
548 BuildLinkItems(Items, InputFilenames, Libraries);
549
550 // Link all the items together
Reid Spencerc82a5da2007-04-04 06:34:22 +0000551 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
Reid Spencer708585a2007-02-09 03:08:06 +0000552 return 1; // Error already printed
Reid Spencerc0af3f02004-09-13 01:27:53 +0000553 }
Reid Spencerc0af3f02004-09-13 01:27:53 +0000554
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000555 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
556
557 // Optimize the module
558 Optimize(Composite.get());
559
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000560#if defined(_WIN32) || defined(__CYGWIN__)
561 if (!LinkAsLibrary) {
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000562 // Default to "a.exe" instead of "a.out".
563 if (OutputFilename.getNumOccurrences() == 0)
564 OutputFilename = "a.exe";
565
566 // If there is no suffix add an "exe" one.
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000567 sys::Path ExeFile( OutputFilename );
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000568 if (ExeFile.getSuffix() == "") {
569 ExeFile.appendSuffix("exe");
570 OutputFilename = ExeFile.toString();
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000571 }
572 }
573#endif
574
Gabor Greifa99be512007-07-05 17:07:56 +0000575 // Generate the bitcode for the optimized module.
576 std::string RealBitcodeOutput = OutputFilename;
Argyrios Kyrtzidis5b90a722008-06-15 12:01:16 +0000577
Gabor Greifa99be512007-07-05 17:07:56 +0000578 if (!LinkAsLibrary) RealBitcodeOutput += ".bc";
579 GenerateBitcode(Composite.get(), RealBitcodeOutput);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000580
581 // If we are not linking a library, generate either a native executable
582 // or a JIT shell script, depending upon what the user wants.
583 if (!LinkAsLibrary) {
Reid Spencer73a74be2005-12-21 05:03:23 +0000584 // If the user wants to run a post-link optimization, run it now.
585 if (!PostLinkOpts.empty()) {
586 std::vector<std::string> opts = PostLinkOpts;
587 for (std::vector<std::string>::iterator I = opts.begin(),
588 E = opts.end(); I != E; ++I) {
589 sys::Path prog(*I);
590 if (!prog.canExecute()) {
591 prog = sys::Program::FindProgramByName(*I);
592 if (prog.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000593 PrintAndExit(std::string("Optimization program '") + *I +
Reid Spencer73a74be2005-12-21 05:03:23 +0000594 "' is not found or not executable.");
595 }
596 // Get the program arguments
597 sys::Path tmp_output("opt_result");
Reid Spencere5c9cb52006-08-23 00:39:35 +0000598 std::string ErrMsg;
Reid Spencer708585a2007-02-09 03:08:06 +0000599 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
600 PrintAndExit(ErrMsg);
601
Reid Spencer73a74be2005-12-21 05:03:23 +0000602 const char* args[4];
603 args[0] = I->c_str();
Gabor Greifa99be512007-07-05 17:07:56 +0000604 args[1] = RealBitcodeOutput.c_str();
Reid Spencer73a74be2005-12-21 05:03:23 +0000605 args[2] = tmp_output.c_str();
606 args[3] = 0;
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000607 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
Gabor Greifa99be512007-07-05 17:07:56 +0000608 if (tmp_output.isBitcodeFile() || tmp_output.isBitcodeFile()) {
609 sys::Path target(RealBitcodeOutput);
Reid Spencer73a74be2005-12-21 05:03:23 +0000610 target.eraseFromDisk();
Reid Spencer708585a2007-02-09 03:08:06 +0000611 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
612 PrintAndExit(ErrMsg, 2);
Reid Spencer73a74be2005-12-21 05:03:23 +0000613 } else
Gabor Greifa99be512007-07-05 17:07:56 +0000614 PrintAndExit("Post-link optimization output is not bitcode");
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000615 } else {
Reid Spencer708585a2007-02-09 03:08:06 +0000616 PrintAndExit(ErrMsg);
Reid Spencer73a74be2005-12-21 05:03:23 +0000617 }
618 }
619 }
620
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000621 // If the user wants to generate a native executable, compile it from the
Gabor Greifa99be512007-07-05 17:07:56 +0000622 // bitcode file.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000623 //
Gabor Greifa99be512007-07-05 17:07:56 +0000624 // Otherwise, create a script that will run the bitcode through the JIT.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000625 if (Native) {
626 // Name of the Assembly Language output file
627 sys::Path AssemblyFile ( OutputFilename);
628 AssemblyFile.appendSuffix("s");
629
630 // Mark the output files for removal if we get an interrupt.
631 sys::RemoveFileOnSignal(AssemblyFile);
632 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
633
634 // Determine the locations of the llc and gcc programs.
635 sys::Path llc = FindExecutable("llc", argv[0]);
636 if (llc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000637 PrintAndExit("Failed to find llc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000638
639 sys::Path gcc = FindExecutable("gcc", argv[0]);
640 if (gcc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000641 PrintAndExit("Failed to find gcc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000642
Gabor Greifa99be512007-07-05 17:07:56 +0000643 // Generate an assembly language file for the bitcode.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000644 std::string ErrMsg;
Gabor Greifa99be512007-07-05 17:07:56 +0000645 if (0 != GenerateAssembly(AssemblyFile.toString(), RealBitcodeOutput,
Reid Spencer708585a2007-02-09 03:08:06 +0000646 llc, ErrMsg))
647 PrintAndExit(ErrMsg);
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000648
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000649 if (0 != GenerateNative(OutputFilename, AssemblyFile.toString(),
Reid Spencerc82a5da2007-04-04 06:34:22 +0000650 NativeLinkItems, gcc, envp, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000651 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000652
653 // Remove the assembly language file.
Reid Spencera229c5c2005-07-08 03:08:58 +0000654 AssemblyFile.eraseFromDisk();
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000655 } else if (NativeCBE) {
656 sys::Path CFile (OutputFilename);
657 CFile.appendSuffix("cbe.c");
658
659 // Mark the output files for removal if we get an interrupt.
660 sys::RemoveFileOnSignal(CFile);
661 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
662
663 // Determine the locations of the llc and gcc programs.
664 sys::Path llc = FindExecutable("llc", argv[0]);
665 if (llc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000666 PrintAndExit("Failed to find llc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000667
668 sys::Path gcc = FindExecutable("gcc", argv[0]);
669 if (gcc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000670 PrintAndExit("Failed to find gcc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000671
Gabor Greifa99be512007-07-05 17:07:56 +0000672 // Generate an assembly language file for the bitcode.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000673 std::string ErrMsg;
674 if (0 != GenerateCFile(
Gabor Greifa99be512007-07-05 17:07:56 +0000675 CFile.toString(), RealBitcodeOutput, llc, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000676 PrintAndExit(ErrMsg);
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000677
Reid Spencerc82a5da2007-04-04 06:34:22 +0000678 if (0 != GenerateNative(OutputFilename, CFile.toString(),
679 NativeLinkItems, gcc, envp, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000680 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000681
682 // Remove the assembly language file.
Reid Spencera229c5c2005-07-08 03:08:58 +0000683 CFile.eraseFromDisk();
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000684
685 } else {
686 EmitShellScript(argv);
687 }
Misha Brukman3da94ae2005-04-22 00:00:37 +0000688
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000689 // Make the script executable...
Reid Spencere1647f42006-08-22 23:27:23 +0000690 std::string ErrMsg;
Reid Spencer708585a2007-02-09 03:08:06 +0000691 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
692 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000693
Gabor Greifa99be512007-07-05 17:07:56 +0000694 // Make the bitcode file readable and directly executable in LLEE as well
695 if (sys::Path(RealBitcodeOutput).makeExecutableOnDisk(&ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000696 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000697
Gabor Greifa99be512007-07-05 17:07:56 +0000698 if (sys::Path(RealBitcodeOutput).makeReadableOnDisk(&ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000699 PrintAndExit(ErrMsg);
700 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000701 } catch (const std::string& msg) {
Reid Spencer708585a2007-02-09 03:08:06 +0000702 PrintAndExit(msg,2);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000703 } catch (...) {
Reid Spencer708585a2007-02-09 03:08:06 +0000704 PrintAndExit("Unexpected unknown exception occurred.", 2);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000705 }
Reid Spencer708585a2007-02-09 03:08:06 +0000706
707 // Graceful exit
708 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000709}