Merge System into Support.
[oota-llvm.git] / tools / llvm-dis / llvm-dis.cpp
index d1f61d70b01d9c428ad3b7bc38dea66ed9d577b5..9e057755f83f8c83f5687233b882826fd9570dec 100644 (file)
-//===------------------------------------------------------------------------===
-// LLVM 'DIS' UTILITY 
+//===-- 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.
+//
+//===----------------------------------------------------------------------===//
 //
 // 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
-//
-// TODO: add -vcg which prints VCG compatible output.
 //
-//===------------------------------------------------------------------------===
+//===----------------------------------------------------------------------===//
 
-#include <iostream.h>
-#include <fstream.h>
+#include "llvm/LLVMContext.h"
 #include "llvm/Module.h"
-#include "llvm/Assembly/Writer.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Tools/CommandLine.h"
-#include "llvm/Method.h"
-#include "llvm/CFG.h"
+#include "llvm/Type.h"
+#include "llvm/Bitcode/ReaderWriter.h"
+#include "llvm/Assembly/AssemblyAnnotationWriter.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/FormattedStream.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/PrettyStackTrace.h"
+#include "llvm/Support/ToolOutputFile.h"
+#include "llvm/Support/Signals.h"
+using namespace llvm;
 
-// OutputMode - The different orderings to print basic blocks in...
-enum OutputMode {
-  Default = 0,           // Method Order (list order)
-  dfo,                   // Depth First ordering
-  rdfo,                  // Reverse Depth First ordering
-  po,                    // Post Order
-  rpo,                   // Reverse Post Order
-};
+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"));
 
-cl::String InputFilename ("", "Load <arg> file, print as assembly", 0, "-");
-cl::String OutputFilename("o", "Override output filename", 0, "");
-cl::Flag   Force         ("f", "Overwrite output files", 0, 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"),
- 0);
+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 {
+  
+class CommentWriter : public AssemblyAnnotationWriter {
+public:
+  void emitFunctionAnnot(const Function *F,
+                         formatted_raw_ostream &OS) {
+    OS << "; [#uses=" << F->getNumUses() << ']';  // Output # uses
+    OS << '\n';
+  }
+  void printInfoComment(const Value &V, formatted_raw_ostream &OS) {
+    if (V.getType()->isVoidTy()) return;
+      
+    OS.PadToColumn(50);
+    OS << "; [#uses=" << V.getNumUses() << ']';  // Output # uses
+  }
+};
+  
+} // end anon namespace
 
 int main(int argc, char **argv) {
-  cl::ParseCommandLineOptions(argc, argv, " llvm .bc -> .ll disassembler\n");
-  ostream *Out = &cout;  // Default to printing to stdout...
+  // Print a stack trace if we signal out.
+  sys::PrintStackTraceOnErrorSignal();
+  PrettyStackTraceProgram X(argc, argv);
+  
+  LLVMContext &Context = getGlobalContext();
+  llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
+  
+  
+  cl::ParseCommandLineOptions(argc, argv, "llvm .bc -> .ll disassembler\n");
+
+  std::string ErrorMessage;
+  std::auto_ptr<Module> M;
+  if (MemoryBuffer *Buffer
+         = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
+    M.reset(ParseBitcodeFile(Buffer, Context, &ErrorMessage));
+    delete Buffer;
+  }
 
-  Module *C = ParseBytecodeFile(InputFilename.getValue());
-  if (C == 0) {
-    cerr << "bytecode didn't read correctly.\n";
+  if (M.get() == 0) {
+    errs() << argv[0] << ": ";
+    if (ErrorMessage.size())
+      errs() << ErrorMessage << "\n";
+    else
+      errs() << "bitcode didn't read correctly.\n";
     return 1;
   }
   
-  if (OutputFilename.getValue() != "") {   // Specified an output filename?
-    Out = new ofstream(OutputFilename.getValue().c_str(), 
-                      (Force.getValue() ? 0 : ios::noreplace)|ios::out);
-  } else {
-    if (InputFilename.getValue() == "-") {
-      OutputFilename.setValue("-");
-      Out = &cout;
+  // 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 {
-      string IFN = InputFilename.getValue();
+      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.setValue(string(IFN.begin(), IFN.end()-3));
-      } else {
-       OutputFilename.setValue(IFN);   // Append a .ll to it
-      }
-      OutputFilename.setValue(OutputFilename.getValue() + ".ll");
-      Out = new ofstream(OutputFilename.getValue().c_str(), 
-                        (Force.getValue() ? 0 : ios::noreplace)|ios::out);
+      // 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 = IFN+".ll";
     }
   }
 
-  if (!Out->good()) {
-    cerr << "Error opening " << OutputFilename.getValue() 
-        << ": sending to stdout instead!\n";
-    Out = &cout;
+  std::string ErrorInfo;
+  OwningPtr<tool_output_file> 
+  Out(new tool_output_file(OutputFilename.c_str(), ErrorInfo,
+                           raw_fd_ostream::F_Binary));
+  if (!ErrorInfo.empty()) {
+    errs() << ErrorInfo << '\n';
+    return 1;
   }
 
-  // All that dis does is write the assembly out to a file... which is exactly
-  // what the writer library is supposed to do...
-  //
-  if (WriteMode.getValue() == Default) {
-    (*Out) << C;           // Print out in list order
-  } else {
-    // TODO: This does not print anything other than the basic blocks in the
-    // methods... more should definately be printed.  It should be valid output
-    // consumable by the assembler.
-    //
-    for (Module::iterator I = C->begin(), End = C->end(); I != End; ++I) {
-      Method *M = *I;
-      (*Out) << "-------------- Method: " << M->getName() << " -------------\n";
+  OwningPtr<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());
 
-      switch (WriteMode.getValue()) {
-      case dfo:                   // Depth First ordering
-       copy(cfg::df_begin(M), cfg::df_end(M),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      case rdfo:            // Reverse Depth First ordering
-       copy(cfg::df_begin(M, true), cfg::df_end(M),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      case po:                    // Post Order
-       copy(cfg::po_begin(M), cfg::po_end(M),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      case rpo: {           // Reverse Post Order
-       cfg::ReversePostOrderTraversal RPOT(M);
-       copy(RPOT.begin(), RPOT.end(),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      }
-      default:
-       abort();
-       break;
-      }
-    }
-  }
-  delete C;
+  // Declare success.
+  Out->keep();
 
-  if (Out != &cout) delete Out;
   return 0;
 }
+