Chapter 5, 6, and 7 of the ocaml/kaleidoscope tutorial
[oota-llvm.git] / tools / llvm-dis / llvm-dis.cpp
index 2a7eb4e06ea5875beda1359be3b6f731c95ed954..9802541e0f6bbaf1bf1d1ec64be76f49e2618396 100644 (file)
+//===-- 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
-//
-// TODO: add -vcg which prints VCG compatible output.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Module.h"
-#include "llvm/Assembly/Writer.h"
-#include "llvm/Bytecode/Reader.h"
-#include "llvm/Method.h"
-#include "Support/DepthFirstIterator.h"
-#include "Support/PostOrderIterator.h"
-#include "Support/CommandLine.h"
+#include "llvm/PassManager.h"
+#include "llvm/Bitcode/ReaderWriter.h"
+#include "llvm/Assembly/PrintModulePass.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/Streams.h"
+#include "llvm/System/Signals.h"
+#include <iostream>
 #include <fstream>
+#include <memory>
+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"));
 
-// 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
-};
-
-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"),
- 0);
+static cl::opt<bool>
+Force("f", cl::desc("Overwrite output files"));
+
+static cl::opt<bool>
+DontPrint("disable-output", cl::desc("Don't output the .ll file"), cl::Hidden);
 
 int main(int argc, char **argv) {
-  cl::ParseCommandLineOptions(argc, argv, " llvm .bc -> .ll disassembler\n");
-  ostream *Out = &cout;  // Default to printing to stdout...
+  llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
+  try {
+    cl::ParseCommandLineOptions(argc, argv, "llvm .bc -> .ll disassembler\n");
+    sys::PrintStackTraceOnErrorSignal();
 
-  Module *C = ParseBytecodeFile(InputFilename);
-  if (C == 0) {
-    cerr << "bytecode didn't read correctly.\n";
-    return 1;
-  }
-  
-  if (OutputFilename != "") {   // Specified an output filename?
-    Out = new ofstream(OutputFilename.c_str(), 
-                      (Force ? 0 : ios::noreplace)|ios::out);
-  } else {
-    if (InputFilename == "-") {
-      OutputFilename = "-";
-      Out = &cout;
+    std::ostream *Out = &std::cout;  // Default to printing to stdout.
+    std::string ErrorMessage;
+
+    std::auto_ptr<Module> M;
+   
+    if (MemoryBuffer *Buffer
+           = MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage)) {
+      M.reset(ParseBitcodeFile(Buffer, &ErrorMessage));
+      delete Buffer;
+    }
+
+    if (M.get() == 0) {
+      cerr << argv[0] << ": ";
+      if (ErrorMessage.size())
+        cerr << ErrorMessage << "\n";
+      else
+        cerr << "bitcode didn't read correctly.\n";
+      return 1;
+    }
+    
+    if (DontPrint) {
+      // Just use stdout.  We won't actually print anything on it.
+    } else if (OutputFilename != "") {   // Specified an output filename?
+      if (OutputFilename != "-") { // Not stdout?
+        if (!Force && std::ifstream(OutputFilename.c_str())) {
+          // If force is not specified, make sure not to overwrite a file!
+          cerr << argv[0] << ": error opening '" << OutputFilename
+               << "': file exists! Sending to standard output.\n";
+        } else {
+          Out = new std::ofstream(OutputFilename.c_str());
+        }
+      }
     } else {
-      string IFN = InputFilename;
-      int Len = IFN.length();
-      if (IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
-       // Source ends in .bc
-       OutputFilename = string(IFN.begin(), IFN.end()-3);
+      if (InputFilename == "-") {
+        OutputFilename = "-";
       } else {
-       OutputFilename = IFN;   // Append a .ll to it
+        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)+".ll";
+        } else {
+          OutputFilename = IFN+".ll";
+        }
+
+        if (!Force && std::ifstream(OutputFilename.c_str())) {
+          // If force is not specified, make sure not to overwrite a file!
+          cerr << argv[0] << ": 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 unlinked from the disk if we get a
+          // SIGINT
+          sys::RemoveFileOnSignal(sys::Path(OutputFilename));
+        }
       }
-      OutputFilename += ".ll";
-      Out = new ofstream(OutputFilename.c_str(), 
-                        (Force ? 0 : ios::noreplace)|ios::out);
     }
-  }
 
-  if (!Out->good()) {
-    cerr << "Error opening " << OutputFilename
-        << ": sending to stdout instead!\n";
-    Out = &cout;
-  }
+    if (!Out->good()) {
+      cerr << argv[0] << ": error opening " << OutputFilename
+           << ": sending to stdout instead!\n";
+      Out = &std::cout;
+    }
 
-  // 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 == 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";
-
-      switch (WriteMode) {
-      case dfo:                   // Depth First ordering
-       copy(df_begin(M), df_end(M),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      case rdfo:            // Reverse Depth First ordering
-       copy(df_begin(M, true), df_end(M),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      case po:                    // Post Order
-       copy(po_begin(M), po_end(M),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      case rpo: {           // Reverse Post Order
-       ReversePostOrderTraversal RPOT(M);
-       copy(RPOT.begin(), RPOT.end(),
-            ostream_iterator<BasicBlock*>(*Out, "\n"));
-       break;
-      }
-      default:
-       abort();
-       break;
-      }
+    // All that llvm-dis does is write the assembly to a file.
+    if (!DontPrint) {
+      PassManager Passes;
+      OStream L(*Out);
+      Passes.add(new PrintModulePass(&L));
+      Passes.run(*M.get());
     }
+
+    if (Out != &std::cout) {
+      ((std::ofstream*)Out)->close();
+      delete Out;
+    }
+    return 0;
+  } catch (const std::string& msg) {
+    cerr << argv[0] << ": " << msg << "\n";
+  } catch (...) {
+    cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
   }
-  delete C;
 
-  if (Out != &cout) delete Out;
-  return 0;
+  return 1;
 }
+