LLDB mainline
SBThread.cpp
Go to the documentation of this file.
1//===-- SBThread.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/API/SBThread.h"
10#include "Utils.h"
11#include "lldb/API/SBAddress.h"
12#include "lldb/API/SBDebugger.h"
13#include "lldb/API/SBEvent.h"
14#include "lldb/API/SBFileSpec.h"
15#include "lldb/API/SBFormat.h"
16#include "lldb/API/SBFrame.h"
18#include "lldb/API/SBProcess.h"
19#include "lldb/API/SBStream.h"
24#include "lldb/API/SBValue.h"
26#include "lldb/Core/Debugger.h"
31#include "lldb/Target/Process.h"
32#include "lldb/Target/Queue.h"
35#include "lldb/Target/Target.h"
36#include "lldb/Target/Thread.h"
43#include "lldb/Utility/State.h"
44#include "lldb/Utility/Stream.h"
48
49#include <memory>
50
51using namespace lldb;
52using namespace lldb_private;
53
59
60// Constructors
64
65SBThread::SBThread(const ThreadSP &lldb_object_sp)
66 : m_opaque_sp(new ExecutionContextRef(lldb_object_sp)) {
67 LLDB_INSTRUMENT_VA(this, lldb_object_sp);
68}
69
71 LLDB_INSTRUMENT_VA(this, rhs);
72
74}
75
76// Assignment operator
77
79 LLDB_INSTRUMENT_VA(this, rhs);
80
81 if (this != &rhs)
83 return *this;
84}
85
86// Destructor
87SBThread::~SBThread() = default;
88
91
92 SBQueue sb_queue;
93 QueueSP queue_sp;
94 llvm::Expected<StoppedExecutionContext> exe_ctx =
96 if (!exe_ctx) {
97 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
98 return SBQueue();
99 }
100
101 if (exe_ctx->HasThreadScope()) {
102 queue_sp = exe_ctx->GetThreadPtr()->GetQueue();
103 if (queue_sp) {
104 sb_queue.SetQueue(queue_sp);
105 }
106 }
107
108 return sb_queue;
109}
110
111bool SBThread::IsValid() const {
112 LLDB_INSTRUMENT_VA(this);
113 return this->operator bool();
114}
115SBThread::operator bool() const {
116 LLDB_INSTRUMENT_VA(this);
117 if (!m_opaque_sp)
118 return false;
119
120 llvm::Expected<StoppedExecutionContext> exe_ctx =
122 if (!exe_ctx) {
123 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
124 return false;
125 }
126
127 return m_opaque_sp->GetThreadSP().get() != nullptr;
128}
129
131 LLDB_INSTRUMENT_VA(this);
132
133 m_opaque_sp->Clear();
134}
135
137 LLDB_INSTRUMENT_VA(this);
138
140 llvm::Expected<StoppedExecutionContext> exe_ctx =
142 if (!exe_ctx) {
143 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
144 return reason;
145 }
146
147 if (exe_ctx->HasThreadScope())
148 return exe_ctx->GetThreadPtr()->GetStopReason();
149
150 return reason;
151}
152
154 LLDB_INSTRUMENT_VA(this);
155
156 llvm::Expected<StoppedExecutionContext> exe_ctx =
158 if (exe_ctx) {
159 if (exe_ctx->HasThreadScope()) {
160 StopInfoSP stop_info_sp = exe_ctx->GetThreadPtr()->GetStopInfo();
161 if (stop_info_sp)
162 return stop_info_sp->GetStopReasonDataCount();
163 }
164 } else {
165 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
166 return 0;
167 }
168 return 0;
169}
170
172 LLDB_INSTRUMENT_VA(this, idx);
173
174 llvm::Expected<StoppedExecutionContext> exe_ctx =
176 if (exe_ctx) {
177 if (exe_ctx->HasThreadScope()) {
178 Thread *thread = exe_ctx->GetThreadPtr();
179 StopInfoSP stop_info_sp = thread->GetStopInfo();
180 if (stop_info_sp)
181 return stop_info_sp->GetStopReasonDataAtIndex(idx);
182 }
183 } else {
184 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
185 return 0;
186 }
187 return 0;
188}
189
191 LLDB_INSTRUMENT_VA(this, stream);
192
193 Stream &strm = stream.ref();
194
195 llvm::Expected<StoppedExecutionContext> exe_ctx =
197 if (!exe_ctx) {
198 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
199 return false;
200 }
201
202 if (!exe_ctx->HasThreadScope())
203 return false;
204
205 StopInfoSP stop_info = exe_ctx->GetThreadPtr()->GetStopInfo();
206 StructuredData::ObjectSP info = stop_info->GetExtendedInfo();
207 if (!info)
208 return false;
209
210 info->Dump(strm);
211
212 return true;
213}
214
217 LLDB_INSTRUMENT_VA(this, type);
218
219 SBThreadCollection threads;
220
221 llvm::Expected<StoppedExecutionContext> exe_ctx =
223 if (!exe_ctx) {
224 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
225 return SBThreadCollection();
226 }
227
228 if (!exe_ctx->HasThreadScope())
229 return SBThreadCollection();
230
231 ProcessSP process_sp = exe_ctx->GetProcessSP();
232
233 StopInfoSP stop_info = exe_ctx->GetThreadPtr()->GetStopInfo();
234 StructuredData::ObjectSP info = stop_info->GetExtendedInfo();
235 if (!info)
236 return threads;
237
238 threads = process_sp->GetInstrumentationRuntime(type)
239 ->GetBacktracesFromExtendedStopInfo(info);
240 return threads;
241}
242
244 LLDB_INSTRUMENT_VA(this, stream);
245
246 if (!m_opaque_sp)
247 return false;
248
249 llvm::Expected<StoppedExecutionContext> exe_ctx =
251 if (!exe_ctx) {
252 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
253 return false;
254 }
255
256 if (!exe_ctx->HasThreadScope())
257 return false;
258
259 Stream &strm = stream.ref();
260 const std::string stop_desc = exe_ctx->GetThreadPtr()->GetStopDescription();
261 strm.PutCString(stop_desc);
262
263 return true;
264}
265
266size_t SBThread::GetStopDescription(char *dst_or_null, size_t dst_len) {
267 LLDB_INSTRUMENT_VA(this, dst_or_null, dst_len);
268
269 if (dst_or_null)
270 *dst_or_null = 0;
271
272 llvm::Expected<StoppedExecutionContext> exe_ctx =
274 if (!exe_ctx) {
275 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
276 return 0;
277 }
278
279 if (!exe_ctx->HasThreadScope())
280 return 0;
281
282 std::string thread_stop_desc = exe_ctx->GetThreadPtr()->GetStopDescription();
283 if (thread_stop_desc.empty())
284 return 0;
285
286 if (dst_or_null)
287 return ::snprintf(dst_or_null, dst_len, "%s", thread_stop_desc.c_str()) + 1;
288
289 // NULL dst passed in, return the length needed to contain the
290 // description.
291 return thread_stop_desc.size() + 1; // Include the NULL byte for size
292}
293
295 LLDB_INSTRUMENT_VA(this);
296
297 ValueObjectSP return_valobj_sp;
298 llvm::Expected<StoppedExecutionContext> exe_ctx =
300 if (!exe_ctx) {
301 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
302 return SBValue();
303 }
304
305 if (exe_ctx->HasThreadScope()) {
306 StopInfoSP stop_info_sp = exe_ctx->GetThreadPtr()->GetStopInfo();
307 if (stop_info_sp) {
308 return_valobj_sp = StopInfo::GetReturnValueObject(stop_info_sp);
309 }
310 }
311
312 return SBValue(return_valobj_sp);
313}
314
315void SBThread::SetThread(const ThreadSP &lldb_object_sp) {
316 m_opaque_sp->SetThreadSP(lldb_object_sp);
317}
318
320 LLDB_INSTRUMENT_VA(this);
321
322 llvm::Expected<StoppedExecutionContext> exe_ctx =
324 if (!exe_ctx) {
325 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
327 }
328
329 ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
330 if (thread_sp)
331 return thread_sp->GetID();
333}
334
335uint32_t SBThread::GetIndexID() const {
336 LLDB_INSTRUMENT_VA(this);
337
338 llvm::Expected<StoppedExecutionContext> exe_ctx =
340 if (!exe_ctx) {
341 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
343 }
344
345 ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
346 if (thread_sp)
347 return thread_sp->GetIndexID();
349}
350
351const char *SBThread::GetName() const {
352 LLDB_INSTRUMENT_VA(this);
353
354 llvm::Expected<StoppedExecutionContext> exe_ctx =
356 if (!exe_ctx) {
357 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
358 return nullptr;
359 }
360
361 if (!exe_ctx->HasThreadScope())
362 return nullptr;
363
364 return ConstString(exe_ctx->GetThreadPtr()->GetName()).GetCString();
365}
366
367const char *SBThread::GetQueueName() const {
368 LLDB_INSTRUMENT_VA(this);
369
370 llvm::Expected<StoppedExecutionContext> exe_ctx =
372 if (!exe_ctx) {
373 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
374 return nullptr;
375 }
376
377 if (!exe_ctx->HasThreadScope())
378 return nullptr;
379
380 return ConstString(exe_ctx->GetThreadPtr()->GetQueueName()).GetCString();
381}
382
384 LLDB_INSTRUMENT_VA(this);
385
387 llvm::Expected<StoppedExecutionContext> exe_ctx =
389 if (!exe_ctx) {
390 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
391 return id;
392 }
393
394 if (exe_ctx->HasThreadScope()) {
395 id = exe_ctx->GetThreadPtr()->GetQueueID();
396 }
397
398 return id;
399}
400
401bool SBThread::GetInfoItemByPathAsString(const char *path, SBStream &strm) {
402 LLDB_INSTRUMENT_VA(this, path, strm);
403
404 bool success = false;
405 llvm::Expected<StoppedExecutionContext> exe_ctx =
407 if (exe_ctx) {
408 if (exe_ctx->HasThreadScope()) {
409 Thread *thread = exe_ctx->GetThreadPtr();
410 StructuredData::ObjectSP info_root_sp = thread->GetExtendedInfo();
411 if (info_root_sp) {
413 info_root_sp->GetObjectForDotSeparatedPath(path);
414 if (node) {
415 if (node->GetType() == eStructuredDataTypeString) {
416 strm.ref() << node->GetAsString()->GetValue();
417 success = true;
418 }
419 if (node->GetType() == eStructuredDataTypeInteger) {
420 strm.Printf("0x%" PRIx64, node->GetUnsignedIntegerValue());
421 success = true;
422 }
423 if (node->GetType() == eStructuredDataTypeFloat) {
424 strm.Printf("0x%f", node->GetAsFloat()->GetValue());
425 success = true;
426 }
427 if (node->GetType() == eStructuredDataTypeBoolean) {
428 if (node->GetAsBoolean()->GetValue())
429 strm.Printf("true");
430 else
431 strm.Printf("false");
432 success = true;
433 }
434 if (node->GetType() == eStructuredDataTypeNull) {
435 strm.Printf("null");
436 success = true;
437 }
438 }
439 }
440 }
441 } else {
442 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
443 return success;
444 }
445
446 return success;
447}
448
450 ThreadPlan *new_plan) {
451 Thread *thread = exe_ctx.GetThreadPtr();
452 if (!thread)
453 return Status::FromErrorString("No thread in SBThread::ResumeNewPlan");
454
455 // User level plans should be Controlling Plans so they can be interrupted,
456 // other plans executed, and then a "continue" will resume the plan.
457 if (new_plan != nullptr) {
458 new_plan->SetIsControllingPlan(true);
459 new_plan->SetOkayToDiscard(false);
460 }
461
462 // Why do we need to set the current thread by ID here???
463 Process *process = exe_ctx.GetProcessPtr();
464 process->GetThreadList().SetSelectedThreadByID(thread->GetID());
465
466 // Release the run lock but keep the API lock.
467 TargetAPIMutex api_mutex = exe_ctx.AllowResume();
468 std::unique_lock<TargetAPIMutex> guard(api_mutex, std::adopt_lock);
469 if (process->GetTarget().GetDebugger().GetAsyncExecution())
470 return process->Resume();
471 return process->ResumeSynchronous(nullptr);
472}
473
474void SBThread::StepOver(lldb::RunMode stop_other_threads) {
475 LLDB_INSTRUMENT_VA(this, stop_other_threads);
476
477 SBError error; // Ignored
478 StepOver(stop_other_threads, error);
479}
480
481void SBThread::StepOver(lldb::RunMode stop_other_threads, SBError &error) {
482 LLDB_INSTRUMENT_VA(this, stop_other_threads, error);
483
484 llvm::Expected<StoppedExecutionContext> exe_ctx =
486 if (!exe_ctx) {
487 error = Status::FromError(exe_ctx.takeError());
488 return;
489 }
490
491 if (!exe_ctx->HasThreadScope()) {
492 error = Status::FromErrorString("this SBThread object is invalid");
493 return;
494 }
495
496 Thread *thread = exe_ctx->GetThreadPtr();
497 bool abort_other_plans = false;
498 StackFrameSP frame_sp(thread->GetStackFrameAtIndex(0));
499
500 Status new_plan_status;
501 ThreadPlanSP new_plan_sp;
502 if (frame_sp) {
503 if (frame_sp->HasDebugInformation()) {
504 const LazyBool avoid_no_debug = eLazyBoolCalculate;
505 SymbolContext sc(frame_sp->GetSymbolContext(eSymbolContextEverything));
506 new_plan_sp = thread->QueueThreadPlanForStepOverRange(
507 abort_other_plans, sc.line_entry, sc, stop_other_threads,
508 new_plan_status, avoid_no_debug);
509 } else {
510 new_plan_sp = thread->QueueThreadPlanForStepSingleInstruction(
511 true, abort_other_plans, stop_other_threads, new_plan_status);
512 }
513 }
514 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
515}
516
517void SBThread::StepInto(lldb::RunMode stop_other_threads) {
518 LLDB_INSTRUMENT_VA(this, stop_other_threads);
519
520 StepInto(nullptr, stop_other_threads);
521}
522
523void SBThread::StepInto(const char *target_name,
524 lldb::RunMode stop_other_threads) {
525 LLDB_INSTRUMENT_VA(this, target_name, stop_other_threads);
526
527 SBError error; // Ignored
528 StepInto(target_name, LLDB_INVALID_LINE_NUMBER, error, stop_other_threads);
529}
530
531void SBThread::StepInto(const char *target_name, uint32_t end_line,
532 SBError &error, lldb::RunMode stop_other_threads) {
533 LLDB_INSTRUMENT_VA(this, target_name, end_line, error, stop_other_threads);
534
535 llvm::Expected<StoppedExecutionContext> exe_ctx =
537 if (!exe_ctx) {
538 error = Status::FromError(exe_ctx.takeError());
539 return;
540 }
541
542 if (!exe_ctx->HasThreadScope()) {
543 error = Status::FromErrorString("this SBThread object is invalid");
544 return;
545 }
546
547 bool abort_other_plans = false;
548
549 Thread *thread = exe_ctx->GetThreadPtr();
550 StackFrameSP frame_sp(thread->GetStackFrameAtIndex(0));
551 ThreadPlanSP new_plan_sp;
552 Status new_plan_status;
553
554 if (frame_sp && frame_sp->HasDebugInformation()) {
555 SymbolContext sc(frame_sp->GetSymbolContext(eSymbolContextEverything));
556 AddressRange range;
557 if (end_line == LLDB_INVALID_LINE_NUMBER)
558 range = sc.line_entry.range;
559 else {
560 llvm::Error err = sc.GetAddressRangeFromHereToEndLine(end_line, range);
561 if (err) {
562 error = Status::FromErrorString(llvm::toString(std::move(err)).c_str());
563 return;
564 }
565 }
566
567 const LazyBool step_out_avoids_code_without_debug_info =
569 const LazyBool step_in_avoids_code_without_debug_info =
571 new_plan_sp = thread->QueueThreadPlanForStepInRange(
572 abort_other_plans, range, sc, target_name, stop_other_threads,
573 new_plan_status, step_in_avoids_code_without_debug_info,
574 step_out_avoids_code_without_debug_info);
575 } else {
576 new_plan_sp = thread->QueueThreadPlanForStepSingleInstruction(
577 false, abort_other_plans, stop_other_threads, new_plan_status);
578 }
579
580 if (new_plan_status.Success())
581 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
582 else
583 error = Status::FromErrorString(new_plan_status.AsCString());
584}
585
587 LLDB_INSTRUMENT_VA(this);
588
589 SBError error; // Ignored
590 StepOut(error);
591}
592
595
596 llvm::Expected<StoppedExecutionContext> exe_ctx =
598 if (!exe_ctx) {
599 error = Status::FromError(exe_ctx.takeError());
600 return;
601 }
602
603 if (!exe_ctx->HasThreadScope()) {
604 error = Status::FromErrorString("this SBThread object is invalid");
605 return;
606 }
607
608 bool abort_other_plans = false;
609 bool stop_other_threads = false;
610
611 Thread *thread = exe_ctx->GetThreadPtr();
612
613 const LazyBool avoid_no_debug = eLazyBoolCalculate;
614 Status new_plan_status;
615 ThreadPlanSP new_plan_sp(thread->QueueThreadPlanForStepOut(
616 abort_other_plans, nullptr, false, stop_other_threads, eVoteYes,
617 eVoteNoOpinion, 0, new_plan_status, avoid_no_debug));
618
619 if (new_plan_status.Success())
620 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
621 else
622 error = Status::FromErrorString(new_plan_status.AsCString());
623}
624
626 LLDB_INSTRUMENT_VA(this, sb_frame);
627
628 SBError error; // Ignored
629 StepOutOfFrame(sb_frame, error);
630}
631
633 LLDB_INSTRUMENT_VA(this, sb_frame, error);
634
635 llvm::Expected<StoppedExecutionContext> exe_ctx =
637 if (!exe_ctx) {
638 error = Status::FromError(exe_ctx.takeError());
639 return;
640 }
641
642 if (!sb_frame.IsValid()) {
643 error = Status::FromErrorString("passed invalid SBFrame object");
644 return;
645 }
646
647 StackFrameSP frame_sp(sb_frame.GetFrameSP());
648
649 if (!exe_ctx->HasThreadScope()) {
650 error = Status::FromErrorString("this SBThread object is invalid");
651 return;
652 }
653
654 bool abort_other_plans = false;
655 bool stop_other_threads = false;
656 Thread *thread = exe_ctx->GetThreadPtr();
657 if (sb_frame.GetThread().GetThreadID() != thread->GetID()) {
658 error = Status::FromErrorString("passed a frame from another thread");
659 return;
660 }
661
662 Status new_plan_status;
663 ThreadPlanSP new_plan_sp(thread->QueueThreadPlanForStepOut(
664 abort_other_plans, nullptr, false, stop_other_threads, eVoteYes,
665 eVoteNoOpinion, frame_sp->GetFrameIndex(), new_plan_status));
666
667 if (new_plan_status.Success())
668 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
669 else
670 error = Status::FromErrorString(new_plan_status.AsCString());
671}
672
673void SBThread::StepInstruction(bool step_over) {
674 LLDB_INSTRUMENT_VA(this, step_over);
675
676 SBError error; // Ignored
677 StepInstruction(step_over, error);
678}
679
681 LLDB_INSTRUMENT_VA(this, step_over, error);
682
683 llvm::Expected<StoppedExecutionContext> exe_ctx =
685 if (!exe_ctx) {
686 error = Status::FromError(exe_ctx.takeError());
687 return;
688 }
689
690 if (!exe_ctx->HasThreadScope()) {
691 error = Status::FromErrorString("this SBThread object is invalid");
692 return;
693 }
694
695 Thread *thread = exe_ctx->GetThreadPtr();
696 Status new_plan_status;
697 ThreadPlanSP new_plan_sp(thread->QueueThreadPlanForStepSingleInstruction(
698 step_over, false, true, new_plan_status));
699
700 if (new_plan_status.Success())
701 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
702 else
703 error = Status::FromErrorString(new_plan_status.AsCString());
704}
705
707 LLDB_INSTRUMENT_VA(this, addr);
708
709 SBError error; // Ignored
710 RunToAddress(addr, error);
711}
712
714 LLDB_INSTRUMENT_VA(this, addr, error);
715
716 llvm::Expected<StoppedExecutionContext> exe_ctx =
718 if (!exe_ctx) {
719 error = Status::FromError(exe_ctx.takeError());
720 return;
721 }
722
723 if (!exe_ctx->HasThreadScope()) {
724 error = Status::FromErrorString("this SBThread object is invalid");
725 return;
726 }
727
728 bool abort_other_plans = false;
729 bool stop_other_threads = true;
730
731 Address target_addr(addr);
732
733 Thread *thread = exe_ctx->GetThreadPtr();
734
735 Status new_plan_status;
736 ThreadPlanSP new_plan_sp(thread->QueueThreadPlanForRunToAddress(
737 abort_other_plans, target_addr, stop_other_threads, new_plan_status));
738
739 if (new_plan_status.Success())
740 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
741 else
742 error = Status::FromErrorString(new_plan_status.AsCString());
743}
744
746 lldb::SBFileSpec &sb_file_spec, uint32_t line) {
747 LLDB_INSTRUMENT_VA(this, sb_frame, sb_file_spec, line);
748
749 SBError sb_error;
750 char path[PATH_MAX];
751
752 llvm::Expected<StoppedExecutionContext> exe_ctx =
754 if (!exe_ctx)
755 return Status::FromError(exe_ctx.takeError());
756
757 StackFrameSP frame_sp(sb_frame.GetFrameSP());
758
759 if (exe_ctx->HasThreadScope()) {
760 Target *target = exe_ctx->GetTargetPtr();
761 Thread *thread = exe_ctx->GetThreadPtr();
762
763 if (line == 0) {
764 sb_error = Status::FromErrorString("invalid line argument");
765 return sb_error;
766 }
767
768 if (!frame_sp) {
769 // We don't want to run SelectMostRelevantFrame here, for instance if
770 // you called a sequence of StepOverUntil's you wouldn't want the
771 // frame changed out from under you because you stepped into a
772 // recognized frame.
773 frame_sp = thread->GetSelectedFrame(DoNoSelectMostRelevantFrame);
774 if (!frame_sp)
775 frame_sp = thread->GetStackFrameAtIndex(0);
776 }
777
778 SymbolContext frame_sc;
779 if (!frame_sp) {
780 sb_error = Status::FromErrorString("no valid frames in thread to step");
781 return sb_error;
782 }
783
784 // If we have a frame, get its line
785 frame_sc = frame_sp->GetSymbolContext(
786 eSymbolContextCompUnit | eSymbolContextFunction |
787 eSymbolContextLineEntry | eSymbolContextSymbol);
788
789 if (frame_sc.comp_unit == nullptr) {
791 "frame %u doesn't have debug information", frame_sp->GetFrameIndex());
792 return sb_error;
793 }
794
795 FileSpec step_file_spec;
796 if (sb_file_spec.IsValid()) {
797 // The file spec passed in was valid, so use it
798 step_file_spec = sb_file_spec.ref();
799 } else {
800 if (frame_sc.line_entry.IsValid())
801 step_file_spec = frame_sc.line_entry.GetFile();
802 else {
803 sb_error = Status::FromErrorString(
804 "invalid file argument or no file for frame");
805 return sb_error;
806 }
807 }
808
809 // Grab the current function, then we will make sure the "until" address is
810 // within the function. We discard addresses that are out of the current
811 // function, and then if there are no addresses remaining, give an
812 // appropriate error message.
813
814 bool all_in_function = true;
815
816 std::vector<addr_t> step_over_until_addrs;
817 const bool abort_other_plans = false;
818 const bool stop_other_threads = false;
819 // TODO: Handle SourceLocationSpec column information
820 SourceLocationSpec location_spec(
821 step_file_spec, line, /*column=*/std::nullopt, /*check_inlines=*/true,
822 /*exact_match=*/false);
823
824 SymbolContextList sc_list;
825 frame_sc.comp_unit->ResolveSymbolContext(location_spec,
826 eSymbolContextLineEntry, sc_list);
827 for (const SymbolContext &sc : sc_list) {
828 addr_t step_addr =
829 sc.line_entry.range.GetBaseAddress().GetLoadAddress(target);
830 if (step_addr != LLDB_INVALID_ADDRESS) {
831 AddressRange unused_range;
832 if (frame_sc.function->GetRangeContainingLoadAddress(step_addr, *target,
833 unused_range))
834 step_over_until_addrs.push_back(step_addr);
835 else
836 all_in_function = false;
837 }
838 }
839
840 if (step_over_until_addrs.empty()) {
841 if (all_in_function) {
842 step_file_spec.GetPath(path, sizeof(path));
844 "No line entries for %s:%u", path, line);
845 } else
846 sb_error = Status::FromErrorString(
847 "step until target not in current function");
848 } else {
849 Status new_plan_status;
850 ThreadPlanSP new_plan_sp = thread->QueueThreadPlanForStepUntil(
851 abort_other_plans, step_over_until_addrs, stop_other_threads,
852 frame_sp->GetFrameIndex(), new_plan_status);
853
854 if (new_plan_status.Success())
855 sb_error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
856 else
857 sb_error = Status::FromErrorString(new_plan_status.AsCString());
858 }
859 } else {
860 sb_error = Status::FromErrorString("this SBThread object is invalid");
861 }
862 return sb_error;
863}
864
865SBError SBThread::StepUsingScriptedThreadPlan(const char *script_class_name) {
866 LLDB_INSTRUMENT_VA(this, script_class_name);
867
868 return StepUsingScriptedThreadPlan(script_class_name, true);
869}
870
871SBError SBThread::StepUsingScriptedThreadPlan(const char *script_class_name,
872 bool resume_immediately) {
873 LLDB_INSTRUMENT_VA(this, script_class_name, resume_immediately);
874
876 return StepUsingScriptedThreadPlan(script_class_name, no_data,
877 resume_immediately);
878}
879
880SBError SBThread::StepUsingScriptedThreadPlan(const char *script_class_name,
881 SBStructuredData &args_data,
882 bool resume_immediately) {
883 LLDB_INSTRUMENT_VA(this, script_class_name, args_data, resume_immediately);
884
886
887 llvm::Expected<StoppedExecutionContext> exe_ctx =
889 if (!exe_ctx)
890 return Status::FromError(exe_ctx.takeError());
891
892 if (!exe_ctx->HasThreadScope()) {
893 error = Status::FromErrorString("this SBThread object is invalid");
894 return error;
895 }
896
897 Thread *thread = exe_ctx->GetThreadPtr();
898 Status new_plan_status;
899 StructuredData::ObjectSP obj_sp = args_data.m_impl_up->GetObjectSP();
900
901 StructuredData::DictionarySP args_dict_sp;
902 if (obj_sp && obj_sp->GetType() == lldb::eStructuredDataTypeDictionary)
903 args_dict_sp = std::static_pointer_cast<StructuredData::Dictionary>(obj_sp);
904
905 ScriptedMetadata scripted_metadata(script_class_name, args_dict_sp);
906 ThreadPlanSP new_plan_sp = thread->QueueThreadPlanForStepScripted(
907 false, scripted_metadata, false, new_plan_status);
908
909 if (new_plan_status.Fail()) {
910 error = Status::FromErrorString(new_plan_status.AsCString());
911 return error;
912 }
913
914 if (!resume_immediately)
915 return error;
916
917 if (new_plan_status.Success())
918 error = ResumeNewPlan(std::move(*exe_ctx), new_plan_sp.get());
919 else
920 error = Status::FromErrorString(new_plan_status.AsCString());
921
922 return error;
923}
924
926 LLDB_INSTRUMENT_VA(this, file_spec, line);
927
928 SBError sb_error;
929
930 llvm::Expected<StoppedExecutionContext> exe_ctx =
932 if (!exe_ctx)
933 return Status::FromError(exe_ctx.takeError());
934
935 if (!exe_ctx->HasThreadScope()) {
936 sb_error = Status::FromErrorString("this SBThread object is invalid");
937 return sb_error;
938 }
939
940 Thread *thread = exe_ctx->GetThreadPtr();
941
942 Status err = thread->JumpToLine(file_spec.ref(), line, true);
943 sb_error.SetError(std::move(err));
944 return sb_error;
945}
946
948 LLDB_INSTRUMENT_VA(this, frame, return_value);
949
950 SBError sb_error;
951
952 llvm::Expected<StoppedExecutionContext> exe_ctx =
954 if (!exe_ctx)
955 return Status::FromError(exe_ctx.takeError());
956
957 if (exe_ctx->HasThreadScope()) {
958 Thread *thread = exe_ctx->GetThreadPtr();
959 sb_error.SetError(
960 thread->ReturnFromFrame(frame.GetFrameSP(), return_value.GetSP()));
961 }
962
963 return sb_error;
964}
965
967 LLDB_INSTRUMENT_VA(this);
968
969 SBError sb_error;
970
971 llvm::Expected<StoppedExecutionContext> exe_ctx =
973 if (!exe_ctx)
974 return Status::FromError(exe_ctx.takeError());
975
976 if (exe_ctx->HasThreadScope()) {
977 Thread *thread = exe_ctx->GetThreadPtr();
978 sb_error.SetError(thread->UnwindInnermostExpression());
979 if (sb_error.Success())
980 thread->SetSelectedFrameByIndex(0, false);
981 }
982
983 return sb_error;
984}
985
987 LLDB_INSTRUMENT_VA(this);
988
989 SBError error; // Ignored
990 return Suspend(error);
991}
992
995
996 llvm::Expected<StoppedExecutionContext> exe_ctx =
998 if (!exe_ctx) {
999 error = Status::FromError(exe_ctx.takeError());
1000 return false;
1001 }
1002
1003 bool result = false;
1004 if (exe_ctx->HasThreadScope()) {
1005 exe_ctx->GetThreadPtr()->SetResumeState(eStateSuspended);
1006 result = true;
1007 } else
1008 error = Status::FromErrorString("this SBThread object is invalid");
1009 return result;
1010}
1011
1013 LLDB_INSTRUMENT_VA(this);
1014
1015 SBError error; // Ignored
1016 return Resume(error);
1017}
1018
1021
1022 llvm::Expected<StoppedExecutionContext> exe_ctx =
1024 if (!exe_ctx) {
1025 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1026 error = Status::FromErrorString("process is running");
1027 return false;
1028 }
1029
1030 bool result = false;
1031 if (exe_ctx->HasThreadScope()) {
1032 const bool override_suspend = true;
1033 exe_ctx->GetThreadPtr()->SetResumeState(eStateRunning, override_suspend);
1034 result = true;
1035 } else
1036 error = Status::FromErrorString("this SBThread object is invalid");
1037 return result;
1038}
1039
1041 LLDB_INSTRUMENT_VA(this);
1042
1043 llvm::Expected<StoppedExecutionContext> exe_ctx =
1045 if (!exe_ctx) {
1046 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1047 return false;
1048 }
1049
1050 if (exe_ctx->HasThreadScope())
1051 return exe_ctx->GetThreadPtr()->GetResumeState() == eStateSuspended;
1052 return false;
1053}
1054
1056 LLDB_INSTRUMENT_VA(this);
1057
1058 llvm::Expected<StoppedExecutionContext> exe_ctx =
1060 if (!exe_ctx) {
1061 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1062 return false;
1063 }
1064
1065 if (exe_ctx->HasThreadScope())
1066 return StateIsStoppedState(exe_ctx->GetThreadPtr()->GetState(), true);
1067 return false;
1068}
1069
1071 LLDB_INSTRUMENT_VA(this);
1072
1073 SBProcess sb_process;
1074 llvm::Expected<StoppedExecutionContext> exe_ctx =
1076 if (!exe_ctx) {
1077 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1078 return SBProcess();
1079 }
1080
1081 if (exe_ctx->HasThreadScope()) {
1082 // Have to go up to the target so we can get a shared pointer to our
1083 // process...
1084 sb_process.SetSP(exe_ctx->GetProcessSP());
1085 }
1086
1087 return sb_process;
1088}
1089
1091 LLDB_INSTRUMENT_VA(this);
1092
1093 llvm::Expected<StoppedExecutionContext> exe_ctx =
1095 if (!exe_ctx) {
1096 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1097 return 0;
1098 }
1099
1100 if (exe_ctx->HasThreadScope())
1101 return exe_ctx->GetThreadPtr()->GetStackFrameCount();
1102
1103 return 0;
1104}
1105
1107 LLDB_INSTRUMENT_VA(this, idx);
1108
1109 SBFrame sb_frame;
1110 llvm::Expected<StoppedExecutionContext> exe_ctx =
1112 if (!exe_ctx) {
1113 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1114 return SBFrame();
1115 }
1116
1117 if (exe_ctx->HasThreadScope()) {
1118 StackFrameSP frame_sp = exe_ctx->GetThreadPtr()->GetStackFrameAtIndex(idx);
1119 sb_frame.SetFrameSP(frame_sp);
1120 }
1121
1122 return sb_frame;
1123}
1124
1126 LLDB_INSTRUMENT_VA(this);
1127
1128 SBFrameList sb_frame_list;
1129 llvm::Expected<StoppedExecutionContext> exe_ctx =
1131 if (!exe_ctx) {
1132 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1133 return SBFrameList();
1134 }
1135
1136 if (exe_ctx->HasThreadScope()) {
1137 StackFrameListSP frame_list_sp =
1138 exe_ctx->GetThreadPtr()->GetStackFrameList();
1139 sb_frame_list.SetFrameList(frame_list_sp);
1140 }
1141
1142 return sb_frame_list;
1143}
1144
1146 LLDB_INSTRUMENT_VA(this);
1147
1148 SBFrame sb_frame;
1149 llvm::Expected<StoppedExecutionContext> exe_ctx =
1151 if (!exe_ctx) {
1152 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1153 return SBFrame();
1154 }
1155
1156 if (exe_ctx->HasThreadScope()) {
1157 StackFrameSP frame_sp =
1158 exe_ctx->GetThreadPtr()->GetSelectedFrame(SelectMostRelevantFrame);
1159 sb_frame.SetFrameSP(frame_sp);
1160 }
1161
1162 return sb_frame;
1163}
1164
1166 LLDB_INSTRUMENT_VA(this, idx);
1167
1168 SBFrame sb_frame;
1169 StackFrameSP frame_sp;
1170 llvm::Expected<StoppedExecutionContext> exe_ctx =
1172 if (!exe_ctx) {
1173 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1174 return SBFrame();
1175 }
1176
1177 if (exe_ctx->HasThreadScope()) {
1178 Thread *thread = exe_ctx->GetThreadPtr();
1179 frame_sp = thread->GetStackFrameAtIndex(idx);
1180 if (frame_sp) {
1181 thread->SetSelectedFrame(frame_sp.get());
1182 sb_frame.SetFrameSP(frame_sp);
1183 }
1184 }
1185
1186 return sb_frame;
1187}
1188
1190 LLDB_INSTRUMENT_VA(event);
1191
1192 return Thread::ThreadEventData::GetEventDataFromEvent(event.get()) != nullptr;
1193}
1194
1200
1206
1207bool SBThread::operator==(const SBThread &rhs) const {
1208 LLDB_INSTRUMENT_VA(this, rhs);
1209
1210 return m_opaque_sp->GetThreadSP().get() ==
1211 rhs.m_opaque_sp->GetThreadSP().get();
1212}
1213
1214bool SBThread::operator!=(const SBThread &rhs) const {
1215 LLDB_INSTRUMENT_VA(this, rhs);
1216
1217 return m_opaque_sp->GetThreadSP().get() !=
1218 rhs.m_opaque_sp->GetThreadSP().get();
1219}
1220
1221bool SBThread::GetStatus(SBStream &status) const {
1222 LLDB_INSTRUMENT_VA(this, status);
1223
1224 Stream &strm = status.ref();
1225
1226 llvm::Expected<StoppedExecutionContext> exe_ctx =
1228 if (!exe_ctx) {
1229 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1230 return false;
1231 }
1232
1233 if (exe_ctx->HasThreadScope()) {
1234 exe_ctx->GetThreadPtr()->GetStatus(strm, 0, 1, 1, true,
1235 /*show_hidden=*/true);
1236 } else
1237 strm.PutCString("No status");
1238
1239 return true;
1240}
1241
1242bool SBThread::GetDescription(SBStream &description) const {
1243 LLDB_INSTRUMENT_VA(this, description);
1244
1245 return GetDescription(description, false);
1246}
1247
1248bool SBThread::GetDescription(SBStream &description, bool stop_format) const {
1249 LLDB_INSTRUMENT_VA(this, description, stop_format);
1250
1251 Stream &strm = description.ref();
1252
1253 llvm::Expected<StoppedExecutionContext> exe_ctx =
1255 if (!exe_ctx) {
1256 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1257 return false;
1258 }
1259
1260 if (exe_ctx->HasThreadScope()) {
1261 exe_ctx->GetThreadPtr()->DumpUsingSettingsFormat(
1262 strm, LLDB_INVALID_THREAD_ID, stop_format);
1263 } else
1264 strm.PutCString("No value");
1265
1266 return true;
1267}
1268
1270 SBStream &output) {
1271 Stream &strm = output.ref();
1272
1273 SBError error;
1274 if (!format) {
1275 error = Status::FromErrorString("The provided SBFormat object is invalid");
1276 return error;
1277 }
1278
1279 llvm::Expected<StoppedExecutionContext> exe_ctx =
1281 if (!exe_ctx) {
1282 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1283 return error;
1284 }
1285
1286 if (exe_ctx->HasThreadScope()) {
1287 if (exe_ctx->GetThreadPtr()->DumpUsingFormat(
1288 strm, LLDB_INVALID_THREAD_ID, format.GetFormatEntrySP().get())) {
1289 return error;
1290 }
1291 }
1292
1294 "It was not possible to generate a thread description with the given "
1295 "format string '%s'",
1296 format.GetFormatEntrySP()->string.c_str());
1297 return error;
1298}
1299
1301 LLDB_INSTRUMENT_VA(this, type);
1302
1303 llvm::Expected<StoppedExecutionContext> exe_ctx =
1305 SBThread sb_origin_thread;
1306 if (exe_ctx) {
1307 if (exe_ctx->HasThreadScope()) {
1308 ThreadSP real_thread(exe_ctx->GetThreadSP());
1309 if (real_thread) {
1310 ConstString type_const(type);
1311 Process *process = exe_ctx->GetProcessPtr();
1312 if (process) {
1313 SystemRuntime *runtime = process->GetSystemRuntime();
1314 if (runtime) {
1315 ThreadSP new_thread_sp(
1316 runtime->GetExtendedBacktraceThread(real_thread, type_const));
1317 if (new_thread_sp) {
1318 // Save this in the Process' ExtendedThreadList so a strong
1319 // pointer retains the object.
1320 process->GetExtendedThreadList().AddThread(new_thread_sp);
1321 sb_origin_thread.SetThread(new_thread_sp);
1322 }
1323 }
1324 }
1325 }
1326 }
1327 } else {
1328 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1329 }
1330
1331 return sb_origin_thread;
1332}
1333
1335 LLDB_INSTRUMENT_VA(this);
1336
1337 llvm::Expected<StoppedExecutionContext> exe_ctx =
1339 if (!exe_ctx) {
1340 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1341 return LLDB_INVALID_INDEX32;
1342 }
1343
1344 ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
1345 if (thread_sp)
1346 return thread_sp->GetExtendedBacktraceOriginatingIndexID();
1347 return LLDB_INVALID_INDEX32;
1348}
1349
1351 LLDB_INSTRUMENT_VA(this);
1352
1353 llvm::Expected<StoppedExecutionContext> exe_ctx =
1355 if (!exe_ctx) {
1356 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1357 return SBValue();
1358 }
1359
1360 ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
1361 if (!thread_sp)
1362 return SBValue();
1363
1364 return SBValue(thread_sp->GetCurrentException());
1365}
1366
1368 LLDB_INSTRUMENT_VA(this);
1369
1370 llvm::Expected<StoppedExecutionContext> exe_ctx =
1372 if (!exe_ctx) {
1373 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1374 return SBThread();
1375 }
1376
1377 ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
1378 if (!thread_sp)
1379 return SBThread();
1380
1381 return SBThread(thread_sp->GetCurrentExceptionBacktrace());
1382}
1383
1385 LLDB_INSTRUMENT_VA(this);
1386
1387 llvm::Expected<StoppedExecutionContext> exe_ctx =
1389 if (!exe_ctx) {
1390 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1391 return false;
1392 }
1393
1394 ThreadSP thread_sp(m_opaque_sp->GetThreadSP());
1395 if (thread_sp)
1396 return thread_sp->SafeToCallFunctions();
1397 return true;
1398}
1399
1400lldb::ThreadSP SBThread::GetSP() const { return m_opaque_sp->GetThreadSP(); }
1401
1405
1407 return m_opaque_sp->GetThreadSP().get();
1408}
1409
1411 LLDB_INSTRUMENT_VA(this);
1412
1413 llvm::Expected<StoppedExecutionContext> exe_ctx =
1415 if (!exe_ctx) {
1416 LLDB_LOG_ERROR(GetLog(LLDBLog::API), exe_ctx.takeError(), "{0}");
1417 return SBValue();
1418 }
1419
1420 ThreadSP thread_sp = m_opaque_sp->GetThreadSP();
1421 if (!thread_sp)
1422 return SBValue();
1423 return thread_sp->GetSiginfoValue();
1424}
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_INSTRUMENT()
#define LLDB_INSTRUMENT_VA(...)
#define LLDB_LOG_ERROR(log, error,...)
Definition Log.h:405
static Status ResumeNewPlan(StoppedExecutionContext exe_ctx, ThreadPlan *new_plan)
Definition SBThread.cpp:449
bool Success() const
Definition SBError.cpp:81
void SetError(uint32_t err, lldb::ErrorType type)
Definition SBError.cpp:124
lldb_private::Event * get() const
Definition SBEvent.cpp:134
bool IsValid() const
const lldb_private::FileSpec & ref() const
Class that represents a format string that can be used to generate descriptions of objects like frame...
Definition SBFormat.h:28
lldb::FormatEntrySP GetFormatEntrySP() const
Definition SBFormat.cpp:44
Represents a list of SBFrame objects.
Definition SBFrameList.h:31
void SetFrameList(const lldb::StackFrameListSP &frame_list_sp)
bool IsValid() const
Definition SBFrame.cpp:96
void SetFrameSP(const lldb::StackFrameSP &lldb_object_sp)
Definition SBFrame.cpp:92
lldb::SBThread GetThread() const
Definition SBFrame.cpp:608
lldb::StackFrameSP GetFrameSP() const
Definition SBFrame.cpp:88
void SetSP(const lldb::ProcessSP &process_sp)
void SetQueue(const lldb::QueueSP &queue_sp)
Definition SBQueue.cpp:254
lldb_private::Stream & ref()
Definition SBStream.cpp:179
StructuredDataImplUP m_impl_up
static const char * GetBroadcasterClassName()
Definition SBThread.cpp:54
void StepInto(lldb::RunMode stop_other_threads=lldb::eOnlyDuringStepping)
Definition SBThread.cpp:517
bool Suspend()
LLDB currently supports process centric debugging which means when any thread in a process stops,...
Definition SBThread.cpp:986
const char * GetName() const
Definition SBThread.cpp:351
bool GetStopDescription(lldb::SBStream &stream) const
Gets a human-readable description of why the thread stopped.
Definition SBThread.cpp:243
const lldb::SBThread & operator=(const lldb::SBThread &rhs)
Definition SBThread.cpp:78
lldb::SBFrame SetSelectedFrame(uint32_t frame_idx)
SBError UnwindInnermostExpression()
Definition SBThread.cpp:966
friend class SBThreadCollection
Definition SBThread.h:255
bool IsValid() const
Definition SBThread.cpp:111
uint32_t GetNumFrames()
friend class SBProcess
Definition SBThread.h:250
const char * GetQueueName() const
Definition SBThread.cpp:367
SBValue GetSiginfo()
uint32_t GetIndexID() const
Definition SBThread.cpp:335
bool GetDescription(lldb::SBStream &description) const
static bool EventIsThreadEvent(const SBEvent &event)
lldb_private::Thread * operator->()
lldb_private::Thread * get()
void StepOutOfFrame(SBFrame &frame)
Definition SBThread.cpp:625
bool GetStatus(lldb::SBStream &status) const
friend class SBValue
Definition SBThread.h:252
static SBFrame GetStackFrameFromEvent(const SBEvent &event)
lldb::queue_id_t GetQueueID() const
Definition SBThread.cpp:383
lldb::SBFrameList GetFrames() const
bool GetInfoItemByPathAsString(const char *path, SBStream &strm)
Definition SBThread.cpp:401
lldb::SBFrame GetSelectedFrame()
friend class SBFrameList
Definition SBThread.h:249
bool operator!=(const lldb::SBThread &rhs) const
SBError StepUsingScriptedThreadPlan(const char *script_class_name)
Definition SBThread.cpp:865
lldb::tid_t GetThreadID() const
Definition SBThread.cpp:319
lldb::SBFrame GetFrameAtIndex(uint32_t idx)
uint32_t GetExtendedBacktraceOriginatingIndexID()
lldb::SBQueue GetQueue() const
Definition SBThread.cpp:89
bool SafeToCallFunctions()
lldb::SBProcess GetProcess()
size_t GetStopReasonDataCount()
Get the number of words associated with the stop reason.
Definition SBThread.cpp:153
void StepInstruction(bool step_over)
Definition SBThread.cpp:673
SBThread GetCurrentExceptionBacktrace()
friend class SBFrame
Definition SBThread.h:248
static SBThread GetThreadFromEvent(const SBEvent &event)
bool GetStopReasonExtendedInfoAsJSON(lldb::SBStream &stream)
Definition SBThread.cpp:190
lldb::StopReason GetStopReason()
Definition SBThread.cpp:136
SBValue GetStopReturnValue()
Definition SBThread.cpp:294
void StepOver(lldb::RunMode stop_other_threads=lldb::eOnlyDuringStepping)
Definition SBThread.cpp:474
SBError JumpToLine(lldb::SBFileSpec &file_spec, uint32_t line)
Definition SBThread.cpp:925
SBError GetDescriptionWithFormat(const SBFormat &format, SBStream &output)
Similar to GetDescription() but the format of the description can be configured via the format parame...
SBThreadCollection GetStopReasonExtendedBacktraces(InstrumentationRuntimeType type)
Definition SBThread.cpp:216
SBValue GetCurrentException()
void SetThread(const lldb::ThreadSP &lldb_object_sp)
Definition SBThread.cpp:315
lldb::ThreadSP GetSP() const
SBThread GetExtendedBacktraceThread(const char *type)
lldb::ExecutionContextRefSP m_opaque_sp
Definition SBThread.h:268
void RunToAddress(lldb::addr_t addr)
Definition SBThread.cpp:706
uint64_t GetStopReasonDataAtIndex(uint32_t idx)
Get information associated with a stop reason.
Definition SBThread.cpp:171
SBError ReturnFromFrame(SBFrame &frame, SBValue &return_value)
Definition SBThread.cpp:947
bool operator==(const lldb::SBThread &rhs) const
SBError StepOverUntil(lldb::SBFrame &frame, lldb::SBFileSpec &file_spec, uint32_t line)
Definition SBThread.cpp:745
lldb::ValueObjectSP GetSP() const
Same as the protected version of GetSP that takes a locker, except that we make the locker locally in...
Definition SBValue.cpp:1018
A section + offset based address range class.
A section + offset based address class.
Definition Address.h:62
void ResolveSymbolContext(const SourceLocationSpec &src_location_spec, lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list, RealpathPrefixes *realpath_prefixes=nullptr)
Resolve symbol contexts by file and line.
A uniqued constant string class.
Definition ConstString.h:40
const char * GetCString() const
Get the string value as a C string.
const char * AsCString(const char *value_if_empty) const
Get the string value as a C string.
Execution context objects refer to objects in the execution of the program that is being debugged.
Process * GetProcessPtr() const
Returns a pointer to the process object.
Thread * GetThreadPtr() const
Returns a pointer to the thread object.
A file utility class.
Definition FileSpec.h:56
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition FileSpec.cpp:380
bool GetRangeContainingLoadAddress(lldb::addr_t load_addr, Target &target, AddressRange &range)
Definition Function.h:432
A plug-in interface definition class for debugging a process.
Definition Process.h:360
ThreadList & GetThreadList()
Definition Process.h:2395
Status Resume()
Resumes all of a process's threads as configured using the Thread run control functions.
Definition Process.cpp:1341
virtual SystemRuntime * GetSystemRuntime()
Get the system runtime plug-in for this process.
Definition Process.cpp:3133
ThreadList & GetExtendedThreadList()
Definition Process.h:2406
Status ResumeSynchronous(Stream *stream)
Resume a process, and wait for it to stop.
Definition Process.cpp:1358
Target & GetTarget()
Get the target object pointer for this module.
Definition Process.h:1259
"lldb/Core/SourceLocationSpec.h" A source location specifier class.
An error handling class.
Definition Status.h:118
static Status FromErrorStringWithFormat(const char *format,...) __attribute__((format(printf
Definition Status.cpp:106
static Status FromErrorString(const char *str)
Definition Status.h:141
bool Fail() const
Test for error condition.
Definition Status.cpp:293
const char * AsCString(const char *default_error_str="unknown error") const
Get the error string associated with the current error.
Definition Status.cpp:194
static Status FromError(llvm::Error error)
Avoid using this in new code. Migrate APIs to llvm::Expected instead.
Definition Status.cpp:136
bool Success() const
Test for success condition.
Definition Status.cpp:303
static lldb::ValueObjectSP GetReturnValueObject(lldb::StopInfoSP &stop_info_sp)
A stream class that can stream formatted output to a file.
Definition Stream.h:28
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition Stream.cpp:63
std::shared_ptr< Dictionary > DictionarySP
std::shared_ptr< Object > ObjectSP
Defines a list of symbol context objects.
Defines a symbol context baton that can be handed other debug core functions.
llvm::Error GetAddressRangeFromHereToEndLine(uint32_t end_line, AddressRange &range)
Function * function
The Function for a given query.
CompileUnit * comp_unit
The CompileUnit for a given query.
LineEntry line_entry
The LineEntry for a given query.
A plug-in interface definition class for system runtimes.
virtual lldb::ThreadSP GetExtendedBacktraceThread(lldb::ThreadSP thread, ConstString type)
Return a Thread which shows the origin of this thread's creation.
A Lockable handle over a Target's API mutex, returned by Target::GetAPIMutex() and backing the public...
Debugger & GetDebugger() const
Definition Target.h:1337
void AddThread(const lldb::ThreadSP &thread_sp)
bool SetSelectedThreadByID(lldb::tid_t tid, bool notify=false)
void SetOkayToDiscard(bool value)
Definition ThreadPlan.h:427
bool SetIsControllingPlan(bool value)
Definition ThreadPlan.h:419
static const ThreadEventData * GetEventDataFromEvent(const Event *event_ptr)
Definition Thread.cpp:179
static lldb::ThreadSP GetThreadFromEvent(const Event *event_ptr)
Definition Thread.cpp:189
static lldb::StackFrameSP GetStackFrameFromEvent(const Event *event_ptr)
Definition Thread.cpp:206
static llvm::StringRef GetStaticBroadcasterClass()
Definition Thread.cpp:221
#define LLDB_INVALID_QUEUE_ID
#define LLDB_INVALID_LINE_NUMBER
#define LLDB_INVALID_THREAD_ID
#define LLDB_INVALID_INDEX32
#define LLDB_INVALID_ADDRESS
@ DoNoSelectMostRelevantFrame
@ SelectMostRelevantFrame
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition Log.h:338
bool StateIsStoppedState(lldb::StateType state, bool must_exist)
Check if a state represents a state where the process or thread is stopped.
Definition State.cpp:89
std::unique_ptr< T > clone(const std::unique_ptr< T > &src)
Definition Utils.h:17
llvm::Expected< StoppedExecutionContext > GetStoppedExecutionContext(const ExecutionContextRef *exe_ctx_ref_ptr)
std::shared_ptr< lldb_private::ThreadPlan > ThreadPlanSP
std::shared_ptr< lldb_private::Queue > QueueSP
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
std::shared_ptr< lldb_private::Thread > ThreadSP
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
@ eStateSuspended
Process or thread is in a suspended state as far as the debugger is concerned while other processes o...
@ eStateRunning
Process or thread is running and can't be examined.
std::shared_ptr< lldb_private::Process > ProcessSP
InstrumentationRuntimeType
std::shared_ptr< lldb_private::StopInfo > StopInfoSP
uint64_t addr_t
Definition lldb-types.h:80
StopReason
Thread stop reasons.
@ eStructuredDataTypeFloat
@ eStructuredDataTypeDictionary
@ eStructuredDataTypeInteger
@ eStructuredDataTypeNull
@ eStructuredDataTypeBoolean
@ eStructuredDataTypeString
class LLDB_API SBQueue
Definition SBDefines.h:102
RunMode
Thread Run Modes.
uint64_t tid_t
Definition lldb-types.h:85
uint64_t queue_id_t
Definition lldb-types.h:92
std::shared_ptr< lldb_private::StackFrameList > StackFrameListSP
bool IsValid() const
Check if a line entry object is valid.
Definition LineEntry.cpp:35
AddressRange range
The section offset address range for this line entry.
Definition LineEntry.h:137
const FileSpec & GetFile() const
Helper to access the file.
Definition LineEntry.h:134
A wrapper class representing an execution context with non-null Target and Process pointers,...
TargetAPIMutex AllowResume()
Clears this context, unlocking the ProcessRunLock and returning the locked API lock,...
#define PATH_MAX