aboutsummaryrefslogtreecommitdiff
path: root/docs/CommandGuide/extract.html
blob: 72112e8b2d1747e164cfa6a99ed0a4d87858175e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<html>
<title>
LLVM: extract tool
</title>

<body bgcolor=white>

<center>
<h1>LLVM: <tt>extract</tt> tool</h1>
</center>
<HR>

<h3>NAME</h3>
<tt>extract</tt>

<h3>
SYNOPSIS
</h3>

<tt>extract [options] [filename]</tt>
<h3>
DESCRIPTION
</h3>

The <tt>extract</tt> command takes the name of a function and extracts it from
the specified LLVM bytecode file.  It is primarily used as a debugging tool to
reduce test cases from larger programs that are triggering a bug.
<p>

In addition to extracting the bytecode of the specified function,
<tt>extract</tt> will also remove unreachable global variables, prototypes, and
unused types.
<p>

The <tt>extract</tt> command reads its input from standard input if filename is
omitted or if filename is -.  The output is always written to standard output.

<h3>OPTIONS</h3>

<ul>
<ul>
	<li> -f
	<br>
	Force overwrite.  Normally, <tt>extract</tt> will refuse to overwrite an
	output file that already exists.  With this option, <tt>extract</tt>
	will overwrite the output file and replace it with new bytecode.
	<p>

	<li>-func &lt;function&gt;
	<br>
	Extract the specified function from the LLVM bytecode.
	<p>

	<li> -help
	<br>
	Print a summary of command line options.
	<p>

	<li> -o &lt;filename&gt;
	<br>
	Specify the output filename.  If filename is "-" (the default), then
	<tt>extract</tt> sends its output to standard output.
	<p>

	<li> -stats
	<br>
	Print statistics.
	<p>

	<li> -time-passes
	<br>
	Record the amount of time needed for each pass and print it to standard
	error.
	<p>
</ul>

<h3>
EXIT STATUS
</h3>

If <tt>extract</tt> succeeds, it will exit with 0.  Otherwise, if an error
occurs, it will exit with a non-zero value.

<h3>
SEE ALSO
</h3>
<a href="bugpoint.html"><tt>bugpoint</tt></a>

<HR>
Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
</body>
</html>