Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / e4cea8cd3407b93b4ff80ad2db97f16743809008 / . / llvm / docs / CommandGuide / llvm-dis.html
blob: 7211206d300ff5aa744213c16a45a8fb46b020b5 [file] [log] [blame]
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]1<html>
2<title>
Chris Lattner29793072003-09-25 19:50:05 +0000[diff] [blame]3LLVM: llvm-dis tool
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]4</title>
5
Chris Lattner7c2b1262003-10-07 20:12:05 +0000[diff] [blame]6<body bgcolor=white>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]7
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]8<center><h1>LLVM: <tt>llvm-dis</tt> tool</h1></center>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]9<HR>
10
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]11<h3>NAME</h3>
12<tt>llvm-dis</tt>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]13
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]14<h3>SYNOPSIS</h3>
15<tt>llvm-dis [options] [filename]</tt>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]16
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]17<h3>DESCRIPTION</h3>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]18
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]19The <tt>llvm-dis</tt> command is the LLVM disassembler. It takes an LLVM
20bytecode file and converts it into LLVM assembly language or C source code with
21equivalent functionality.
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]22<p>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]23
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]24If filename is omitted, <tt>llvm-dis</tt> reads its input from standard input.
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]25<p>
26
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]27The default output file for <tt>llvm-dis</tt> is determined by the following logic:
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]28<ul>
29 <li>
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]30 If the input is standard input or the file -, then the output is
31 standard output.
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]32 <p>
33
34 <li>
35 If the input filename ends in .bc, then the output filename will be
36 identical, except that the .bc suffix will be replaced by the .ll or .c
37 suffix (for LLVM assembly language and C code, respectively).
38 <p>
39
40 <li>
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]41 If the input filename does not end in .bc, then the output filename will
42 be identical to the input filename, except that the .ll or .c suffix
43 will be appended to the filename (for LLVM assembly language and C code,
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]44 respectively).
45</ul>
46
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]47<h3>OPTIONS</h3>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]48
49<ul>
50 <li> -llvm
51 <br>
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]52 Instruct <tt>llvm-dis</tt> to generate LLVM assembly code in human
53 readable format. This is the default behavior.
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]54 <p>
55
56 <li> -c
57 <br>
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]58 Instruct <tt>llvm-dis</tt> to generate C source code.
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]59 <p>
60
61 <li> -f
62 <br>
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]63 Force overwrite. Normally, <tt>llvm-dis</tt> will refuse to overwrite
64 an output file that already exists. With this option, <tt>llvm-dis</tt>
65 will overwrite the output file.
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]66 <p>
67
68 <li> -help
69 <br>
70 Print a summary of command line options.
71 <p>
72
73 <li> -o &lt;filename&gt;
74 <br>
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]75 Specify the output filename. If filename is -, then the output is sent
76 to standard output.
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]77 <p>
78
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]79 <li> -time-passes
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]80 <br>
John Criswell93359ac2003-09-26 02:59:00 +0000[diff] [blame]81 Record the amount of time needed for each pass and print it to standard
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]82 error.
83 <p>
84</ul>
85
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]86<h3>EXIT STATUS</h3>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]87
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]88If <tt>llvm-dis</tt> succeeds, it will exit with 0. Otherwise, if an error
89occurs, it will exit with a non-zero value.
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]90
Chris Lattner75b1d852003-10-07 20:17:24 +0000[diff] [blame]91<h3>SEE ALSO</h3>
92
93<a href="llvm-as.html"><tt>llvm-as</tt></a>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]94
95<HR>
Chris Lattner7c2b1262003-10-07 20:12:05 +0000[diff] [blame]96Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]97</body>
98</html>
99