tools/llvm-extract/llvm-extract.cpp

   1 //===----------------------------------------------------------------------===//
   2 // LLVM extract Utility
   3 //
   4 // This utility changes the input module to only contain a single function,
   5 // which is primarily used for debugging transformations.
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "llvm/Module.h"
  10 #include "llvm/PassManager.h"
  11 #include "llvm/Bytecode/Reader.h"
  12 #include "llvm/Bytecode/WriteBytecodePass.h"
  13 #include "llvm/Transforms/IPO.h"
  14 #include "Support/CommandLine.h"
  15 #include <memory>
  16
  17 // InputFilename - The filename to read from.
  18 static cl::opt<std::string>
  19 InputFilename(cl::Positional, cl::desc("<input bytecode file>"),
  20               cl::init("-"), cl::value_desc("filename"));
  21
  22
  23 // ExtractFunc - The function to extract from the module... defaults to main.
  24 static cl::opt<std::string>
  25 ExtractFunc("func", cl::desc("Specify function to extract"), cl::init("main"),
  26             cl::value_desc("function"));
  27
  28
  29 struct FunctionExtractorPass : public Pass {
  30   bool run(Module &M) {
  31     // Mark all global variables to be internal
  32     for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
  33       I->setInternalLinkage(true);
  34
  35     Function *Named = 0;
  36
  37     // Loop over all of the functions in the module, dropping all references in
  38     // functions that are not the named function.
  39     for (Module::iterator I = M.begin(), E = M.end(); I != E;)
  40       // Check to see if this is the named function!
  41       if (I->getName() == ExtractFunc && !I->isExternal()) {
  42         if (Named) {                            // Two functions, same name?
  43           std::cerr << "extract ERROR: Two functions named: '" << ExtractFunc
  44                     << "' found!\n";
  45           exit(1);
  46         }
  47
  48         // Yes, it is.  Keep track of it...
  49         Named = I;
  50
  51         // Make sure it's globally accessable...
  52         Named->setInternalLinkage(false);
  53
  54         // Remove the named function from the module.
  55         M.getFunctionList().remove(I);
  56       } else {
  57         // Nope it's not the named function, delete the body of the function
  58         I->dropAllReferences();
  59         ++I;
  60       }
  61
  62     // All of the functions that still have uses now must be used by global
  63     // variables or the named function.  Loop through them and create a new,
  64     // external function for the used ones... making all uses point to the new
  65     // functions.
  66     std::vector<Function*> NewFunctions;
  67
  68     for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  69       if (!I->use_empty()) {
  70         Function *New = new Function(I->getFunctionType(), false, I->getName());
  71         I->replaceAllUsesWith(New);
  72         NewFunctions.push_back(New);
  73       }
  74
  75     // Now the module only has unused functions with their references dropped.
  76     // Delete them all now!
  77     M.getFunctionList().clear();
  78
  79     // Re-insert the named function...
  80     if (Named)
  81       M.getFunctionList().push_back(Named);
  82     else
  83       std::cerr << "Warning: Function '" << ExtractFunc << "' not found!\n";
  84
  85     // Insert all of the function stubs...
  86     M.getFunctionList().insert(M.end(), NewFunctions.begin(),
  87                                NewFunctions.end());
  88     return true;
  89   }
  90 };
  91
  92
  93 static RegisterPass<FunctionExtractorPass> X("extract", "Function Extractor");
  94
  95
  96 int main(int argc, char **argv) {
  97   cl::ParseCommandLineOptions(argc, argv, " llvm extractor\n");
  98
  99   std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
 100   if (M.get() == 0) {
 101     std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
 102     return 1;
 103   }
 104
 105   // In addition to just parsing the input from GCC, we also want to spiff it up
 106   // a little bit.  Do this now.
 107   //
 108   PassManager Passes;
 109   Passes.add(new FunctionExtractorPass());
 110   Passes.add(createGlobalDCEPass());              // Delete unreachable globals
 111   Passes.add(createConstantMergePass());          // Merge dup global constants
 112   Passes.add(createDeadTypeEliminationPass());    // Remove dead types...
 113   Passes.add(new WriteBytecodePass(&std::cout));  // Write bytecode to file...
 114
 115   Passes.run(*M.get());
 116   return 0;
 117 }