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   return;
 121 }
 122
 123 static inline void addPass(PassManager &PM, Pass *P) {
 124   // Add the pass to the pass manager...
 125   PM.add(P);
 126
 127   // If we are verifying all of the intermediate steps, add the verifier...
 128   if (Verify) PM.add(createVerifierPass());
 129 }
 130
 131 static bool isBytecodeLibrary(const sys::Path &FullPath) {
 132   // Check for a bytecode file
 133   if (FullPath.isBytecodeFile()) return true;
 134   // Check for a dynamic library file
 135   if (FullPath.isDynamicLibrary()) return false;
 136   // Check for a true bytecode archive file
 137   if (FullPath.isArchive() ) {
 138     std::string ErrorMessage;
 139     Archive* ar = Archive::OpenAndLoadSymbols( FullPath, &ErrorMessage );
 140     return ar->isBytecodeArchive();
 141   }
 142   return false;
 143 }
 144
 145 static bool isBytecodeLPath(const std::string &LibPath) {
 146   bool isBytecodeLPath = false;
 147
 148   // Make sure the -L path has a '/' character
 149   // because llvm-g++ passes them without the ending
 150   // '/' char and sys::Path doesn't think it is a
 151   // directory (see: sys::Path::isDirectory) without it
 152   std::string dir = LibPath;
 153   if ( dir[dir.length()-1] != '/' )
 154   dir.append("/");
 155
 156   sys::Path LPath(dir);
 157
 158   // Grab the contents of the -L path
 159   std::set<sys::Path> Files;
 160   LPath.getDirectoryContents(Files);
 161
 162   // Iterate over the contents one by one to determine
 163   // if this -L path has any bytecode shared libraries
 164   // or archives
 165   std::set<sys::Path>::iterator File = Files.begin();
 166   for (; File != Files.end(); ++File) {
 167
 168     if ( File->isDirectory() )
 169       continue;
 170
 171     std::string path = File->toString();
 172     std::string dllsuffix = sys::Path::GetDLLSuffix();
 173
 174     // Check for an ending '.dll,.so' or '.a' suffix as all
 175     // other files are not of interest to us here
 176     if ( path.find(dllsuffix, path.size()-dllsuffix.size()) == std::string::npos
 177         && path.find(".a", path.size()-2) == std::string::npos )
 178       continue;
 179
 180     // Finally, check to see if the file is a true bytecode file
 181     if (isBytecodeLibrary(*File))
 182       isBytecodeLPath = true;
 183   }
 184   return isBytecodeLPath;
 185 }
 186
 187 /// GenerateBytecode - generates a bytecode file from the specified module.
 188 ///
 189 /// Inputs:
 190 ///  M           - The module for which bytecode should be generated.
 191 ///  StripLevel  - 2 if we should strip all symbols, 1 if we should strip
 192 ///                debug info.
 193 ///  Internalize - Flags whether all symbols should be marked internal.
 194 ///  Out         - Pointer to file stream to which to write the output.
 195 ///
 196 /// Returns non-zero value on error.
 197 ///
 198 int llvm::GenerateBytecode(Module *M, int StripLevel, bool Internalize,
 199                            std::ostream *Out) {
 200   // In addition to just linking the input from GCC, we also want to spiff it up
 201   // a little bit.  Do this now.
 202   PassManager Passes;
 203
 204   if (Verify) Passes.add(createVerifierPass());
 205
 206   // Add an appropriate TargetData instance for this module...
 207   addPass(Passes, new TargetData("gccld", M));
 208
 209   // Often if the programmer does not specify proper prototypes for the
 210   // functions they are calling, they end up calling a vararg version of the
 211   // function that does not get a body filled in (the real function has typed
 212   // arguments).  This pass merges the two functions.
 213   addPass(Passes, createFunctionResolvingPass());
 214
 215   if (!DisableOptimizations) {
 216     if (Internalize) {
 217       // Now that composite has been compiled, scan through the module, looking
 218       // for a main function.  If main is defined, mark all other functions
 219       // internal.
 220       addPass(Passes, createInternalizePass());
 221     }
 222
 223     // Now that we internalized some globals, see if we can hack on them!
 224     addPass(Passes, createGlobalOptimizerPass());
 225
 226     // Linking modules together can lead to duplicated global constants, only
 227     // keep one copy of each constant...
 228     addPass(Passes, createConstantMergePass());
 229
 230     // Propagate constants at call sites into the functions they call.
 231     addPass(Passes, createIPSCCPPass());
 232
 233     // Remove unused arguments from functions...
 234     addPass(Passes, createDeadArgEliminationPass());
 235
 236     if (!DisableInline)
 237       addPass(Passes, createFunctionInliningPass()); // Inline small functions
 238
 239     addPass(Passes, createPruneEHPass());            // Remove dead EH info
 240     addPass(Passes, createGlobalOptimizerPass());    // Optimize globals again.
 241     addPass(Passes, createGlobalDCEPass());          // Remove dead functions
 242
 243     // If we didn't decide to inline a function, check to see if we can
 244     // transform it to pass arguments by value instead of by reference.
 245     addPass(Passes, createArgumentPromotionPass());
 246
 247     // The IPO passes may leave cruft around.  Clean up after them.
 248     addPass(Passes, createInstructionCombiningPass());
 249
 250     addPass(Passes, createScalarReplAggregatesPass()); // Break up allocas
 251
 252     // Run a few AA driven optimizations here and now, to cleanup the code.
 253     addPass(Passes, createGlobalsModRefPass());      // IP alias analysis
 254
 255     addPass(Passes, createLICMPass());               // Hoist loop invariants
 256     addPass(Passes, createLoadValueNumberingPass()); // GVN for load instrs
 257     addPass(Passes, createGCSEPass());               // Remove common subexprs
 258     addPass(Passes, createDeadStoreEliminationPass()); // Nuke dead stores
 259
 260     // Cleanup and simplify the code after the scalar optimizations.
 261     addPass(Passes, createInstructionCombiningPass());
 262
 263     // Delete basic blocks, which optimization passes may have killed...
 264     addPass(Passes, createCFGSimplificationPass());
 265
 266     // Now that we have optimized the program, discard unreachable functions...
 267     addPass(Passes, createGlobalDCEPass());
 268   }
 269
 270   // If the -s or -S command line options were specified, strip the symbols out
 271   // of the resulting program to make it smaller.  -s and -S are GLD options
 272   // that we are supporting.
 273   if (StripLevel)
 274     addPass(Passes, createStripSymbolsPass(StripLevel == 1));
 275
 276   // Make sure everything is still good.
 277   Passes.add(createVerifierPass());
 278
 279   // Add the pass that writes bytecode to the output file...
 280   addPass(Passes, new WriteBytecodePass(Out));
 281
 282   // Run our queue of passes all at once now, efficiently.
 283   Passes.run(*M);
 284
 285   return 0;
 286 }
 287
 288 /// GenerateAssembly - generates a native assembly language source file from the
 289 /// specified bytecode file.
 290 ///
 291 /// Inputs:
 292 ///  InputFilename  - The name of the output bytecode file.
 293 ///  OutputFilename - The name of the file to generate.
 294 ///  llc            - The pathname to use for LLC.
 295 ///
 296 /// Return non-zero value on error.
 297 ///
 298 int llvm::GenerateAssembly(const std::string &OutputFilename,
 299                            const std::string &InputFilename,
 300                            const sys::Path &llc) {
 301   // Run LLC to convert the bytecode file into assembly code.
 302   std::vector<const char*> args;
 303   args.push_back("-f");
 304   args.push_back("-o");
 305   args.push_back(OutputFilename.c_str());
 306   args.push_back(InputFilename.c_str());
 307   args.push_back(0);
 308
 309   return sys::Program::ExecuteAndWait(llc, &args[0]);
 310 }
 311
 312 /// GenerateAssembly - generates a native assembly language source file from the
 313 /// specified bytecode file.
 314 int llvm::GenerateCFile(const std::string &OutputFile,
 315                         const std::string &InputFile,
 316                         const sys::Path &llc ) {
 317   // Run LLC to convert the bytecode file into C.
 318   std::vector<const char*> args;
 319   args.push_back("-march=c");
 320   args.push_back("-f");
 321   args.push_back("-o");
 322   args.push_back(OutputFile.c_str());
 323   args.push_back(InputFile.c_str());
 324   args.push_back(0);
 325   return sys::Program::ExecuteAndWait(llc, &args[0]);
 326 }
 327
 328 /// GenerateNative - generates a native assembly language source file from the
 329 /// specified assembly source file.
 330 ///
 331 /// Inputs:
 332 ///  InputFilename  - The name of the output bytecode file.
 333 ///  OutputFilename - The name of the file to generate.
 334 ///  Libraries      - The list of libraries with which to link.
 335 ///  gcc            - The pathname to use for GGC.
 336 ///  envp           - A copy of the process's current environment.
 337 ///
 338 /// Outputs:
 339 ///  None.
 340 ///
 341 /// Returns non-zero value on error.
 342 ///
 343 int llvm::GenerateNative(const std::string &OutputFilename,
 344                          const std::string &InputFilename,
 345                          const std::vector<std::string> &LibPaths,
 346                          const std::vector<std::string> &Libraries,
 347                          const sys::Path &gcc, char ** const envp,
 348                          bool Shared,
 349                          const std::string &RPath,
 350                          const std::string &SOName) {
 351   // Remove these environment variables from the environment of the
 352   // programs that we will execute.  It appears that GCC sets these
 353   // environment variables so that the programs it uses can configure
 354   // themselves identically.
 355   //
 356   // However, when we invoke GCC below, we want it to use its normal
 357   // configuration.  Hence, we must sanitize its environment.
 358   char ** clean_env = CopyEnv(envp);
 359   if (clean_env == NULL)
 360     return 1;
 361   RemoveEnv("LIBRARY_PATH", clean_env);
 362   RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
 363   RemoveEnv("GCC_EXEC_PREFIX", clean_env);
 364   RemoveEnv("COMPILER_PATH", clean_env);
 365   RemoveEnv("COLLECT_GCC", clean_env);
 366
 367
 368   // Run GCC to assemble and link the program into native code.
 369   //
 370   // Note:
 371   //  We can't just assemble and link the file with the system assembler
 372   //  and linker because we don't know where to put the _start symbol.
 373   //  GCC mysteriously knows how to do it.
 374   std::vector<const char*> args;
 375   args.push_back("-fno-strict-aliasing");
 376   args.push_back("-O3");
 377   args.push_back("-o");
 378   args.push_back(OutputFilename.c_str());
 379   args.push_back(InputFilename.c_str());
 380
 381   if (Shared) args.push_back("-shared");
 382   if (!RPath.empty()) {
 383     std::string rp = "-Wl,-rpath," + RPath;
 384     args.push_back(rp.c_str());
 385   }
 386   if (!SOName.empty()) {
 387     std::string so = "-Wl,-soname," + SOName;
 388     args.push_back(so.c_str());
 389   }
 390
 391   // Add in the libpaths to find the libraries.
 392   //
 393   // Note:
 394   //  When gccld is called from the llvm-gxx frontends, the -L paths for
 395   //  the LLVM cfrontend install paths are appended.  We don't want the
 396   //  native linker to use these -L paths as they contain bytecode files.
 397   //  Further, we don't want any -L paths that contain bytecode shared
 398   //  libraries or true bytecode archive files.  We omit them in all such
 399   //  cases.
 400   for (unsigned index = 0; index < LibPaths.size(); index++) {
 401     if (!isBytecodeLPath( LibPaths[index]) ) {
 402       args.push_back("-L");
 403       args.push_back(LibPaths[index].c_str());
 404     }
 405   }
 406
 407   // Add in the libraries to link.
 408   for (unsigned index = 0; index < Libraries.size(); index++) {
 409     if (Libraries[index] != "crtend") {
 410       args.push_back("-l");
 411       args.push_back(Libraries[index].c_str());
 412     }
 413   }
 414   args.push_back(0);
 415
 416   // Run the compiler to assembly and link together the program.
 417   return sys::Program::ExecuteAndWait(gcc, &args[0], (const char**)clean_env);
 418 }
 419