contrib/llvm-project/lldb/source/Plugins/Process/Utility/HistoryThread.h

   1 //===-- HistoryThread.h -----------------------------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef liblldb_HistoryThread_h_
  10 #define liblldb_HistoryThread_h_
  11
  12 #include <mutex>
  13
  14 #include "lldb/Core/UserSettingsController.h"
  15 #include "lldb/Target/ExecutionContextScope.h"
  16 #include "lldb/Target/StackFrameList.h"
  17 #include "lldb/Target/Thread.h"
  18 #include "lldb/Utility/Broadcaster.h"
  19 #include "lldb/Utility/Event.h"
  20 #include "lldb/Utility/UserID.h"
  21 #include "lldb/lldb-private.h"
  22
  23 namespace lldb_private {
  24
  25 /// \class HistoryThread HistoryThread.h "HistoryThread.h"
  26 /// A thread object representing a backtrace from a previous point in the
  27 /// process execution
  28 ///
  29 /// This subclass of Thread is used to provide a backtrace from earlier in
  30 /// process execution.  It is given a backtrace list of pc addresses and it
  31 /// will create stack frames for them.
  32
  33 class HistoryThread : public lldb_private::Thread {
  34 public:
  35   HistoryThread(lldb_private::Process &process, lldb::tid_t tid,
  36                 std::vector<lldb::addr_t> pcs);
  37
  38   ~HistoryThread() override;
  39
  40   lldb::RegisterContextSP GetRegisterContext() override;
  41
  42   lldb::RegisterContextSP
  43   CreateRegisterContextForFrame(StackFrame *frame) override;
  44
  45   void RefreshStateAfterStop() override {}
  46
  47   bool CalculateStopInfo() override { return false; }
  48
  49   void SetExtendedBacktraceToken(uint64_t token) override {
  50     m_extended_unwind_token = token;
  51   }
  52
  53   uint64_t GetExtendedBacktraceToken() override {
  54     return m_extended_unwind_token;
  55   }
  56
  57   const char *GetQueueName() override { return m_queue_name.c_str(); }
  58
  59   void SetQueueName(const char *name) override { m_queue_name = name; }
  60
  61   lldb::queue_id_t GetQueueID() override { return m_queue_id; }
  62
  63   void SetQueueID(lldb::queue_id_t queue) override { m_queue_id = queue; }
  64
  65   const char *GetThreadName() { return m_thread_name.c_str(); }
  66
  67   uint32_t GetExtendedBacktraceOriginatingIndexID() override;
  68
  69   void SetThreadName(const char *name) { m_thread_name = name; }
  70
  71   const char *GetName() override { return m_thread_name.c_str(); }
  72
  73   void SetName(const char *name) override { m_thread_name = name; }
  74
  75 protected:
  76   virtual lldb::StackFrameListSP GetStackFrameList();
  77
  78   mutable std::mutex m_framelist_mutex;
  79   lldb::StackFrameListSP m_framelist;
  80   std::vector<lldb::addr_t> m_pcs;
  81
  82   uint64_t m_extended_unwind_token;
  83   std::string m_queue_name;
  84   std::string m_thread_name;
  85   lldb::tid_t m_originating_unique_thread_id;
  86   lldb::queue_id_t m_queue_id;
  87 };
  88
  89 } // namespace lldb_private
  90
  91 #endif // liblldb_HistoryThread_h_