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 (!Named && I->getName() == ExtractFunc) {
  42         // Yes, it is.  Keep track of it...
  43         Named = I;
  44
  45         // Make sure it's globally accessable...
  46         Named->setInternalLinkage(false);
  47
  48         // Remove the named function from the module.
  49         M.getFunctionList().remove(I);
  50       } else {
  51         // Nope it's not the named function, delete the body of the function
  52         I->dropAllReferences();
  53         ++I;
  54       }
  55
  56     // All of the functions that still have uses now must be used by global
  57     // variables or the named function.  Loop through them and create a new,
  58     // external function for the used ones... making all uses point to the new
  59     // functions.
  60     std::vector<Function*> NewFunctions;
  61
  62     for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
  63       if (!I->use_empty()) {
  64         Function *New = new Function(I->getFunctionType(), false, I->getName());
  65         I->replaceAllUsesWith(New);
  66         NewFunctions.push_back(New);
  67       }
  68
  69     // Now the module only has unused functions with their references dropped.
  70     // Delete them all now!
  71     M.getFunctionList().clear();
  72
  73     // Re-insert the named function...
  74     if (Named)
  75       M.getFunctionList().push_back(Named);
  76     else
  77       std::cerr << "Warning: Function '" << ExtractFunc << "' not found!\n";
  78
  79     // Insert all of the function stubs...
  80     M.getFunctionList().insert(M.end(), NewFunctions.begin(),
  81                                NewFunctions.end());
  82     return true;
  83   }
  84 };
  85
  86
  87 static RegisterPass<FunctionExtractorPass> X("extract", "Function Extractor");
  88
  89
  90 int main(int argc, char **argv) {
  91   cl::ParseCommandLineOptions(argc, argv, " llvm extractor\n");
  92
  93   std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
  94   if (M.get() == 0) {
  95     std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
  96     return 1;
  97   }
  98
  99   // In addition to just parsing the input from GCC, we also want to spiff it up
 100   // a little bit.  Do this now.
 101   //
 102   PassManager Passes;
 103   Passes.add(new FunctionExtractorPass());
 104   Passes.add(createGlobalDCEPass());              // Delete unreachable globals
 105   Passes.add(createConstantMergePass());          // Merge dup global constants
 106   Passes.add(createDeadTypeEliminationPass());    // Remove dead types...
 107   Passes.add(new WriteBytecodePass(&std::cout));  // Write bytecode to file...
 108
 109   Passes.run(*M.get());
 110   return 0;
 111 }