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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>llvm-extract - extract a function from an LLVM module — LLVM 13 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="llvm-bcanalyzer - LLVM bitcode analyzer" href="llvm-bcanalyzer.html" />
<link rel="prev" title="bugpoint - automatic test case reduction tool" href="bugpoint.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="../index.html">
<img src="../_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="llvm-bcanalyzer.html" title="llvm-bcanalyzer - LLVM bitcode analyzer"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="bugpoint.html" title="bugpoint - automatic test case reduction tool"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="../index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">LLVM Command Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">llvm-extract - extract a function from an LLVM module</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/CommandGuide/llvm-extract.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="llvm-extract-extract-a-function-from-an-llvm-module">
<h1>llvm-extract - extract a function from an LLVM module<a class="headerlink" href="#llvm-extract-extract-a-function-from-an-llvm-module" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-extract</strong> [<em>options</em>] <strong>–func</strong> <em>function-name</em> [<em>filename</em>]</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The <strong class="program">llvm-extract</strong> command takes the name of a function and extracts
it from the specified LLVM bitcode file. It is primarily used as a debugging
tool to reduce test cases from larger programs that are triggering a bug.</p>
<p>In addition to extracting the bitcode of the specified function,
<strong class="program">llvm-extract</strong> will also remove unreachable global variables,
prototypes, and unused types.</p>
<p>The <strong class="program">llvm-extract</strong> command reads its input from standard input if
filename is omitted or if filename is <code class="docutils literal notranslate"><span class="pre">-</span></code>. The output is always written to
standard output, unless the <strong>-o</strong> option is specified (see below).</p>
</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p><strong>–alias</strong> <em>alias-name</em></p>
<blockquote>
<div><p>Extract the alias named <em>function-name</em> from the LLVM bitcode. May be
specified multiple times to extract multiple alias at once.</p>
</div></blockquote>
<p><strong>–ralias</strong> <em>alias-regular-expr</em></p>
<blockquote>
<div><p>Extract the alias matching <em>alias-regular-expr</em> from the LLVM bitcode.
All alias matching the regular expression will be extracted. May be
specified multiple times.</p>
</div></blockquote>
<p><strong>–bb</strong> <em>basic-block-specifier</em></p>
<blockquote>
<div><p>Extract basic blocks(s) specified in <em>basic-block-specifier</em>. May be
specified multiple times. Each <function:bb[;bb]> specifier pair will create
a function. If multiple basic blocks are specified in one pair, the first
block in the sequence should dominate the rest.</p>
</div></blockquote>
<p><strong>–delete</strong></p>
<blockquote>
<div><p>Delete specified Globals from Module.</p>
</div></blockquote>
<p><strong>-f</strong></p>
<blockquote>
<div><p>Enable binary output on terminals. Normally, <strong class="program">llvm-extract</strong> will
refuse to write raw bitcode output if the output stream is a terminal. With
this option, <strong class="program">llvm-extract</strong> will write raw bitcode regardless of the
output device.</p>
</div></blockquote>
<p><strong>–func</strong> <em>function-name</em></p>
<blockquote>
<div><p>Extract the function named <em>function-name</em> from the LLVM bitcode. May be
specified multiple times to extract multiple functions at once.</p>
</div></blockquote>
<p><strong>–rfunc</strong> <em>function-regular-expr</em></p>
<blockquote>
<div><p>Extract the function(s) matching <em>function-regular-expr</em> from the LLVM bitcode.
All functions matching the regular expression will be extracted. May be
specified multiple times.</p>
</div></blockquote>
<p><strong>–glob</strong> <em>global-name</em></p>
<blockquote>
<div><p>Extract the global variable named <em>global-name</em> from the LLVM bitcode. May be
specified multiple times to extract multiple global variables at once.</p>
</div></blockquote>
<p><strong>–rglob</strong> <em>glob-regular-expr</em></p>
<blockquote>
<div><p>Extract the global variable(s) matching <em>global-regular-expr</em> from the LLVM
bitcode. All global variables matching the regular expression will be
extracted. May be specified multiple times.</p>
</div></blockquote>
<p><strong>–keep-const-init</strong></p>
<blockquote>
<div><p>Preserve the values of constant globals.</p>
</div></blockquote>
<p><strong>–recursive</strong></p>
<blockquote>
<div><p>Recursively extract all called functions</p>
</div></blockquote>
<p><strong>-help</strong></p>
<blockquote>
<div><p>Print a summary of command line options.</p>
</div></blockquote>
<p><strong>-o</strong> <em>filename</em></p>
<blockquote>
<div><p>Specify the output filename. If filename is “-” (the default), then
<strong class="program">llvm-extract</strong> sends its output to standard output.</p>
</div></blockquote>
<p><strong>-S</strong></p>
<blockquote>
<div><p>Write output in LLVM intermediate language (instead of bitcode).</p>
</div></blockquote>
</div>
<div class="section" id="exit-status">
<h2>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h2>
<p>If <strong class="program">llvm-extract</strong> succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non-zero value.</p>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p><em class="manpage"><a class="manpage reference external" href="https://llvm.org/docs/CommandGuide/bugpoint.html">bugpoint(1)</a></em></p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="llvm-bcanalyzer.html" title="llvm-bcanalyzer - LLVM bitcode analyzer"
>next</a> |</li>
<li class="right" >
<a href="bugpoint.html" title="bugpoint - automatic test case reduction tool"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="../index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >LLVM Command Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">llvm-extract - extract a function from an LLVM module</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
