tools/gccld/GenerateCode.cpp

   1 //===- GenerateCode.cpp - Functions for generating executable files  ------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains functions for generating executable files once linking
  11 // has finished.  This includes generating a shell script to run the JIT or
  12 // a native executable derived from the bytecode.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "gccld.h"
  17 #include "llvm/System/Program.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/PassManager.h"
  20 #include "llvm/Analysis/LoadValueNumbering.h"
  21 #include "llvm/Analysis/Passes.h"
  22 #include "llvm/Analysis/Verifier.h"
  23 #include "llvm/Bytecode/Archive.h"
  24 #include "llvm/Bytecode/WriteBytecodePass.h"
  25 #include "llvm/Target/TargetData.h"
  26 #include "llvm/Transforms/IPO.h"
  27 #include "llvm/Transforms/Scalar.h"
  28 #include "llvm/Support/SystemUtils.h"
  29 #include "llvm/Support/CommandLine.h"
  30
  31 using namespace llvm;
  32
  33 namespace {
  34   cl::opt<bool>
  35   DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
  36
  37   cl::opt<bool>
  38   Verify("verify", cl::desc("Verify intermediate results of all passes"));
  39
  40   cl::opt<bool>
  41   DisableOptimizations("disable-opt",
  42                        cl::desc("Do not run any optimization passes"));
  43 }
  44
  45 /// CopyEnv - This function takes an array of environment variables and makes a
  46 /// copy of it.  This copy can then be manipulated any way the caller likes
  47 /// without affecting the process's real environment.
  48 ///
  49 /// Inputs:
  50 ///  envp - An array of C strings containing an environment.
  51 ///
  52 /// Return value:
  53 ///  NULL - An error occurred.
  54 ///
  55 ///  Otherwise, a pointer to a new array of C strings is returned.  Every string
  56 ///  in the array is a duplicate of the one in the original array (i.e. we do
  57 ///  not copy the char *'s from one array to another).
  58 ///
  59 static char ** CopyEnv(char ** const envp) {
  60   // Count the number of entries in the old list;
  61   unsigned entries;   // The number of entries in the old environment list
  62   for (entries = 0; envp[entries] != NULL; entries++)
  63     /*empty*/;
  64
  65   // Add one more entry for the NULL pointer that ends the list.
  66   ++entries;
  67
  68   // If there are no entries at all, just return NULL.
  69   if (entries == 0)
  70     return NULL;
  71
  72   // Allocate a new environment list.
  73   char **newenv = new char* [entries];
  74   if ((newenv = new char* [entries]) == NULL)
  75     return NULL;
  76
  77   // Make a copy of the list.  Don't forget the NULL that ends the list.
  78   entries = 0;
  79   while (envp[entries] != NULL) {
  80     newenv[entries] = new char[strlen (envp[entries]) + 1];
  81     strcpy (newenv[entries], envp[entries]);
  82     ++entries;
  83   }
  84   newenv[entries] = NULL;
  85
  86   return newenv;
  87 }
  88
  89
  90 /// RemoveEnv - Remove the specified environment variable from the environment
  91 /// array.
  92 ///
  93 /// Inputs:
  94 ///  name - The name of the variable to remove.  It cannot be NULL.
  95 ///  envp - The array of environment variables.  It cannot be NULL.
  96 ///
  97 /// Notes:
  98 ///  This is mainly done because functions to remove items from the environment
  99 ///  are not available across all platforms.  In particular, Solaris does not
 100 ///  seem to have an unsetenv() function or a setenv() function (or they are
 101 ///  undocumented if they do exist).
 102 ///
 103 static void RemoveEnv(const char * name, char ** const envp) {
 104   for (unsigned index=0; envp[index] != NULL; index++) {
 105     // Find the first equals sign in the array and make it an EOS character.
 106     char *p = strchr (envp[index], '=');
 107     if (p == NULL)
 108       continue;
 109     else
 110       *p = '\0';
 111
 112     // Compare the two strings.  If they are equal, zap this string.
 113     // Otherwise, restore it.
 114     if (!strcmp(name, envp[index]))
 115       *envp[index] = '\0';
 116     else
 117       *p = '=';
 118   }
 119 }
 120
 121 static void dumpArgs(const char **args) {
 122   std::cerr << *args++;
 123   while (*args)
 124     std::cerr << ' ' << *args++;
 125   std::cerr << '\n' << std::flush;
 126 }
 127
 128 static inline void addPass(PassManager &PM, Pass *P) {
 129   // Add the pass to the pass manager...
 130   PM.add(P);
 131
 132   // If we are verifying all of the intermediate steps, add the verifier...
 133   if (Verify) PM.add(createVerifierPass());
 134 }
 135
 136 static bool isBytecodeLibrary(const sys::Path &FullPath) {
 137   // Check for a bytecode file
 138   if (FullPath.isBytecodeFile()) return true;
 139   // Check for a dynamic library file
 140   if (FullPath.isDynamicLibrary()) return false;
 141   // Check for a true bytecode archive file
 142   if (FullPath.isArchive() ) {
 143     std::string ErrorMessage;
 144     Archive* ar = Archive::OpenAndLoadSymbols( FullPath, &ErrorMessage );
 145     return ar->isBytecodeArchive();
 146   }
 147   return false;
 148 }
 149
 150 static bool isBytecodeLPath(const std::string &LibPath) {
 151   sys::Path LPath(LibPath);
 152
 153   // Make sure it exists and is a directory
 154   try {
 155     if (!LPath.exists() || !LPath.isDirectory())
 156       return false;
 157   } catch (std::string& xcptn) {
 158     return false;
 159   }
 160
 161   // Grab the contents of the -L path
 162   std::set<sys::Path> Files;
 163   LPath.getDirectoryContents(Files);
 164
 165   // Iterate over the contents one by one to determine
 166   // if this -L path has any bytecode shared libraries
 167   // or archives
 168   std::set<sys::Path>::iterator File = Files.begin();
 169   std::string dllsuffix = sys::Path::GetDLLSuffix();
 170   for (; File != Files.end(); ++File) {
 171
 172     if ( File->isDirectory() )
 173       continue;
 174
 175     std::string path = File->toString();
 176
 177     // Check for an ending '.dll,.so' or '.a' suffix as all
 178     // other files are not of interest to us here
 179     if (path.find(dllsuffix, path.size()-dllsuffix.size()) == std::string::npos
 180         && path.find(".a", path.size()-2) == std::string::npos)
 181       continue;
 182
 183     // Finally, check to see if the file is a true bytecode file
 184     if (isBytecodeLibrary(*File))
 185       return true;
 186   }
 187   return false;
 188 }
 189
 190 /// GenerateBytecode - generates a bytecode file from the specified module.
 191 ///
 192 /// Inputs:
 193 ///  M           - The module for which bytecode should be generated.
 194 ///  StripLevel  - 2 if we should strip all symbols, 1 if we should strip
 195 ///                debug info.
 196 ///  Internalize - Flags whether all symbols should be marked internal.
 197 ///  Out         - Pointer to file stream to which to write the output.
 198 ///
 199 /// Returns non-zero value on error.
 200 ///
 201 int llvm::GenerateBytecode(Module *M, int StripLevel, bool Internalize,
 202                            std::ostream *Out) {
 203   // In addition to just linking the input from GCC, we also want to spiff it up
 204   // a little bit.  Do this now.
 205   PassManager Passes;
 206
 207   if (Verify) Passes.add(createVerifierPass());
 208
 209   // Add an appropriate TargetData instance for this module...
 210   addPass(Passes, new TargetData("gccld", M));
 211
 212   // Often if the programmer does not specify proper prototypes for the
 213   // functions they are calling, they end up calling a vararg version of the
 214   // function that does not get a body filled in (the real function has typed
 215   // arguments).  This pass merges the two functions.
 216   addPass(Passes, createFunctionResolvingPass());
 217
 218   if (!DisableOptimizations) {
 219     // Now that composite has been compiled, scan through the module, looking
 220     // for a main function.  If main is defined, mark all other functions
 221     // internal.
 222     addPass(Passes, createInternalizePass(Internalize));
 223
 224     // Now that we internalized some globals, see if we can hack on them!
 225     addPass(Passes, createGlobalOptimizerPass());
 226
 227     // Linking modules together can lead to duplicated global constants, only
 228     // keep one copy of each constant...
 229     addPass(Passes, createConstantMergePass());
 230
 231     // Propagate constants at call sites into the functions they call.
 232     addPass(Passes, createIPSCCPPass());
 233
 234     // Remove unused arguments from functions...
 235     addPass(Passes, createDeadArgEliminationPass());
 236
 237     if (!DisableInline)
 238       addPass(Passes, createFunctionInliningPass()); // Inline small functions
 239
 240     addPass(Passes, createPruneEHPass());            // Remove dead EH info
 241     addPass(Passes, createGlobalOptimizerPass());    // Optimize globals again.
 242     addPass(Passes, createGlobalDCEPass());          // Remove dead functions
 243
 244     // If we didn't decide to inline a function, check to see if we can
 245     // transform it to pass arguments by value instead of by reference.
 246     addPass(Passes, createArgumentPromotionPass());
 247
 248     // The IPO passes may leave cruft around.  Clean up after them.
 249     addPass(Passes, createInstructionCombiningPass());
 250
 251     addPass(Passes, createScalarReplAggregatesPass()); // Break up allocas
 252
 253     // Run a few AA driven optimizations here and now, to cleanup the code.
 254     addPass(Passes, createGlobalsModRefPass());      // IP alias analysis
 255
 256     addPass(Passes, createLICMPass());               // Hoist loop invariants
 257     addPass(Passes, createLoadValueNumberingPass()); // GVN for load instrs
 258     addPass(Passes, createGCSEPass());               // Remove common subexprs
 259     addPass(Passes, createDeadStoreEliminationPass()); // Nuke dead stores
 260
 261     // Cleanup and simplify the code after the scalar optimizations.
 262     addPass(Passes, createInstructionCombiningPass());
 263
 264     // Delete basic blocks, which optimization passes may have killed...
 265     addPass(Passes, createCFGSimplificationPass());
 266
 267     // Now that we have optimized the program, discard unreachable functions...
 268     addPass(Passes, createGlobalDCEPass());
 269   }
 270
 271   // If the -s or -S command line options were specified, strip the symbols out
 272   // of the resulting program to make it smaller.  -s and -S are GLD options
 273   // that we are supporting.
 274   if (StripLevel)
 275     addPass(Passes, createStripSymbolsPass(StripLevel == 1));
 276
 277   // Make sure everything is still good.
 278   Passes.add(createVerifierPass());
 279
 280   // Add the pass that writes bytecode to the output file...
 281   addPass(Passes, new WriteBytecodePass(Out));
 282
 283   // Run our queue of passes all at once now, efficiently.
 284   Passes.run(*M);
 285
 286   return 0;
 287 }
 288
 289 /// GenerateAssembly - generates a native assembly language source file from the
 290 /// specified bytecode file.
 291 ///
 292 /// Inputs:
 293 ///  InputFilename  - The name of the output bytecode file.
 294 ///  OutputFilename - The name of the file to generate.
 295 ///  llc            - The pathname to use for LLC.
 296 ///
 297 /// Return non-zero value on error.
 298 ///
 299 int llvm::GenerateAssembly(const std::string &OutputFilename,
 300                            const std::string &InputFilename,
 301                            const sys::Path &llc,
 302                            bool Verbose) {
 303   // Run LLC to convert the bytecode file into assembly code.
 304   std::vector<const char*> args;
 305   args.push_back(llc.c_str());
 306   args.push_back("-f");
 307   args.push_back("-o");
 308   args.push_back(OutputFilename.c_str());
 309   args.push_back(InputFilename.c_str());
 310   args.push_back(0);
 311   if (Verbose) dumpArgs(&args[0]);
 312   return sys::Program::ExecuteAndWait(llc, &args[0]);
 313 }
 314
 315 /// GenerateCFile - generates a C source file from the specified bytecode file.
 316 int llvm::GenerateCFile(const std::string &OutputFile,
 317                         const std::string &InputFile,
 318                         const sys::Path &llc,
 319                         bool Verbose) {
 320   // Run LLC to convert the bytecode file into C.
 321   std::vector<const char*> args;
 322   args.push_back(llc.c_str());
 323   args.push_back("-march=c");
 324   args.push_back("-f");
 325   args.push_back("-o");
 326   args.push_back(OutputFile.c_str());
 327   args.push_back(InputFile.c_str());
 328   args.push_back(0);
 329   if (Verbose) dumpArgs(&args[0]);
 330   return sys::Program::ExecuteAndWait(llc, &args[0]);
 331 }
 332
 333 /// GenerateNative - generates a native executable file from the specified
 334 /// assembly source file.
 335 ///
 336 /// Inputs:
 337 ///  InputFilename  - The name of the output bytecode file.
 338 ///  OutputFilename - The name of the file to generate.
 339 ///  Libraries      - The list of libraries with which to link.
 340 ///  gcc            - The pathname to use for GGC.
 341 ///  envp           - A copy of the process's current environment.
 342 ///
 343 /// Outputs:
 344 ///  None.
 345 ///
 346 /// Returns non-zero value on error.
 347 ///
 348 int llvm::GenerateNative(const std::string &OutputFilename,
 349                          const std::string &InputFilename,
 350                          const std::vector<std::string> &LibPaths,
 351                          const std::vector<std::string> &Libraries,
 352                          const sys::Path &gcc, char ** const envp,
 353                          bool Shared,
 354                          bool ExportAllAsDynamic,
 355                          const std::string &RPath,
 356                          const std::string &SOName,
 357                          bool Verbose) {
 358   // Remove these environment variables from the environment of the
 359   // programs that we will execute.  It appears that GCC sets these
 360   // environment variables so that the programs it uses can configure
 361   // themselves identically.
 362   //
 363   // However, when we invoke GCC below, we want it to use its normal
 364   // configuration.  Hence, we must sanitize its environment.
 365   char ** clean_env = CopyEnv(envp);
 366   if (clean_env == NULL)
 367     return 1;
 368   RemoveEnv("LIBRARY_PATH", clean_env);
 369   RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
 370   RemoveEnv("GCC_EXEC_PREFIX", clean_env);
 371   RemoveEnv("COMPILER_PATH", clean_env);
 372   RemoveEnv("COLLECT_GCC", clean_env);
 373
 374
 375   // Run GCC to assemble and link the program into native code.
 376   //
 377   // Note:
 378   //  We can't just assemble and link the file with the system assembler
 379   //  and linker because we don't know where to put the _start symbol.
 380   //  GCC mysteriously knows how to do it.
 381   std::vector<const char*> args;
 382   args.push_back(gcc.c_str());
 383   args.push_back("-fno-strict-aliasing");
 384   args.push_back("-O3");
 385   args.push_back("-o");
 386   args.push_back(OutputFilename.c_str());
 387   args.push_back(InputFilename.c_str());
 388
 389   // StringsToDelete - We don't want to call c_str() on temporary strings.
 390   // If we need a temporary string, copy it here so that the memory is not
 391   // reclaimed until after the exec call.  All of these strings are allocated
 392   // with strdup.
 393   std::vector<char*> StringsToDelete;
 394
 395   if (Shared) args.push_back("-shared");
 396   if (ExportAllAsDynamic) args.push_back("-export-dynamic");
 397   if (!RPath.empty()) {
 398     std::string rp = "-Wl,-rpath," + RPath;
 399     StringsToDelete.push_back(strdup(rp.c_str()));
 400     args.push_back(StringsToDelete.back());
 401   }
 402   if (!SOName.empty()) {
 403     std::string so = "-Wl,-soname," + SOName;
 404     StringsToDelete.push_back(strdup(so.c_str()));
 405     args.push_back(StringsToDelete.back());
 406   }
 407
 408   // Add in the libpaths to find the libraries.
 409   //
 410   // Note:
 411   //  When gccld is called from the llvm-gxx frontends, the -L paths for
 412   //  the LLVM cfrontend install paths are appended.  We don't want the
 413   //  native linker to use these -L paths as they contain bytecode files.
 414   //  Further, we don't want any -L paths that contain bytecode shared
 415   //  libraries or true bytecode archive files.  We omit them in all such
 416   //  cases.
 417   for (unsigned index = 0; index < LibPaths.size(); index++)
 418     if (!isBytecodeLPath(LibPaths[index])) {
 419       std::string Tmp = "-L"+LibPaths[index];
 420       StringsToDelete.push_back(strdup(Tmp.c_str()));
 421       args.push_back(StringsToDelete.back());
 422     }
 423
 424   // Add in the libraries to link.
 425   for (unsigned index = 0; index < Libraries.size(); index++)
 426     // HACK: If this is libg, discard it.  This gets added by the compiler
 427     // driver when doing: 'llvm-gcc main.c -Wl,-native -o a.out -g'. Note that
 428     // this should really be fixed by changing the llvm-gcc compiler driver.
 429     if (Libraries[index] != "crtend" && Libraries[index] != "g") {
 430       std::string Tmp = "-l"+Libraries[index];
 431       StringsToDelete.push_back(strdup(Tmp.c_str()));
 432       args.push_back(StringsToDelete.back());
 433     }
 434   args.push_back(0); // Null terminate.
 435
 436   // Run the compiler to assembly and link together the program.
 437   if (Verbose) dumpArgs(&args[0]);
 438   int Res = sys::Program::ExecuteAndWait(gcc, &args[0], (const char**)clean_env);
 439
 440   while (!StringsToDelete.empty()) {
 441     free(StringsToDelete.back());
 442     StringsToDelete.pop_back();
 443   }
 444   return Res;
 445 }
 446