1 .\" Man page generated from reStructuredText.

     2 .

     3 .TH "LLVM-EXTRACT" "1" "2016-07-10" "3.8" "LLVM"

     4 .SH NAME

     5 llvm-extract \- extract a function from an LLVM module

     6 .

     7 .nr rst2man-indent-level 0

     8 .

     9 .de1 rstReportMargin

    10 \\$1 \\n[an-margin]

    11 level \\n[rst2man-indent-level]

    12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]

    13 -

    14 \\n[rst2man-indent0]

    15 \\n[rst2man-indent1]

    16 \\n[rst2man-indent2]

    17 ..

    18 .de1 INDENT

    19 .\" .rstReportMargin pre:

    20 . RS \\$1

    21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]

    22 . nr rst2man-indent-level +1

    23 .\" .rstReportMargin post:

    24 ..

    25 .de UNINDENT

    26 . RE

    27 .\" indent \\n[an-margin]

    28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]

    29 .nr rst2man-indent-level -1

    30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]

    31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u

    32 ..

    33 .SH SYNOPSIS

    34 .sp

    35 \fBllvm\-extract\fP [\fIoptions\fP] \fB\-\-func\fP \fIfunction\-name\fP [\fIfilename\fP]

    36 .SH DESCRIPTION

    37 .sp

    38 The \fBllvm\-extract\fP command takes the name of a function and extracts

    39 it from the specified LLVM bitcode file.  It is primarily used as a debugging

    40 tool to reduce test cases from larger programs that are triggering a bug.

    41 .sp

    42 In addition to extracting the bitcode of the specified function,

    43 \fBllvm\-extract\fP will also remove unreachable global variables,

    44 prototypes, and unused types.

    45 .sp

    46 The \fBllvm\-extract\fP command reads its input from standard input if

    47 filename is omitted or if filename is \fB\-\fP\&.  The output is always written to

    48 standard output, unless the \fB\-o\fP option is specified (see below).

    49 .SH OPTIONS

    50 .sp

    51 \fB\-f\fP

    52 .INDENT 0.0

    53 .INDENT 3.5

    54 Enable binary output on terminals.  Normally, \fBllvm\-extract\fP will

    55 refuse to write raw bitcode output if the output stream is a terminal.  With

    56 this option, \fBllvm\-extract\fP will write raw bitcode regardless of the

    57 output device.

    58 .UNINDENT

    59 .UNINDENT

    60 .sp

    61 \fB\-\-func\fP \fIfunction\-name\fP

    62 .INDENT 0.0

    63 .INDENT 3.5

    64 Extract the function named \fIfunction\-name\fP from the LLVM bitcode.  May be

    65 specified multiple times to extract multiple functions at once.

    66 .UNINDENT

    67 .UNINDENT

    68 .sp

    69 \fB\-\-rfunc\fP \fIfunction\-regular\-expr\fP

    70 .INDENT 0.0

    71 .INDENT 3.5

    72 Extract the function(s) matching \fIfunction\-regular\-expr\fP from the LLVM bitcode.

    73 All functions matching the regular expression will be extracted.  May be

    74 specified multiple times.

    75 .UNINDENT

    76 .UNINDENT

    77 .sp

    78 \fB\-\-glob\fP \fIglobal\-name\fP

    79 .INDENT 0.0

    80 .INDENT 3.5

    81 Extract the global variable named \fIglobal\-name\fP from the LLVM bitcode.  May be

    82 specified multiple times to extract multiple global variables at once.

    83 .UNINDENT

    84 .UNINDENT

    85 .sp

    86 \fB\-\-rglob\fP \fIglob\-regular\-expr\fP

    87 .INDENT 0.0

    88 .INDENT 3.5

    89 Extract the global variable(s) matching \fIglobal\-regular\-expr\fP from the LLVM

    90 bitcode.  All global variables matching the regular expression will be

    91 extracted.  May be specified multiple times.

    92 .UNINDENT

    93 .UNINDENT

    94 .sp

    95 \fB\-help\fP

    96 .INDENT 0.0

    97 .INDENT 3.5

    98 Print a summary of command line options.

    99 .UNINDENT

   100 .UNINDENT

   101 .sp

   102 \fB\-o\fP \fIfilename\fP

   103 .INDENT 0.0

   104 .INDENT 3.5

   105 Specify the output filename.  If filename is "\-" (the default), then

   106 \fBllvm\-extract\fP sends its output to standard output.

   107 .UNINDENT

   108 .UNINDENT

   109 .sp

   110 \fB\-S\fP

   111 .INDENT 0.0

   112 .INDENT 3.5

   113 Write output in LLVM intermediate language (instead of bitcode).

   114 .UNINDENT

   115 .UNINDENT

   116 .SH EXIT STATUS

   117 .sp

   118 If \fBllvm\-extract\fP succeeds, it will exit with 0.  Otherwise, if an error

   119 occurs, it will exit with a non\-zero value.

   120 .SH SEE ALSO

   121 .sp

   122 bugpoint

   123 .SH AUTHOR

   124 Maintained by The LLVM Team (http://llvm.org/).

   125 .SH COPYRIGHT

   126 2003-2016, LLVM Project

   127 .\" Generated by docutils manpage writer.

   128 .