1 //===-- NativeThreadLinux.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_NativeThreadLinux_H_
10 #define liblldb_NativeThreadLinux_H_
11 
12 #include "Plugins/Process/Linux/NativeRegisterContextLinux.h"
13 #include "Plugins/Process/Linux/SingleStepCheck.h"
14 #include "lldb/Host/common/NativeThreadProtocol.h"
15 #include "lldb/lldb-private-forward.h"
16 
17 #include <csignal>
18 #include <map>
19 #include <memory>
20 #include <string>
21 
22 namespace lldb_private {
23 namespace process_linux {
24 
25 class NativeProcessLinux;
26 
27 class NativeThreadLinux : public NativeThreadProtocol {
28   friend class NativeProcessLinux;
29 
30 public:
31   NativeThreadLinux(NativeProcessLinux &process, lldb::tid_t tid);
32 
33   // ---------------------------------------------------------------------
34   // NativeThreadProtocol Interface
35   // ---------------------------------------------------------------------
36   std::string GetName() override;
37 
38   lldb::StateType GetState() override;
39 
40   bool GetStopReason(ThreadStopInfo &stop_info,
41                      std::string &description) override;
42 
43   NativeRegisterContextLinux &GetRegisterContext() override {
44     return *m_reg_context_up;
45   }
46 
47   Status SetWatchpoint(lldb::addr_t addr, size_t size, uint32_t watch_flags,
48                        bool hardware) override;
49 
50   Status RemoveWatchpoint(lldb::addr_t addr) override;
51 
52   Status SetHardwareBreakpoint(lldb::addr_t addr, size_t size) override;
53 
54   Status RemoveHardwareBreakpoint(lldb::addr_t addr) override;
55 
56 private:
57   // ---------------------------------------------------------------------
58   // Interface for friend classes
59   // ---------------------------------------------------------------------
60 
61   /// Resumes the thread.  If @p signo is anything but
62   /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread.
63   Status Resume(uint32_t signo);
64 
65   /// Single steps the thread.  If @p signo is anything but
66   /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread.
67   Status SingleStep(uint32_t signo);
68 
69   void SetStoppedBySignal(uint32_t signo, const siginfo_t *info = nullptr);
70 
71   /// Return true if the thread is stopped.
72   /// If stopped by a signal, indicate the signo in the signo argument.
73   /// Otherwise, return LLDB_INVALID_SIGNAL_NUMBER.
74   bool IsStopped(int *signo);
75 
76   void SetStoppedByExec();
77 
78   void SetStoppedByBreakpoint();
79 
80   void SetStoppedByWatchpoint(uint32_t wp_index);
81 
82   bool IsStoppedAtBreakpoint();
83 
84   bool IsStoppedAtWatchpoint();
85 
86   void SetStoppedByTrace();
87 
88   void SetStoppedWithNoReason();
89 
90   void SetExited();
91 
92   Status RequestStop();
93 
94   // ---------------------------------------------------------------------
95   // Private interface
96   // ---------------------------------------------------------------------
97   void MaybeLogStateChange(lldb::StateType new_state);
98 
99   NativeProcessLinux &GetProcess();
100 
101   void SetStopped();
102 
103   // ---------------------------------------------------------------------
104   // Member Variables
105   // ---------------------------------------------------------------------
106   lldb::StateType m_state;
107   ThreadStopInfo m_stop_info;
108   std::unique_ptr<NativeRegisterContextLinux> m_reg_context_up;
109   std::string m_stop_description;
110   using WatchpointIndexMap = std::map<lldb::addr_t, uint32_t>;
111   WatchpointIndexMap m_watchpoint_index_map;
112   WatchpointIndexMap m_hw_break_index_map;
113   std::unique_ptr<SingleStepWorkaround> m_step_workaround;
114 };
115 } // namespace process_linux
116 } // namespace lldb_private
117 
118 #endif // #ifndef liblldb_NativeThreadLinux_H_
119