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/WriteBytecodePass.h"
  24 #include "llvm/Target/TargetData.h"
  25 #include "llvm/Transforms/IPO.h"
  26 #include "llvm/Transforms/Scalar.h"
  27 #include "llvm/Support/SystemUtils.h"
  28 #include "llvm/Support/CommandLine.h"
  29
  30 using namespace llvm;
  31
  32 namespace {
  33   cl::opt<bool>
  34   DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
  35
  36   cl::opt<bool>
  37   Verify("verify", cl::desc("Verify intermediate results of all passes"));
  38
  39   cl::opt<bool>
  40   DisableOptimizations("disable-opt",
  41                        cl::desc("Do not run any optimization passes"));
  42 }
  43
  44 /// CopyEnv - This function takes an array of environment variables and makes a
  45 /// copy of it.  This copy can then be manipulated any way the caller likes
  46 /// without affecting the process's real environment.
  47 ///
  48 /// Inputs:
  49 ///  envp - An array of C strings containing an environment.
  50 ///
  51 /// Return value:
  52 ///  NULL - An error occurred.
  53 ///
  54 ///  Otherwise, a pointer to a new array of C strings is returned.  Every string
  55 ///  in the array is a duplicate of the one in the original array (i.e. we do
  56 ///  not copy the char *'s from one array to another).
  57 ///
  58 static char ** CopyEnv(char ** const envp) {
  59   // Count the number of entries in the old list;
  60   unsigned entries;   // The number of entries in the old environment list
  61   for (entries = 0; envp[entries] != NULL; entries++)
  62     /*empty*/;
  63
  64   // Add one more entry for the NULL pointer that ends the list.
  65   ++entries;
  66
  67   // If there are no entries at all, just return NULL.
  68   if (entries == 0)
  69     return NULL;
  70
  71   // Allocate a new environment list.
  72   char **newenv = new char* [entries];
  73   if ((newenv = new char* [entries]) == NULL)
  74     return NULL;
  75
  76   // Make a copy of the list.  Don't forget the NULL that ends the list.
  77   entries = 0;
  78   while (envp[entries] != NULL) {
  79     newenv[entries] = new char[strlen (envp[entries]) + 1];
  80     strcpy (newenv[entries], envp[entries]);
  81     ++entries;
  82   }
  83   newenv[entries] = NULL;
  84
  85   return newenv;
  86 }
  87
  88
  89 /// RemoveEnv - Remove the specified environment variable from the environment
  90 /// array.
  91 ///
  92 /// Inputs:
  93 ///  name - The name of the variable to remove.  It cannot be NULL.
  94 ///  envp - The array of environment variables.  It cannot be NULL.
  95 ///
  96 /// Notes:
  97 ///  This is mainly done because functions to remove items from the environment
  98 ///  are not available across all platforms.  In particular, Solaris does not
  99 ///  seem to have an unsetenv() function or a setenv() function (or they are
 100 ///  undocumented if they do exist).
 101 ///
 102 static void RemoveEnv(const char * name, char ** const envp) {
 103   for (unsigned index=0; envp[index] != NULL; index++) {
 104     // Find the first equals sign in the array and make it an EOS character.
 105     char *p = strchr (envp[index], '=');
 106     if (p == NULL)
 107       continue;
 108     else
 109       *p = '\0';
 110
 111     // Compare the two strings.  If they are equal, zap this string.
 112     // Otherwise, restore it.
 113     if (!strcmp(name, envp[index]))
 114       *envp[index] = '\0';
 115     else
 116       *p = '=';
 117   }
 118
 119   return;
 120 }
 121
 122 static inline void addPass(PassManager &PM, Pass *P) {
 123   // Add the pass to the pass manager...
 124   PM.add(P);
 125
 126   // If we are verifying all of the intermediate steps, add the verifier...
 127   if (Verify) PM.add(createVerifierPass());
 128 }
 129
 130 /// GenerateBytecode - generates a bytecode file from the specified module.
 131 ///
 132 /// Inputs:
 133 ///  M           - The module for which bytecode should be generated.
 134 ///  StripLevel  - 2 if we should strip all symbols, 1 if we should strip
 135 ///                debug info.
 136 ///  Internalize - Flags whether all symbols should be marked internal.
 137 ///  Out         - Pointer to file stream to which to write the output.
 138 ///
 139 /// Returns non-zero value on error.
 140 ///
 141 int llvm::GenerateBytecode(Module *M, int StripLevel, bool Internalize,
 142                            std::ostream *Out) {
 143   // In addition to just linking the input from GCC, we also want to spiff it up
 144   // a little bit.  Do this now.
 145   PassManager Passes;
 146
 147   if (Verify) Passes.add(createVerifierPass());
 148
 149   // Add an appropriate TargetData instance for this module...
 150   addPass(Passes, new TargetData("gccld", M));
 151
 152   // Often if the programmer does not specify proper prototypes for the
 153   // functions they are calling, they end up calling a vararg version of the
 154   // function that does not get a body filled in (the real function has typed
 155   // arguments).  This pass merges the two functions.
 156   addPass(Passes, createFunctionResolvingPass());
 157
 158   if (!DisableOptimizations) {
 159     if (Internalize) {
 160       // Now that composite has been compiled, scan through the module, looking
 161       // for a main function.  If main is defined, mark all other functions
 162       // internal.
 163       addPass(Passes, createInternalizePass());
 164     }
 165
 166     // Now that we internalized some globals, see if we can hack on them!
 167     addPass(Passes, createGlobalOptimizerPass());
 168
 169     // Linking modules together can lead to duplicated global constants, only
 170     // keep one copy of each constant...
 171     addPass(Passes, createConstantMergePass());
 172
 173     // Propagate constants at call sites into the functions they call.
 174     addPass(Passes, createIPSCCPPass());
 175
 176     // Remove unused arguments from functions...
 177     addPass(Passes, createDeadArgEliminationPass());
 178
 179     if (!DisableInline)
 180       addPass(Passes, createFunctionInliningPass()); // Inline small functions
 181
 182     addPass(Passes, createPruneEHPass());            // Remove dead EH info
 183     addPass(Passes, createGlobalOptimizerPass());    // Optimize globals again.
 184     addPass(Passes, createGlobalDCEPass());          // Remove dead functions
 185
 186     // If we didn't decide to inline a function, check to see if we can
 187     // transform it to pass arguments by value instead of by reference.
 188     addPass(Passes, createArgumentPromotionPass());
 189
 190     // The IPO passes may leave cruft around.  Clean up after them.
 191     addPass(Passes, createInstructionCombiningPass());
 192
 193     addPass(Passes, createScalarReplAggregatesPass()); // Break up allocas
 194
 195     // Run a few AA driven optimizations here and now, to cleanup the code.
 196     addPass(Passes, createGlobalsModRefPass());      // IP alias analysis
 197
 198     addPass(Passes, createLICMPass());               // Hoist loop invariants
 199     addPass(Passes, createLoadValueNumberingPass()); // GVN for load instrs
 200     addPass(Passes, createGCSEPass());               // Remove common subexprs
 201     addPass(Passes, createDeadStoreEliminationPass()); // Nuke dead stores
 202
 203     // Cleanup and simplify the code after the scalar optimizations.
 204     addPass(Passes, createInstructionCombiningPass());
 205
 206     // Delete basic blocks, which optimization passes may have killed...
 207     addPass(Passes, createCFGSimplificationPass());
 208
 209     // Now that we have optimized the program, discard unreachable functions...
 210     addPass(Passes, createGlobalDCEPass());
 211   }
 212
 213   // If the -s or -S command line options were specified, strip the symbols out
 214   // of the resulting program to make it smaller.  -s and -S are GLD options
 215   // that we are supporting.
 216   if (StripLevel)
 217     addPass(Passes, createStripSymbolsPass(StripLevel == 1));
 218
 219   // Make sure everything is still good.
 220   Passes.add(createVerifierPass());
 221
 222   // Add the pass that writes bytecode to the output file...
 223   addPass(Passes, new WriteBytecodePass(Out));
 224
 225   // Run our queue of passes all at once now, efficiently.
 226   Passes.run(*M);
 227
 228   return 0;
 229 }
 230
 231 /// GenerateAssembly - generates a native assembly language source file from the
 232 /// specified bytecode file.
 233 ///
 234 /// Inputs:
 235 ///  InputFilename  - The name of the output bytecode file.
 236 ///  OutputFilename - The name of the file to generate.
 237 ///  llc            - The pathname to use for LLC.
 238 ///
 239 /// Return non-zero value on error.
 240 ///
 241 int llvm::GenerateAssembly(const std::string &OutputFilename,
 242                            const std::string &InputFilename,
 243                            const sys::Path &llc) {
 244   // Run LLC to convert the bytecode file into assembly code.
 245   std::vector<const char*> args;
 246   args.push_back("-f");
 247   args.push_back("-o");
 248   args.push_back(OutputFilename.c_str());
 249   args.push_back(InputFilename.c_str());
 250   args.push_back(0);
 251
 252   return sys::Program::ExecuteAndWait(llc, &args[0]);
 253 }
 254
 255 /// GenerateAssembly - generates a native assembly language source file from the
 256 /// specified bytecode file.
 257 int llvm::GenerateCFile(const std::string &OutputFile,
 258                         const std::string &InputFile,
 259                         const sys::Path &llc ) {
 260   // Run LLC to convert the bytecode file into C.
 261   std::vector<const char*> args;
 262   args.push_back("-march=c");
 263   args.push_back("-f");
 264   args.push_back("-o");
 265   args.push_back(OutputFile.c_str());
 266   args.push_back(InputFile.c_str());
 267   args.push_back(0);
 268   return sys::Program::ExecuteAndWait(llc, &args[0]);
 269 }
 270
 271 /// GenerateNative - generates a native assembly language source file from the
 272 /// specified assembly source file.
 273 ///
 274 /// Inputs:
 275 ///  InputFilename  - The name of the output bytecode file.
 276 ///  OutputFilename - The name of the file to generate.
 277 ///  Libraries      - The list of libraries with which to link.
 278 ///  gcc            - The pathname to use for GGC.
 279 ///  envp           - A copy of the process's current environment.
 280 ///
 281 /// Outputs:
 282 ///  None.
 283 ///
 284 /// Returns non-zero value on error.
 285 ///
 286 int llvm::GenerateNative(const std::string &OutputFilename,
 287                          const std::string &InputFilename,
 288                          const std::vector<std::string> &Libraries,
 289                          const sys::Path &gcc, char ** const envp) {
 290   // Remove these environment variables from the environment of the
 291   // programs that we will execute.  It appears that GCC sets these
 292   // environment variables so that the programs it uses can configure
 293   // themselves identically.
 294   //
 295   // However, when we invoke GCC below, we want it to use its normal
 296   // configuration.  Hence, we must sanitize its environment.
 297   char ** clean_env = CopyEnv(envp);
 298   if (clean_env == NULL)
 299     return 1;
 300   RemoveEnv("LIBRARY_PATH", clean_env);
 301   RemoveEnv("COLLECT_GCC_OPTIONS", clean_env);
 302   RemoveEnv("GCC_EXEC_PREFIX", clean_env);
 303   RemoveEnv("COMPILER_PATH", clean_env);
 304   RemoveEnv("COLLECT_GCC", clean_env);
 305
 306
 307   // Run GCC to assemble and link the program into native code.
 308   //
 309   // Note:
 310   //  We can't just assemble and link the file with the system assembler
 311   //  and linker because we don't know where to put the _start symbol.
 312   //  GCC mysteriously knows how to do it.
 313   std::vector<const char*> args;
 314   args.push_back("-fno-strict-aliasing");
 315   args.push_back("-O3");
 316   args.push_back("-o");
 317   args.push_back(OutputFilename.c_str());
 318   args.push_back(InputFilename.c_str());
 319
 320   // Add in the libraries to link.
 321   for (unsigned index = 0; index < Libraries.size(); index++) {
 322     if (Libraries[index] != "crtend") {
 323       args.push_back("-l");
 324       args.push_back(Libraries[index].c_str());
 325     }
 326   }
 327   args.push_back(0);
 328
 329   // Run the compiler to assembly and link together the program.
 330   return sys::Program::ExecuteAndWait(gcc, &args[0], (const char**)clean_env);
 331 }
 332