blob: 28187c932db2ea48d558c7c37b7d7baa820720ec [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"
Reid Spencer6da1e0d2004-12-14 04:20:08 +000025#include "llvm/System/Program.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000026#include "llvm/Module.h"
27#include "llvm/PassManager.h"
Chris Lattnerbb3f3d32007-05-06 05:56:58 +000028#include "llvm/Bitcode/ReaderWriter.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000029#include "llvm/Target/TargetData.h"
Reid Spenceraefd04b2004-09-25 16:00:07 +000030#include "llvm/Target/TargetMachine.h"
31#include "llvm/Target/TargetMachineRegistry.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"
Bill Wendling68fe61d2006-11-29 00:19:40 +000036#include "llvm/Support/Streams.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000037#include "llvm/Support/SystemUtils.h"
Reid Spencer445564a2004-11-20 20:02:56 +000038#include "llvm/System/Signals.h"
Chris Lattner5d5a8972009-01-05 19:01:32 +000039#include "llvm/Config/config.h"
Reid Spencerc0af3f02004-09-13 01:27:53 +000040#include <fstream>
41#include <memory>
Anton Korobeynikovae9f3a32008-02-20 11:08:44 +000042#include <cstring>
Reid Spencerc0af3f02004-09-13 01:27:53 +000043using namespace llvm;
44
Reid Spencer445564a2004-11-20 20:02:56 +000045// Input/Output Options
46static cl::list<std::string> InputFilenames(cl::Positional, cl::OneOrMore,
Gabor Greifa99be512007-07-05 17:07:56 +000047 cl::desc("<input bitcode files>"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000048
Reid Spencer445564a2004-11-20 20:02:56 +000049static cl::opt<std::string> OutputFilename("o", cl::init("a.out"),
Misha Brukman3da94ae2005-04-22 00:00:37 +000050 cl::desc("Override output filename"),
Reid Spencer445564a2004-11-20 20:02:56 +000051 cl::value_desc("filename"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000052
Misha Brukman3da94ae2005-04-22 00:00:37 +000053static cl::opt<bool> Verbose("v",
Reid Spencer445564a2004-11-20 20:02:56 +000054 cl::desc("Print information about actions taken"));
Misha Brukman3da94ae2005-04-22 00:00:37 +000055
Reid Spencer445564a2004-11-20 20:02:56 +000056static cl::list<std::string> LibPaths("L", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000057 cl::desc("Specify a library search path"),
Reid Spencer445564a2004-11-20 20:02:56 +000058 cl::value_desc("directory"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000059
Chris Lattner3992f522008-01-27 22:58:59 +000060static cl::list<std::string> FrameworkPaths("F", cl::Prefix,
61 cl::desc("Specify a framework search path"),
62 cl::value_desc("directory"));
63
Reid Spencer445564a2004-11-20 20:02:56 +000064static cl::list<std::string> Libraries("l", cl::Prefix,
Misha Brukman3da94ae2005-04-22 00:00:37 +000065 cl::desc("Specify libraries to link to"),
Reid Spencer445564a2004-11-20 20:02:56 +000066 cl::value_desc("library prefix"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000067
Chris Lattner3992f522008-01-27 22:58:59 +000068static cl::list<std::string> Frameworks("framework",
69 cl::desc("Specify frameworks to link to"),
70 cl::value_desc("framework"));
71
Reid Spencer708585a2007-02-09 03:08:06 +000072// Options to control the linking, optimization, and code gen processes
Misha Brukman3da94ae2005-04-22 00:00:37 +000073static cl::opt<bool> LinkAsLibrary("link-as-library",
Reid Spencer445564a2004-11-20 20:02:56 +000074 cl::desc("Link the .bc files together as a library, not an executable"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000075
Reid Spencer445564a2004-11-20 20:02:56 +000076static cl::alias Relink("r", cl::aliasopt(LinkAsLibrary),
77 cl::desc("Alias for -link-as-library"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000078
Reid Spencer445564a2004-11-20 20:02:56 +000079static cl::opt<bool> Native("native",
80 cl::desc("Generate a native binary instead of a shell script"));
Reid Spencerc0af3f02004-09-13 01:27:53 +000081
Reid Spencer445564a2004-11-20 20:02:56 +000082static cl::opt<bool>NativeCBE("native-cbe",
83 cl::desc("Generate a native binary with the C backend and GCC"));
84
Reid Spencer73a74be2005-12-21 05:03:23 +000085static cl::list<std::string> PostLinkOpts("post-link-opts",
Reid Spenceraf303d52006-06-07 23:03:13 +000086 cl::value_desc("path"),
Reid Spencer73a74be2005-12-21 05:03:23 +000087 cl::desc("Run one or more optimization programs after linking"));
88
Reid Spenceraf303d52006-06-07 23:03:13 +000089static cl::list<std::string> XLinker("Xlinker", cl::value_desc("option"),
90 cl::desc("Pass options to the system linker"));
91
Reid Spencer708585a2007-02-09 03:08:06 +000092// Compatibility options that llvm-ld ignores but are supported for
93// compatibility with LD
Misha Brukman3da94ae2005-04-22 00:00:37 +000094static cl::opt<std::string> CO3("soname", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +000095 cl::desc("Compatibility option: ignored"));
96
Misha Brukman3da94ae2005-04-22 00:00:37 +000097static cl::opt<std::string> CO4("version-script", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +000098 cl::desc("Compatibility option: ignored"));
99
Misha Brukman3da94ae2005-04-22 00:00:37 +0000100static cl::opt<bool> CO5("eh-frame-hdr", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000101 cl::desc("Compatibility option: ignored"));
102
Misha Brukman3da94ae2005-04-22 00:00:37 +0000103static cl::opt<std::string> CO6("h", cl::Hidden,
Reid Spencer445564a2004-11-20 20:02:56 +0000104 cl::desc("Compatibility option: ignored"));
105
Reid Spencer98a030c2007-02-08 19:03:11 +0000106static cl::opt<bool> CO7("start-group", cl::Hidden,
107 cl::desc("Compatibility option: ignored"));
108
109static cl::opt<bool> CO8("end-group", cl::Hidden,
110 cl::desc("Compatibility option: ignored"));
Reid Spenceraf303d52006-06-07 23:03:13 +0000111
Andrew Lenharth0c6ba442008-11-19 17:00:08 +0000112static cl::opt<std::string> CO9("m", cl::Hidden,
113 cl::desc("Compatibility option: ignored"));
114
Reid Spencer445564a2004-11-20 20:02:56 +0000115/// This is just for convenience so it doesn't have to be passed around
116/// everywhere.
Reid Spencerc4064132004-12-13 03:01:14 +0000117static std::string progname;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000118
Reid Spencer708585a2007-02-09 03:08:06 +0000119/// PrintAndExit - Prints a message to standard error and exits with error code
Reid Spencerc0af3f02004-09-13 01:27:53 +0000120///
121/// Inputs:
Reid Spencerc0af3f02004-09-13 01:27:53 +0000122/// Message - The message to print to standard error.
123///
Reid Spencer708585a2007-02-09 03:08:06 +0000124static void PrintAndExit(const std::string &Message, int errcode = 1) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000125 cerr << progname << ": " << Message << "\n";
Reid Spencer708585a2007-02-09 03:08:06 +0000126 llvm_shutdown();
127 exit(errcode);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000128}
129
Reid Spencer3b726392007-04-29 23:59:47 +0000130static void PrintCommand(const std::vector<const char*> &args) {
131 std::vector<const char*>::const_iterator I = args.begin(), E = args.end();
132 for (; I != E; ++I)
133 if (*I)
134 cout << "'" << *I << "'" << " ";
135 cout << "\n" << std::flush;
136}
137
Reid Spencer445564a2004-11-20 20:02:56 +0000138/// CopyEnv - This function takes an array of environment variables and makes a
139/// copy of it. This copy can then be manipulated any way the caller likes
140/// without affecting the process's real environment.
141///
142/// Inputs:
143/// envp - An array of C strings containing an environment.
144///
145/// Return value:
146/// NULL - An error occurred.
147///
148/// Otherwise, a pointer to a new array of C strings is returned. Every string
149/// in the array is a duplicate of the one in the original array (i.e. we do
150/// not copy the char *'s from one array to another).
151///
152static char ** CopyEnv(char ** const envp) {
153 // Count the number of entries in the old list;
154 unsigned entries; // The number of entries in the old environment list
155 for (entries = 0; envp[entries] != NULL; entries++)
156 /*empty*/;
157
158 // Add one more entry for the NULL pointer that ends the list.
159 ++entries;
160
161 // If there are no entries at all, just return NULL.
162 if (entries == 0)
163 return NULL;
164
165 // Allocate a new environment list.
166 char **newenv = new char* [entries];
167 if ((newenv = new char* [entries]) == NULL)
168 return NULL;
169
170 // Make a copy of the list. Don't forget the NULL that ends the list.
171 entries = 0;
172 while (envp[entries] != NULL) {
173 newenv[entries] = new char[strlen (envp[entries]) + 1];
174 strcpy (newenv[entries], envp[entries]);
175 ++entries;
176 }
177 newenv[entries] = NULL;
178
179 return newenv;
180}
181
182
183/// RemoveEnv - Remove the specified environment variable from the environment
184/// array.
185///
186/// Inputs:
187/// name - The name of the variable to remove. It cannot be NULL.
188/// envp - The array of environment variables. It cannot be NULL.
189///
190/// Notes:
191/// This is mainly done because functions to remove items from the environment
192/// are not available across all platforms. In particular, Solaris does not
193/// seem to have an unsetenv() function or a setenv() function (or they are
194/// undocumented if they do exist).
195///
196static void RemoveEnv(const char * name, char ** const envp) {
197 for (unsigned index=0; envp[index] != NULL; index++) {
198 // Find the first equals sign in the array and make it an EOS character.
199 char *p = strchr (envp[index], '=');
200 if (p == NULL)
201 continue;
202 else
203 *p = '\0';
204
205 // Compare the two strings. If they are equal, zap this string.
206 // Otherwise, restore it.
207 if (!strcmp(name, envp[index]))
208 *envp[index] = '\0';
209 else
210 *p = '=';
211 }
212
213 return;
214}
215
Gabor Greifa99be512007-07-05 17:07:56 +0000216/// GenerateBitcode - generates a bitcode file from the module provided
217void GenerateBitcode(Module* M, const std::string& FileName) {
Reid Spencer445564a2004-11-20 20:02:56 +0000218
Reid Spencer3b726392007-04-29 23:59:47 +0000219 if (Verbose)
Gabor Greifa99be512007-07-05 17:07:56 +0000220 cout << "Generating Bitcode To " << FileName << '\n';
Reid Spencer3b726392007-04-29 23:59:47 +0000221
Reid Spencer445564a2004-11-20 20:02:56 +0000222 // Create the output file.
Jeff Cohen5fb6ed42005-01-22 17:36:17 +0000223 std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
224 std::ios::binary;
225 std::ofstream Out(FileName.c_str(), io_mode);
Reid Spencer708585a2007-02-09 03:08:06 +0000226 if (!Out.good())
227 PrintAndExit("error opening '" + FileName + "' for writing!");
Reid Spencer445564a2004-11-20 20:02:56 +0000228
Gabor Greifa99be512007-07-05 17:07:56 +0000229 // Ensure that the bitcode file gets removed from the disk if we get a
Reid Spencer445564a2004-11-20 20:02:56 +0000230 // terminating signal.
231 sys::RemoveFileOnSignal(sys::Path(FileName));
232
233 // Write it out
Chris Lattner44dadff2007-05-06 09:29:57 +0000234 WriteBitcodeToFile(M, Out);
Reid Spencer445564a2004-11-20 20:02:56 +0000235
Gabor Greifa99be512007-07-05 17:07:56 +0000236 // Close the bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000237 Out.close();
238}
239
240/// GenerateAssembly - generates a native assembly language source file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000241/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000242///
243/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000244/// InputFilename - The name of the input bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000245/// OutputFilename - The name of the file to generate.
246/// llc - The pathname to use for LLC.
247/// envp - The environment to use when running LLC.
248///
249/// Return non-zero value on error.
250///
251static int GenerateAssembly(const std::string &OutputFilename,
252 const std::string &InputFilename,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000253 const sys::Path &llc,
254 std::string &ErrMsg ) {
Gabor Greifa99be512007-07-05 17:07:56 +0000255 // Run LLC to convert the bitcode file into assembly code.
Reid Spencerf6358c72004-12-19 18:00:56 +0000256 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000257 args.push_back(llc.c_str());
Argyrios Kyrtzidisca29dff2008-06-27 15:08:59 +0000258 // We will use GCC to assemble the program so set the assembly syntax to AT&T,
259 // regardless of what the target in the bitcode file is.
260 args.push_back("-x86-asm-syntax=att");
Chris Lattnerbf9add42005-04-10 20:59:38 +0000261 args.push_back("-f");
262 args.push_back("-o");
263 args.push_back(OutputFilename.c_str());
264 args.push_back(InputFilename.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000265 args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000266
Reid Spencer3b726392007-04-29 23:59:47 +0000267 if (Verbose) {
268 cout << "Generating Assembly With: \n";
269 PrintCommand(args);
270 }
271
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000272 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000273}
274
Gabor Greifa99be512007-07-05 17:07:56 +0000275/// GenerateCFile - generates a C source file from the specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000276static int GenerateCFile(const std::string &OutputFile,
277 const std::string &InputFile,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000278 const sys::Path &llc,
279 std::string& ErrMsg) {
Gabor Greifa99be512007-07-05 17:07:56 +0000280 // Run LLC to convert the bitcode file into C.
Reid Spencerf6358c72004-12-19 18:00:56 +0000281 std::vector<const char*> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000282 args.push_back(llc.c_str());
283 args.push_back("-march=c");
284 args.push_back("-f");
285 args.push_back("-o");
286 args.push_back(OutputFile.c_str());
287 args.push_back(InputFile.c_str());
Chris Lattner7456e3c2005-02-13 23:10:45 +0000288 args.push_back(0);
Reid Spencer3b726392007-04-29 23:59:47 +0000289
290 if (Verbose) {
291 cout << "Generating C Source With: \n";
292 PrintCommand(args);
293 }
294
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000295 return sys::Program::ExecuteAndWait(llc, &args[0], 0, 0, 0, 0, &ErrMsg);
Reid Spencer445564a2004-11-20 20:02:56 +0000296}
297
Devang Patele2f8ad82006-06-27 18:07:29 +0000298/// GenerateNative - generates a native object file from the
Gabor Greifa99be512007-07-05 17:07:56 +0000299/// specified bitcode file.
Reid Spencer445564a2004-11-20 20:02:56 +0000300///
301/// Inputs:
Gabor Greifa99be512007-07-05 17:07:56 +0000302/// InputFilename - The name of the input bitcode file.
Reid Spencerc82a5da2007-04-04 06:34:22 +0000303/// OutputFilename - The name of the file to generate.
304/// NativeLinkItems - The native libraries, files, code with which to link
305/// LibPaths - The list of directories in which to find libraries.
Chris Lattner3992f522008-01-27 22:58:59 +0000306/// FrameworksPaths - The list of directories in which to find frameworks.
307/// Frameworks - The list of frameworks (dynamic libraries)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000308/// gcc - The pathname to use for GGC.
309/// envp - A copy of the process's current environment.
Reid Spencer445564a2004-11-20 20:02:56 +0000310///
311/// Outputs:
312/// None.
313///
314/// Returns non-zero value on error.
315///
316static int GenerateNative(const std::string &OutputFilename,
317 const std::string &InputFilename,
Reid Spencer49521432006-11-11 11:54:25 +0000318 const Linker::ItemList &LinkItems,
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000319 const sys::Path &gcc, char ** const envp,
320 std::string& ErrMsg) {
Reid Spencer445564a2004-11-20 20:02:56 +0000321 // Remove these environment variables from the environment of the
322 // programs that we will execute. It appears that GCC sets these
323 // environment variables so that the programs it uses can configure
324 // themselves identically.
325 //
326 // However, when we invoke GCC below, we want it to use its normal
327 // configuration. Hence, we must sanitize its environment.
328 char ** clean_env = CopyEnv(envp);
329 if (clean_env == NULL)
330 return 1;
331 RemoveEnv("LIBRARY_PATH", clean_env);
332 RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
333 RemoveEnv("GCC_EXEC_PREFIX", clean_env);
334 RemoveEnv("COMPILER_PATH", clean_env);
335 RemoveEnv("COLLECT_GCC", clean_env);
336
Reid Spencer445564a2004-11-20 20:02:56 +0000337
338 // Run GCC to assemble and link the program into native code.
339 //
340 // Note:
341 // We can't just assemble and link the file with the system assembler
342 // and linker because we don't know where to put the _start symbol.
343 // GCC mysteriously knows how to do it.
Chris Lattner3f931b82007-06-19 16:46:48 +0000344 std::vector<std::string> args;
Chris Lattnerbf9add42005-04-10 20:59:38 +0000345 args.push_back(gcc.c_str());
Reid Spencer6da1e0d2004-12-14 04:20:08 +0000346 args.push_back("-fno-strict-aliasing");
347 args.push_back("-O3");
348 args.push_back("-o");
Chris Lattner3f931b82007-06-19 16:46:48 +0000349 args.push_back(OutputFilename);
350 args.push_back(InputFilename);
Reid Spencer445564a2004-11-20 20:02:56 +0000351
Chris Lattner3992f522008-01-27 22:58:59 +0000352 // Add in the library and framework paths
Reid Spenceraf303d52006-06-07 23:03:13 +0000353 for (unsigned index = 0; index < LibPaths.size(); index++) {
Chris Lattner3992f522008-01-27 22:58:59 +0000354 args.push_back("-L" + LibPaths[index]);
355 }
356 for (unsigned index = 0; index < FrameworkPaths.size(); index++) {
357 args.push_back("-F" + FrameworkPaths[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000358 }
359
360 // Add the requested options
Chris Lattner03a1c7a2008-01-09 01:01:17 +0000361 for (unsigned index = 0; index < XLinker.size(); index++)
Chris Lattner3f931b82007-06-19 16:46:48 +0000362 args.push_back(XLinker[index]);
Reid Spenceraf303d52006-06-07 23:03:13 +0000363
Reid Spencer445564a2004-11-20 20:02:56 +0000364 // Add in the libraries to link.
Reid Spencer49521432006-11-11 11:54:25 +0000365 for (unsigned index = 0; index < LinkItems.size(); index++)
366 if (LinkItems[index].first != "crtend") {
Chris Lattner3f931b82007-06-19 16:46:48 +0000367 if (LinkItems[index].second)
368 args.push_back("-l" + LinkItems[index].first);
369 else
370 args.push_back(LinkItems[index].first);
Reid Spencerf6358c72004-12-19 18:00:56 +0000371 }
Reid Spenceraf303d52006-06-07 23:03:13 +0000372
Chris Lattner3992f522008-01-27 22:58:59 +0000373 // Add in frameworks to link.
374 for (unsigned index = 0; index < Frameworks.size(); index++) {
375 args.push_back("-framework");
376 args.push_back(Frameworks[index]);
377 }
Chris Lattner3f931b82007-06-19 16:46:48 +0000378
379 // Now that "args" owns all the std::strings for the arguments, call the c_str
380 // method to get the underlying string array. We do this game so that the
381 // std::string array is guaranteed to outlive the const char* array.
382 std::vector<const char *> Args;
383 for (unsigned i = 0, e = args.size(); i != e; ++i)
384 Args.push_back(args[i].c_str());
385 Args.push_back(0);
Reid Spencer445564a2004-11-20 20:02:56 +0000386
Reid Spencer3b726392007-04-29 23:59:47 +0000387 if (Verbose) {
388 cout << "Generating Native Executable With:\n";
Chris Lattner3f931b82007-06-19 16:46:48 +0000389 PrintCommand(Args);
Reid Spencer3b726392007-04-29 23:59:47 +0000390 }
391
Reid Spencer445564a2004-11-20 20:02:56 +0000392 // Run the compiler to assembly and link together the program.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000393 int R = sys::Program::ExecuteAndWait(
Chris Lattner3f931b82007-06-19 16:46:48 +0000394 gcc, &Args[0], (const char**)clean_env, 0, 0, 0, &ErrMsg);
Chris Lattner2f863622006-05-14 18:38:13 +0000395 delete [] clean_env;
396 return R;
Reid Spencer445564a2004-11-20 20:02:56 +0000397}
398
Reid Spencerc0af3f02004-09-13 01:27:53 +0000399/// EmitShellScript - Output the wrapper file that invokes the JIT on the LLVM
Gabor Greifa99be512007-07-05 17:07:56 +0000400/// bitcode file for the program.
Reid Spencerc0af3f02004-09-13 01:27:53 +0000401static void EmitShellScript(char **argv) {
Reid Spencer3b726392007-04-29 23:59:47 +0000402 if (Verbose)
403 cout << "Emitting Shell Script\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000404#if defined(_WIN32) || defined(__CYGWIN__)
405 // Windows doesn't support #!/bin/sh style shell scripts in .exe files. To
406 // support windows systems, we copy the llvm-stub.exe executable from the
407 // build tree to the destination file.
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000408 std::string ErrMsg;
Reid Spencer8d8b41d2004-12-22 13:50:17 +0000409 sys::Path llvmstub = FindExecutable("llvm-stub.exe", argv[0]);
Reid Spencer708585a2007-02-09 03:08:06 +0000410 if (llvmstub.isEmpty())
411 PrintAndExit("Could not find llvm-stub.exe executable!");
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000412
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000413 if (0 != sys::CopyFile(sys::Path(OutputFilename), llvmstub, &ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000414 PrintAndExit(ErrMsg);
Anton Korobeynikov7d515442006-09-01 20:35:17 +0000415
Reid Spencerc0af3f02004-09-13 01:27:53 +0000416 return;
417#endif
418
419 // Output the script to start the program...
420 std::ofstream Out2(OutputFilename.c_str());
421 if (!Out2.good())
Reid Spencer708585a2007-02-09 03:08:06 +0000422 PrintAndExit("error opening '" + OutputFilename + "' for writing!");
Reid Spencerc0af3f02004-09-13 01:27:53 +0000423
424 Out2 << "#!/bin/sh\n";
425 // Allow user to setenv LLVMINTERP if lli is not in their PATH.
426 Out2 << "lli=${LLVMINTERP-lli}\n";
427 Out2 << "exec $lli \\\n";
428 // gcc accepts -l<lib> and implicitly searches /lib and /usr/lib.
429 LibPaths.push_back("/lib");
430 LibPaths.push_back("/usr/lib");
431 LibPaths.push_back("/usr/X11R6/lib");
432 // We don't need to link in libc! In fact, /usr/lib/libc.so may not be a
433 // shared object at all! See RH 8: plain text.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000434 std::vector<std::string>::iterator libc =
Reid Spencerc0af3f02004-09-13 01:27:53 +0000435 std::find(Libraries.begin(), Libraries.end(), "c");
436 if (libc != Libraries.end()) Libraries.erase(libc);
437 // List all the shared object (native) libraries this executable will need
438 // on the command line, so that we don't have to do this manually!
Misha Brukman3da94ae2005-04-22 00:00:37 +0000439 for (std::vector<std::string>::iterator i = Libraries.begin(),
Reid Spencerc0af3f02004-09-13 01:27:53 +0000440 e = Libraries.end(); i != e; ++i) {
Chris Lattner5d5a8972009-01-05 19:01:32 +0000441 // try explicit -L arguments first:
442 sys::Path FullLibraryPath;
443 for (cl::list<std::string>::const_iterator P = LibPaths.begin(),
444 E = LibPaths.end(); P != E; ++P) {
445 FullLibraryPath = *P;
446 FullLibraryPath.appendComponent("lib" + *i);
447 FullLibraryPath.appendSuffix(&(LTDL_SHLIB_EXT[1]));
448 if (!FullLibraryPath.isEmpty()) {
449 if (!FullLibraryPath.isDynamicLibrary()) {
450 // Not a native shared library; mark as invalid
451 FullLibraryPath = sys::Path();
452 } else break;
453 }
454 }
455 if (FullLibraryPath.isEmpty())
456 FullLibraryPath = sys::Path::FindLibrary(*i);
457 if (!FullLibraryPath.isEmpty())
Reid Spencerc4064132004-12-13 03:01:14 +0000458 Out2 << " -load=" << FullLibraryPath.toString() << " \\\n";
Reid Spencerc0af3f02004-09-13 01:27:53 +0000459 }
460 Out2 << " $0.bc ${1+\"$@\"}\n";
461 Out2.close();
462}
463
Reid Spencerc4064132004-12-13 03:01:14 +0000464// BuildLinkItems -- This function generates a LinkItemList for the LinkItems
465// linker function by combining the Files and Libraries in the order they were
466// declared on the command line.
467static void BuildLinkItems(
468 Linker::ItemList& Items,
469 const cl::list<std::string>& Files,
470 const cl::list<std::string>& Libraries) {
471
Misha Brukman3da94ae2005-04-22 00:00:37 +0000472 // Build the list of linkage items for LinkItems.
Reid Spencerc4064132004-12-13 03:01:14 +0000473
474 cl::list<std::string>::const_iterator fileIt = Files.begin();
475 cl::list<std::string>::const_iterator libIt = Libraries.begin();
476
477 int libPos = -1, filePos = -1;
Reid Spencer05f7e792004-12-13 17:18:19 +0000478 while ( libIt != Libraries.end() || fileIt != Files.end() ) {
Reid Spencerc4064132004-12-13 03:01:14 +0000479 if (libIt != Libraries.end())
480 libPos = Libraries.getPosition(libIt - Libraries.begin());
481 else
482 libPos = -1;
483 if (fileIt != Files.end())
484 filePos = Files.getPosition(fileIt - Files.begin());
485 else
486 filePos = -1;
487
488 if (filePos != -1 && (libPos == -1 || filePos < libPos)) {
489 // Add a source file
490 Items.push_back(std::make_pair(*fileIt++, false));
491 } else if (libPos != -1 && (filePos == -1 || libPos < filePos)) {
492 // Add a library
493 Items.push_back(std::make_pair(*libIt++, true));
Reid Spencerc4064132004-12-13 03:01:14 +0000494 }
495 }
496}
497
Reid Spencer445564a2004-11-20 20:02:56 +0000498// Rightly this should go in a header file but it just seems such a waste.
499namespace llvm {
500extern void Optimize(Module*);
501}
502
Reid Spencerc0af3f02004-09-13 01:27:53 +0000503int main(int argc, char **argv, char **envp) {
Chris Lattnerc30598b2006-12-06 01:18:01 +0000504 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000505 try {
506 // Initial global variable above for convenience printing of program name.
507 progname = sys::Path(argv[0]).getBasename();
Misha Brukman3da94ae2005-04-22 00:00:37 +0000508
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000509 // Parse the command line options
Dan Gohman82a13c92007-10-08 15:45:12 +0000510 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000511 sys::PrintStackTraceOnErrorSignal();
Reid Spencerc0af3f02004-09-13 01:27:53 +0000512
Reid Spencer49521432006-11-11 11:54:25 +0000513 // Construct a Linker (now that Verbose is set)
514 Linker TheLinker(progname, OutputFilename, Verbose);
Reid Spencerc82a5da2007-04-04 06:34:22 +0000515
Gabor Greifa99be512007-07-05 17:07:56 +0000516 // Keep track of the native link items (versus the bitcode items)
Reid Spencerc82a5da2007-04-04 06:34:22 +0000517 Linker::ItemList NativeLinkItems;
Reid Spencer49521432006-11-11 11:54:25 +0000518
519 // Add library paths to the linker
Reid Spencer78df5c32006-03-06 06:38:19 +0000520 TheLinker.addPaths(LibPaths);
521 TheLinker.addSystemPaths();
522
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000523 // Remove any consecutive duplicates of the same library...
524 Libraries.erase(std::unique(Libraries.begin(), Libraries.end()),
525 Libraries.end());
Reid Spencerc0af3f02004-09-13 01:27:53 +0000526
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000527 if (LinkAsLibrary) {
528 std::vector<sys::Path> Files;
529 for (unsigned i = 0; i < InputFilenames.size(); ++i )
530 Files.push_back(sys::Path(InputFilenames[i]));
531 if (TheLinker.LinkInFiles(Files))
532 return 1; // Error already printed
Reid Spencer6b463b22004-12-08 05:17:40 +0000533
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000534 // The libraries aren't linked in but are noted as "dependent" in the
535 // module.
Misha Brukman3da94ae2005-04-22 00:00:37 +0000536 for (cl::list<std::string>::const_iterator I = Libraries.begin(),
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000537 E = Libraries.end(); I != E ; ++I) {
538 TheLinker.getModule()->addLibrary(*I);
539 }
Reid Spencerc0af3f02004-09-13 01:27:53 +0000540 } else {
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000541 // Build a list of the items from our command line
542 Linker::ItemList Items;
543 BuildLinkItems(Items, InputFilenames, Libraries);
544
545 // Link all the items together
Reid Spencerc82a5da2007-04-04 06:34:22 +0000546 if (TheLinker.LinkInItems(Items, NativeLinkItems) )
Reid Spencer708585a2007-02-09 03:08:06 +0000547 return 1; // Error already printed
Reid Spencerc0af3f02004-09-13 01:27:53 +0000548 }
Reid Spencerc0af3f02004-09-13 01:27:53 +0000549
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000550 std::auto_ptr<Module> Composite(TheLinker.releaseModule());
551
552 // Optimize the module
553 Optimize(Composite.get());
554
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000555#if defined(_WIN32) || defined(__CYGWIN__)
556 if (!LinkAsLibrary) {
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000557 // Default to "a.exe" instead of "a.out".
558 if (OutputFilename.getNumOccurrences() == 0)
559 OutputFilename = "a.exe";
560
561 // If there is no suffix add an "exe" one.
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000562 sys::Path ExeFile( OutputFilename );
Argyrios Kyrtzidis48cca1f2008-06-15 15:20:16 +0000563 if (ExeFile.getSuffix() == "") {
564 ExeFile.appendSuffix("exe");
565 OutputFilename = ExeFile.toString();
Argyrios Kyrtzidis16621832008-06-15 13:48:12 +0000566 }
567 }
568#endif
569
Gabor Greifa99be512007-07-05 17:07:56 +0000570 // Generate the bitcode for the optimized module.
571 std::string RealBitcodeOutput = OutputFilename;
Argyrios Kyrtzidis5b90a722008-06-15 12:01:16 +0000572
Gabor Greifa99be512007-07-05 17:07:56 +0000573 if (!LinkAsLibrary) RealBitcodeOutput += ".bc";
574 GenerateBitcode(Composite.get(), RealBitcodeOutput);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000575
576 // If we are not linking a library, generate either a native executable
577 // or a JIT shell script, depending upon what the user wants.
578 if (!LinkAsLibrary) {
Reid Spencer73a74be2005-12-21 05:03:23 +0000579 // If the user wants to run a post-link optimization, run it now.
580 if (!PostLinkOpts.empty()) {
581 std::vector<std::string> opts = PostLinkOpts;
582 for (std::vector<std::string>::iterator I = opts.begin(),
583 E = opts.end(); I != E; ++I) {
584 sys::Path prog(*I);
585 if (!prog.canExecute()) {
586 prog = sys::Program::FindProgramByName(*I);
587 if (prog.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000588 PrintAndExit(std::string("Optimization program '") + *I +
Reid Spencer73a74be2005-12-21 05:03:23 +0000589 "' is not found or not executable.");
590 }
591 // Get the program arguments
592 sys::Path tmp_output("opt_result");
Reid Spencere5c9cb52006-08-23 00:39:35 +0000593 std::string ErrMsg;
Reid Spencer708585a2007-02-09 03:08:06 +0000594 if (tmp_output.createTemporaryFileOnDisk(true, &ErrMsg))
595 PrintAndExit(ErrMsg);
596
Reid Spencer73a74be2005-12-21 05:03:23 +0000597 const char* args[4];
598 args[0] = I->c_str();
Gabor Greifa99be512007-07-05 17:07:56 +0000599 args[1] = RealBitcodeOutput.c_str();
Reid Spencer73a74be2005-12-21 05:03:23 +0000600 args[2] = tmp_output.c_str();
601 args[3] = 0;
Anton Korobeynikov9ba8a762007-02-16 19:11:07 +0000602 if (0 == sys::Program::ExecuteAndWait(prog, args, 0,0,0,0, &ErrMsg)) {
Gabor Greifa99be512007-07-05 17:07:56 +0000603 if (tmp_output.isBitcodeFile() || tmp_output.isBitcodeFile()) {
604 sys::Path target(RealBitcodeOutput);
Reid Spencer73a74be2005-12-21 05:03:23 +0000605 target.eraseFromDisk();
Reid Spencer708585a2007-02-09 03:08:06 +0000606 if (tmp_output.renamePathOnDisk(target, &ErrMsg))
607 PrintAndExit(ErrMsg, 2);
Reid Spencer73a74be2005-12-21 05:03:23 +0000608 } else
Gabor Greifa99be512007-07-05 17:07:56 +0000609 PrintAndExit("Post-link optimization output is not bitcode");
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000610 } else {
Reid Spencer708585a2007-02-09 03:08:06 +0000611 PrintAndExit(ErrMsg);
Reid Spencer73a74be2005-12-21 05:03:23 +0000612 }
613 }
614 }
615
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000616 // If the user wants to generate a native executable, compile it from the
Gabor Greifa99be512007-07-05 17:07:56 +0000617 // bitcode file.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000618 //
Gabor Greifa99be512007-07-05 17:07:56 +0000619 // Otherwise, create a script that will run the bitcode through the JIT.
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000620 if (Native) {
621 // Name of the Assembly Language output file
622 sys::Path AssemblyFile ( OutputFilename);
623 AssemblyFile.appendSuffix("s");
624
625 // Mark the output files for removal if we get an interrupt.
626 sys::RemoveFileOnSignal(AssemblyFile);
627 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
628
629 // Determine the locations of the llc and gcc programs.
630 sys::Path llc = FindExecutable("llc", argv[0]);
631 if (llc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000632 PrintAndExit("Failed to find llc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000633
634 sys::Path gcc = FindExecutable("gcc", argv[0]);
635 if (gcc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000636 PrintAndExit("Failed to find gcc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000637
Gabor Greifa99be512007-07-05 17:07:56 +0000638 // Generate an assembly language file for the bitcode.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000639 std::string ErrMsg;
Gabor Greifa99be512007-07-05 17:07:56 +0000640 if (0 != GenerateAssembly(AssemblyFile.toString(), RealBitcodeOutput,
Reid Spencer708585a2007-02-09 03:08:06 +0000641 llc, ErrMsg))
642 PrintAndExit(ErrMsg);
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000643
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000644 if (0 != GenerateNative(OutputFilename, AssemblyFile.toString(),
Reid Spencerc82a5da2007-04-04 06:34:22 +0000645 NativeLinkItems, gcc, envp, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000646 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000647
648 // Remove the assembly language file.
Reid Spencera229c5c2005-07-08 03:08:58 +0000649 AssemblyFile.eraseFromDisk();
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000650 } else if (NativeCBE) {
651 sys::Path CFile (OutputFilename);
652 CFile.appendSuffix("cbe.c");
653
654 // Mark the output files for removal if we get an interrupt.
655 sys::RemoveFileOnSignal(CFile);
656 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
657
658 // Determine the locations of the llc and gcc programs.
659 sys::Path llc = FindExecutable("llc", argv[0]);
660 if (llc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000661 PrintAndExit("Failed to find llc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000662
663 sys::Path gcc = FindExecutable("gcc", argv[0]);
664 if (gcc.isEmpty())
Reid Spencer708585a2007-02-09 03:08:06 +0000665 PrintAndExit("Failed to find gcc");
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000666
Gabor Greifa99be512007-07-05 17:07:56 +0000667 // Generate an assembly language file for the bitcode.
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000668 std::string ErrMsg;
669 if (0 != GenerateCFile(
Gabor Greifa99be512007-07-05 17:07:56 +0000670 CFile.toString(), RealBitcodeOutput, llc, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000671 PrintAndExit(ErrMsg);
Reid Spencer8ea5ecb2006-08-21 06:04:45 +0000672
Reid Spencerc82a5da2007-04-04 06:34:22 +0000673 if (0 != GenerateNative(OutputFilename, CFile.toString(),
674 NativeLinkItems, gcc, envp, ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000675 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000676
677 // Remove the assembly language file.
Reid Spencera229c5c2005-07-08 03:08:58 +0000678 CFile.eraseFromDisk();
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000679
680 } else {
681 EmitShellScript(argv);
682 }
Misha Brukman3da94ae2005-04-22 00:00:37 +0000683
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000684 // Make the script executable...
Reid Spencere1647f42006-08-22 23:27:23 +0000685 std::string ErrMsg;
Reid Spencer708585a2007-02-09 03:08:06 +0000686 if (sys::Path(OutputFilename).makeExecutableOnDisk(&ErrMsg))
687 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000688
Gabor Greifa99be512007-07-05 17:07:56 +0000689 // Make the bitcode file readable and directly executable in LLEE as well
690 if (sys::Path(RealBitcodeOutput).makeExecutableOnDisk(&ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000691 PrintAndExit(ErrMsg);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000692
Gabor Greifa99be512007-07-05 17:07:56 +0000693 if (sys::Path(RealBitcodeOutput).makeReadableOnDisk(&ErrMsg))
Reid Spencer708585a2007-02-09 03:08:06 +0000694 PrintAndExit(ErrMsg);
695 }
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000696 } catch (const std::string& msg) {
Reid Spencer708585a2007-02-09 03:08:06 +0000697 PrintAndExit(msg,2);
Reid Spencer1ef8bda2004-12-30 05:36:08 +0000698 } catch (...) {
Reid Spencer708585a2007-02-09 03:08:06 +0000699 PrintAndExit("Unexpected unknown exception occurred.", 2);
Reid Spencerc0af3f02004-09-13 01:27:53 +0000700 }
Reid Spencer708585a2007-02-09 03:08:06 +0000701
702 // Graceful exit
703 return 0;
Reid Spencerc0af3f02004-09-13 01:27:53 +0000704}