LLDB  mainline
NativeThreadLinux.h
Go to the documentation of this file.
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 
16 
17 #include "llvm/ADT/StringRef.h"
18 
19 #include <csignal>
20 #include <map>
21 #include <memory>
22 #include <string>
23 
24 namespace lldb_private {
25 namespace process_linux {
26 
27 class NativeProcessLinux;
28 
30  friend class NativeProcessLinux;
31 
32 public:
34 
35  // NativeThreadProtocol Interface
36  std::string GetName() override;
37 
38  lldb::StateType GetState() override;
39 
40  bool GetStopReason(ThreadStopInfo &stop_info,
41  std::string &description) override;
42 
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 
55 
57 
58  const NativeProcessLinux &GetProcess() const;
59 
60  llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>>
61  GetSiginfo() const override;
62 
63 private:
64  // Interface for friend classes
65 
66  /// Resumes the thread. If \p signo is anything but
67  /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread.
68  Status Resume(uint32_t signo);
69 
70  /// Single steps the thread. If \p signo is anything but
71  /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread.
72  Status SingleStep(uint32_t signo);
73 
74  void SetStoppedBySignal(uint32_t signo, const siginfo_t *info = nullptr);
75 
76  /// Return true if the thread is stopped.
77  /// If stopped by a signal, indicate the signo in the signo argument.
78  /// Otherwise, return LLDB_INVALID_SIGNAL_NUMBER.
79  bool IsStopped(int *signo);
80 
81  void SetStoppedByExec();
82 
84 
85  void SetStoppedByWatchpoint(uint32_t wp_index);
86 
87  bool IsStoppedAtBreakpoint();
88 
89  bool IsStoppedAtWatchpoint();
90 
91  void SetStoppedByTrace();
92 
93  void SetStoppedByFork(bool is_vfork, lldb::pid_t child_pid);
94 
95  void SetStoppedByVForkDone();
96 
98 
99  void SetStoppedByProcessorTrace(llvm::StringRef description);
100 
101  void SetExited();
102 
104 
105  // Private interface
106  void MaybeLogStateChange(lldb::StateType new_state);
107 
108  void SetStopped();
109 
110  /// Extend m_stop_description with logical and allocation tag values.
111  /// If there is an error along the way just add the information we were able
112  /// to get.
113  void AnnotateSyncTagCheckFault(const siginfo_t *info);
114 
115  // Member Variables
118  std::unique_ptr<NativeRegisterContextLinux> m_reg_context_up;
120  using WatchpointIndexMap = std::map<lldb::addr_t, uint32_t>;
123  std::unique_ptr<SingleStepWorkaround> m_step_workaround;
124 };
125 } // namespace process_linux
126 } // namespace lldb_private
127 
128 #endif // #ifndef liblldb_NativeThreadLinux_H_
lldb_private::process_linux::NativeThreadLinux::SetStoppedByVForkDone
void SetStoppedByVForkDone()
Definition: NativeThreadLinux.cpp:467
lldb_private::process_linux::NativeThreadLinux::IsStopped
bool IsStopped(int *signo)
Return true if the thread is stopped.
Definition: NativeThreadLinux.cpp:367
lldb_private::NativeThreadProtocol
Definition: NativeThreadProtocol.h:24
lldb_private::process_linux::NativeThreadLinux::Resume
Status Resume(uint32_t signo)
Resumes the thread.
Definition: NativeThreadLinux.cpp:211
lldb_private::process_linux::NativeRegisterContextLinux
Definition: NativeRegisterContextLinux.h:22
lldb_private::process_linux::NativeThreadLinux::SetStoppedByProcessorTrace
void SetStoppedByProcessorTrace(llvm::StringRef description)
Definition: NativeThreadLinux.cpp:481
lldb_private::process_linux::NativeThreadLinux::m_stop_info
ThreadStopInfo m_stop_info
Definition: NativeThreadLinux.h:117
lldb_private::process_linux::NativeThreadLinux::m_watchpoint_index_map
WatchpointIndexMap m_watchpoint_index_map
Definition: NativeThreadLinux.h:121
lldb_private::process_linux::NativeThreadLinux::GetSiginfo
llvm::Expected< std::unique_ptr< llvm::MemoryBuffer > > GetSiginfo() const override
Definition: NativeThreadLinux.cpp:548
lldb_private::process_linux::NativeThreadLinux
Definition: NativeThreadLinux.h:29
lldb_private::process_linux::NativeThreadLinux::m_step_workaround
std::unique_ptr< SingleStepWorkaround > m_step_workaround
Definition: NativeThreadLinux.h:123
lldb_private::process_linux::NativeThreadLinux::m_state
lldb::StateType m_state
Definition: NativeThreadLinux.h:116
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
lldb_private::process_linux::NativeThreadLinux::SetStoppedByFork
void SetStoppedByFork(bool is_vfork, lldb::pid_t child_pid)
Definition: NativeThreadLinux.cpp:457
lldb-private-forward.h
lldb_private::process_linux::NativeThreadLinux::RemoveHardwareBreakpoint
Status RemoveHardwareBreakpoint(lldb::addr_t addr) override
Definition: NativeThreadLinux.cpp:197
lldb_private::process_linux::NativeThreadLinux::SetStoppedByExec
void SetStoppedByExec()
Definition: NativeThreadLinux.cpp:394
lldb_private::process_linux::NativeThreadLinux::GetName
std::string GetName() override
Definition: NativeThreadLinux.cpp:101
lldb_private::process_linux::NativeThreadLinux::WatchpointIndexMap
std::map< lldb::addr_t, uint32_t > WatchpointIndexMap
Definition: NativeThreadLinux.h:120
lldb_private::process_linux::NativeThreadLinux::m_stop_description
std::string m_stop_description
Definition: NativeThreadLinux.h:119
lldb_private::process_linux::NativeThreadLinux::SingleStep
Status SingleStep(uint32_t signo)
Single steps the thread.
Definition: NativeThreadLinux.cpp:253
lldb_private::process_linux::NativeThreadLinux::RemoveWatchpoint
Status RemoveWatchpoint(lldb::addr_t addr) override
Definition: NativeThreadLinux.cpp:168
lldb_private::process_linux::NativeProcessLinux
Definition: NativeProcessLinux.h:40
SingleStepCheck.h
lldb_private::process_linux::NativeThreadLinux::SetStopped
void SetStopped()
Definition: NativeThreadLinux.cpp:381
lldb_private::process_linux::NativeThreadLinux::GetState
lldb::StateType GetState() override
Definition: NativeThreadLinux.cpp:110
lldb_private::process_linux::NativeThreadLinux::SetStoppedByTrace
void SetStoppedByTrace()
Definition: NativeThreadLinux.cpp:450
lldb_private::process_linux::NativeThreadLinux::MaybeLogStateChange
void MaybeLogStateChange(lldb::StateType new_state)
Definition: NativeThreadLinux.cpp:524
lldb_private::process_linux::NativeThreadLinux::IsStoppedAtBreakpoint
bool IsStoppedAtBreakpoint()
Definition: NativeThreadLinux.cpp:440
lldb_private::process_linux::NativeThreadLinux::SetWatchpoint
Status SetWatchpoint(lldb::addr_t addr, size_t size, uint32_t watch_flags, bool hardware) override
Definition: NativeThreadLinux.cpp:151
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:40
lldb_private::process_linux::NativeThreadLinux::RequestStop
Status RequestStop()
Definition: NativeThreadLinux.cpp:498
lldb_private::process_linux::NativeThreadLinux::SetHardwareBreakpoint
Status SetHardwareBreakpoint(lldb::addr_t addr, size_t size) override
Definition: NativeThreadLinux.cpp:179
lldb_private::process_linux::NativeThreadLinux::m_hw_break_index_map
WatchpointIndexMap m_hw_break_index_map
Definition: NativeThreadLinux.h:122
lldb_private::process_linux::NativeThreadLinux::SetStoppedByBreakpoint
void SetStoppedByBreakpoint()
Definition: NativeThreadLinux.cpp:404
lldb_private::ThreadStopInfo
Definition: Debug.h:131
lldb_private::process_linux::NativeThreadLinux::SetExited
void SetExited()
Definition: NativeThreadLinux.cpp:490
lldb_private::process_linux::NativeThreadLinux::GetProcess
NativeProcessLinux & GetProcess()
Definition: NativeThreadLinux.cpp:539
lldb_private::process_linux::NativeThreadLinux::SetStoppedBySignal
void SetStoppedBySignal(uint32_t signo, const siginfo_t *info=nullptr)
Definition: NativeThreadLinux.cpp:279
lldb_private::process_linux::NativeThreadLinux::NativeThreadLinux
NativeThreadLinux(NativeProcessLinux &process, lldb::tid_t tid)
Definition: NativeThreadLinux.cpp:92
lldb_private::Status
Definition: Status.h:44
lldb_private::process_linux::NativeThreadLinux::SetStoppedByWatchpoint
void SetStoppedByWatchpoint(uint32_t wp_index)
Definition: NativeThreadLinux.cpp:412
uint32_t
NativeThreadProtocol.h
lldb::pid_t
uint64_t pid_t
Definition: lldb-types.h:85
lldb_private::process_linux::NativeThreadLinux::AnnotateSyncTagCheckFault
void AnnotateSyncTagCheckFault(const siginfo_t *info)
Extend m_stop_description with logical and allocation tag values.
Definition: NativeThreadLinux.cpp:314
lldb_private::process_linux::NativeThreadLinux::m_reg_context_up
std::unique_ptr< NativeRegisterContextLinux > m_reg_context_up
Definition: NativeThreadLinux.h:118
lldb_private::process_linux::NativeThreadLinux::SetStoppedWithNoReason
void SetStoppedWithNoReason()
Definition: NativeThreadLinux.cpp:474
NativeRegisterContextLinux.h
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::process_linux::NativeThreadLinux::GetRegisterContext
NativeRegisterContextLinux & GetRegisterContext() override
Definition: NativeThreadLinux.h:43
lldb::StateType
StateType
Process and Thread States.
Definition: lldb-enumerations.h:73
lldb_private::process_linux::NativeThreadLinux::IsStoppedAtWatchpoint
bool IsStoppedAtWatchpoint()
Definition: NativeThreadLinux.cpp:445
lldb_private::process_linux::NativeThreadLinux::GetStopReason
bool GetStopReason(ThreadStopInfo &stop_info, std::string &description) override
Definition: NativeThreadLinux.cpp:112
lldb::tid_t
uint64_t tid_t
Definition: lldb-types.h:86