1 //===-- ThreadGDBRemote.cpp -------------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 11 #include "ThreadGDBRemote.h" 12 13 #include "lldb/Breakpoint/Watchpoint.h" 14 #include "lldb/Core/ArchSpec.h" 15 #include "lldb/Core/DataExtractor.h" 16 #include "lldb/Core/State.h" 17 #include "lldb/Core/StreamString.h" 18 #include "lldb/Target/Platform.h" 19 #include "lldb/Target/Process.h" 20 #include "lldb/Target/RegisterContext.h" 21 #include "lldb/Target/StopInfo.h" 22 #include "lldb/Target/SystemRuntime.h" 23 #include "lldb/Target/Target.h" 24 #include "lldb/Target/UnixSignals.h" 25 #include "lldb/Target/Unwind.h" 26 27 #include "ProcessGDBRemote.h" 28 #include "ProcessGDBRemoteLog.h" 29 #include "Utility/StringExtractorGDBRemote.h" 30 31 using namespace lldb; 32 using namespace lldb_private; 33 using namespace lldb_private::process_gdb_remote; 34 35 //---------------------------------------------------------------------- 36 // Thread Registers 37 //---------------------------------------------------------------------- 38 39 ThreadGDBRemote::ThreadGDBRemote (Process &process, lldb::tid_t tid) : 40 Thread(process, tid), 41 m_thread_name (), 42 m_dispatch_queue_name (), 43 m_thread_dispatch_qaddr (LLDB_INVALID_ADDRESS), 44 m_queue_kind(eQueueKindUnknown), 45 m_queue_serial(0) 46 { 47 ProcessGDBRemoteLog::LogIf(GDBR_LOG_THREAD, "%p: ThreadGDBRemote::ThreadGDBRemote (pid = %i, tid = 0x%4.4x)", 48 this, 49 process.GetID(), 50 GetID()); 51 } 52 53 ThreadGDBRemote::~ThreadGDBRemote () 54 { 55 ProcessSP process_sp(GetProcess()); 56 ProcessGDBRemoteLog::LogIf(GDBR_LOG_THREAD, "%p: ThreadGDBRemote::~ThreadGDBRemote (pid = %i, tid = 0x%4.4x)", 57 this, 58 process_sp ? process_sp->GetID() : LLDB_INVALID_PROCESS_ID, 59 GetID()); 60 DestroyThread(); 61 } 62 63 const char * 64 ThreadGDBRemote::GetName () 65 { 66 if (m_thread_name.empty()) 67 return NULL; 68 return m_thread_name.c_str(); 69 } 70 71 void 72 ThreadGDBRemote::ClearQueueInfo () 73 { 74 m_dispatch_queue_name.clear(); 75 m_queue_kind = eQueueKindUnknown; 76 m_queue_serial = 0; 77 } 78 79 void 80 ThreadGDBRemote::SetQueueInfo (std::string &&queue_name, QueueKind queue_kind, uint64_t queue_serial) 81 { 82 m_dispatch_queue_name = queue_name; 83 m_queue_kind = queue_kind; 84 m_queue_serial = queue_serial; 85 } 86 87 88 const char * 89 ThreadGDBRemote::GetQueueName () 90 { 91 // If our cached queue info is valid, then someone called ThreadGDBRemote::SetQueueInfo(...) 92 // with valid information that was gleaned from the stop reply packet. In this case we trust 93 // that the info is valid in m_dispatch_queue_name without refetching it 94 if (CachedQueueInfoIsValid()) 95 { 96 if (m_dispatch_queue_name.empty()) 97 return nullptr; 98 else 99 return m_dispatch_queue_name.c_str(); 100 } 101 // Always re-fetch the dispatch queue name since it can change 102 103 if (m_thread_dispatch_qaddr != 0 || m_thread_dispatch_qaddr != LLDB_INVALID_ADDRESS) 104 { 105 ProcessSP process_sp (GetProcess()); 106 if (process_sp) 107 { 108 SystemRuntime *runtime = process_sp->GetSystemRuntime (); 109 if (runtime) 110 m_dispatch_queue_name = runtime->GetQueueNameFromThreadQAddress (m_thread_dispatch_qaddr); 111 else 112 m_dispatch_queue_name.clear(); 113 114 if (!m_dispatch_queue_name.empty()) 115 return m_dispatch_queue_name.c_str(); 116 } 117 } 118 return NULL; 119 } 120 121 queue_id_t 122 ThreadGDBRemote::GetQueueID () 123 { 124 // If our cached queue info is valid, then someone called ThreadGDBRemote::SetQueueInfo(...) 125 // with valid information that was gleaned from the stop reply packet. In this case we trust 126 // that the info is valid in m_dispatch_queue_name without refetching it 127 if (CachedQueueInfoIsValid()) 128 return m_queue_serial; 129 130 if (m_thread_dispatch_qaddr != 0 || m_thread_dispatch_qaddr != LLDB_INVALID_ADDRESS) 131 { 132 ProcessSP process_sp (GetProcess()); 133 if (process_sp) 134 { 135 SystemRuntime *runtime = process_sp->GetSystemRuntime (); 136 if (runtime) 137 { 138 return runtime->GetQueueIDFromThreadQAddress (m_thread_dispatch_qaddr); 139 } 140 } 141 } 142 return LLDB_INVALID_QUEUE_ID; 143 } 144 145 QueueSP 146 ThreadGDBRemote::GetQueue () 147 { 148 queue_id_t queue_id = GetQueueID(); 149 QueueSP queue; 150 if (queue_id != LLDB_INVALID_QUEUE_ID) 151 { 152 ProcessSP process_sp (GetProcess()); 153 if (process_sp) 154 { 155 queue = process_sp->GetQueueList().FindQueueByID (queue_id); 156 } 157 } 158 return queue; 159 } 160 161 addr_t 162 ThreadGDBRemote::GetQueueLibdispatchQueueAddress () 163 { 164 addr_t dispatch_queue_t_addr = LLDB_INVALID_ADDRESS; 165 if (m_thread_dispatch_qaddr != 0 || m_thread_dispatch_qaddr != LLDB_INVALID_ADDRESS) 166 { 167 ProcessSP process_sp (GetProcess()); 168 if (process_sp) 169 { 170 SystemRuntime *runtime = process_sp->GetSystemRuntime (); 171 if (runtime) 172 { 173 dispatch_queue_t_addr = runtime->GetLibdispatchQueueAddressFromThreadQAddress (m_thread_dispatch_qaddr); 174 } 175 } 176 } 177 return dispatch_queue_t_addr; 178 } 179 180 StructuredData::ObjectSP 181 ThreadGDBRemote::FetchThreadExtendedInfo () 182 { 183 StructuredData::ObjectSP object_sp; 184 const lldb::user_id_t tid = GetProtocolID(); 185 Log *log(GetLogIfAnyCategoriesSet (GDBR_LOG_THREAD)); 186 if (log) 187 log->Printf ("Fetching extended information for thread %4.4" PRIx64, tid); 188 ProcessSP process_sp (GetProcess()); 189 if (process_sp) 190 { 191 ProcessGDBRemote *gdb_process = static_cast<ProcessGDBRemote *>(process_sp.get()); 192 object_sp = gdb_process->GetExtendedInfoForThread (tid); 193 } 194 return object_sp; 195 } 196 197 void 198 ThreadGDBRemote::WillResume (StateType resume_state) 199 { 200 int signo = GetResumeSignal(); 201 const lldb::user_id_t tid = GetProtocolID(); 202 Log *log(GetLogIfAnyCategoriesSet (GDBR_LOG_THREAD)); 203 if (log) 204 log->Printf ("Resuming thread: %4.4" PRIx64 " with state: %s.", tid, StateAsCString(resume_state)); 205 206 ProcessSP process_sp (GetProcess()); 207 if (process_sp) 208 { 209 ProcessGDBRemote *gdb_process = static_cast<ProcessGDBRemote *>(process_sp.get()); 210 switch (resume_state) 211 { 212 case eStateSuspended: 213 case eStateStopped: 214 // Don't append anything for threads that should stay stopped. 215 break; 216 217 case eStateRunning: 218 if (gdb_process->GetUnixSignals()->SignalIsValid(signo)) 219 gdb_process->m_continue_C_tids.push_back(std::make_pair(tid, signo)); 220 else 221 gdb_process->m_continue_c_tids.push_back(tid); 222 break; 223 224 case eStateStepping: 225 if (gdb_process->GetUnixSignals()->SignalIsValid(signo)) 226 gdb_process->m_continue_S_tids.push_back(std::make_pair(tid, signo)); 227 else 228 gdb_process->m_continue_s_tids.push_back(tid); 229 break; 230 231 default: 232 break; 233 } 234 } 235 } 236 237 void 238 ThreadGDBRemote::RefreshStateAfterStop() 239 { 240 // Invalidate all registers in our register context. We don't set "force" to 241 // true because the stop reply packet might have had some register values 242 // that were expedited and these will already be copied into the register 243 // context by the time this function gets called. The GDBRemoteRegisterContext 244 // class has been made smart enough to detect when it needs to invalidate 245 // which registers are valid by putting hooks in the register read and 246 // register supply functions where they check the process stop ID and do 247 // the right thing. 248 const bool force = false; 249 GetRegisterContext()->InvalidateIfNeeded (force); 250 } 251 252 bool 253 ThreadGDBRemote::ThreadIDIsValid (lldb::tid_t thread) 254 { 255 return thread != 0; 256 } 257 258 void 259 ThreadGDBRemote::Dump(Log *log, uint32_t index) 260 { 261 } 262 263 264 bool 265 ThreadGDBRemote::ShouldStop (bool &step_more) 266 { 267 return true; 268 } 269 lldb::RegisterContextSP 270 ThreadGDBRemote::GetRegisterContext () 271 { 272 if (m_reg_context_sp.get() == NULL) 273 m_reg_context_sp = CreateRegisterContextForFrame (NULL); 274 return m_reg_context_sp; 275 } 276 277 lldb::RegisterContextSP 278 ThreadGDBRemote::CreateRegisterContextForFrame (StackFrame *frame) 279 { 280 lldb::RegisterContextSP reg_ctx_sp; 281 uint32_t concrete_frame_idx = 0; 282 283 if (frame) 284 concrete_frame_idx = frame->GetConcreteFrameIndex (); 285 286 287 if (concrete_frame_idx == 0) 288 { 289 ProcessSP process_sp (GetProcess()); 290 if (process_sp) 291 { 292 ProcessGDBRemote *gdb_process = static_cast<ProcessGDBRemote *>(process_sp.get()); 293 // read_all_registers_at_once will be true if 'p' packet is not supported. 294 bool read_all_registers_at_once = !gdb_process->GetGDBRemote().GetpPacketSupported (GetID()); 295 reg_ctx_sp.reset (new GDBRemoteRegisterContext (*this, concrete_frame_idx, gdb_process->m_register_info, read_all_registers_at_once)); 296 } 297 } 298 else 299 { 300 Unwind *unwinder = GetUnwinder (); 301 if (unwinder) 302 reg_ctx_sp = unwinder->CreateRegisterContextForFrame (frame); 303 } 304 return reg_ctx_sp; 305 } 306 307 bool 308 ThreadGDBRemote::PrivateSetRegisterValue (uint32_t reg, StringExtractor &response) 309 { 310 GDBRemoteRegisterContext *gdb_reg_ctx = static_cast<GDBRemoteRegisterContext *>(GetRegisterContext ().get()); 311 assert (gdb_reg_ctx); 312 return gdb_reg_ctx->PrivateSetRegisterValue (reg, response); 313 } 314 315 bool 316 ThreadGDBRemote::PrivateSetRegisterValue (uint32_t reg, uint64_t regval) 317 { 318 GDBRemoteRegisterContext *gdb_reg_ctx = static_cast<GDBRemoteRegisterContext *>(GetRegisterContext ().get()); 319 assert (gdb_reg_ctx); 320 return gdb_reg_ctx->PrivateSetRegisterValue (reg, regval); 321 } 322 323 bool 324 ThreadGDBRemote::CalculateStopInfo () 325 { 326 ProcessSP process_sp (GetProcess()); 327 if (process_sp) 328 return static_cast<ProcessGDBRemote *>(process_sp.get())->CalculateThreadStopInfo(this); 329 return false; 330 } 331 332 333