tools/llvm-readobj/ObjDumper.h

   1 //===-- ObjDumper.h ---------------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_TOOLS_LLVM_READOBJ_OBJDUMPER_H
  11 #define LLVM_TOOLS_LLVM_READOBJ_OBJDUMPER_H
  12
  13 #include <memory>
  14 #include <system_error>
  15
  16 namespace llvm {
  17 namespace object {
  18   class ObjectFile;
  19 }
  20
  21 class StreamWriter;
  22
  23 class ObjDumper {
  24 public:
  25   ObjDumper(StreamWriter& Writer);
  26   virtual ~ObjDumper();
  27
  28   virtual void printFileHeaders() = 0;
  29   virtual void printSections() = 0;
  30   virtual void printRelocations() = 0;
  31   virtual void printSymbols() = 0;
  32   virtual void printDynamicSymbols() = 0;
  33   virtual void printUnwindInfo() = 0;
  34
  35   // Only implemented for ELF at this time.
  36   virtual void printDynamicRelocations() { }
  37   virtual void printDynamicTable() { }
  38   virtual void printNeededLibraries() { }
  39   virtual void printProgramHeaders() { }
  40   virtual void printHashTable() { }
  41   virtual void printLoadName() {}
  42
  43   // Only implemented for ARM ELF at this time.
  44   virtual void printAttributes() { }
  45
  46   // Only implemented for MIPS ELF at this time.
  47   virtual void printMipsPLTGOT() { }
  48   virtual void printMipsABIFlags() { }
  49   virtual void printMipsReginfo() { }
  50
  51   // Only implemented for PE/COFF.
  52   virtual void printCOFFImports() { }
  53   virtual void printCOFFExports() { }
  54   virtual void printCOFFDirectives() { }
  55   virtual void printCOFFBaseReloc() { }
  56
  57   // Only implemented for MachO.
  58   virtual void printMachODataInCode() { }
  59
  60   virtual void printStackMap() const = 0;
  61
  62 protected:
  63   StreamWriter& W;
  64 };
  65
  66 std::error_code createCOFFDumper(const object::ObjectFile *Obj,
  67                                  StreamWriter &Writer,
  68                                  std::unique_ptr<ObjDumper> &Result);
  69
  70 std::error_code createELFDumper(const object::ObjectFile *Obj,
  71                                 StreamWriter &Writer,
  72                                 std::unique_ptr<ObjDumper> &Result);
  73
  74 std::error_code createMachODumper(const object::ObjectFile *Obj,
  75                                   StreamWriter &Writer,
  76                                   std::unique_ptr<ObjDumper> &Result);
  77
  78 } // namespace llvm
  79
  80 #endif