include/lldb/Symbol/UnwindTable.h

   1 //===-- Symtab.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
  11 #ifndef liblldb_UnwindTable_h
  12 #define liblldb_UnwindTable_h
  13
  14 #include <map>
  15 #include <mutex>
  16
  17 #include "lldb/lldb-private.h"
  18
  19 namespace lldb_private {
  20
  21 // A class which holds all the FuncUnwinders objects for a given ObjectFile.
  22 // The UnwindTable is populated with FuncUnwinders objects lazily during
  23 // the debug session.
  24
  25 class UnwindTable
  26 {
  27 public:
  28     UnwindTable(ObjectFile& objfile);
  29     ~UnwindTable();
  30
  31     lldb_private::DWARFCallFrameInfo *
  32     GetEHFrameInfo ();
  33
  34     lldb_private::CompactUnwindInfo *
  35     GetCompactUnwindInfo ();
  36
  37     ArmUnwindInfo *
  38     GetArmUnwindInfo ();
  39
  40     lldb::FuncUnwindersSP
  41     GetFuncUnwindersContainingAddress (const Address& addr, SymbolContext &sc);
  42
  43     bool
  44     GetAllowAssemblyEmulationUnwindPlans ();
  45
  46 // Normally when we create a new FuncUnwinders object we track it in this UnwindTable so it can
  47 // be reused later.  But for the target modules show-unwind we want to create brand new
  48 // UnwindPlans for the function of interest - so ignore any existing FuncUnwinders for that
  49 // function and don't add this new one to our UnwindTable.
  50 // This FuncUnwinders object does have a reference to the UnwindTable but the lifetime of this
  51 // uncached FuncUnwinders is expected to be short so in practice this will not be a problem.
  52     lldb::FuncUnwindersSP
  53     GetUncachedFuncUnwindersContainingAddress (const Address& addr, SymbolContext &sc);
  54
  55     bool
  56     GetArchitecture (lldb_private::ArchSpec &arch);
  57
  58 private:
  59     void
  60     Dump (Stream &s);
  61
  62     void Initialize ();
  63
  64     typedef std::map<lldb::addr_t, lldb::FuncUnwindersSP> collection;
  65     typedef collection::iterator iterator;
  66     typedef collection::const_iterator const_iterator;
  67
  68     ObjectFile&         m_object_file;
  69     collection          m_unwinds;
  70
  71     bool                m_initialized;  // delay some initialization until ObjectFile is set up
  72     std::mutex m_mutex;
  73
  74     std::unique_ptr<DWARFCallFrameInfo> m_eh_frame_up;
  75     std::unique_ptr<CompactUnwindInfo>  m_compact_unwind_up;
  76     std::unique_ptr<ArmUnwindInfo>      m_arm_unwind_up;
  77
  78     DISALLOW_COPY_AND_ASSIGN (UnwindTable);
  79 };
  80
  81 } // namespace lldb_private
  82
  83 #endif  // liblldb_UnwindTable_h