blob: 608ae24560a4a47e6f6952fcab6f29b9a73506ca [file] [log] [blame]
Misha Brukmande03bc02005-04-24 17:36:05 +00001//===- llvm-extract.cpp - LLVM function extraction utility ----------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
John Criswell7c0e0222003-10-20 17:47:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner21c62da2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
John Criswell7c0e0222003-10-20 17:47:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner579d9142002-05-22 20:27:00 +00009//
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 Anderson8b477ed2009-07-01 16:58:40 +000015#include "llvm/LLVMContext.h"
Chris Lattner579d9142002-05-22 20:27:00 +000016#include "llvm/Module.h"
17#include "llvm/PassManager.h"
Chris Lattnerc48e1db2007-05-06 05:13:17 +000018#include "llvm/Bitcode/ReaderWriter.h"
Chris Lattner33974ca2002-07-23 22:04:40 +000019#include "llvm/Transforms/IPO.h"
Brian Gaeke20408902003-10-28 22:22:16 +000020#include "llvm/Target/TargetData.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000021#include "llvm/Support/CommandLine.h"
Chris Lattnerc30598b2006-12-06 01:18:01 +000022#include "llvm/Support/ManagedStatic.h"
Chris Lattnerc48e1db2007-05-06 05:13:17 +000023#include "llvm/Support/MemoryBuffer.h"
Chris Lattnercc14d252009-03-06 05:34:10 +000024#include "llvm/Support/PrettyStackTrace.h"
Dan Gohmana1bdced2009-07-15 17:29:42 +000025#include "llvm/Support/raw_ostream.h"
Chris Lattnerbed85ff2004-05-27 05:41:36 +000026#include "llvm/System/Signals.h"
Chris Lattner579d9142002-05-22 20:27:00 +000027#include <memory>
Brian Gaeked0fde302003-11-11 22:41:34 +000028using namespace llvm;
29
Chris Lattner5ff62e92002-07-22 02:10:13 +000030// InputFilename - The filename to read from.
Chris Lattnerc7a09852002-07-25 16:31:09 +000031static cl::opt<std::string>
Gabor Greifa99be512007-07-05 17:07:56 +000032InputFilename(cl::Positional, cl::desc("<input bitcode file>"),
Chris Lattner5ff62e92002-07-22 02:10:13 +000033 cl::init("-"), cl::value_desc("filename"));
Misha Brukman3da94ae2005-04-22 00:00:37 +000034
Chris Lattnerba9cc1f2004-02-18 16:53:59 +000035static cl::opt<std::string>
Misha Brukman3da94ae2005-04-22 00:00:37 +000036OutputFilename("o", cl::desc("Specify output filename"),
Chris Lattnerba9cc1f2004-02-18 16:53:59 +000037 cl::value_desc("filename"), cl::init("-"));
38
39static cl::opt<bool>
40Force("f", cl::desc("Overwrite output files"));
Chris Lattner5ff62e92002-07-22 02:10:13 +000041
Misha Brukmanca718e42004-04-22 23:07:39 +000042static cl::opt<bool>
Andrew Lenharthd245a8a2008-03-07 19:51:57 +000043DeleteFn("delete", cl::desc("Delete specified Globals from Module"));
Misha Brukmanca718e42004-04-22 23:07:39 +000044
Anton Korobeynikovb10308e2007-01-28 13:31:35 +000045static cl::opt<bool>
46Relink("relink",
47 cl::desc("Turn external linkage for callees of function to delete"));
48
Andrew Lenharthd245a8a2008-03-07 19:51:57 +000049// ExtractFunc - The function to extract from the module...
Chris Lattnerc7a09852002-07-25 16:31:09 +000050static cl::opt<std::string>
Andrew Lenharthd245a8a2008-03-07 19:51:57 +000051ExtractFunc("func", cl::desc("Specify function to extract"), cl::init(""),
Chris Lattner5ff62e92002-07-22 02:10:13 +000052 cl::value_desc("function"));
53
Andrew Lenharthd245a8a2008-03-07 19:51:57 +000054// ExtractGlobal - The global to extract from the module...
55static cl::opt<std::string>
56ExtractGlobal("glob", cl::desc("Specify global to extract"), cl::init(""),
57 cl::value_desc("global"));
58
Chris Lattner579d9142002-05-22 20:27:00 +000059int main(int argc, char **argv) {
Chris Lattnercc14d252009-03-06 05:34:10 +000060 // Print a stack trace if we signal out.
Chris Lattnerc48e1db2007-05-06 05:13:17 +000061 sys::PrintStackTraceOnErrorSignal();
Chris Lattnercc14d252009-03-06 05:34:10 +000062 PrettyStackTraceProgram X(argc, argv);
Owen Anderson8b477ed2009-07-01 16:58:40 +000063
Owen Anderson0d7c6952009-07-15 22:16:10 +000064 LLVMContext &Context = getGlobalContext();
Chris Lattnercc14d252009-03-06 05:34:10 +000065 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
66 cl::ParseCommandLineOptions(argc, argv, "llvm extractor\n");
Chris Lattner579d9142002-05-22 20:27:00 +000067
Chris Lattnerc48e1db2007-05-06 05:13:17 +000068 std::auto_ptr<Module> M;
69
Chris Lattner065344d2007-05-06 23:45:49 +000070 MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFilename);
Chris Lattner44dadff2007-05-06 09:29:57 +000071 if (Buffer == 0) {
Dan Gohmanac95cc72009-07-16 15:30:09 +000072 errs() << argv[0] << ": Error reading file '" + InputFilename + "'\n";
Chris Lattner44dadff2007-05-06 09:29:57 +000073 return 1;
Chris Lattnerc48e1db2007-05-06 05:13:17 +000074 } else {
Owen Anderson31895e72009-07-01 21:22:36 +000075 M.reset(ParseBitcodeFile(Buffer, Context));
Chris Lattnerba9cc1f2004-02-18 16:53:59 +000076 }
Chris Lattner44dadff2007-05-06 09:29:57 +000077 delete Buffer;
Chris Lattnerc48e1db2007-05-06 05:13:17 +000078
79 if (M.get() == 0) {
Dan Gohmanac95cc72009-07-16 15:30:09 +000080 errs() << argv[0] << ": bitcode didn't read correctly.\n";
Chris Lattnerc48e1db2007-05-06 05:13:17 +000081 return 1;
82 }
83
84 // Figure out which function we should extract
Dan Gohman51747a72009-04-20 16:19:02 +000085 GlobalVariable *G = !ExtractGlobal.empty() ?
Andrew Lenharthd245a8a2008-03-07 19:51:57 +000086 M.get()->getNamedGlobal(ExtractGlobal) : 0;
87
88 // Figure out which function we should extract
Dan Gohman51747a72009-04-20 16:19:02 +000089 if (ExtractFunc.empty() && ExtractGlobal.empty()) ExtractFunc = "main";
Andrew Lenharth6a021a42008-03-07 20:07:24 +000090 Function *F = M.get()->getFunction(ExtractFunc);
Andrew Lenharthd245a8a2008-03-07 19:51:57 +000091
92 if (F == 0 && G == 0) {
Dan Gohmanac95cc72009-07-16 15:30:09 +000093 errs() << argv[0] << ": program doesn't contain function named '"
94 << ExtractFunc << "' or a global named '" << ExtractGlobal << "'!\n";
Chris Lattnerc48e1db2007-05-06 05:13:17 +000095 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 Lenharthd245a8a2008-03-07 19:51:57 +0000103 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 Lattnerc48e1db2007-05-06 05:13:17 +0000108 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 Gohmana1bdced2009-07-15 17:29:42 +0000113 raw_ostream *Out = 0;
Chris Lattnerc48e1db2007-05-06 05:13:17 +0000114
115 if (OutputFilename != "-") { // Not stdout?
Dan Gohmana1bdced2009-07-15 17:29:42 +0000116 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 Lattnerc48e1db2007-05-06 05:13:17 +0000124 return 1;
125 }
Chris Lattnerc48e1db2007-05-06 05:13:17 +0000126 } else { // Specified stdout
Dan Gohmana1bdced2009-07-15 17:29:42 +0000127 // FIXME: errs() is not binary!
128 Out = &errs();
Chris Lattnerc48e1db2007-05-06 05:13:17 +0000129 }
130
Dan Gohmana1bdced2009-07-15 17:29:42 +0000131 Passes.add(createBitcodeWriterPass(*Out));
Chris Lattnerc48e1db2007-05-06 05:13:17 +0000132 Passes.run(*M.get());
133
Dan Gohmana1bdced2009-07-15 17:29:42 +0000134 if (Out != &errs())
Chris Lattnerc48e1db2007-05-06 05:13:17 +0000135 delete Out;
136 return 0;
Chris Lattner579d9142002-05-22 20:27:00 +0000137}