+//===-- llvm-dis.cpp - The low-level LLVM disassembler --------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
//===----------------------------------------------------------------------===//
-// LLVM 'DIS' UTILITY
//
// This utility may be invoked in the following manner:
-// dis [options] - Read LLVM bytecode from stdin, write assembly to stdout
-// dis [options] x.bc - Read LLVM bytecode from the x.bc file, write assembly
-// to the x.ll file.
+// llvm-dis [options] - Read LLVM bitcode from stdin, write asm to stdout
+// llvm-dis [options] x.bc - Read LLVM bitcode from the x.bc file, write asm
+// to the x.ll file.
// Options:
// --help - Output information about command line switches
-// -dfo - Print basic blocks in depth first order
-// -rdfo - Print basic blocks in reverse depth first order
-// -po - Print basic blocks in post order
-// -rpo - Print basic blocks in reverse post order
-//
-// -c - Print C code
-//
-// TODO: add -vcg which prints VCG compatible output.
//
//===----------------------------------------------------------------------===//
-#include "llvm/Module.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Support/CFG.h"
-#include "Support/DepthFirstIterator.h"
-#include "Support/PostOrderIterator.h"
-#include "Support/CommandLine.h"
-#include "Support/Signals.h"
-#include "llvm/Assembly/CWriter.h"
-#include <fstream>
-#include <iostream>
-using std::cerr;
-
-// OutputMode - The different orderings to print basic blocks in...
-enum OutputMode {
- Default = 0, // Function Order (list order)
- dfo, // Depth First ordering
- rdfo, // Reverse Depth First ordering
- po, // Post Order
- rpo, // Reverse Post Order
-
- c, // Generate C code
+#include "llvm/IR/LLVMContext.h"
+#include "llvm/Bitcode/ReaderWriter.h"
+#include "llvm/IR/AssemblyAnnotationWriter.h"
+#include "llvm/IR/DebugInfo.h"
+#include "llvm/IR/DiagnosticInfo.h"
+#include "llvm/IR/DiagnosticPrinter.h"
+#include "llvm/IR/IntrinsicInst.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IR/Type.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/DataStream.h"
+#include "llvm/Support/FileSystem.h"
+#include "llvm/Support/FormattedStream.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/PrettyStackTrace.h"
+#include "llvm/Support/Signals.h"
+#include "llvm/Support/ToolOutputFile.h"
+#include <system_error>
+using namespace llvm;
+
+static cl::opt<std::string>
+InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
+
+static cl::opt<std::string>
+OutputFilename("o", cl::desc("Override output filename"),
+ cl::value_desc("filename"));
+
+static cl::opt<bool>
+Force("f", cl::desc("Enable binary output on terminals"));
+
+static cl::opt<bool>
+DontPrint("disable-output", cl::desc("Don't output the .ll file"), cl::Hidden);
+
+static cl::opt<bool>
+ShowAnnotations("show-annotations",
+ cl::desc("Add informational comments to the .ll file"));
+
+namespace {
+
+static void printDebugLoc(const DebugLoc &DL, formatted_raw_ostream &OS) {
+ OS << DL.getLine() << ":" << DL.getCol();
+ if (MDNode *N = DL.getInlinedAt(getGlobalContext())) {
+ DebugLoc IDL = DebugLoc::getFromDILocation(N);
+ if (!IDL.isUnknown()) {
+ OS << "@";
+ printDebugLoc(IDL,OS);
+ }
+ }
+}
+class CommentWriter : public AssemblyAnnotationWriter {
+public:
+ void emitFunctionAnnot(const Function *F,
+ formatted_raw_ostream &OS) override {
+ OS << "; [#uses=" << F->getNumUses() << ']'; // Output # uses
+ OS << '\n';
+ }
+ void printInfoComment(const Value &V, formatted_raw_ostream &OS) override {
+ bool Padded = false;
+ if (!V.getType()->isVoidTy()) {
+ OS.PadToColumn(50);
+ Padded = true;
+ OS << "; [#uses=" << V.getNumUses() << " type=" << *V.getType() << "]"; // Output # uses and type
+ }
+ if (const Instruction *I = dyn_cast<Instruction>(&V)) {
+ const DebugLoc &DL = I->getDebugLoc();
+ if (!DL.isUnknown()) {
+ if (!Padded) {
+ OS.PadToColumn(50);
+ Padded = true;
+ OS << ";";
+ }
+ OS << " [debug line = ";
+ printDebugLoc(DL,OS);
+ OS << "]";
+ }
+ if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(I)) {
+ DIVariable Var(DDI->getVariable());
+ if (!Padded) {
+ OS.PadToColumn(50);
+ OS << ";";
+ }
+ OS << " [debug variable = " << Var.getName() << "]";
+ }
+ else if (const DbgValueInst *DVI = dyn_cast<DbgValueInst>(I)) {
+ DIVariable Var(DVI->getVariable());
+ if (!Padded) {
+ OS.PadToColumn(50);
+ OS << ";";
+ }
+ OS << " [debug variable = " << Var.getName() << "]";
+ }
+ }
+ }
};
-cl::String InputFilename ("", "Load <arg> file, print as assembly", 0, "-");
-cl::String OutputFilename("o", "Override output filename", cl::NoFlags, "");
-cl::Flag Force ("f", "Overwrite output files", cl::NoFlags, false);
-cl::EnumFlags<enum OutputMode> WriteMode(cl::NoFlags,
- clEnumVal(Default, "Write basic blocks in bytecode order"),
- clEnumVal(dfo , "Write basic blocks in depth first order"),
- clEnumVal(rdfo , "Write basic blocks in reverse DFO"),
- clEnumVal(po , "Write basic blocks in postorder"),
- clEnumVal(rpo , "Write basic blocks in reverse postorder"),
+} // end anon namespace
- clEnumVal(c , "Write corresponding C code"),
- 0);
+static void diagnosticHandler(const DiagnosticInfo &DI, void *Context) {
+ assert(DI.getSeverity() == DS_Error && "Only expecting errors");
+
+ raw_ostream &OS = errs();
+ OS << (char *)Context << ": ";
+ DiagnosticPrinterRawOStream DP(OS);
+ DI.print(DP);
+ OS << '\n';
+ exit(1);
+}
int main(int argc, char **argv) {
- cl::ParseCommandLineOptions(argc, argv, " llvm .bc -> .ll disassembler\n");
- std::ostream *Out = &std::cout; // Default to printing to stdout...
+ // Print a stack trace if we signal out.
+ sys::PrintStackTraceOnErrorSignal();
+ PrettyStackTraceProgram X(argc, argv);
- Module *M = ParseBytecodeFile(InputFilename);
- if (M == 0) {
- cerr << "bytecode didn't read correctly.\n";
- return 1;
+ LLVMContext &Context = getGlobalContext();
+ llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
+
+ Context.setDiagnosticHandler(diagnosticHandler, argv[0]);
+
+ cl::ParseCommandLineOptions(argc, argv, "llvm .bc -> .ll disassembler\n");
+
+ std::string ErrorMessage;
+ std::unique_ptr<Module> M;
+
+ // Use the bitcode streaming interface
+ DataStreamer *Streamer = getDataFileStreamer(InputFilename, &ErrorMessage);
+ if (Streamer) {
+ std::string DisplayFilename;
+ if (InputFilename == "-")
+ DisplayFilename = "<stdin>";
+ else
+ DisplayFilename = InputFilename;
+ ErrorOr<std::unique_ptr<Module>> MOrErr =
+ getStreamedBitcodeModule(DisplayFilename, Streamer, Context);
+ M = std::move(*MOrErr);
+ M->materializeAllPermanently();
}
-
- if (OutputFilename != "") { // Specified an output filename?
- if (!Force && std::ifstream(OutputFilename.c_str())) {
- // If force is not specified, make sure not to overwrite a file!
- cerr << "Error opening '" << OutputFilename
- << "': File exists! Sending to standard output.\n";
- } else {
- Out = new std::ofstream(OutputFilename.c_str());
- }
- } else {
+
+ // Just use stdout. We won't actually print anything on it.
+ if (DontPrint)
+ OutputFilename = "-";
+
+ if (OutputFilename.empty()) { // Unspecified output, infer it.
if (InputFilename == "-") {
OutputFilename = "-";
} else {
- std::string IFN = InputFilename;
+ const std::string &IFN = InputFilename;
int Len = IFN.length();
- if (IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
- // Source ends in .bc
- OutputFilename = std::string(IFN.begin(), IFN.end()-3);
- } else {
- OutputFilename = IFN; // Append a .ll to it
- }
- if (WriteMode == c)
- OutputFilename += ".c";
+ // If the source ends in .bc, strip it off.
+ if (IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c')
+ OutputFilename = std::string(IFN.begin(), IFN.end()-3)+".ll";
else
- OutputFilename += ".ll";
-
- if (!Force && std::ifstream(OutputFilename.c_str())) {
- // If force is not specified, make sure not to overwrite a file!
- cerr << "Error opening '" << OutputFilename
- << "': File exists! Sending to standard output.\n";
- } else {
- Out = new std::ofstream(OutputFilename.c_str());
-
- // Make sure that the Out file gets unlink'd from the disk if we get a
- // SIGINT
- RemoveFileOnSignal(OutputFilename);
- }
+ OutputFilename = IFN+".ll";
}
}
- if (!Out->good()) {
- cerr << "Error opening " << OutputFilename
- << ": sending to stdout instead!\n";
- Out = &std::cout;
+ std::error_code EC;
+ std::unique_ptr<tool_output_file> Out(
+ new tool_output_file(OutputFilename, EC, sys::fs::F_None));
+ if (EC) {
+ errs() << EC.message() << '\n';
+ return 1;
}
- // All that dis does is write the assembly or C out to a file... which is
- // exactly what the writer or cwriter library is supposed to do...
- if (WriteMode == Default) {
- (*Out) << M; // Print out in list order
- } else if (WriteMode == c) {
- WriteToC(M, *Out);
- } else {
- // TODO: This does not print anything other than the basic blocks in the
- // functions... more should definately be printed. It should be valid
- // output consumable by the assembler.
- //
- for (Module::iterator I = M->begin(), End = M->end(); I != End; ++I) {
- Function *F = *I;
- (*Out) << "-------------- Method: " << F->getName() << " -------------\n";
-
- switch (WriteMode) {
- case dfo: // Depth First ordering
- copy(df_begin(F), df_end(F),
- std::ostream_iterator<BasicBlock*>(*Out, "\n"));
- break;
- case rdfo: // Reverse Depth First ordering
- copy(df_begin(F, true), df_end(F),
- std::ostream_iterator<BasicBlock*>(*Out, "\n"));
- break;
- case po: // Post Order
- copy(po_begin(F), po_end(F),
- std::ostream_iterator<BasicBlock*>(*Out, "\n"));
- break;
- case rpo: { // Reverse Post Order
-#if 0 // FIXME, GCC 3.0.4 bug
- ReversePostOrderTraversal<Function*> RPOT(F);
- copy(RPOT.begin(), RPOT.end(),
- std::ostream_iterator<BasicBlock*>(*Out, "\n"));
-#endif
- break;
- }
- default:
- abort();
- break;
- }
- }
- }
- delete M;
+ std::unique_ptr<AssemblyAnnotationWriter> Annotator;
+ if (ShowAnnotations)
+ Annotator.reset(new CommentWriter());
+
+ // All that llvm-dis does is write the assembly to a file.
+ if (!DontPrint)
+ M->print(Out->os(), Annotator.get());
+
+ // Declare success.
+ Out->keep();
- if (Out != &std::cout) delete Out;
return 0;
}
-