lldb/source/Target/Thread.cpp

   1 //===-- Thread.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 "lldb/Target/Thread.h"
  10 #include "lldb/Breakpoint/BreakpointLocation.h"
  11 #include "lldb/Core/Debugger.h"
  12 #include "lldb/Core/FormatEntity.h"
  13 #include "lldb/Core/Module.h"
  14 #include "lldb/Core/StructuredDataImpl.h"
  15 #include "lldb/Host/Host.h"
  16 #include "lldb/Interpreter/OptionValueFileSpecList.h"
  17 #include "lldb/Interpreter/OptionValueProperties.h"
  18 #include "lldb/Interpreter/Property.h"
  19 #include "lldb/Symbol/Function.h"
  20 #include "lldb/Target/ABI.h"
  21 #include "lldb/Target/DynamicLoader.h"
  22 #include "lldb/Target/ExecutionContext.h"
  23 #include "lldb/Target/LanguageRuntime.h"
  24 #include "lldb/Target/Process.h"
  25 #include "lldb/Target/RegisterContext.h"
  26 #include "lldb/Target/ScriptedThreadPlan.h"
  27 #include "lldb/Target/StackFrameRecognizer.h"
  28 #include "lldb/Target/StopInfo.h"
  29 #include "lldb/Target/SystemRuntime.h"
  30 #include "lldb/Target/Target.h"
  31 #include "lldb/Target/ThreadPlan.h"
  32 #include "lldb/Target/ThreadPlanBase.h"
  33 #include "lldb/Target/ThreadPlanCallFunction.h"
  34 #include "lldb/Target/ThreadPlanRunToAddress.h"
  35 #include "lldb/Target/ThreadPlanStack.h"
  36 #include "lldb/Target/ThreadPlanStepInRange.h"
  37 #include "lldb/Target/ThreadPlanStepInstruction.h"
  38 #include "lldb/Target/ThreadPlanStepOut.h"
  39 #include "lldb/Target/ThreadPlanStepOverBreakpoint.h"
  40 #include "lldb/Target/ThreadPlanStepOverRange.h"
  41 #include "lldb/Target/ThreadPlanStepThrough.h"
  42 #include "lldb/Target/ThreadPlanStepUntil.h"
  43 #include "lldb/Target/ThreadSpec.h"
  44 #include "lldb/Target/UnwindLLDB.h"
  45 #include "lldb/Utility/LLDBLog.h"
  46 #include "lldb/Utility/Log.h"
  47 #include "lldb/Utility/RegularExpression.h"
  48 #include "lldb/Utility/State.h"
  49 #include "lldb/Utility/Stream.h"
  50 #include "lldb/Utility/StreamString.h"
  51 #include "lldb/ValueObject/ValueObject.h"
  52 #include "lldb/ValueObject/ValueObjectConstResult.h"
  53 #include "lldb/lldb-enumerations.h"
  54
  55 #include <memory>
  56 #include <optional>
  57
  58 using namespace lldb;
  59 using namespace lldb_private;
  60
  61 ThreadProperties &Thread::GetGlobalProperties() {
  62   // NOTE: intentional leak so we don't crash if global destructor chain gets
  63   // called as other threads still use the result of this function
  64   static ThreadProperties *g_settings_ptr = new ThreadProperties(true);
  65   return *g_settings_ptr;
  66 }
  67
  68 #define LLDB_PROPERTIES_thread
  69 #include "TargetProperties.inc"
  70
  71 enum {
  72 #define LLDB_PROPERTIES_thread
  73 #include "TargetPropertiesEnum.inc"
  74 };
  75
  76 class ThreadOptionValueProperties
  77     : public Cloneable<ThreadOptionValueProperties, OptionValueProperties> {
  78 public:
  79   ThreadOptionValueProperties(llvm::StringRef name) : Cloneable(name) {}
  80
  81   const Property *
  82   GetPropertyAtIndex(size_t idx,
  83                      const ExecutionContext *exe_ctx) const override {
  84     // When getting the value for a key from the thread options, we will always
  85     // try and grab the setting from the current thread if there is one. Else
  86     // we just use the one from this instance.
  87     if (exe_ctx) {
  88       Thread *thread = exe_ctx->GetThreadPtr();
  89       if (thread) {
  90         ThreadOptionValueProperties *instance_properties =
  91             static_cast<ThreadOptionValueProperties *>(
  92                 thread->GetValueProperties().get());
  93         if (this != instance_properties)
  94           return instance_properties->ProtectedGetPropertyAtIndex(idx);
  95       }
  96     }
  97     return ProtectedGetPropertyAtIndex(idx);
  98   }
  99 };
 100
 101 ThreadProperties::ThreadProperties(bool is_global) : Properties() {
 102   if (is_global) {
 103     m_collection_sp = std::make_shared<ThreadOptionValueProperties>("thread");
 104     m_collection_sp->Initialize(g_thread_properties);
 105   } else
 106     m_collection_sp =
 107         OptionValueProperties::CreateLocalCopy(Thread::GetGlobalProperties());
 108 }
 109
 110 ThreadProperties::~ThreadProperties() = default;
 111
 112 const RegularExpression *ThreadProperties::GetSymbolsToAvoidRegexp() {
 113   const uint32_t idx = ePropertyStepAvoidRegex;
 114   return GetPropertyAtIndexAs<const RegularExpression *>(idx);
 115 }
 116
 117 FileSpecList ThreadProperties::GetLibrariesToAvoid() const {
 118   const uint32_t idx = ePropertyStepAvoidLibraries;
 119   return GetPropertyAtIndexAs<FileSpecList>(idx, {});
 120 }
 121
 122 bool ThreadProperties::GetTraceEnabledState() const {
 123   const uint32_t idx = ePropertyEnableThreadTrace;
 124   return GetPropertyAtIndexAs<bool>(
 125       idx, g_thread_properties[idx].default_uint_value != 0);
 126 }
 127
 128 bool ThreadProperties::GetStepInAvoidsNoDebug() const {
 129   const uint32_t idx = ePropertyStepInAvoidsNoDebug;
 130   return GetPropertyAtIndexAs<bool>(
 131       idx, g_thread_properties[idx].default_uint_value != 0);
 132 }
 133
 134 bool ThreadProperties::GetStepOutAvoidsNoDebug() const {
 135   const uint32_t idx = ePropertyStepOutAvoidsNoDebug;
 136   return GetPropertyAtIndexAs<bool>(
 137       idx, g_thread_properties[idx].default_uint_value != 0);
 138 }
 139
 140 uint64_t ThreadProperties::GetMaxBacktraceDepth() const {
 141   const uint32_t idx = ePropertyMaxBacktraceDepth;
 142   return GetPropertyAtIndexAs<uint64_t>(
 143       idx, g_thread_properties[idx].default_uint_value);
 144 }
 145
 146 uint64_t ThreadProperties::GetSingleThreadPlanTimeout() const {
 147   const uint32_t idx = ePropertySingleThreadPlanTimeout;
 148   return GetPropertyAtIndexAs<uint64_t>(
 149       idx, g_thread_properties[idx].default_uint_value);
 150 }
 151
 152 // Thread Event Data
 153
 154 llvm::StringRef Thread::ThreadEventData::GetFlavorString() {
 155   return "Thread::ThreadEventData";
 156 }
 157
 158 Thread::ThreadEventData::ThreadEventData(const lldb::ThreadSP thread_sp)
 159     : m_thread_sp(thread_sp), m_stack_id() {}
 160
 161 Thread::ThreadEventData::ThreadEventData(const lldb::ThreadSP thread_sp,
 162                                          const StackID &stack_id)
 163     : m_thread_sp(thread_sp), m_stack_id(stack_id) {}
 164
 165 Thread::ThreadEventData::ThreadEventData() : m_thread_sp(), m_stack_id() {}
 166
 167 Thread::ThreadEventData::~ThreadEventData() = default;
 168
 169 void Thread::ThreadEventData::Dump(Stream *s) const {}
 170
 171 const Thread::ThreadEventData *
 172 Thread::ThreadEventData::GetEventDataFromEvent(const Event *event_ptr) {
 173   if (event_ptr) {
 174     const EventData *event_data = event_ptr->GetData();
 175     if (event_data &&
 176         event_data->GetFlavor() == ThreadEventData::GetFlavorString())
 177       return static_cast<const ThreadEventData *>(event_ptr->GetData());
 178   }
 179   return nullptr;
 180 }
 181
 182 ThreadSP Thread::ThreadEventData::GetThreadFromEvent(const Event *event_ptr) {
 183   ThreadSP thread_sp;
 184   const ThreadEventData *event_data = GetEventDataFromEvent(event_ptr);
 185   if (event_data)
 186     thread_sp = event_data->GetThread();
 187   return thread_sp;
 188 }
 189
 190 StackID Thread::ThreadEventData::GetStackIDFromEvent(const Event *event_ptr) {
 191   StackID stack_id;
 192   const ThreadEventData *event_data = GetEventDataFromEvent(event_ptr);
 193   if (event_data)
 194     stack_id = event_data->GetStackID();
 195   return stack_id;
 196 }
 197
 198 StackFrameSP
 199 Thread::ThreadEventData::GetStackFrameFromEvent(const Event *event_ptr) {
 200   const ThreadEventData *event_data = GetEventDataFromEvent(event_ptr);
 201   StackFrameSP frame_sp;
 202   if (event_data) {
 203     ThreadSP thread_sp = event_data->GetThread();
 204     if (thread_sp) {
 205       frame_sp = thread_sp->GetStackFrameList()->GetFrameWithStackID(
 206           event_data->GetStackID());
 207     }
 208   }
 209   return frame_sp;
 210 }
 211
 212 // Thread class
 213
 214 llvm::StringRef Thread::GetStaticBroadcasterClass() {
 215   static constexpr llvm::StringLiteral class_name("lldb.thread");
 216   return class_name;
 217 }
 218
 219 Thread::Thread(Process &process, lldb::tid_t tid, bool use_invalid_index_id)
 220     : ThreadProperties(false), UserID(tid),
 221       Broadcaster(process.GetTarget().GetDebugger().GetBroadcasterManager(),
 222                   Thread::GetStaticBroadcasterClass().str()),
 223       m_process_wp(process.shared_from_this()), m_stop_info_sp(),
 224       m_stop_info_stop_id(0), m_stop_info_override_stop_id(0),
 225       m_should_run_before_public_stop(false),
 226       m_index_id(use_invalid_index_id ? LLDB_INVALID_INDEX32
 227                                       : process.GetNextThreadIndexID(tid)),
 228       m_reg_context_sp(), m_state(eStateUnloaded), m_state_mutex(),
 229       m_frame_mutex(), m_curr_frames_sp(), m_prev_frames_sp(),
 230       m_prev_framezero_pc(), m_resume_signal(LLDB_INVALID_SIGNAL_NUMBER),
 231       m_resume_state(eStateRunning), m_temporary_resume_state(eStateRunning),
 232       m_unwinder_up(), m_destroy_called(false),
 233       m_override_should_notify(eLazyBoolCalculate),
 234       m_extended_info_fetched(false), m_extended_info() {
 235   Log *log = GetLog(LLDBLog::Object);
 236   LLDB_LOGF(log, "%p Thread::Thread(tid = 0x%4.4" PRIx64 ")",
 237             static_cast<void *>(this), GetID());
 238
 239   CheckInWithManager();
 240 }
 241
 242 Thread::~Thread() {
 243   Log *log = GetLog(LLDBLog::Object);
 244   LLDB_LOGF(log, "%p Thread::~Thread(tid = 0x%4.4" PRIx64 ")",
 245             static_cast<void *>(this), GetID());
 246   /// If you hit this assert, it means your derived class forgot to call
 247   /// DestroyThread in its destructor.
 248   assert(m_destroy_called);
 249 }
 250
 251 void Thread::DestroyThread() {
 252   m_destroy_called = true;
 253   m_stop_info_sp.reset();
 254   m_reg_context_sp.reset();
 255   m_unwinder_up.reset();
 256   std::lock_guard<std::recursive_mutex> guard(m_frame_mutex);
 257   m_curr_frames_sp.reset();
 258   m_prev_frames_sp.reset();
 259   m_prev_framezero_pc.reset();
 260 }
 261
 262 void Thread::BroadcastSelectedFrameChange(StackID &new_frame_id) {
 263   if (EventTypeHasListeners(eBroadcastBitSelectedFrameChanged)) {
 264     auto data_sp =
 265         std::make_shared<ThreadEventData>(shared_from_this(), new_frame_id);
 266     BroadcastEvent(eBroadcastBitSelectedFrameChanged, data_sp);
 267   }
 268 }
 269
 270 lldb::StackFrameSP
 271 Thread::GetSelectedFrame(SelectMostRelevant select_most_relevant) {
 272   StackFrameListSP stack_frame_list_sp(GetStackFrameList());
 273   StackFrameSP frame_sp = stack_frame_list_sp->GetFrameAtIndex(
 274       stack_frame_list_sp->GetSelectedFrameIndex(select_most_relevant));
 275   FrameSelectedCallback(frame_sp.get());
 276   return frame_sp;
 277 }
 278
 279 uint32_t Thread::SetSelectedFrame(lldb_private::StackFrame *frame,
 280                                   bool broadcast) {
 281   uint32_t ret_value = GetStackFrameList()->SetSelectedFrame(frame);
 282   if (broadcast)
 283     BroadcastSelectedFrameChange(frame->GetStackID());
 284   FrameSelectedCallback(frame);
 285   return ret_value;
 286 }
 287
 288 bool Thread::SetSelectedFrameByIndex(uint32_t frame_idx, bool broadcast) {
 289   StackFrameSP frame_sp(GetStackFrameList()->GetFrameAtIndex(frame_idx));
 290   if (frame_sp) {
 291     GetStackFrameList()->SetSelectedFrame(frame_sp.get());
 292     if (broadcast)
 293       BroadcastSelectedFrameChange(frame_sp->GetStackID());
 294     FrameSelectedCallback(frame_sp.get());
 295     return true;
 296   } else
 297     return false;
 298 }
 299
 300 bool Thread::SetSelectedFrameByIndexNoisily(uint32_t frame_idx,
 301                                             Stream &output_stream) {
 302   const bool broadcast = true;
 303   bool success = SetSelectedFrameByIndex(frame_idx, broadcast);
 304   if (success) {
 305     StackFrameSP frame_sp = GetSelectedFrame(DoNoSelectMostRelevantFrame);
 306     if (frame_sp) {
 307       bool already_shown = false;
 308       SymbolContext frame_sc(
 309           frame_sp->GetSymbolContext(eSymbolContextLineEntry));
 310       const Debugger &debugger = GetProcess()->GetTarget().GetDebugger();
 311       if (debugger.GetUseExternalEditor() && frame_sc.line_entry.GetFile() &&
 312           frame_sc.line_entry.line != 0) {
 313         if (llvm::Error e = Host::OpenFileInExternalEditor(
 314                 debugger.GetExternalEditor(), frame_sc.line_entry.GetFile(),
 315                 frame_sc.line_entry.line)) {
 316           LLDB_LOG_ERROR(GetLog(LLDBLog::Host), std::move(e),
 317                          "OpenFileInExternalEditor failed: {0}");
 318         } else {
 319           already_shown = true;
 320         }
 321       }
 322
 323       bool show_frame_info = true;
 324       bool show_source = !already_shown;
 325       FrameSelectedCallback(frame_sp.get());
 326       return frame_sp->GetStatus(output_stream, show_frame_info, show_source);
 327     }
 328     return false;
 329   } else
 330     return false;
 331 }
 332
 333 void Thread::FrameSelectedCallback(StackFrame *frame) {
 334   if (!frame)
 335     return;
 336
 337   if (frame->HasDebugInformation() &&
 338       (GetProcess()->GetWarningsOptimization() ||
 339        GetProcess()->GetWarningsUnsupportedLanguage())) {
 340     SymbolContext sc =
 341         frame->GetSymbolContext(eSymbolContextFunction | eSymbolContextModule);
 342     GetProcess()->PrintWarningOptimization(sc);
 343     GetProcess()->PrintWarningUnsupportedLanguage(sc);
 344   }
 345 }
 346
 347 lldb::StopInfoSP Thread::GetStopInfo() {
 348   if (m_destroy_called)
 349     return m_stop_info_sp;
 350
 351   ThreadPlanSP completed_plan_sp(GetCompletedPlan());
 352   ProcessSP process_sp(GetProcess());
 353   const uint32_t stop_id = process_sp ? process_sp->GetStopID() : UINT32_MAX;
 354
 355   // Here we select the stop info according to priorirty: - m_stop_info_sp (if
 356   // not trace) - preset value - completed plan stop info - new value with plan
 357   // from completed plan stack - m_stop_info_sp (trace stop reason is OK now) -
 358   // ask GetPrivateStopInfo to set stop info
 359
 360   bool have_valid_stop_info = m_stop_info_sp &&
 361       m_stop_info_sp ->IsValid() &&
 362       m_stop_info_stop_id == stop_id;
 363   bool have_valid_completed_plan = completed_plan_sp && completed_plan_sp->PlanSucceeded();
 364   bool plan_failed = completed_plan_sp && !completed_plan_sp->PlanSucceeded();
 365   bool plan_overrides_trace =
 366     have_valid_stop_info && have_valid_completed_plan
 367     && (m_stop_info_sp->GetStopReason() == eStopReasonTrace);
 368
 369   if (have_valid_stop_info && !plan_overrides_trace && !plan_failed) {
 370     return m_stop_info_sp;
 371   } else if (completed_plan_sp) {
 372     return StopInfo::CreateStopReasonWithPlan(
 373         completed_plan_sp, GetReturnValueObject(), GetExpressionVariable());
 374   } else {
 375     GetPrivateStopInfo();
 376     return m_stop_info_sp;
 377   }
 378 }
 379
 380 void Thread::CalculatePublicStopInfo() {
 381   ResetStopInfo();
 382   SetStopInfo(GetStopInfo());
 383 }
 384
 385 lldb::StopInfoSP Thread::GetPrivateStopInfo(bool calculate) {
 386   if (!calculate)
 387     return m_stop_info_sp;
 388
 389   if (m_destroy_called)
 390     return m_stop_info_sp;
 391
 392   ProcessSP process_sp(GetProcess());
 393   if (process_sp) {
 394     const uint32_t process_stop_id = process_sp->GetStopID();
 395     if (m_stop_info_stop_id != process_stop_id) {
 396       // We preserve the old stop info for a variety of reasons:
 397       // 1) Someone has already updated it by the time we get here
 398       // 2) We didn't get to execute the breakpoint instruction we stopped at
 399       // 3) This is a virtual step so we didn't actually run
 400       // 4) If this thread wasn't allowed to run the last time round.
 401       if (m_stop_info_sp) {
 402         if (m_stop_info_sp->IsValid() || IsStillAtLastBreakpointHit() ||
 403             GetCurrentPlan()->IsVirtualStep()
 404             || GetTemporaryResumeState() == eStateSuspended)
 405           SetStopInfo(m_stop_info_sp);
 406         else
 407           m_stop_info_sp.reset();
 408       }
 409
 410       if (!m_stop_info_sp) {
 411         if (!CalculateStopInfo())
 412           SetStopInfo(StopInfoSP());
 413       }
 414     }
 415
 416     // The stop info can be manually set by calling Thread::SetStopInfo() prior
 417     // to this function ever getting called, so we can't rely on
 418     // "m_stop_info_stop_id != process_stop_id" as the condition for the if
 419     // statement below, we must also check the stop info to see if we need to
 420     // override it. See the header documentation in
 421     // Architecture::OverrideStopInfo() for more information on the stop
 422     // info override callback.
 423     if (m_stop_info_override_stop_id != process_stop_id) {
 424       m_stop_info_override_stop_id = process_stop_id;
 425       if (m_stop_info_sp) {
 426         if (const Architecture *arch =
 427                 process_sp->GetTarget().GetArchitecturePlugin())
 428           arch->OverrideStopInfo(*this);
 429       }
 430     }
 431   }
 432
 433   // If we were resuming the process and it was interrupted,
 434   // return no stop reason.  This thread would like to resume.
 435   if (m_stop_info_sp && m_stop_info_sp->WasContinueInterrupted(*this))
 436     return {};
 437
 438   return m_stop_info_sp;
 439 }
 440
 441 lldb::StopReason Thread::GetStopReason() {
 442   lldb::StopInfoSP stop_info_sp(GetStopInfo());
 443   if (stop_info_sp)
 444     return stop_info_sp->GetStopReason();
 445   return eStopReasonNone;
 446 }
 447
 448 bool Thread::StopInfoIsUpToDate() const {
 449   ProcessSP process_sp(GetProcess());
 450   if (process_sp)
 451     return m_stop_info_stop_id == process_sp->GetStopID();
 452   else
 453     return true; // Process is no longer around so stop info is always up to
 454                  // date...
 455 }
 456
 457 void Thread::ResetStopInfo() {
 458   if (m_stop_info_sp) {
 459     m_stop_info_sp.reset();
 460   }
 461 }
 462
 463 void Thread::SetStopInfo(const lldb::StopInfoSP &stop_info_sp) {
 464   m_stop_info_sp = stop_info_sp;
 465   if (m_stop_info_sp) {
 466     m_stop_info_sp->MakeStopInfoValid();
 467     // If we are overriding the ShouldReportStop, do that here:
 468     if (m_override_should_notify != eLazyBoolCalculate)
 469       m_stop_info_sp->OverrideShouldNotify(m_override_should_notify ==
 470                                            eLazyBoolYes);
 471   }
 472
 473   ProcessSP process_sp(GetProcess());
 474   if (process_sp)
 475     m_stop_info_stop_id = process_sp->GetStopID();
 476   else
 477     m_stop_info_stop_id = UINT32_MAX;
 478   Log *log = GetLog(LLDBLog::Thread);
 479   LLDB_LOGF(log, "%p: tid = 0x%" PRIx64 ": stop info = %s (stop_id = %u)",
 480             static_cast<void *>(this), GetID(),
 481             stop_info_sp ? stop_info_sp->GetDescription() : "<NULL>",
 482             m_stop_info_stop_id);
 483 }
 484
 485 void Thread::SetShouldReportStop(Vote vote) {
 486   if (vote == eVoteNoOpinion)
 487     return;
 488   else {
 489     m_override_should_notify = (vote == eVoteYes ? eLazyBoolYes : eLazyBoolNo);
 490     if (m_stop_info_sp)
 491       m_stop_info_sp->OverrideShouldNotify(m_override_should_notify ==
 492                                            eLazyBoolYes);
 493   }
 494 }
 495
 496 void Thread::SetStopInfoToNothing() {
 497   // Note, we can't just NULL out the private reason, or the native thread
 498   // implementation will try to go calculate it again.  For now, just set it to
 499   // a Unix Signal with an invalid signal number.
 500   SetStopInfo(
 501       StopInfo::CreateStopReasonWithSignal(*this, LLDB_INVALID_SIGNAL_NUMBER));
 502 }
 503
 504 bool Thread::ThreadStoppedForAReason() { return (bool)GetPrivateStopInfo(); }
 505
 506 bool Thread::CheckpointThreadState(ThreadStateCheckpoint &saved_state) {
 507   saved_state.register_backup_sp.reset();
 508   lldb::StackFrameSP frame_sp(GetStackFrameAtIndex(0));
 509   if (frame_sp) {
 510     lldb::RegisterCheckpointSP reg_checkpoint_sp(
 511         new RegisterCheckpoint(RegisterCheckpoint::Reason::eExpression));
 512     if (reg_checkpoint_sp) {
 513       lldb::RegisterContextSP reg_ctx_sp(frame_sp->GetRegisterContext());
 514       if (reg_ctx_sp && reg_ctx_sp->ReadAllRegisterValues(*reg_checkpoint_sp))
 515         saved_state.register_backup_sp = reg_checkpoint_sp;
 516     }
 517   }
 518   if (!saved_state.register_backup_sp)
 519     return false;
 520
 521   saved_state.stop_info_sp = GetStopInfo();
 522   ProcessSP process_sp(GetProcess());
 523   if (process_sp)
 524     saved_state.orig_stop_id = process_sp->GetStopID();
 525   saved_state.current_inlined_depth = GetCurrentInlinedDepth();
 526   saved_state.m_completed_plan_checkpoint =
 527       GetPlans().CheckpointCompletedPlans();
 528
 529   return true;
 530 }
 531
 532 bool Thread::RestoreRegisterStateFromCheckpoint(
 533     ThreadStateCheckpoint &saved_state) {
 534   if (saved_state.register_backup_sp) {
 535     lldb::StackFrameSP frame_sp(GetStackFrameAtIndex(0));
 536     if (frame_sp) {
 537       lldb::RegisterContextSP reg_ctx_sp(frame_sp->GetRegisterContext());
 538       if (reg_ctx_sp) {
 539         bool ret =
 540             reg_ctx_sp->WriteAllRegisterValues(*saved_state.register_backup_sp);
 541
 542         // Clear out all stack frames as our world just changed.
 543         ClearStackFrames();
 544         reg_ctx_sp->InvalidateIfNeeded(true);
 545         if (m_unwinder_up)
 546           m_unwinder_up->Clear();
 547         return ret;
 548       }
 549     }
 550   }
 551   return false;
 552 }
 553
 554 void Thread::RestoreThreadStateFromCheckpoint(
 555     ThreadStateCheckpoint &saved_state) {
 556   if (saved_state.stop_info_sp)
 557     saved_state.stop_info_sp->MakeStopInfoValid();
 558   SetStopInfo(saved_state.stop_info_sp);
 559   GetStackFrameList()->SetCurrentInlinedDepth(
 560       saved_state.current_inlined_depth);
 561   GetPlans().RestoreCompletedPlanCheckpoint(
 562       saved_state.m_completed_plan_checkpoint);
 563 }
 564
 565 StateType Thread::GetState() const {
 566   // If any other threads access this we will need a mutex for it
 567   std::lock_guard<std::recursive_mutex> guard(m_state_mutex);
 568   return m_state;
 569 }
 570
 571 void Thread::SetState(StateType state) {
 572   std::lock_guard<std::recursive_mutex> guard(m_state_mutex);
 573   m_state = state;
 574 }
 575
 576 std::string Thread::GetStopDescription() {
 577   StackFrameSP frame_sp = GetStackFrameAtIndex(0);
 578
 579   if (!frame_sp)
 580     return GetStopDescriptionRaw();
 581
 582   auto recognized_frame_sp = frame_sp->GetRecognizedFrame();
 583
 584   if (!recognized_frame_sp)
 585     return GetStopDescriptionRaw();
 586
 587   std::string recognized_stop_description =
 588       recognized_frame_sp->GetStopDescription();
 589
 590   if (!recognized_stop_description.empty())
 591     return recognized_stop_description;
 592
 593   return GetStopDescriptionRaw();
 594 }
 595
 596 std::string Thread::GetStopDescriptionRaw() {
 597   StopInfoSP stop_info_sp = GetStopInfo();
 598   std::string raw_stop_description;
 599   if (stop_info_sp && stop_info_sp->IsValid()) {
 600     raw_stop_description = stop_info_sp->GetDescription();
 601     assert((!raw_stop_description.empty() ||
 602             stop_info_sp->GetStopReason() == eStopReasonNone) &&
 603            "StopInfo returned an empty description.");
 604   }
 605   return raw_stop_description;
 606 }
 607
 608 void Thread::WillStop() {
 609   ThreadPlan *current_plan = GetCurrentPlan();
 610
 611   // FIXME: I may decide to disallow threads with no plans.  In which
 612   // case this should go to an assert.
 613
 614   if (!current_plan)
 615     return;
 616
 617   current_plan->WillStop();
 618 }
 619
 620 void Thread::SetupForResume() {
 621   if (GetResumeState() != eStateSuspended) {
 622     // First check whether this thread is going to "actually" resume at all.
 623     // For instance, if we're stepping from one level to the next of an
 624     // virtual inlined call stack, we just change the inlined call stack index
 625     // without actually running this thread.  In that case, for this thread we
 626     // shouldn't push a step over breakpoint plan or do that work.
 627     if (GetCurrentPlan()->IsVirtualStep())
 628       return;
 629
 630     // If we're at a breakpoint push the step-over breakpoint plan.  Do this
 631     // before telling the current plan it will resume, since we might change
 632     // what the current plan is.
 633
 634     lldb::RegisterContextSP reg_ctx_sp(GetRegisterContext());
 635     if (reg_ctx_sp) {
 636       const addr_t thread_pc = reg_ctx_sp->GetPC();
 637       BreakpointSiteSP bp_site_sp =
 638           GetProcess()->GetBreakpointSiteList().FindByAddress(thread_pc);
 639       if (bp_site_sp) {
 640         // Note, don't assume there's a ThreadPlanStepOverBreakpoint, the
 641         // target may not require anything special to step over a breakpoint.
 642
 643         ThreadPlan *cur_plan = GetCurrentPlan();
 644
 645         bool push_step_over_bp_plan = false;
 646         if (cur_plan->GetKind() == ThreadPlan::eKindStepOverBreakpoint) {
 647           ThreadPlanStepOverBreakpoint *bp_plan =
 648               (ThreadPlanStepOverBreakpoint *)cur_plan;
 649           if (bp_plan->GetBreakpointLoadAddress() != thread_pc)
 650             push_step_over_bp_plan = true;
 651         } else
 652           push_step_over_bp_plan = true;
 653
 654         if (push_step_over_bp_plan) {
 655           ThreadPlanSP step_bp_plan_sp(new ThreadPlanStepOverBreakpoint(*this));
 656           if (step_bp_plan_sp) {
 657             step_bp_plan_sp->SetPrivate(true);
 658
 659             if (GetCurrentPlan()->RunState() != eStateStepping) {
 660               ThreadPlanStepOverBreakpoint *step_bp_plan =
 661                   static_cast<ThreadPlanStepOverBreakpoint *>(
 662                       step_bp_plan_sp.get());
 663               step_bp_plan->SetAutoContinue(true);
 664             }
 665             QueueThreadPlan(step_bp_plan_sp, false);
 666           }
 667         }
 668       }
 669     }
 670   }
 671 }
 672
 673 bool Thread::ShouldResume(StateType resume_state) {
 674   // At this point clear the completed plan stack.
 675   GetPlans().WillResume();
 676   m_override_should_notify = eLazyBoolCalculate;
 677
 678   StateType prev_resume_state = GetTemporaryResumeState();
 679
 680   SetTemporaryResumeState(resume_state);
 681
 682   lldb::ThreadSP backing_thread_sp(GetBackingThread());
 683   if (backing_thread_sp)
 684     backing_thread_sp->SetTemporaryResumeState(resume_state);
 685
 686   // Make sure m_stop_info_sp is valid.  Don't do this for threads we suspended
 687   // in the previous run.
 688   if (prev_resume_state != eStateSuspended)
 689     GetPrivateStopInfo();
 690
 691   // This is a little dubious, but we are trying to limit how often we actually
 692   // fetch stop info from the target, 'cause that slows down single stepping.
 693   // So assume that if we got to the point where we're about to resume, and we
 694   // haven't yet had to fetch the stop reason, then it doesn't need to know
 695   // about the fact that we are resuming...
 696   const uint32_t process_stop_id = GetProcess()->GetStopID();
 697   if (m_stop_info_stop_id == process_stop_id &&
 698       (m_stop_info_sp && m_stop_info_sp->IsValid())) {
 699     StopInfo *stop_info = GetPrivateStopInfo().get();
 700     if (stop_info)
 701       stop_info->WillResume(resume_state);
 702   }
 703
 704   // Tell all the plans that we are about to resume in case they need to clear
 705   // any state. We distinguish between the plan on the top of the stack and the
 706   // lower plans in case a plan needs to do any special business before it
 707   // runs.
 708
 709   bool need_to_resume = false;
 710   ThreadPlan *plan_ptr = GetCurrentPlan();
 711   if (plan_ptr) {
 712     need_to_resume = plan_ptr->WillResume(resume_state, true);
 713
 714     while ((plan_ptr = GetPreviousPlan(plan_ptr)) != nullptr) {
 715       plan_ptr->WillResume(resume_state, false);
 716     }
 717
 718     // If the WillResume for the plan says we are faking a resume, then it will
 719     // have set an appropriate stop info. In that case, don't reset it here.
 720
 721     if (need_to_resume && resume_state != eStateSuspended) {
 722       m_stop_info_sp.reset();
 723     }
 724   }
 725
 726   if (need_to_resume) {
 727     ClearStackFrames();
 728     // Let Thread subclasses do any special work they need to prior to resuming
 729     WillResume(resume_state);
 730   }
 731
 732   return need_to_resume;
 733 }
 734
 735 void Thread::DidResume() {
 736   SetResumeSignal(LLDB_INVALID_SIGNAL_NUMBER);
 737   // This will get recomputed each time when we stop.
 738   SetShouldRunBeforePublicStop(false);
 739 }
 740
 741 void Thread::DidStop() { SetState(eStateStopped); }
 742
 743 bool Thread::ShouldStop(Event *event_ptr) {
 744   ThreadPlan *current_plan = GetCurrentPlan();
 745
 746   bool should_stop = true;
 747
 748   Log *log = GetLog(LLDBLog::Step);
 749
 750   if (GetResumeState() == eStateSuspended) {
 751     LLDB_LOGF(log,
 752               "Thread::%s for tid = 0x%4.4" PRIx64 " 0x%4.4" PRIx64
 753               ", should_stop = 0 (ignore since thread was suspended)",
 754               __FUNCTION__, GetID(), GetProtocolID());
 755     return false;
 756   }
 757
 758   if (GetTemporaryResumeState() == eStateSuspended) {
 759     LLDB_LOGF(log,
 760               "Thread::%s for tid = 0x%4.4" PRIx64 " 0x%4.4" PRIx64
 761               ", should_stop = 0 (ignore since thread was suspended)",
 762               __FUNCTION__, GetID(), GetProtocolID());
 763     return false;
 764   }
 765
 766   // Based on the current thread plan and process stop info, check if this
 767   // thread caused the process to stop. NOTE: this must take place before the
 768   // plan is moved from the current plan stack to the completed plan stack.
 769   if (!ThreadStoppedForAReason()) {
 770     LLDB_LOGF(log,
 771               "Thread::%s for tid = 0x%4.4" PRIx64 " 0x%4.4" PRIx64
 772               ", pc = 0x%16.16" PRIx64
 773               ", should_stop = 0 (ignore since no stop reason)",
 774               __FUNCTION__, GetID(), GetProtocolID(),
 775               GetRegisterContext() ? GetRegisterContext()->GetPC()
 776                                    : LLDB_INVALID_ADDRESS);
 777     return false;
 778   }
 779
 780   // Clear the "must run me before stop" if it was set:
 781   SetShouldRunBeforePublicStop(false);
 782
 783   if (log) {
 784     LLDB_LOGF(log,
 785               "Thread::%s(%p) for tid = 0x%4.4" PRIx64 " 0x%4.4" PRIx64
 786               ", pc = 0x%16.16" PRIx64,
 787               __FUNCTION__, static_cast<void *>(this), GetID(), GetProtocolID(),
 788               GetRegisterContext() ? GetRegisterContext()->GetPC()
 789                                    : LLDB_INVALID_ADDRESS);
 790     LLDB_LOGF(log, "^^^^^^^^ Thread::ShouldStop Begin ^^^^^^^^");
 791     StreamString s;
 792     s.IndentMore();
 793     GetProcess()->DumpThreadPlansForTID(
 794         s, GetID(), eDescriptionLevelVerbose, true /* internal */,
 795         false /* condense_trivial */, true /* skip_unreported */);
 796     LLDB_LOGF(log, "Plan stack initial state:\n%s", s.GetData());
 797   }
 798
 799   // The top most plan always gets to do the trace log...
 800   current_plan->DoTraceLog();
 801
 802   // First query the stop info's ShouldStopSynchronous.  This handles
 803   // "synchronous" stop reasons, for example the breakpoint command on internal
 804   // breakpoints.  If a synchronous stop reason says we should not stop, then
 805   // we don't have to do any more work on this stop.
 806   StopInfoSP private_stop_info(GetPrivateStopInfo());
 807   if (private_stop_info &&
 808       !private_stop_info->ShouldStopSynchronous(event_ptr)) {
 809     LLDB_LOGF(log, "StopInfo::ShouldStop async callback says we should not "
 810                    "stop, returning ShouldStop of false.");
 811     return false;
 812   }
 813
 814   // If we've already been restarted, don't query the plans since the state
 815   // they would examine is not current.
 816   if (Process::ProcessEventData::GetRestartedFromEvent(event_ptr))
 817     return false;
 818
 819   // Before the plans see the state of the world, calculate the current inlined
 820   // depth.
 821   GetStackFrameList()->CalculateCurrentInlinedDepth();
 822
 823   // If the base plan doesn't understand why we stopped, then we have to find a
 824   // plan that does. If that plan is still working, then we don't need to do
 825   // any more work.  If the plan that explains the stop is done, then we should
 826   // pop all the plans below it, and pop it, and then let the plans above it
 827   // decide whether they still need to do more work.
 828
 829   bool done_processing_current_plan = false;
 830   if (!current_plan->PlanExplainsStop(event_ptr)) {
 831     if (current_plan->TracerExplainsStop()) {
 832       done_processing_current_plan = true;
 833       should_stop = false;
 834     } else {
 835       // Leaf plan that does not explain the stop should be popped.
 836       // The plan should be push itself later again before resuming to stay
 837       // as leaf.
 838       if (current_plan->IsLeafPlan())
 839         PopPlan();
 840
 841       // If the current plan doesn't explain the stop, then find one that does
 842       // and let it handle the situation.
 843       ThreadPlan *plan_ptr = current_plan;
 844       while ((plan_ptr = GetPreviousPlan(plan_ptr)) != nullptr) {
 845         if (plan_ptr->PlanExplainsStop(event_ptr)) {
 846           LLDB_LOGF(log, "Plan %s explains stop.", plan_ptr->GetName());
 847
 848           should_stop = plan_ptr->ShouldStop(event_ptr);
 849
 850           // plan_ptr explains the stop, next check whether plan_ptr is done,
 851           // if so, then we should take it and all the plans below it off the
 852           // stack.
 853
 854           if (plan_ptr->MischiefManaged()) {
 855             // We're going to pop the plans up to and including the plan that
 856             // explains the stop.
 857             ThreadPlan *prev_plan_ptr = GetPreviousPlan(plan_ptr);
 858
 859             do {
 860               if (should_stop)
 861                 current_plan->WillStop();
 862               PopPlan();
 863             } while ((current_plan = GetCurrentPlan()) != prev_plan_ptr);
 864             // Now, if the responsible plan was not "Okay to discard" then
 865             // we're done, otherwise we forward this to the next plan in the
 866             // stack below.
 867             done_processing_current_plan =
 868                 (plan_ptr->IsControllingPlan() && !plan_ptr->OkayToDiscard());
 869           } else {
 870             bool should_force_run = plan_ptr->ShouldRunBeforePublicStop();
 871             if (should_force_run) {
 872               SetShouldRunBeforePublicStop(true);
 873               should_stop = false;
 874             }
 875             done_processing_current_plan = true;
 876           }
 877           break;
 878         }
 879       }
 880     }
 881   }
 882
 883   if (!done_processing_current_plan) {
 884     bool override_stop = false;
 885
 886     // We're starting from the base plan, so just let it decide;
 887     if (current_plan->IsBasePlan()) {
 888       should_stop = current_plan->ShouldStop(event_ptr);
 889       LLDB_LOGF(log, "Base plan says should stop: %i.", should_stop);
 890     } else {
 891       // Otherwise, don't let the base plan override what the other plans say
 892       // to do, since presumably if there were other plans they would know what
 893       // to do...
 894       while (true) {
 895         if (current_plan->IsBasePlan())
 896           break;
 897
 898         should_stop = current_plan->ShouldStop(event_ptr);
 899         LLDB_LOGF(log, "Plan %s should stop: %d.", current_plan->GetName(),
 900                   should_stop);
 901         if (current_plan->MischiefManaged()) {
 902           if (should_stop)
 903             current_plan->WillStop();
 904
 905           if (current_plan->ShouldAutoContinue(event_ptr)) {
 906             override_stop = true;
 907             LLDB_LOGF(log, "Plan %s auto-continue: true.",
 908                       current_plan->GetName());
 909           }
 910
 911           // If a Controlling Plan wants to stop, we let it. Otherwise, see if
 912           // the plan's parent wants to stop.
 913
 914           PopPlan();
 915           if (should_stop && current_plan->IsControllingPlan() &&
 916               !current_plan->OkayToDiscard()) {
 917             break;
 918           }
 919
 920           current_plan = GetCurrentPlan();
 921           if (current_plan == nullptr) {
 922             break;
 923           }
 924         } else {
 925           break;
 926         }
 927       }
 928     }
 929
 930     if (override_stop)
 931       should_stop = false;
 932   }
 933
 934   // One other potential problem is that we set up a controlling plan, then stop
 935   // in before it is complete - for instance by hitting a breakpoint during a
 936   // step-over - then do some step/finish/etc operations that wind up past the
 937   // end point condition of the initial plan.  We don't want to strand the
 938   // original plan on the stack, This code clears stale plans off the stack.
 939
 940   if (should_stop) {
 941     ThreadPlan *plan_ptr = GetCurrentPlan();
 942
 943     // Discard the stale plans and all plans below them in the stack, plus move
 944     // the completed plans to the completed plan stack
 945     while (!plan_ptr->IsBasePlan()) {
 946       bool stale = plan_ptr->IsPlanStale();
 947       ThreadPlan *examined_plan = plan_ptr;
 948       plan_ptr = GetPreviousPlan(examined_plan);
 949
 950       if (stale) {
 951         LLDB_LOGF(
 952             log,
 953             "Plan %s being discarded in cleanup, it says it is already done.",
 954             examined_plan->GetName());
 955         while (GetCurrentPlan() != examined_plan) {
 956           DiscardPlan();
 957         }
 958         if (examined_plan->IsPlanComplete()) {
 959           // plan is complete but does not explain the stop (example: step to a
 960           // line with breakpoint), let us move the plan to
 961           // completed_plan_stack anyway
 962           PopPlan();
 963         } else
 964           DiscardPlan();
 965       }
 966     }
 967   }
 968
 969   if (log) {
 970     StreamString s;
 971     s.IndentMore();
 972     GetProcess()->DumpThreadPlansForTID(
 973         s, GetID(), eDescriptionLevelVerbose, true /* internal */,
 974         false /* condense_trivial */, true /* skip_unreported */);
 975     LLDB_LOGF(log, "Plan stack final state:\n%s", s.GetData());
 976     LLDB_LOGF(log, "vvvvvvvv Thread::ShouldStop End (returning %i) vvvvvvvv",
 977               should_stop);
 978   }
 979   return should_stop;
 980 }
 981
 982 Vote Thread::ShouldReportStop(Event *event_ptr) {
 983   StateType thread_state = GetResumeState();
 984   StateType temp_thread_state = GetTemporaryResumeState();
 985
 986   Log *log = GetLog(LLDBLog::Step);
 987
 988   if (thread_state == eStateSuspended || thread_state == eStateInvalid) {
 989     LLDB_LOGF(log,
 990               "Thread::ShouldReportStop() tid = 0x%4.4" PRIx64
 991               ": returning vote %i (state was suspended or invalid)",
 992               GetID(), eVoteNoOpinion);
 993     return eVoteNoOpinion;
 994   }
 995
 996   if (temp_thread_state == eStateSuspended ||
 997       temp_thread_state == eStateInvalid) {
 998     LLDB_LOGF(log,
 999               "Thread::ShouldReportStop() tid = 0x%4.4" PRIx64
1000               ": returning vote %i (temporary state was suspended or invalid)",
1001               GetID(), eVoteNoOpinion);
1002     return eVoteNoOpinion;
1003   }
1004
1005   if (!ThreadStoppedForAReason()) {
1006     LLDB_LOGF(log,
1007               "Thread::ShouldReportStop() tid = 0x%4.4" PRIx64
1008               ": returning vote %i (thread didn't stop for a reason.)",
1009               GetID(), eVoteNoOpinion);
1010     return eVoteNoOpinion;
1011   }
1012
1013   if (GetPlans().AnyCompletedPlans()) {
1014     // Pass skip_private = false to GetCompletedPlan, since we want to ask
1015     // the last plan, regardless of whether it is private or not.
1016     LLDB_LOGF(log,
1017               "Thread::ShouldReportStop() tid = 0x%4.4" PRIx64
1018               ": returning vote for complete stack's back plan",
1019               GetID());
1020     return GetPlans().GetCompletedPlan(false)->ShouldReportStop(event_ptr);
1021   } else {
1022     Vote thread_vote = eVoteNoOpinion;
1023     ThreadPlan *plan_ptr = GetCurrentPlan();
1024     while (true) {
1025       if (plan_ptr->PlanExplainsStop(event_ptr)) {
1026         thread_vote = plan_ptr->ShouldReportStop(event_ptr);
1027         break;
1028       }
1029       if (plan_ptr->IsBasePlan())
1030         break;
1031       else
1032         plan_ptr = GetPreviousPlan(plan_ptr);
1033     }
1034     LLDB_LOGF(log,
1035               "Thread::ShouldReportStop() tid = 0x%4.4" PRIx64
1036               ": returning vote %i for current plan",
1037               GetID(), thread_vote);
1038
1039     return thread_vote;
1040   }
1041 }
1042
1043 Vote Thread::ShouldReportRun(Event *event_ptr) {
1044   StateType thread_state = GetResumeState();
1045
1046   if (thread_state == eStateSuspended || thread_state == eStateInvalid) {
1047     return eVoteNoOpinion;
1048   }
1049
1050   Log *log = GetLog(LLDBLog::Step);
1051   if (GetPlans().AnyCompletedPlans()) {
1052     // Pass skip_private = false to GetCompletedPlan, since we want to ask
1053     // the last plan, regardless of whether it is private or not.
1054     LLDB_LOGF(log,
1055               "Current Plan for thread %d(%p) (0x%4.4" PRIx64
1056               ", %s): %s being asked whether we should report run.",
1057               GetIndexID(), static_cast<void *>(this), GetID(),
1058               StateAsCString(GetTemporaryResumeState()),
1059               GetCompletedPlan()->GetName());
1060
1061     return GetPlans().GetCompletedPlan(false)->ShouldReportRun(event_ptr);
1062   } else {
1063     LLDB_LOGF(log,
1064               "Current Plan for thread %d(%p) (0x%4.4" PRIx64
1065               ", %s): %s being asked whether we should report run.",
1066               GetIndexID(), static_cast<void *>(this), GetID(),
1067               StateAsCString(GetTemporaryResumeState()),
1068               GetCurrentPlan()->GetName());
1069
1070     return GetCurrentPlan()->ShouldReportRun(event_ptr);
1071   }
1072 }
1073
1074 bool Thread::MatchesSpec(const ThreadSpec *spec) {
1075   return (spec == nullptr) ? true : spec->ThreadPassesBasicTests(*this);
1076 }
1077
1078 ThreadPlanStack &Thread::GetPlans() const {
1079   ThreadPlanStack *plans = GetProcess()->FindThreadPlans(GetID());
1080   if (plans)
1081     return *plans;
1082
1083   // History threads don't have a thread plan, but they do ask get asked to
1084   // describe themselves, which usually involves pulling out the stop reason.
1085   // That in turn will check for a completed plan on the ThreadPlanStack.
1086   // Instead of special-casing at that point, we return a Stack with a
1087   // ThreadPlanNull as its base plan.  That will give the right answers to the
1088   // queries GetDescription makes, and only assert if you try to run the thread.
1089   if (!m_null_plan_stack_up)
1090     m_null_plan_stack_up = std::make_unique<ThreadPlanStack>(*this, true);
1091   return *m_null_plan_stack_up;
1092 }
1093
1094 void Thread::PushPlan(ThreadPlanSP thread_plan_sp) {
1095   assert(thread_plan_sp && "Don't push an empty thread plan.");
1096
1097   Log *log = GetLog(LLDBLog::Step);
1098   if (log) {
1099     StreamString s;
1100     thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelFull);
1101     LLDB_LOGF(log, "Thread::PushPlan(0x%p): \"%s\", tid = 0x%4.4" PRIx64 ".",
1102               static_cast<void *>(this), s.GetData(),
1103               thread_plan_sp->GetThread().GetID());
1104   }
1105
1106   GetPlans().PushPlan(std::move(thread_plan_sp));
1107 }
1108
1109 void Thread::PopPlan() {
1110   Log *log = GetLog(LLDBLog::Step);
1111   ThreadPlanSP popped_plan_sp = GetPlans().PopPlan();
1112   if (log) {
1113     LLDB_LOGF(log, "Popping plan: \"%s\", tid = 0x%4.4" PRIx64 ".",
1114               popped_plan_sp->GetName(), popped_plan_sp->GetThread().GetID());
1115   }
1116 }
1117
1118 void Thread::DiscardPlan() {
1119   Log *log = GetLog(LLDBLog::Step);
1120   ThreadPlanSP discarded_plan_sp = GetPlans().DiscardPlan();
1121
1122   LLDB_LOGF(log, "Discarding plan: \"%s\", tid = 0x%4.4" PRIx64 ".",
1123             discarded_plan_sp->GetName(),
1124             discarded_plan_sp->GetThread().GetID());
1125 }
1126
1127 void Thread::AutoCompleteThreadPlans(CompletionRequest &request) const {
1128   const ThreadPlanStack &plans = GetPlans();
1129   if (!plans.AnyPlans())
1130     return;
1131
1132   // Iterate from the second plan (index: 1) to skip the base plan.
1133   ThreadPlanSP p;
1134   uint32_t i = 1;
1135   while ((p = plans.GetPlanByIndex(i, false))) {
1136     StreamString strm;
1137     p->GetDescription(&strm, eDescriptionLevelInitial);
1138     request.TryCompleteCurrentArg(std::to_string(i), strm.GetString());
1139     i++;
1140   }
1141 }
1142
1143 ThreadPlan *Thread::GetCurrentPlan() const {
1144   return GetPlans().GetCurrentPlan().get();
1145 }
1146
1147 ThreadPlanSP Thread::GetCompletedPlan() const {
1148   return GetPlans().GetCompletedPlan();
1149 }
1150
1151 ValueObjectSP Thread::GetReturnValueObject() const {
1152   return GetPlans().GetReturnValueObject();
1153 }
1154
1155 ExpressionVariableSP Thread::GetExpressionVariable() const {
1156   return GetPlans().GetExpressionVariable();
1157 }
1158
1159 bool Thread::IsThreadPlanDone(ThreadPlan *plan) const {
1160   return GetPlans().IsPlanDone(plan);
1161 }
1162
1163 bool Thread::WasThreadPlanDiscarded(ThreadPlan *plan) const {
1164   return GetPlans().WasPlanDiscarded(plan);
1165 }
1166
1167 bool Thread::CompletedPlanOverridesBreakpoint() const {
1168   return GetPlans().AnyCompletedPlans();
1169 }
1170
1171 ThreadPlan *Thread::GetPreviousPlan(ThreadPlan *current_plan) const{
1172   return GetPlans().GetPreviousPlan(current_plan);
1173 }
1174
1175 Status Thread::QueueThreadPlan(ThreadPlanSP &thread_plan_sp,
1176                                bool abort_other_plans) {
1177   Status status;
1178   StreamString s;
1179   if (!thread_plan_sp->ValidatePlan(&s)) {
1180     DiscardThreadPlansUpToPlan(thread_plan_sp);
1181     thread_plan_sp.reset();
1182     return Status(s.GetString().str());
1183   }
1184
1185   if (abort_other_plans)
1186     DiscardThreadPlans(true);
1187
1188   PushPlan(thread_plan_sp);
1189
1190   // This seems a little funny, but I don't want to have to split up the
1191   // constructor and the DidPush in the scripted plan, that seems annoying.
1192   // That means the constructor has to be in DidPush. So I have to validate the
1193   // plan AFTER pushing it, and then take it off again...
1194   if (!thread_plan_sp->ValidatePlan(&s)) {
1195     DiscardThreadPlansUpToPlan(thread_plan_sp);
1196     thread_plan_sp.reset();
1197     return Status(s.GetString().str());
1198   }
1199
1200   return status;
1201 }
1202
1203 bool Thread::DiscardUserThreadPlansUpToIndex(uint32_t plan_index) {
1204   // Count the user thread plans from the back end to get the number of the one
1205   // we want to discard:
1206
1207   ThreadPlan *up_to_plan_ptr = GetPlans().GetPlanByIndex(plan_index).get();
1208   if (up_to_plan_ptr == nullptr)
1209     return false;
1210
1211   DiscardThreadPlansUpToPlan(up_to_plan_ptr);
1212   return true;
1213 }
1214
1215 void Thread::DiscardThreadPlansUpToPlan(lldb::ThreadPlanSP &up_to_plan_sp) {
1216   DiscardThreadPlansUpToPlan(up_to_plan_sp.get());
1217 }
1218
1219 void Thread::DiscardThreadPlansUpToPlan(ThreadPlan *up_to_plan_ptr) {
1220   Log *log = GetLog(LLDBLog::Step);
1221   LLDB_LOGF(log,
1222             "Discarding thread plans for thread tid = 0x%4.4" PRIx64
1223             ", up to %p",
1224             GetID(), static_cast<void *>(up_to_plan_ptr));
1225   GetPlans().DiscardPlansUpToPlan(up_to_plan_ptr);
1226 }
1227
1228 void Thread::DiscardThreadPlans(bool force) {
1229   Log *log = GetLog(LLDBLog::Step);
1230   if (log) {
1231     LLDB_LOGF(log,
1232               "Discarding thread plans for thread (tid = 0x%4.4" PRIx64
1233               ", force %d)",
1234               GetID(), force);
1235   }
1236
1237   if (force) {
1238     GetPlans().DiscardAllPlans();
1239     return;
1240   }
1241   GetPlans().DiscardConsultingControllingPlans();
1242 }
1243
1244 Status Thread::UnwindInnermostExpression() {
1245   Status error;
1246   ThreadPlan *innermost_expr_plan = GetPlans().GetInnermostExpression();
1247   if (!innermost_expr_plan) {
1248     error = Status::FromErrorString(
1249         "No expressions currently active on this thread");
1250     return error;
1251   }
1252   DiscardThreadPlansUpToPlan(innermost_expr_plan);
1253   return error;
1254 }
1255
1256 ThreadPlanSP Thread::QueueBasePlan(bool abort_other_plans) {
1257   ThreadPlanSP thread_plan_sp(new ThreadPlanBase(*this));
1258   QueueThreadPlan(thread_plan_sp, abort_other_plans);
1259   return thread_plan_sp;
1260 }
1261
1262 ThreadPlanSP Thread::QueueThreadPlanForStepSingleInstruction(
1263     bool step_over, bool abort_other_plans, bool stop_other_threads,
1264     Status &status) {
1265   ThreadPlanSP thread_plan_sp(new ThreadPlanStepInstruction(
1266       *this, step_over, stop_other_threads, eVoteNoOpinion, eVoteNoOpinion));
1267   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1268   return thread_plan_sp;
1269 }
1270
1271 ThreadPlanSP Thread::QueueThreadPlanForStepOverRange(
1272     bool abort_other_plans, const AddressRange &range,
1273     const SymbolContext &addr_context, lldb::RunMode stop_other_threads,
1274     Status &status, LazyBool step_out_avoids_code_withoug_debug_info) {
1275   ThreadPlanSP thread_plan_sp;
1276   thread_plan_sp = std::make_shared<ThreadPlanStepOverRange>(
1277       *this, range, addr_context, stop_other_threads,
1278       step_out_avoids_code_withoug_debug_info);
1279
1280   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1281   return thread_plan_sp;
1282 }
1283
1284 // Call the QueueThreadPlanForStepOverRange method which takes an address
1285 // range.
1286 ThreadPlanSP Thread::QueueThreadPlanForStepOverRange(
1287     bool abort_other_plans, const LineEntry &line_entry,
1288     const SymbolContext &addr_context, lldb::RunMode stop_other_threads,
1289     Status &status, LazyBool step_out_avoids_code_withoug_debug_info) {
1290   const bool include_inlined_functions = true;
1291   auto address_range =
1292       line_entry.GetSameLineContiguousAddressRange(include_inlined_functions);
1293   return QueueThreadPlanForStepOverRange(
1294       abort_other_plans, address_range, addr_context, stop_other_threads,
1295       status, step_out_avoids_code_withoug_debug_info);
1296 }
1297
1298 ThreadPlanSP Thread::QueueThreadPlanForStepInRange(
1299     bool abort_other_plans, const AddressRange &range,
1300     const SymbolContext &addr_context, const char *step_in_target,
1301     lldb::RunMode stop_other_threads, Status &status,
1302     LazyBool step_in_avoids_code_without_debug_info,
1303     LazyBool step_out_avoids_code_without_debug_info) {
1304   ThreadPlanSP thread_plan_sp(new ThreadPlanStepInRange(
1305       *this, range, addr_context, step_in_target, stop_other_threads,
1306       step_in_avoids_code_without_debug_info,
1307       step_out_avoids_code_without_debug_info));
1308   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1309   return thread_plan_sp;
1310 }
1311
1312 // Call the QueueThreadPlanForStepInRange method which takes an address range.
1313 ThreadPlanSP Thread::QueueThreadPlanForStepInRange(
1314     bool abort_other_plans, const LineEntry &line_entry,
1315     const SymbolContext &addr_context, const char *step_in_target,
1316     lldb::RunMode stop_other_threads, Status &status,
1317     LazyBool step_in_avoids_code_without_debug_info,
1318     LazyBool step_out_avoids_code_without_debug_info) {
1319   const bool include_inlined_functions = false;
1320   return QueueThreadPlanForStepInRange(
1321       abort_other_plans,
1322       line_entry.GetSameLineContiguousAddressRange(include_inlined_functions),
1323       addr_context, step_in_target, stop_other_threads, status,
1324       step_in_avoids_code_without_debug_info,
1325       step_out_avoids_code_without_debug_info);
1326 }
1327
1328 ThreadPlanSP Thread::QueueThreadPlanForStepOut(
1329     bool abort_other_plans, SymbolContext *addr_context, bool first_insn,
1330     bool stop_other_threads, Vote report_stop_vote, Vote report_run_vote,
1331     uint32_t frame_idx, Status &status,
1332     LazyBool step_out_avoids_code_without_debug_info) {
1333   ThreadPlanSP thread_plan_sp(new ThreadPlanStepOut(
1334       *this, addr_context, first_insn, stop_other_threads, report_stop_vote,
1335       report_run_vote, frame_idx, step_out_avoids_code_without_debug_info));
1336
1337   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1338   return thread_plan_sp;
1339 }
1340
1341 ThreadPlanSP Thread::QueueThreadPlanForStepOutNoShouldStop(
1342     bool abort_other_plans, SymbolContext *addr_context, bool first_insn,
1343     bool stop_other_threads, Vote report_stop_vote, Vote report_run_vote,
1344     uint32_t frame_idx, Status &status, bool continue_to_next_branch) {
1345   const bool calculate_return_value =
1346       false; // No need to calculate the return value here.
1347   ThreadPlanSP thread_plan_sp(new ThreadPlanStepOut(
1348       *this, addr_context, first_insn, stop_other_threads, report_stop_vote,
1349       report_run_vote, frame_idx, eLazyBoolNo, continue_to_next_branch,
1350       calculate_return_value));
1351
1352   ThreadPlanStepOut *new_plan =
1353       static_cast<ThreadPlanStepOut *>(thread_plan_sp.get());
1354   new_plan->ClearShouldStopHereCallbacks();
1355
1356   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1357   return thread_plan_sp;
1358 }
1359
1360 ThreadPlanSP Thread::QueueThreadPlanForStepThrough(StackID &return_stack_id,
1361                                                    bool abort_other_plans,
1362                                                    bool stop_other_threads,
1363                                                    Status &status) {
1364   ThreadPlanSP thread_plan_sp(
1365       new ThreadPlanStepThrough(*this, return_stack_id, stop_other_threads));
1366   if (!thread_plan_sp || !thread_plan_sp->ValidatePlan(nullptr))
1367     return ThreadPlanSP();
1368
1369   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1370   return thread_plan_sp;
1371 }
1372
1373 ThreadPlanSP Thread::QueueThreadPlanForRunToAddress(bool abort_other_plans,
1374                                                     Address &target_addr,
1375                                                     bool stop_other_threads,
1376                                                     Status &status) {
1377   ThreadPlanSP thread_plan_sp(
1378       new ThreadPlanRunToAddress(*this, target_addr, stop_other_threads));
1379
1380   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1381   return thread_plan_sp;
1382 }
1383
1384 ThreadPlanSP Thread::QueueThreadPlanForStepUntil(
1385     bool abort_other_plans, lldb::addr_t *address_list, size_t num_addresses,
1386     bool stop_other_threads, uint32_t frame_idx, Status &status) {
1387   ThreadPlanSP thread_plan_sp(new ThreadPlanStepUntil(
1388       *this, address_list, num_addresses, stop_other_threads, frame_idx));
1389
1390   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1391   return thread_plan_sp;
1392 }
1393
1394 lldb::ThreadPlanSP Thread::QueueThreadPlanForStepScripted(
1395     bool abort_other_plans, const char *class_name,
1396     StructuredData::ObjectSP extra_args_sp, bool stop_other_threads,
1397     Status &status) {
1398
1399   ThreadPlanSP thread_plan_sp(new ScriptedThreadPlan(
1400       *this, class_name, StructuredDataImpl(extra_args_sp)));
1401   thread_plan_sp->SetStopOthers(stop_other_threads);
1402   status = QueueThreadPlan(thread_plan_sp, abort_other_plans);
1403   return thread_plan_sp;
1404 }
1405
1406 uint32_t Thread::GetIndexID() const { return m_index_id; }
1407
1408 TargetSP Thread::CalculateTarget() {
1409   TargetSP target_sp;
1410   ProcessSP process_sp(GetProcess());
1411   if (process_sp)
1412     target_sp = process_sp->CalculateTarget();
1413   return target_sp;
1414 }
1415
1416 ProcessSP Thread::CalculateProcess() { return GetProcess(); }
1417
1418 ThreadSP Thread::CalculateThread() { return shared_from_this(); }
1419
1420 StackFrameSP Thread::CalculateStackFrame() { return StackFrameSP(); }
1421
1422 void Thread::CalculateExecutionContext(ExecutionContext &exe_ctx) {
1423   exe_ctx.SetContext(shared_from_this());
1424 }
1425
1426 StackFrameListSP Thread::GetStackFrameList() {
1427   std::lock_guard<std::recursive_mutex> guard(m_frame_mutex);
1428
1429   if (!m_curr_frames_sp)
1430     m_curr_frames_sp =
1431         std::make_shared<StackFrameList>(*this, m_prev_frames_sp, true);
1432
1433   return m_curr_frames_sp;
1434 }
1435
1436 std::optional<addr_t> Thread::GetPreviousFrameZeroPC() {
1437   return m_prev_framezero_pc;
1438 }
1439
1440 void Thread::ClearStackFrames() {
1441   std::lock_guard<std::recursive_mutex> guard(m_frame_mutex);
1442
1443   GetUnwinder().Clear();
1444   m_prev_framezero_pc.reset();
1445   if (RegisterContextSP reg_ctx_sp = GetRegisterContext())
1446     m_prev_framezero_pc = reg_ctx_sp->GetPC();
1447
1448   // Only store away the old "reference" StackFrameList if we got all its
1449   // frames:
1450   // FIXME: At some point we can try to splice in the frames we have fetched
1451   // into the new frame as we make it, but let's not try that now.
1452   if (m_curr_frames_sp && m_curr_frames_sp->WereAllFramesFetched())
1453     m_prev_frames_sp.swap(m_curr_frames_sp);
1454   m_curr_frames_sp.reset();
1455
1456   m_extended_info.reset();
1457   m_extended_info_fetched = false;
1458 }
1459
1460 lldb::StackFrameSP Thread::GetFrameWithConcreteFrameIndex(uint32_t unwind_idx) {
1461   return GetStackFrameList()->GetFrameWithConcreteFrameIndex(unwind_idx);
1462 }
1463
1464 Status Thread::ReturnFromFrameWithIndex(uint32_t frame_idx,
1465                                         lldb::ValueObjectSP return_value_sp,
1466                                         bool broadcast) {
1467   StackFrameSP frame_sp = GetStackFrameAtIndex(frame_idx);
1468   Status return_error;
1469
1470   if (!frame_sp) {
1471     return_error = Status::FromErrorStringWithFormat(
1472         "Could not find frame with index %d in thread 0x%" PRIx64 ".",
1473         frame_idx, GetID());
1474   }
1475
1476   return ReturnFromFrame(frame_sp, return_value_sp, broadcast);
1477 }
1478
1479 Status Thread::ReturnFromFrame(lldb::StackFrameSP frame_sp,
1480                                lldb::ValueObjectSP return_value_sp,
1481                                bool broadcast) {
1482   Status return_error;
1483
1484   if (!frame_sp) {
1485     return_error = Status::FromErrorString("Can't return to a null frame.");
1486     return return_error;
1487   }
1488
1489   Thread *thread = frame_sp->GetThread().get();
1490   uint32_t older_frame_idx = frame_sp->GetFrameIndex() + 1;
1491   StackFrameSP older_frame_sp = thread->GetStackFrameAtIndex(older_frame_idx);
1492   if (!older_frame_sp) {
1493     return_error = Status::FromErrorString("No older frame to return to.");
1494     return return_error;
1495   }
1496
1497   if (return_value_sp) {
1498     lldb::ABISP abi = thread->GetProcess()->GetABI();
1499     if (!abi) {
1500       return_error =
1501           Status::FromErrorString("Could not find ABI to set return value.");
1502       return return_error;
1503     }
1504     SymbolContext sc = frame_sp->GetSymbolContext(eSymbolContextFunction);
1505
1506     // FIXME: ValueObject::Cast doesn't currently work correctly, at least not
1507     // for scalars.
1508     // Turn that back on when that works.
1509     if (/* DISABLES CODE */ (false) && sc.function != nullptr) {
1510       Type *function_type = sc.function->GetType();
1511       if (function_type) {
1512         CompilerType return_type =
1513             sc.function->GetCompilerType().GetFunctionReturnType();
1514         if (return_type) {
1515           StreamString s;
1516           return_type.DumpTypeDescription(&s);
1517           ValueObjectSP cast_value_sp = return_value_sp->Cast(return_type);
1518           if (cast_value_sp) {
1519             cast_value_sp->SetFormat(eFormatHex);
1520             return_value_sp = cast_value_sp;
1521           }
1522         }
1523       }
1524     }
1525
1526     return_error = abi->SetReturnValueObject(older_frame_sp, return_value_sp);
1527     if (!return_error.Success())
1528       return return_error;
1529   }
1530
1531   // Now write the return registers for the chosen frame: Note, we can't use
1532   // ReadAllRegisterValues->WriteAllRegisterValues, since the read & write cook
1533   // their data
1534
1535   StackFrameSP youngest_frame_sp = thread->GetStackFrameAtIndex(0);
1536   if (youngest_frame_sp) {
1537     lldb::RegisterContextSP reg_ctx_sp(youngest_frame_sp->GetRegisterContext());
1538     if (reg_ctx_sp) {
1539       bool copy_success = reg_ctx_sp->CopyFromRegisterContext(
1540           older_frame_sp->GetRegisterContext());
1541       if (copy_success) {
1542         thread->DiscardThreadPlans(true);
1543         thread->ClearStackFrames();
1544         if (broadcast && EventTypeHasListeners(eBroadcastBitStackChanged)) {
1545           auto data_sp = std::make_shared<ThreadEventData>(shared_from_this());
1546           BroadcastEvent(eBroadcastBitStackChanged, data_sp);
1547         }
1548       } else {
1549         return_error =
1550             Status::FromErrorString("Could not reset register values.");
1551       }
1552     } else {
1553       return_error = Status::FromErrorString("Frame has no register context.");
1554     }
1555   } else {
1556     return_error = Status::FromErrorString("Returned past top frame.");
1557   }
1558   return return_error;
1559 }
1560
1561 static void DumpAddressList(Stream &s, const std::vector<Address> &list,
1562                             ExecutionContextScope *exe_scope) {
1563   for (size_t n = 0; n < list.size(); n++) {
1564     s << "\t";
1565     list[n].Dump(&s, exe_scope, Address::DumpStyleResolvedDescription,
1566                  Address::DumpStyleSectionNameOffset);
1567     s << "\n";
1568   }
1569 }
1570
1571 Status Thread::JumpToLine(const FileSpec &file, uint32_t line,
1572                           bool can_leave_function, std::string *warnings) {
1573   ExecutionContext exe_ctx(GetStackFrameAtIndex(0));
1574   Target *target = exe_ctx.GetTargetPtr();
1575   TargetSP target_sp = exe_ctx.GetTargetSP();
1576   RegisterContext *reg_ctx = exe_ctx.GetRegisterContext();
1577   StackFrame *frame = exe_ctx.GetFramePtr();
1578   const SymbolContext &sc = frame->GetSymbolContext(eSymbolContextFunction);
1579
1580   // Find candidate locations.
1581   std::vector<Address> candidates, within_function, outside_function;
1582   target->GetImages().FindAddressesForLine(target_sp, file, line, sc.function,
1583                                            within_function, outside_function);
1584
1585   // If possible, we try and stay within the current function. Within a
1586   // function, we accept multiple locations (optimized code may do this,
1587   // there's no solution here so we do the best we can). However if we're
1588   // trying to leave the function, we don't know how to pick the right
1589   // location, so if there's more than one then we bail.
1590   if (!within_function.empty())
1591     candidates = within_function;
1592   else if (outside_function.size() == 1 && can_leave_function)
1593     candidates = outside_function;
1594
1595   // Check if we got anything.
1596   if (candidates.empty()) {
1597     if (outside_function.empty()) {
1598       return Status::FromErrorStringWithFormat(
1599           "Cannot locate an address for %s:%i.", file.GetFilename().AsCString(),
1600           line);
1601     } else if (outside_function.size() == 1) {
1602       return Status::FromErrorStringWithFormat(
1603           "%s:%i is outside the current function.",
1604           file.GetFilename().AsCString(), line);
1605     } else {
1606       StreamString sstr;
1607       DumpAddressList(sstr, outside_function, target);
1608       return Status::FromErrorStringWithFormat(
1609           "%s:%i has multiple candidate locations:\n%s",
1610           file.GetFilename().AsCString(), line, sstr.GetData());
1611     }
1612   }
1613
1614   // Accept the first location, warn about any others.
1615   Address dest = candidates[0];
1616   if (warnings && candidates.size() > 1) {
1617     StreamString sstr;
1618     sstr.Printf("%s:%i appears multiple times in this function, selecting the "
1619                 "first location:\n",
1620                 file.GetFilename().AsCString(), line);
1621     DumpAddressList(sstr, candidates, target);
1622     *warnings = std::string(sstr.GetString());
1623   }
1624
1625   if (!reg_ctx->SetPC(dest))
1626     return Status::FromErrorString("Cannot change PC to target address.");
1627
1628   return Status();
1629 }
1630
1631 bool Thread::DumpUsingFormat(Stream &strm, uint32_t frame_idx,
1632                              const FormatEntity::Entry *format) {
1633   ExecutionContext exe_ctx(shared_from_this());
1634   Process *process = exe_ctx.GetProcessPtr();
1635   if (!process || !format)
1636     return false;
1637
1638   StackFrameSP frame_sp;
1639   SymbolContext frame_sc;
1640   if (frame_idx != LLDB_INVALID_FRAME_ID) {
1641     frame_sp = GetStackFrameAtIndex(frame_idx);
1642     if (frame_sp) {
1643       exe_ctx.SetFrameSP(frame_sp);
1644       frame_sc = frame_sp->GetSymbolContext(eSymbolContextEverything);
1645     }
1646   }
1647
1648   return FormatEntity::Format(*format, strm, frame_sp ? &frame_sc : nullptr,
1649                               &exe_ctx, nullptr, nullptr, false, false);
1650 }
1651
1652 void Thread::DumpUsingSettingsFormat(Stream &strm, uint32_t frame_idx,
1653                                      bool stop_format) {
1654   ExecutionContext exe_ctx(shared_from_this());
1655
1656   const FormatEntity::Entry *thread_format;
1657   if (stop_format)
1658     thread_format = exe_ctx.GetTargetRef().GetDebugger().GetThreadStopFormat();
1659   else
1660     thread_format = exe_ctx.GetTargetRef().GetDebugger().GetThreadFormat();
1661
1662   assert(thread_format);
1663
1664   DumpUsingFormat(strm, frame_idx, thread_format);
1665 }
1666
1667 void Thread::SettingsInitialize() {}
1668
1669 void Thread::SettingsTerminate() {}
1670
1671 lldb::addr_t Thread::GetThreadPointer() {
1672   if (m_reg_context_sp)
1673     return m_reg_context_sp->GetThreadPointer();
1674   return LLDB_INVALID_ADDRESS;
1675 }
1676
1677 addr_t Thread::GetThreadLocalData(const ModuleSP module,
1678                                   lldb::addr_t tls_file_addr) {
1679   // The default implementation is to ask the dynamic loader for it. This can
1680   // be overridden for specific platforms.
1681   DynamicLoader *loader = GetProcess()->GetDynamicLoader();
1682   if (loader)
1683     return loader->GetThreadLocalData(module, shared_from_this(),
1684                                       tls_file_addr);
1685   else
1686     return LLDB_INVALID_ADDRESS;
1687 }
1688
1689 bool Thread::SafeToCallFunctions() {
1690   Process *process = GetProcess().get();
1691   if (process) {
1692     DynamicLoader *loader = GetProcess()->GetDynamicLoader();
1693     if (loader && loader->IsFullyInitialized() == false)
1694       return false;
1695
1696     SystemRuntime *runtime = process->GetSystemRuntime();
1697     if (runtime) {
1698       return runtime->SafeToCallFunctionsOnThisThread(shared_from_this());
1699     }
1700   }
1701   return true;
1702 }
1703
1704 lldb::StackFrameSP
1705 Thread::GetStackFrameSPForStackFramePtr(StackFrame *stack_frame_ptr) {
1706   return GetStackFrameList()->GetStackFrameSPForStackFramePtr(stack_frame_ptr);
1707 }
1708
1709 std::string Thread::StopReasonAsString(lldb::StopReason reason) {
1710   switch (reason) {
1711   case eStopReasonInvalid:
1712     return "invalid";
1713   case eStopReasonNone:
1714     return "none";
1715   case eStopReasonTrace:
1716     return "trace";
1717   case eStopReasonBreakpoint:
1718     return "breakpoint";
1719   case eStopReasonWatchpoint:
1720     return "watchpoint";
1721   case eStopReasonSignal:
1722     return "signal";
1723   case eStopReasonException:
1724     return "exception";
1725   case eStopReasonExec:
1726     return "exec";
1727   case eStopReasonFork:
1728     return "fork";
1729   case eStopReasonVFork:
1730     return "vfork";
1731   case eStopReasonVForkDone:
1732     return "vfork done";
1733   case eStopReasonPlanComplete:
1734     return "plan complete";
1735   case eStopReasonThreadExiting:
1736     return "thread exiting";
1737   case eStopReasonInstrumentation:
1738     return "instrumentation break";
1739   case eStopReasonProcessorTrace:
1740     return "processor trace";
1741   case eStopReasonInterrupt:
1742     return "async interrupt";
1743   }
1744
1745   return "StopReason = " + std::to_string(reason);
1746 }
1747
1748 std::string Thread::RunModeAsString(lldb::RunMode mode) {
1749   switch (mode) {
1750   case eOnlyThisThread:
1751     return "only this thread";
1752   case eAllThreads:
1753     return "all threads";
1754   case eOnlyDuringStepping:
1755     return "only during stepping";
1756   }
1757
1758   return "RunMode = " + std::to_string(mode);
1759 }
1760
1761 size_t Thread::GetStatus(Stream &strm, uint32_t start_frame,
1762                          uint32_t num_frames, uint32_t num_frames_with_source,
1763                          bool stop_format, bool show_hidden, bool only_stacks) {
1764
1765   if (!only_stacks) {
1766     ExecutionContext exe_ctx(shared_from_this());
1767     Target *target = exe_ctx.GetTargetPtr();
1768     Process *process = exe_ctx.GetProcessPtr();
1769     strm.Indent();
1770     bool is_selected = false;
1771     if (process) {
1772       if (process->GetThreadList().GetSelectedThread().get() == this)
1773         is_selected = true;
1774     }
1775     strm.Printf("%c ", is_selected ? '*' : ' ');
1776     if (target && target->GetDebugger().GetUseExternalEditor()) {
1777       StackFrameSP frame_sp = GetStackFrameAtIndex(start_frame);
1778       if (frame_sp) {
1779         SymbolContext frame_sc(
1780             frame_sp->GetSymbolContext(eSymbolContextLineEntry));
1781         if (frame_sc.line_entry.line != 0 && frame_sc.line_entry.GetFile()) {
1782           if (llvm::Error e = Host::OpenFileInExternalEditor(
1783                   target->GetDebugger().GetExternalEditor(),
1784                   frame_sc.line_entry.GetFile(), frame_sc.line_entry.line)) {
1785             LLDB_LOG_ERROR(GetLog(LLDBLog::Host), std::move(e),
1786                            "OpenFileInExternalEditor failed: {0}");
1787           }
1788         }
1789       }
1790     }
1791
1792     DumpUsingSettingsFormat(strm, start_frame, stop_format);
1793   }
1794
1795   size_t num_frames_shown = 0;
1796   if (num_frames > 0) {
1797     strm.IndentMore();
1798
1799     const bool show_frame_info = true;
1800     const bool show_frame_unique = only_stacks;
1801     const char *selected_frame_marker = nullptr;
1802     if (num_frames == 1 || only_stacks ||
1803         (GetID() != GetProcess()->GetThreadList().GetSelectedThread()->GetID()))
1804       strm.IndentMore();
1805     else
1806       selected_frame_marker = "* ";
1807
1808     num_frames_shown = GetStackFrameList()->GetStatus(
1809         strm, start_frame, num_frames, show_frame_info, num_frames_with_source,
1810         show_frame_unique, show_hidden, selected_frame_marker);
1811     if (num_frames == 1)
1812       strm.IndentLess();
1813     strm.IndentLess();
1814   }
1815   return num_frames_shown;
1816 }
1817
1818 bool Thread::GetDescription(Stream &strm, lldb::DescriptionLevel level,
1819                             bool print_json_thread, bool print_json_stopinfo) {
1820   const bool stop_format = false;
1821   DumpUsingSettingsFormat(strm, 0, stop_format);
1822   strm.Printf("\n");
1823
1824   StructuredData::ObjectSP thread_info = GetExtendedInfo();
1825
1826   if (print_json_thread || print_json_stopinfo) {
1827     if (thread_info && print_json_thread) {
1828       thread_info->Dump(strm);
1829       strm.Printf("\n");
1830     }
1831
1832     if (print_json_stopinfo && m_stop_info_sp) {
1833       StructuredData::ObjectSP stop_info = m_stop_info_sp->GetExtendedInfo();
1834       if (stop_info) {
1835         stop_info->Dump(strm);
1836         strm.Printf("\n");
1837       }
1838     }
1839
1840     return true;
1841   }
1842
1843   if (thread_info) {
1844     StructuredData::ObjectSP activity =
1845         thread_info->GetObjectForDotSeparatedPath("activity");
1846     StructuredData::ObjectSP breadcrumb =
1847         thread_info->GetObjectForDotSeparatedPath("breadcrumb");
1848     StructuredData::ObjectSP messages =
1849         thread_info->GetObjectForDotSeparatedPath("trace_messages");
1850
1851     bool printed_activity = false;
1852     if (activity && activity->GetType() == eStructuredDataTypeDictionary) {
1853       StructuredData::Dictionary *activity_dict = activity->GetAsDictionary();
1854       StructuredData::ObjectSP id = activity_dict->GetValueForKey("id");
1855       StructuredData::ObjectSP name = activity_dict->GetValueForKey("name");
1856       if (name && name->GetType() == eStructuredDataTypeString && id &&
1857           id->GetType() == eStructuredDataTypeInteger) {
1858         strm.Format("  Activity '{0}', {1:x}\n",
1859                     name->GetAsString()->GetValue(),
1860                     id->GetUnsignedIntegerValue());
1861       }
1862       printed_activity = true;
1863     }
1864     bool printed_breadcrumb = false;
1865     if (breadcrumb && breadcrumb->GetType() == eStructuredDataTypeDictionary) {
1866       if (printed_activity)
1867         strm.Printf("\n");
1868       StructuredData::Dictionary *breadcrumb_dict =
1869           breadcrumb->GetAsDictionary();
1870       StructuredData::ObjectSP breadcrumb_text =
1871           breadcrumb_dict->GetValueForKey("name");
1872       if (breadcrumb_text &&
1873           breadcrumb_text->GetType() == eStructuredDataTypeString) {
1874         strm.Format("  Current Breadcrumb: {0}\n",
1875                     breadcrumb_text->GetAsString()->GetValue());
1876       }
1877       printed_breadcrumb = true;
1878     }
1879     if (messages && messages->GetType() == eStructuredDataTypeArray) {
1880       if (printed_breadcrumb)
1881         strm.Printf("\n");
1882       StructuredData::Array *messages_array = messages->GetAsArray();
1883       const size_t msg_count = messages_array->GetSize();
1884       if (msg_count > 0) {
1885         strm.Printf("  %zu trace messages:\n", msg_count);
1886         for (size_t i = 0; i < msg_count; i++) {
1887           StructuredData::ObjectSP message = messages_array->GetItemAtIndex(i);
1888           if (message && message->GetType() == eStructuredDataTypeDictionary) {
1889             StructuredData::Dictionary *message_dict =
1890                 message->GetAsDictionary();
1891             StructuredData::ObjectSP message_text =
1892                 message_dict->GetValueForKey("message");
1893             if (message_text &&
1894                 message_text->GetType() == eStructuredDataTypeString) {
1895               strm.Format("    {0}\n", message_text->GetAsString()->GetValue());
1896             }
1897           }
1898         }
1899       }
1900     }
1901   }
1902
1903   return true;
1904 }
1905
1906 size_t Thread::GetStackFrameStatus(Stream &strm, uint32_t first_frame,
1907                                    uint32_t num_frames, bool show_frame_info,
1908                                    uint32_t num_frames_with_source,
1909                                    bool show_hidden) {
1910   return GetStackFrameList()->GetStatus(strm, first_frame, num_frames,
1911                                         show_frame_info, num_frames_with_source,
1912                                         /*show_unique*/ false, show_hidden);
1913 }
1914
1915 Unwind &Thread::GetUnwinder() {
1916   if (!m_unwinder_up)
1917     m_unwinder_up = std::make_unique<UnwindLLDB>(*this);
1918   return *m_unwinder_up;
1919 }
1920
1921 void Thread::Flush() {
1922   ClearStackFrames();
1923   m_reg_context_sp.reset();
1924 }
1925
1926 bool Thread::IsStillAtLastBreakpointHit() {
1927   // If we are currently stopped at a breakpoint, always return that stopinfo
1928   // and don't reset it. This allows threads to maintain their breakpoint
1929   // stopinfo, such as when thread-stepping in multithreaded programs.
1930   if (m_stop_info_sp) {
1931     StopReason stop_reason = m_stop_info_sp->GetStopReason();
1932     if (stop_reason == lldb::eStopReasonBreakpoint) {
1933       uint64_t value = m_stop_info_sp->GetValue();
1934       lldb::RegisterContextSP reg_ctx_sp(GetRegisterContext());
1935       if (reg_ctx_sp) {
1936         lldb::addr_t pc = reg_ctx_sp->GetPC();
1937         BreakpointSiteSP bp_site_sp =
1938             GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
1939         if (bp_site_sp && static_cast<break_id_t>(value) == bp_site_sp->GetID())
1940           return true;
1941       }
1942     }
1943   }
1944   return false;
1945 }
1946
1947 Status Thread::StepIn(bool source_step,
1948                       LazyBool step_in_avoids_code_without_debug_info,
1949                       LazyBool step_out_avoids_code_without_debug_info)
1950
1951 {
1952   Status error;
1953   Process *process = GetProcess().get();
1954   if (StateIsStoppedState(process->GetState(), true)) {
1955     StackFrameSP frame_sp = GetStackFrameAtIndex(0);
1956     ThreadPlanSP new_plan_sp;
1957     const lldb::RunMode run_mode = eOnlyThisThread;
1958     const bool abort_other_plans = false;
1959
1960     if (source_step && frame_sp && frame_sp->HasDebugInformation()) {
1961       SymbolContext sc(frame_sp->GetSymbolContext(eSymbolContextEverything));
1962       new_plan_sp = QueueThreadPlanForStepInRange(
1963           abort_other_plans, sc.line_entry, sc, nullptr, run_mode, error,
1964           step_in_avoids_code_without_debug_info,
1965           step_out_avoids_code_without_debug_info);
1966     } else {
1967       new_plan_sp = QueueThreadPlanForStepSingleInstruction(
1968           false, abort_other_plans, run_mode, error);
1969     }
1970
1971     new_plan_sp->SetIsControllingPlan(true);
1972     new_plan_sp->SetOkayToDiscard(false);
1973
1974     // Why do we need to set the current thread by ID here???
1975     process->GetThreadList().SetSelectedThreadByID(GetID());
1976     error = process->Resume();
1977   } else {
1978     error = Status::FromErrorString("process not stopped");
1979   }
1980   return error;
1981 }
1982
1983 Status Thread::StepOver(bool source_step,
1984                         LazyBool step_out_avoids_code_without_debug_info) {
1985   Status error;
1986   Process *process = GetProcess().get();
1987   if (StateIsStoppedState(process->GetState(), true)) {
1988     StackFrameSP frame_sp = GetStackFrameAtIndex(0);
1989     ThreadPlanSP new_plan_sp;
1990
1991     const lldb::RunMode run_mode = eOnlyThisThread;
1992     const bool abort_other_plans = false;
1993
1994     if (source_step && frame_sp && frame_sp->HasDebugInformation()) {
1995       SymbolContext sc(frame_sp->GetSymbolContext(eSymbolContextEverything));
1996       new_plan_sp = QueueThreadPlanForStepOverRange(
1997           abort_other_plans, sc.line_entry, sc, run_mode, error,
1998           step_out_avoids_code_without_debug_info);
1999     } else {
2000       new_plan_sp = QueueThreadPlanForStepSingleInstruction(
2001           true, abort_other_plans, run_mode, error);
2002     }
2003
2004     new_plan_sp->SetIsControllingPlan(true);
2005     new_plan_sp->SetOkayToDiscard(false);
2006
2007     // Why do we need to set the current thread by ID here???
2008     process->GetThreadList().SetSelectedThreadByID(GetID());
2009     error = process->Resume();
2010   } else {
2011     error = Status::FromErrorString("process not stopped");
2012   }
2013   return error;
2014 }
2015
2016 Status Thread::StepOut(uint32_t frame_idx) {
2017   Status error;
2018   Process *process = GetProcess().get();
2019   if (StateIsStoppedState(process->GetState(), true)) {
2020     const bool first_instruction = false;
2021     const bool stop_other_threads = false;
2022     const bool abort_other_plans = false;
2023
2024     ThreadPlanSP new_plan_sp(QueueThreadPlanForStepOut(
2025         abort_other_plans, nullptr, first_instruction, stop_other_threads,
2026         eVoteYes, eVoteNoOpinion, frame_idx, error));
2027
2028     new_plan_sp->SetIsControllingPlan(true);
2029     new_plan_sp->SetOkayToDiscard(false);
2030
2031     // Why do we need to set the current thread by ID here???
2032     process->GetThreadList().SetSelectedThreadByID(GetID());
2033     error = process->Resume();
2034   } else {
2035     error = Status::FromErrorString("process not stopped");
2036   }
2037   return error;
2038 }
2039
2040 ValueObjectSP Thread::GetCurrentException() {
2041   if (auto frame_sp = GetStackFrameAtIndex(0))
2042     if (auto recognized_frame = frame_sp->GetRecognizedFrame())
2043       if (auto e = recognized_frame->GetExceptionObject())
2044         return e;
2045
2046   // NOTE: Even though this behavior is generalized, only ObjC is actually
2047   // supported at the moment.
2048   for (LanguageRuntime *runtime : GetProcess()->GetLanguageRuntimes()) {
2049     if (auto e = runtime->GetExceptionObjectForThread(shared_from_this()))
2050       return e;
2051   }
2052
2053   return ValueObjectSP();
2054 }
2055
2056 ThreadSP Thread::GetCurrentExceptionBacktrace() {
2057   ValueObjectSP exception = GetCurrentException();
2058   if (!exception)
2059     return ThreadSP();
2060
2061   // NOTE: Even though this behavior is generalized, only ObjC is actually
2062   // supported at the moment.
2063   for (LanguageRuntime *runtime : GetProcess()->GetLanguageRuntimes()) {
2064     if (auto bt = runtime->GetBacktraceThreadFromException(exception))
2065       return bt;
2066   }
2067
2068   return ThreadSP();
2069 }
2070
2071 lldb::ValueObjectSP Thread::GetSiginfoValue() {
2072   ProcessSP process_sp = GetProcess();
2073   assert(process_sp);
2074   Target &target = process_sp->GetTarget();
2075   PlatformSP platform_sp = target.GetPlatform();
2076   assert(platform_sp);
2077   ArchSpec arch = target.GetArchitecture();
2078
2079   CompilerType type = platform_sp->GetSiginfoType(arch.GetTriple());
2080   if (!type.IsValid())
2081     return ValueObjectConstResult::Create(
2082         &target, Status::FromErrorString("no siginfo_t for the platform"));
2083
2084   std::optional<uint64_t> type_size = type.GetByteSize(nullptr);
2085   assert(type_size);
2086   llvm::Expected<std::unique_ptr<llvm::MemoryBuffer>> data =
2087       GetSiginfo(*type_size);
2088   if (!data)
2089     return ValueObjectConstResult::Create(&target,
2090                                           Status::FromError(data.takeError()));
2091
2092   DataExtractor data_extractor{data.get()->getBufferStart(), data.get()->getBufferSize(),
2093     process_sp->GetByteOrder(), arch.GetAddressByteSize()};
2094   return ValueObjectConstResult::Create(&target, type, ConstString("__lldb_siginfo"), data_extractor);
2095 }