1 //===-- llvm-dis.cpp - The low-level LLVM disassembler --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This utility may be invoked in the following manner:
11 // llvm-dis [options] - Read LLVM bitcode from stdin, write asm to stdout
12 // llvm-dis [options] x.bc - Read LLVM bitcode from the x.bc file, write asm
15 // --help - Output information about command line switches
17 //===----------------------------------------------------------------------===//
19 #include "llvm/IR/LLVMContext.h"
20 #include "llvm/Bitcode/ReaderWriter.h"
21 #include "llvm/IR/AssemblyAnnotationWriter.h"
22 #include "llvm/IR/DebugInfo.h"
23 #include "llvm/IR/DiagnosticInfo.h"
24 #include "llvm/IR/DiagnosticPrinter.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/IR/Module.h"
27 #include "llvm/IR/Type.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/DataStream.h"
30 #include "llvm/Support/FileSystem.h"
31 #include "llvm/Support/FormattedStream.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/MemoryBuffer.h"
34 #include "llvm/Support/PrettyStackTrace.h"
35 #include "llvm/Support/Signals.h"
36 #include "llvm/Support/ToolOutputFile.h"
37 #include <system_error>
40 static cl::opt
<std::string
>
41 InputFilename(cl::Positional
, cl::desc("<input bitcode>"), cl::init("-"));
43 static cl::opt
<std::string
>
44 OutputFilename("o", cl::desc("Override output filename"),
45 cl::value_desc("filename"));
48 Force("f", cl::desc("Enable binary output on terminals"));
51 DontPrint("disable-output", cl::desc("Don't output the .ll file"), cl::Hidden
);
54 ShowAnnotations("show-annotations",
55 cl::desc("Add informational comments to the .ll file"));
59 static void printDebugLoc(const DebugLoc
&DL
, formatted_raw_ostream
&OS
) {
60 OS
<< DL
.getLine() << ":" << DL
.getCol();
61 if (MDNode
*N
= DL
.getInlinedAt(getGlobalContext())) {
62 DebugLoc IDL
= DebugLoc::getFromDILocation(N
);
63 if (!IDL
.isUnknown()) {
65 printDebugLoc(IDL
,OS
);
69 class CommentWriter
: public AssemblyAnnotationWriter
{
71 void emitFunctionAnnot(const Function
*F
,
72 formatted_raw_ostream
&OS
) override
{
73 OS
<< "; [#uses=" << F
->getNumUses() << ']'; // Output # uses
76 void printInfoComment(const Value
&V
, formatted_raw_ostream
&OS
) override
{
78 if (!V
.getType()->isVoidTy()) {
81 OS
<< "; [#uses=" << V
.getNumUses() << " type=" << *V
.getType() << "]"; // Output # uses and type
83 if (const Instruction
*I
= dyn_cast
<Instruction
>(&V
)) {
84 const DebugLoc
&DL
= I
->getDebugLoc();
85 if (!DL
.isUnknown()) {
91 OS
<< " [debug line = ";
95 if (const DbgDeclareInst
*DDI
= dyn_cast
<DbgDeclareInst
>(I
)) {
96 DIVariable
Var(DDI
->getVariable());
101 OS
<< " [debug variable = " << Var
.getName() << "]";
103 else if (const DbgValueInst
*DVI
= dyn_cast
<DbgValueInst
>(I
)) {
104 DIVariable
Var(DVI
->getVariable());
109 OS
<< " [debug variable = " << Var
.getName() << "]";
115 } // end anon namespace
117 static void diagnosticHandler(const DiagnosticInfo
&DI
, void *Context
) {
118 assert(DI
.getSeverity() == DS_Error
&& "Only expecting errors");
120 raw_ostream
&OS
= errs();
121 OS
<< (char *)Context
<< ": ";
122 DiagnosticPrinterRawOStream
DP(OS
);
128 int main(int argc
, char **argv
) {
129 // Print a stack trace if we signal out.
130 sys::PrintStackTraceOnErrorSignal();
131 PrettyStackTraceProgram
X(argc
, argv
);
133 LLVMContext
&Context
= getGlobalContext();
134 llvm_shutdown_obj Y
; // Call llvm_shutdown() on exit.
136 Context
.setDiagnosticHandler(diagnosticHandler
, argv
[0]);
138 cl::ParseCommandLineOptions(argc
, argv
, "llvm .bc -> .ll disassembler\n");
140 std::string ErrorMessage
;
141 std::unique_ptr
<Module
> M
;
143 // Use the bitcode streaming interface
144 DataStreamer
*Streamer
= getDataFileStreamer(InputFilename
, &ErrorMessage
);
146 std::string DisplayFilename
;
147 if (InputFilename
== "-")
148 DisplayFilename
= "<stdin>";
150 DisplayFilename
= InputFilename
;
151 ErrorOr
<std::unique_ptr
<Module
>> MOrErr
=
152 getStreamedBitcodeModule(DisplayFilename
, Streamer
, Context
);
153 M
= std::move(*MOrErr
);
154 M
->materializeAllPermanently();
157 // Just use stdout. We won't actually print anything on it.
159 OutputFilename
= "-";
161 if (OutputFilename
.empty()) { // Unspecified output, infer it.
162 if (InputFilename
== "-") {
163 OutputFilename
= "-";
165 const std::string
&IFN
= InputFilename
;
166 int Len
= IFN
.length();
167 // If the source ends in .bc, strip it off.
168 if (IFN
[Len
-3] == '.' && IFN
[Len
-2] == 'b' && IFN
[Len
-1] == 'c')
169 OutputFilename
= std::string(IFN
.begin(), IFN
.end()-3)+".ll";
171 OutputFilename
= IFN
+".ll";
176 std::unique_ptr
<tool_output_file
> Out(
177 new tool_output_file(OutputFilename
, EC
, sys::fs::F_None
));
179 errs() << EC
.message() << '\n';
183 std::unique_ptr
<AssemblyAnnotationWriter
> Annotator
;
185 Annotator
.reset(new CommentWriter());
187 // All that llvm-dis does is write the assembly to a file.
189 M
->print(Out
->os(), Annotator
.get());