Misha Brukman | de03bc0 | 2005-04-24 17:36:05 +0000 | [diff] [blame] | 1 | //===- llvm-extract.cpp - LLVM function extraction utility ----------------===// |
Misha Brukman | 3da94ae | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | 7c0e022 | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 21c62da | 2007-12-29 20:44:31 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | 3da94ae | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | 7c0e022 | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 579d914 | 2002-05-22 20:27:00 +0000 | [diff] [blame] | 9 | // |
| 10 | // This utility changes the input module to only contain a single function, |
| 11 | // which is primarily used for debugging transformations. |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
Owen Anderson | 8b477ed | 2009-07-01 16:58:40 +0000 | [diff] [blame] | 15 | #include "llvm/LLVMContext.h" |
Chris Lattner | 579d914 | 2002-05-22 20:27:00 +0000 | [diff] [blame] | 16 | #include "llvm/Module.h" |
| 17 | #include "llvm/PassManager.h" |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 18 | #include "llvm/Bitcode/ReaderWriter.h" |
Chris Lattner | 33974ca | 2002-07-23 22:04:40 +0000 | [diff] [blame] | 19 | #include "llvm/Transforms/IPO.h" |
Brian Gaeke | 2040890 | 2003-10-28 22:22:16 +0000 | [diff] [blame] | 20 | #include "llvm/Target/TargetData.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 21 | #include "llvm/Support/CommandLine.h" |
Chris Lattner | c30598b | 2006-12-06 01:18:01 +0000 | [diff] [blame] | 22 | #include "llvm/Support/ManagedStatic.h" |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 23 | #include "llvm/Support/MemoryBuffer.h" |
Chris Lattner | cc14d25 | 2009-03-06 05:34:10 +0000 | [diff] [blame] | 24 | #include "llvm/Support/PrettyStackTrace.h" |
Dan Gohman | a1bdced | 2009-07-15 17:29:42 +0000 | [diff] [blame] | 25 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | bed85ff | 2004-05-27 05:41:36 +0000 | [diff] [blame] | 26 | #include "llvm/System/Signals.h" |
Chris Lattner | 579d914 | 2002-05-22 20:27:00 +0000 | [diff] [blame] | 27 | #include <memory> |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 28 | using namespace llvm; |
| 29 | |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 30 | // InputFilename - The filename to read from. |
Chris Lattner | c7a0985 | 2002-07-25 16:31:09 +0000 | [diff] [blame] | 31 | static cl::opt<std::string> |
Gabor Greif | a99be51 | 2007-07-05 17:07:56 +0000 | [diff] [blame] | 32 | InputFilename(cl::Positional, cl::desc("<input bitcode file>"), |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 33 | cl::init("-"), cl::value_desc("filename")); |
Misha Brukman | 3da94ae | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 34 | |
Chris Lattner | ba9cc1f | 2004-02-18 16:53:59 +0000 | [diff] [blame] | 35 | static cl::opt<std::string> |
Misha Brukman | 3da94ae | 2005-04-22 00:00:37 +0000 | [diff] [blame] | 36 | OutputFilename("o", cl::desc("Specify output filename"), |
Chris Lattner | ba9cc1f | 2004-02-18 16:53:59 +0000 | [diff] [blame] | 37 | cl::value_desc("filename"), cl::init("-")); |
| 38 | |
| 39 | static cl::opt<bool> |
| 40 | Force("f", cl::desc("Overwrite output files")); |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 41 | |
Misha Brukman | ca718e4 | 2004-04-22 23:07:39 +0000 | [diff] [blame] | 42 | static cl::opt<bool> |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 43 | DeleteFn("delete", cl::desc("Delete specified Globals from Module")); |
Misha Brukman | ca718e4 | 2004-04-22 23:07:39 +0000 | [diff] [blame] | 44 | |
Anton Korobeynikov | b10308e | 2007-01-28 13:31:35 +0000 | [diff] [blame] | 45 | static cl::opt<bool> |
| 46 | Relink("relink", |
| 47 | cl::desc("Turn external linkage for callees of function to delete")); |
| 48 | |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 49 | // ExtractFunc - The function to extract from the module... |
Chris Lattner | c7a0985 | 2002-07-25 16:31:09 +0000 | [diff] [blame] | 50 | static cl::opt<std::string> |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 51 | ExtractFunc("func", cl::desc("Specify function to extract"), cl::init(""), |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 52 | cl::value_desc("function")); |
| 53 | |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 54 | // ExtractGlobal - The global to extract from the module... |
| 55 | static cl::opt<std::string> |
| 56 | ExtractGlobal("glob", cl::desc("Specify global to extract"), cl::init(""), |
| 57 | cl::value_desc("global")); |
| 58 | |
Chris Lattner | 579d914 | 2002-05-22 20:27:00 +0000 | [diff] [blame] | 59 | int main(int argc, char **argv) { |
Chris Lattner | cc14d25 | 2009-03-06 05:34:10 +0000 | [diff] [blame] | 60 | // Print a stack trace if we signal out. |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 61 | sys::PrintStackTraceOnErrorSignal(); |
Chris Lattner | cc14d25 | 2009-03-06 05:34:10 +0000 | [diff] [blame] | 62 | PrettyStackTraceProgram X(argc, argv); |
Owen Anderson | 8b477ed | 2009-07-01 16:58:40 +0000 | [diff] [blame] | 63 | |
Owen Anderson | 0d7c695 | 2009-07-15 22:16:10 +0000 | [diff] [blame] | 64 | LLVMContext &Context = getGlobalContext(); |
Chris Lattner | cc14d25 | 2009-03-06 05:34:10 +0000 | [diff] [blame] | 65 | llvm_shutdown_obj Y; // Call llvm_shutdown() on exit. |
| 66 | cl::ParseCommandLineOptions(argc, argv, "llvm extractor\n"); |
Chris Lattner | 579d914 | 2002-05-22 20:27:00 +0000 | [diff] [blame] | 67 | |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 68 | std::auto_ptr<Module> M; |
| 69 | |
Chris Lattner | 065344d | 2007-05-06 23:45:49 +0000 | [diff] [blame] | 70 | MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFilename); |
Chris Lattner | 44dadff | 2007-05-06 09:29:57 +0000 | [diff] [blame] | 71 | if (Buffer == 0) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 72 | errs() << argv[0] << ": Error reading file '" + InputFilename + "'\n"; |
Chris Lattner | 44dadff | 2007-05-06 09:29:57 +0000 | [diff] [blame] | 73 | return 1; |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 74 | } else { |
Owen Anderson | 31895e7 | 2009-07-01 21:22:36 +0000 | [diff] [blame] | 75 | M.reset(ParseBitcodeFile(Buffer, Context)); |
Chris Lattner | ba9cc1f | 2004-02-18 16:53:59 +0000 | [diff] [blame] | 76 | } |
Chris Lattner | 44dadff | 2007-05-06 09:29:57 +0000 | [diff] [blame] | 77 | delete Buffer; |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 78 | |
| 79 | if (M.get() == 0) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 80 | errs() << argv[0] << ": bitcode didn't read correctly.\n"; |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 81 | return 1; |
| 82 | } |
| 83 | |
| 84 | // Figure out which function we should extract |
Dan Gohman | 51747a7 | 2009-04-20 16:19:02 +0000 | [diff] [blame] | 85 | GlobalVariable *G = !ExtractGlobal.empty() ? |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 86 | M.get()->getNamedGlobal(ExtractGlobal) : 0; |
| 87 | |
| 88 | // Figure out which function we should extract |
Dan Gohman | 51747a7 | 2009-04-20 16:19:02 +0000 | [diff] [blame] | 89 | if (ExtractFunc.empty() && ExtractGlobal.empty()) ExtractFunc = "main"; |
Andrew Lenharth | 6a021a4 | 2008-03-07 20:07:24 +0000 | [diff] [blame] | 90 | Function *F = M.get()->getFunction(ExtractFunc); |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 91 | |
| 92 | if (F == 0 && G == 0) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 93 | errs() << argv[0] << ": program doesn't contain function named '" |
| 94 | << ExtractFunc << "' or a global named '" << ExtractGlobal << "'!\n"; |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 95 | return 1; |
| 96 | } |
| 97 | |
| 98 | // In addition to deleting all other functions, we also want to spiff it |
| 99 | // up a little bit. Do this now. |
| 100 | PassManager Passes; |
| 101 | Passes.add(new TargetData(M.get())); // Use correct TargetData |
| 102 | // Either isolate the function or delete it from the Module |
Andrew Lenharth | d245a8a | 2008-03-07 19:51:57 +0000 | [diff] [blame] | 103 | std::vector<GlobalValue*> GVs; |
| 104 | if (F) GVs.push_back(F); |
| 105 | if (G) GVs.push_back(G); |
| 106 | |
| 107 | Passes.add(createGVExtractionPass(GVs, DeleteFn, Relink)); |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 108 | if (!DeleteFn) |
| 109 | Passes.add(createGlobalDCEPass()); // Delete unreachable globals |
| 110 | Passes.add(createDeadTypeEliminationPass()); // Remove dead types... |
| 111 | Passes.add(createStripDeadPrototypesPass()); // Remove dead func decls |
| 112 | |
Dan Gohman | a1bdced | 2009-07-15 17:29:42 +0000 | [diff] [blame] | 113 | raw_ostream *Out = 0; |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 114 | |
| 115 | if (OutputFilename != "-") { // Not stdout? |
Dan Gohman | a1bdced | 2009-07-15 17:29:42 +0000 | [diff] [blame] | 116 | std::string ErrorInfo; |
| 117 | Out = new raw_fd_ostream(OutputFilename.c_str(), /*Binary=*/true, |
| 118 | Force, ErrorInfo); |
| 119 | if (!ErrorInfo.empty()) { |
| 120 | errs() << ErrorInfo << '\n'; |
| 121 | if (!Force) |
| 122 | errs() << "Use -f command line argument to force output\n"; |
| 123 | delete Out; |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 124 | return 1; |
| 125 | } |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 126 | } else { // Specified stdout |
Dan Gohman | a1bdced | 2009-07-15 17:29:42 +0000 | [diff] [blame] | 127 | // FIXME: errs() is not binary! |
| 128 | Out = &errs(); |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 129 | } |
| 130 | |
Dan Gohman | a1bdced | 2009-07-15 17:29:42 +0000 | [diff] [blame] | 131 | Passes.add(createBitcodeWriterPass(*Out)); |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 132 | Passes.run(*M.get()); |
| 133 | |
Dan Gohman | a1bdced | 2009-07-15 17:29:42 +0000 | [diff] [blame] | 134 | if (Out != &errs()) |
Chris Lattner | c48e1db | 2007-05-06 05:13:17 +0000 | [diff] [blame] | 135 | delete Out; |
| 136 | return 0; |
Chris Lattner | 579d914 | 2002-05-22 20:27:00 +0000 | [diff] [blame] | 137 | } |