elisp code to help with LLVM code standards compliance
[oota-llvm.git] / tools / extract / extract.cpp
index fd865419c9d586b31b492c814bbd0b314245bbdc..78d0426be1847b17ea3f2f5c1d288c51384f3b74 100644 (file)
@@ -1,5 +1,11 @@
+//===- extract.cpp - LLVM function extraction utility ---------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
-// LLVM extract Utility
 //
 // This utility changes the input module to only contain a single function,
 // which is primarily used for debugging transformations.
 #include "llvm/Bytecode/Reader.h"
 #include "llvm/Bytecode/WriteBytecodePass.h"
 #include "llvm/Transforms/IPO.h"
-#include "Support/CommandLine.h"
+#include "llvm/Target/TargetData.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/System/Signals.h"
 #include <memory>
+#include <fstream>
+using namespace llvm;
 
 // InputFilename - The filename to read from.
 static cl::opt<std::string>
 InputFilename(cl::Positional, cl::desc("<input bytecode file>"),
               cl::init("-"), cl::value_desc("filename"));
-              
 
-// ExtractFunc - The function to extract from the module... defaults to main.
 static cl::opt<std::string>
-ExtractFunc("func", cl::desc("Specify function to extract"), cl::init("main"),
-            cl::value_desc("function"));
+OutputFilename("o", cl::desc("Specify output filename"),
+               cl::value_desc("filename"), cl::init("-"));
 
+static cl::opt<bool>
+Force("f", cl::desc("Overwrite output files"));
 
-struct FunctionExtractorPass : public Pass {
-  bool run(Module &M) {
-    // Mark all global variables to be internal
-    for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
-      if (!I->isExternal()) {
-        I->setInitializer(0);  // Make all variables external
-        I->setInternalLinkage(false); // Make sure it's not internal
-      }
-
-    Function *Named = 0;
+static cl::opt<bool>
+DeleteFn("delete", cl::desc("Delete specified function from Module"));
 
-    // Loop over all of the functions in the module, dropping all references in
-    // functions that are not the named function.
-    for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
-      // Check to see if this is the named function!
-      if (I->getName() == ExtractFunc && !I->isExternal()) {
-        if (Named) {                            // Two functions, same name?
-          std::cerr << "extract ERROR: Two functions named: '" << ExtractFunc
-                    << "' found!\n";
-          exit(1);
-        }
-
-        // Yes, it is.  Keep track of it...
-        Named = I;
+// ExtractFunc - The function to extract from the module... defaults to main.
+static cl::opt<std::string>
+ExtractFunc("func", cl::desc("Specify function to extract"), cl::init("main"),
+            cl::value_desc("function"));
 
-        // Make sure it's globally accessable...
-        Named->setInternalLinkage(false);
-      }
-    
-    if (Named == 0) {
-      std::cerr << "Warning: Function '" << ExtractFunc << "' not found!\n";
-      return false;
+int main(int argc, char **argv) {
+  try {
+    cl::ParseCommandLineOptions(argc, argv, " llvm extractor\n");
+    sys::PrintStackTraceOnErrorSignal();
+
+    std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
+    if (M.get() == 0) {
+      std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
+      return 1;
     }
-    
-    // All of the functions may be used by global variables or the named
-    // function.  Loop through them and create a new, external functions that
-    // can be "used", instead of ones with bodies.
-    //
-    std::vector<Function*> NewFunctions;
-    
-    Function *Last = &M.back();  // Figure out where the last real fn is...
 
-    for (Module::iterator I = M.begin(); ; ++I) {
-      if (I->getName() != ExtractFunc) {
-        Function *New = new Function(I->getFunctionType(), false, I->getName());
-        I->setName("");  // Remove Old name
-
-        // If it's not the named function, delete the body of the function
-        I->dropAllReferences();
-
-        M.getFunctionList().push_back(New);
-        NewFunctions.push_back(New);
-      }
-
-      if (&*I == Last) break;  // Stop after processing the last function
+    // Figure out which function we should extract
+    Function *F = M.get()->getNamedFunction(ExtractFunc);
+    if (F == 0) {
+      std::cerr << argv[0] << ": program doesn't contain function named '"
+                << ExtractFunc << "'!\n";
+      return 1;
     }
 
-    // Now that we have replacements all set up, loop through the module,
-    // deleting the old functions, replacing them with the newly created
-    // functions.
-    if (!NewFunctions.empty()) {
-      unsigned FuncNum = 0;
-      Module::iterator I = M.begin();
-      do {
-        if (I->getName() != ExtractFunc) {
-          // Make everything that uses the old function use the new dummy fn
-          I->replaceAllUsesWith(NewFunctions[FuncNum++]);
-          
-          Function *Old = I;
-          ++I;  // Move the iterator to the new function
-
-          // Delete the old function!
-          M.getFunctionList().erase(Old);
-
-        } else {
-          ++I;  // Skip the function we are extracting
-        }
-      } while (&*I != NewFunctions[0]);
+    // In addition to deleting all other functions, we also want to spiff it
+    // up a little bit.  Do this now.
+    PassManager Passes;
+    Passes.add(new TargetData("extract", M.get())); // Use correct TargetData
+    // Either isolate the function or delete it from the Module
+    Passes.add(createFunctionExtractionPass(F, DeleteFn));
+    Passes.add(createGlobalDCEPass());              // Delete unreachable globals
+    Passes.add(createFunctionResolvingPass());      // Delete prototypes
+    Passes.add(createDeadTypeEliminationPass());    // Remove dead types...
+
+    std::ostream *Out = 0;
+
+    if (OutputFilename != "-") {  // Not stdout?
+      if (!Force && std::ifstream(OutputFilename.c_str())) {
+        // If force is not specified, make sure not to overwrite a file!
+        std::cerr << argv[0] << ": error opening '" << OutputFilename
+                  << "': file exists!\n"
+                  << "Use -f command line argument to force output\n";
+        return 1;
+      }
+      std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+                                   std::ios::binary;
+      Out = new std::ofstream(OutputFilename.c_str(), io_mode);
+    } else {                      // Specified stdout
+      // FIXME: cout is not binary!
+      Out = &std::cout;
     }
-    
-    return true;
-  }
-};
-
 
-static RegisterPass<FunctionExtractorPass> X("extract", "Function Extractor");
+    Passes.add(new WriteBytecodePass(Out));  // Write bytecode to file...
+    Passes.run(*M.get());
 
-
-int main(int argc, char **argv) {
-  cl::ParseCommandLineOptions(argc, argv, " llvm extractor\n");
-
-  std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
-  if (M.get() == 0) {
-    std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
-    return 1;
+    if (Out != &std::cout)
+      delete Out;
+    return 0;
+  } catch (const std::string& msg) {
+    std::cerr << argv[0] << ": " << msg << "\n";
+  } catch (...) {
+    std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
   }
-
-  // In addition to just parsing the input from GCC, we also want to spiff it up
-  // a little bit.  Do this now.
-  //
-  PassManager Passes;
-  Passes.add(new FunctionExtractorPass());
-  Passes.add(createGlobalDCEPass());              // Delete unreachable globals
-  Passes.add(createFunctionResolvingPass());      // Delete prototypes
-  Passes.add(createConstantMergePass());          // Merge dup global constants
-  Passes.add(createDeadTypeEliminationPass());    // Remove dead types...
-  Passes.add(new WriteBytecodePass(&std::cout));  // Write bytecode to file...
-
-  Passes.run(*M.get());
-  return 0;
+  return 1;
 }