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
31 /// optionally a stop_id of when those pc addresses were collected, and it
32 /// will create stack frames for them.
33 
34 class HistoryThread : public lldb_private::Thread {
35 public:
36   HistoryThread(lldb_private::Process &process, lldb::tid_t tid,
37                 std::vector<lldb::addr_t> pcs, uint32_t stop_id,
38                 bool stop_id_is_valid);
39 
40   ~HistoryThread() override;
41 
42   lldb::RegisterContextSP GetRegisterContext() override;
43 
44   lldb::RegisterContextSP
45   CreateRegisterContextForFrame(StackFrame *frame) override;
46 
47   void RefreshStateAfterStop() override {}
48 
49   bool CalculateStopInfo() override { return false; }
50 
51   void SetExtendedBacktraceToken(uint64_t token) override {
52     m_extended_unwind_token = token;
53   }
54 
55   uint64_t GetExtendedBacktraceToken() override {
56     return m_extended_unwind_token;
57   }
58 
59   const char *GetQueueName() override { return m_queue_name.c_str(); }
60 
61   void SetQueueName(const char *name) override { m_queue_name = name; }
62 
63   lldb::queue_id_t GetQueueID() override { return m_queue_id; }
64 
65   void SetQueueID(lldb::queue_id_t queue) override { m_queue_id = queue; }
66 
67   const char *GetThreadName() { return m_thread_name.c_str(); }
68 
69   uint32_t GetExtendedBacktraceOriginatingIndexID() override;
70 
71   void SetThreadName(const char *name) { m_thread_name = name; }
72 
73   const char *GetName() override { return m_thread_name.c_str(); }
74 
75   void SetName(const char *name) override { m_thread_name = name; }
76 
77 protected:
78   virtual lldb::StackFrameListSP GetStackFrameList();
79 
80   mutable std::mutex m_framelist_mutex;
81   lldb::StackFrameListSP m_framelist;
82   std::vector<lldb::addr_t> m_pcs;
83   uint32_t m_stop_id;
84   bool m_stop_id_is_valid;
85 
86   uint64_t m_extended_unwind_token;
87   std::string m_queue_name;
88   std::string m_thread_name;
89   lldb::tid_t m_originating_unique_thread_id;
90   lldb::queue_id_t m_queue_id;
91 };
92 
93 } // namespace lldb_private
94 
95 #endif // liblldb_HistoryThread_h_
96