LLDB mainline
ThreadKDP.cpp
Go to the documentation of this file.
1//===-- ThreadKDP.cpp -----------------------------------------------------===//
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#include "ThreadKDP.h"
10
11#include "lldb/Host/SafeMachO.h"
12
14#include "lldb/Target/Process.h"
17#include "lldb/Target/Target.h"
18#include "lldb/Target/Unwind.h"
21#include "lldb/Utility/State.h"
23
25#include "ProcessKDP.h"
26#include "ProcessKDPLog.h"
31
32#include <memory>
33
34using namespace lldb;
35using namespace lldb_private;
36
37// Thread Registers
38
40 : Thread(process, tid), m_thread_name(), m_dispatch_queue_name(),
41 m_thread_dispatch_qaddr(LLDB_INVALID_ADDRESS) {
42 Log *log = GetLog(KDPLog::Thread);
43 LLDB_LOG(log, "this = {0}, tid = {1:x}", this, GetID());
44}
45
47 Log *log = GetLog(KDPLog::Thread);
48 LLDB_LOG(log, "this = {0}, tid = {1:x}", this, GetID());
50}
51
52const char *ThreadKDP::GetName() {
53 if (m_thread_name.empty())
54 return nullptr;
55 return m_thread_name.c_str();
56}
57
58const char *ThreadKDP::GetQueueName() { return nullptr; }
59
61 // Invalidate all registers in our register context. We don't set "force" to
62 // true because the stop reply packet might have had some register values
63 // that were expedited and these will already be copied into the register
64 // context by the time this function gets called. The KDPRegisterContext
65 // class has been made smart enough to detect when it needs to invalidate
66 // which registers are valid by putting hooks in the register read and
67 // register supply functions where they check the process stop ID and do the
68 // right thing.
69 const bool force = false;
71 if (reg_ctx_sp)
72 reg_ctx_sp->InvalidateIfNeeded(force);
73}
74
75bool ThreadKDP::ThreadIDIsValid(lldb::tid_t thread) { return thread != 0; }
76
77void ThreadKDP::Dump(Log *log, uint32_t index) {}
78
79bool ThreadKDP::ShouldStop(bool &step_more) { return true; }
83 return m_reg_context_sp;
84}
85
88 lldb::RegisterContextSP reg_ctx_sp;
89 uint32_t concrete_frame_idx = 0;
90
91 if (frame)
92 concrete_frame_idx = frame->GetConcreteFrameIndex();
93
94 if (concrete_frame_idx == 0) {
95 ProcessSP process_sp(CalculateProcess());
96 if (process_sp) {
97 switch (static_cast<ProcessKDP *>(process_sp.get())
99 .GetCPUType()) {
100 case llvm::MachO::CPU_TYPE_ARM:
101 reg_ctx_sp =
102 std::make_shared<RegisterContextKDP_arm>(*this, concrete_frame_idx);
103 break;
104 case llvm::MachO::CPU_TYPE_ARM64:
105 reg_ctx_sp = std::make_shared<RegisterContextKDP_arm64>(
106 *this, concrete_frame_idx);
107 break;
108 case llvm::MachO::CPU_TYPE_I386:
109 reg_ctx_sp = std::make_shared<RegisterContextKDP_i386>(
110 *this, concrete_frame_idx);
111 break;
112 case llvm::MachO::CPU_TYPE_X86_64:
113 reg_ctx_sp = std::make_shared<RegisterContextKDP_x86_64>(
114 *this, concrete_frame_idx);
115 break;
116 default:
117 llvm_unreachable("Add CPU type support in KDP");
118 }
119 }
120 } else {
121 reg_ctx_sp = GetUnwinder().CreateRegisterContextForFrame(frame);
122 }
123 return reg_ctx_sp;
124}
125
127 ProcessSP process_sp(GetProcess());
128 if (process_sp) {
131 } else {
133 }
134 return true;
135 }
136 return false;
137}
138
140 const DataExtractor &exc_reply_packet) {
141 lldb::offset_t offset = 0;
142 uint8_t reply_command = exc_reply_packet.GetU8(&offset);
143 if (reply_command == CommunicationKDP::KDP_EXCEPTION) {
144 offset = 8;
145 const uint32_t count = exc_reply_packet.GetU32(&offset);
146 if (count >= 1) {
147 // const uint32_t cpu = exc_reply_packet.GetU32 (&offset);
148 offset += 4; // Skip the useless CPU field
149 const uint32_t exc_type = exc_reply_packet.GetU32(&offset);
150 const uint32_t exc_code = exc_reply_packet.GetU32(&offset);
151 const uint32_t exc_subcode = exc_reply_packet.GetU32(&offset);
152 // We have to make a copy of the stop info because the thread list will
153 // iterate through the threads and clear all stop infos..
154
155 // Let the StopInfoMachException::CreateStopReasonWithMachException()
156 // function update the PC if needed as we might hit a software breakpoint
157 // and need to decrement the PC (i386 and x86_64 need this) and KDP
158 // doesn't do this for us.
159 const bool pc_already_adjusted = false;
160 const bool adjust_pc_if_needed = true;
161
164 *this, exc_type, 2, exc_code, exc_subcode, 0, pc_already_adjusted,
165 adjust_pc_if_needed);
166 }
167 }
168}
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
Definition: Log.h:359
CommunicationKDP & GetCommunication()
Definition: ProcessKDP.h:127
bool ShouldStop(bool &step_more)
Definition: ThreadKDP.cpp:79
lldb::RegisterContextSP GetRegisterContext() override
Definition: ThreadKDP.cpp:80
const char * GetQueueName() override
Retrieve the Queue name for the queue currently using this Thread.
Definition: ThreadKDP.cpp:58
ThreadKDP(lldb_private::Process &process, lldb::tid_t tid)
Definition: ThreadKDP.cpp:39
~ThreadKDP() override
Definition: ThreadKDP.cpp:46
lldb::StopInfoSP m_cached_stop_info_sp
Definition: ThreadKDP.h:67
void Dump(lldb_private::Log *log, uint32_t index)
Definition: ThreadKDP.cpp:77
std::string m_thread_name
Definition: ThreadKDP.h:64
void RefreshStateAfterStop() override
Definition: ThreadKDP.cpp:60
lldb::RegisterContextSP CreateRegisterContextForFrame(lldb_private::StackFrame *frame) override
Definition: ThreadKDP.cpp:87
static bool ThreadIDIsValid(lldb::tid_t thread)
Definition: ThreadKDP.cpp:75
void SetStopInfoFrom_KDP_EXCEPTION(const lldb_private::DataExtractor &exc_reply_packet)
Definition: ThreadKDP.cpp:139
const char * GetName() override
Definition: ThreadKDP.cpp:52
bool CalculateStopInfo() override
Ask the thread subclass to set its stop info.
Definition: ThreadKDP.cpp:126
An data extractor class.
Definition: DataExtractor.h:48
uint32_t GetU32(lldb::offset_t *offset_ptr) const
Extract a uint32_t value from *offset_ptr.
uint8_t GetU8(lldb::offset_t *offset_ptr) const
Extract a uint8_t value from *offset_ptr.
A plug-in interface definition class for debugging a process.
Definition: Process.h:341
This base class provides an interface to stack frames.
Definition: StackFrame.h:43
uint32_t GetConcreteFrameIndex() const
Query this frame to find what frame it is in this Thread's StackFrameList, not counting inlined frame...
Definition: StackFrame.h:429
static lldb::StopInfoSP CreateStopReasonWithMachException(Thread &thread, uint32_t exc_type, uint32_t exc_data_count, uint64_t exc_code, uint64_t exc_sub_code, uint64_t exc_sub_sub_code, bool pc_already_adjusted=true, bool adjust_pc_if_needed=false)
static lldb::StopInfoSP CreateStopReasonWithSignal(Thread &thread, int signo, const char *description=nullptr, std::optional< int > code=std::nullopt)
Definition: StopInfo.cpp:1386
void SetStopInfo(const lldb::StopInfoSP &stop_info_sp)
Definition: Thread.cpp:457
lldb::ProcessSP CalculateProcess() override
Definition: Thread.cpp:1398
virtual void DestroyThread()
Definition: Thread.cpp:245
virtual Unwind & GetUnwinder()
Definition: Thread.cpp:1888
lldb::ProcessSP GetProcess() const
Definition: Thread.h:155
lldb::RegisterContextSP m_reg_context_sp
The register context for this thread's current register state.
Definition: Thread.h:1317
lldb::RegisterContextSP CreateRegisterContextForFrame(StackFrame *frame)
Definition: Unwind.h:56
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:331
Definition: SBAddress.h:15
uint64_t offset_t
Definition: lldb-types.h:85
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:385
std::shared_ptr< lldb_private::RegisterContext > RegisterContextSP
Definition: lldb-forward.h:390
uint64_t tid_t
Definition: lldb-types.h:84
lldb::user_id_t GetID() const
Get accessor for the user ID.
Definition: UserID.h:47
#define SIGSTOP