+//===- llvm-extract.cpp - LLVM function extraction utility ----------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file 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/LLVMContext.h"
#include "llvm/Module.h"
#include "llvm/PassManager.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Bytecode/WriteBytecodePass.h"
+#include "llvm/Assembly/PrintModulePass.h"
+#include "llvm/Bitcode/ReaderWriter.h"
#include "llvm/Transforms/IPO.h"
-#include "Support/CommandLine.h"
+#include "llvm/Target/TargetData.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/IRReader.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/PrettyStackTrace.h"
+#include "llvm/Support/raw_ostream.h"
+#include "llvm/Support/SystemUtils.h"
+#include "llvm/System/Signals.h"
#include <memory>
+using namespace llvm;
// InputFilename - The filename to read from.
static cl::opt<std::string>
-InputFilename(cl::Positional, cl::desc("<input bytecode file>"),
+InputFilename(cl::Positional, cl::desc("<input bitcode 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"));
-
-
-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;
-
- // 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;
-
- // Make sure it's globally accessable...
- Named->setInternalLinkage(false);
- }
-
- if (Named == 0) {
- std::cerr << "Warning: Function '" << ExtractFunc << "' not found!\n";
- return false;
- }
-
- // 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
- }
+OutputFilename("o", cl::desc("Specify output filename"),
+ cl::value_desc("filename"), cl::init("-"));
- // 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]);
- }
-
- return true;
- }
-};
+static cl::opt<bool>
+Force("f", cl::desc("Enable binary output on terminals"));
+
+static cl::opt<bool>
+DeleteFn("delete", cl::desc("Delete specified Globals from Module"));
+
+static cl::opt<bool>
+Relink("relink",
+ cl::desc("Turn external linkage for callees of function to delete"));
+// ExtractFuncs - The functions to extract from the module...
+static cl::list<std::string>
+ExtractFuncs("func", cl::desc("Specify function to extract"),
+ cl::ZeroOrMore, cl::value_desc("function"));
-static RegisterPass<FunctionExtractorPass> X("extract", "Function Extractor");
+// ExtractGlobals - The globals to extract from the module...
+static cl::list<std::string>
+ExtractGlobals("glob", cl::desc("Specify global to extract"),
+ cl::ZeroOrMore, cl::value_desc("global"));
+static cl::opt<bool>
+OutputAssembly("S",
+ cl::desc("Write output as LLVM assembly"), cl::Hidden);
int main(int argc, char **argv) {
- cl::ParseCommandLineOptions(argc, argv, " llvm extractor\n");
+ // Print a stack trace if we signal out.
+ sys::PrintStackTraceOnErrorSignal();
+ PrettyStackTraceProgram X(argc, argv);
+
+ LLVMContext &Context = getGlobalContext();
+ llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
+ cl::ParseCommandLineOptions(argc, argv, "llvm extractor\n");
+
+ SMDiagnostic Err;
+ std::auto_ptr<Module> M;
+ M.reset(ParseIRFile(InputFilename, Err, Context));
- std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
if (M.get() == 0) {
- std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
+ Err.Print(argv[0], errs());
return 1;
}
- // In addition to just parsing the input from GCC, we also want to spiff it up
- // a little bit. Do this now.
- //
+ std::vector<GlobalValue *> GVs;
+
+ // Figure out which globals we should extract.
+ for (size_t i = 0, e = ExtractGlobals.size(); i != e; ++i) {
+ GlobalValue *GV = M.get()->getNamedGlobal(ExtractGlobals[i]);
+ if (!GV) {
+ errs() << argv[0] << ": program doesn't contain global named '"
+ << ExtractGlobals[i] << "'!\n";
+ return 1;
+ }
+ GVs.push_back(GV);
+ }
+
+ // Figure out which functions we should extract.
+ for (size_t i = 0, e = ExtractFuncs.size(); i != e; ++i) {
+ GlobalValue *GV = M.get()->getFunction(ExtractFuncs[i]);
+ if (!GV) {
+ errs() << argv[0] << ": program doesn't contain function named '"
+ << ExtractFuncs[i] << "'!\n";
+ return 1;
+ }
+ GVs.push_back(GV);
+ }
+
+ // 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 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.add(new TargetData(M.get())); // Use correct TargetData
+
+ Passes.add(createGVExtractionPass(GVs, DeleteFn, Relink));
+ if (!DeleteFn)
+ Passes.add(createGlobalDCEPass()); // Delete unreachable globals
+ Passes.add(createDeadTypeEliminationPass()); // Remove dead types...
+ Passes.add(createStripDeadPrototypesPass()); // Remove dead func decls
+
+ // Make sure that the Output file gets unlinked from the disk if we get a
+ // SIGINT
+ sys::RemoveFileOnSignal(sys::Path(OutputFilename));
+
+ std::string ErrorInfo;
+ raw_fd_ostream Out(OutputFilename.c_str(), ErrorInfo,
+ raw_fd_ostream::F_Binary);
+ if (!ErrorInfo.empty()) {
+ errs() << ErrorInfo << '\n';
+ return 1;
+ }
+
+ if (OutputAssembly)
+ Passes.add(createPrintModulePass(&Out));
+ else if (Force || !CheckBitcodeOutputToConsole(Out, true))
+ Passes.add(createBitcodeWriterPass(Out));
Passes.run(*M.get());
+
return 0;
}