1 //===-- CommandObjectThread.cpp ---------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "CommandObjectThread.h" 11 12 // C Includes 13 // C++ Includes 14 // Other libraries and framework includes 15 // Project includes 16 #include "lldb/Interpreter/Options.h" 17 #include "lldb/Core/State.h" 18 #include "lldb/Core/SourceManager.h" 19 20 #include "lldb/Host/Host.h" 21 22 #include "lldb/Interpreter/CommandInterpreter.h" 23 #include "lldb/Interpreter/CommandReturnObject.h" 24 25 #include "lldb/Target/Process.h" 26 #include "lldb/Target/RegisterContext.h" 27 #include "lldb/Target/Target.h" 28 #include "lldb/Target/Thread.h" 29 #include "lldb/Target/ThreadPlan.h" 30 #include "lldb/Target/ThreadPlanStepInstruction.h" 31 #include "lldb/Target/ThreadPlanStepOut.h" 32 #include "lldb/Target/ThreadPlanStepRange.h" 33 #include "lldb/Target/ThreadPlanStepInRange.h" 34 #include "lldb/Symbol/LineTable.h" 35 #include "lldb/Symbol/LineEntry.h" 36 37 using namespace lldb; 38 using namespace lldb_private; 39 40 41 //------------------------------------------------------------------------- 42 // CommandObjectThreadBacktrace 43 //------------------------------------------------------------------------- 44 45 class CommandObjectThreadBacktrace : public CommandObject 46 { 47 public: 48 49 class CommandOptions : public Options 50 { 51 public: 52 53 CommandOptions (CommandInterpreter &interpreter) : 54 Options(interpreter) 55 { 56 // Keep default values of all options in one place: OptionParsingStarting () 57 OptionParsingStarting (); 58 } 59 60 virtual 61 ~CommandOptions () 62 { 63 } 64 65 virtual Error 66 SetOptionValue (uint32_t option_idx, const char *option_arg) 67 { 68 Error error; 69 char short_option = (char) m_getopt_table[option_idx].val; 70 71 switch (short_option) 72 { 73 case 'c': 74 { 75 bool success; 76 int32_t input_count = Args::StringToSInt32 (option_arg, -1, 0, &success); 77 if (!success) 78 error.SetErrorStringWithFormat("invalid integer value for option '%c'", short_option); 79 if (input_count < -1) 80 m_count = UINT32_MAX; 81 else 82 m_count = input_count; 83 } 84 break; 85 case 's': 86 { 87 bool success; 88 m_start = Args::StringToUInt32 (option_arg, 0, 0, &success); 89 if (!success) 90 error.SetErrorStringWithFormat("invalid integer value for option '%c'", short_option); 91 } 92 break; 93 default: 94 error.SetErrorStringWithFormat("invalid short option character '%c'", short_option); 95 break; 96 97 } 98 return error; 99 } 100 101 void 102 OptionParsingStarting () 103 { 104 m_count = UINT32_MAX; 105 m_start = 0; 106 } 107 108 const OptionDefinition* 109 GetDefinitions () 110 { 111 return g_option_table; 112 } 113 114 // Options table: Required for subclasses of Options. 115 116 static OptionDefinition g_option_table[]; 117 118 // Instance variables to hold the values for command options. 119 uint32_t m_count; 120 uint32_t m_start; 121 }; 122 123 CommandObjectThreadBacktrace (CommandInterpreter &interpreter) : 124 CommandObject (interpreter, 125 "thread backtrace", 126 "Show the stack for one or more threads. If no threads are specified, show the currently selected thread. Use the thread-index \"all\" to see all threads.", 127 NULL, 128 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused), 129 m_options(interpreter) 130 { 131 CommandArgumentEntry arg; 132 CommandArgumentData thread_idx_arg; 133 134 // Define the first (and only) variant of this arg. 135 thread_idx_arg.arg_type = eArgTypeThreadIndex; 136 thread_idx_arg.arg_repetition = eArgRepeatStar; 137 138 // There is only one variant this argument could be; put it into the argument entry. 139 arg.push_back (thread_idx_arg); 140 141 // Push the data for the first argument into the m_arguments vector. 142 m_arguments.push_back (arg); 143 } 144 145 ~CommandObjectThreadBacktrace() 146 { 147 } 148 149 virtual Options * 150 GetOptions () 151 { 152 return &m_options; 153 } 154 155 virtual bool 156 Execute (Args& command, CommandReturnObject &result) 157 { 158 result.SetStatus (eReturnStatusSuccessFinishResult); 159 Stream &strm = result.GetOutputStream(); 160 161 // Don't show source context when doing backtraces. 162 const uint32_t num_frames_with_source = 0; 163 if (command.GetArgumentCount() == 0) 164 { 165 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 166 Thread *thread = exe_ctx.GetThreadPtr(); 167 if (thread) 168 { 169 // Thread::GetStatus() returns the number of frames shown. 170 if (thread->GetStatus (strm, 171 m_options.m_start, 172 m_options.m_count, 173 num_frames_with_source)) 174 { 175 result.SetStatus (eReturnStatusSuccessFinishResult); 176 } 177 } 178 else 179 { 180 result.AppendError ("invalid thread"); 181 result.SetStatus (eReturnStatusFailed); 182 } 183 } 184 else if (command.GetArgumentCount() == 1 && ::strcmp (command.GetArgumentAtIndex(0), "all") == 0) 185 { 186 Process *process = m_interpreter.GetExecutionContext().GetProcessPtr(); 187 uint32_t num_threads = process->GetThreadList().GetSize(); 188 for (uint32_t i = 0; i < num_threads; i++) 189 { 190 ThreadSP thread_sp = process->GetThreadList().GetThreadAtIndex(i); 191 if (!thread_sp->GetStatus (strm, 192 m_options.m_start, 193 m_options.m_count, 194 num_frames_with_source)) 195 { 196 result.AppendErrorWithFormat ("error displaying backtrace for thread: \"0x%4.4x\"\n", i); 197 result.SetStatus (eReturnStatusFailed); 198 return false; 199 } 200 201 if (i < num_threads - 1) 202 result.AppendMessage(""); 203 204 } 205 } 206 else 207 { 208 uint32_t num_args = command.GetArgumentCount(); 209 Process *process = m_interpreter.GetExecutionContext().GetProcessPtr(); 210 std::vector<ThreadSP> thread_sps; 211 212 for (uint32_t i = 0; i < num_args; i++) 213 { 214 bool success; 215 216 uint32_t thread_idx = Args::StringToUInt32(command.GetArgumentAtIndex(i), 0, 0, &success); 217 if (!success) 218 { 219 result.AppendErrorWithFormat ("invalid thread specification: \"%s\"\n", command.GetArgumentAtIndex(i)); 220 result.SetStatus (eReturnStatusFailed); 221 return false; 222 } 223 224 thread_sps.push_back(process->GetThreadList().FindThreadByIndexID(thread_idx)); 225 226 if (!thread_sps[i]) 227 { 228 result.AppendErrorWithFormat ("no thread with index: \"%s\"\n", command.GetArgumentAtIndex(i)); 229 result.SetStatus (eReturnStatusFailed); 230 return false; 231 } 232 233 } 234 235 for (uint32_t i = 0; i < num_args; i++) 236 { 237 if (!thread_sps[i]->GetStatus (strm, 238 m_options.m_start, 239 m_options.m_count, 240 num_frames_with_source)) 241 { 242 result.AppendErrorWithFormat ("error displaying backtrace for thread: \"%s\"\n", command.GetArgumentAtIndex(i)); 243 result.SetStatus (eReturnStatusFailed); 244 return false; 245 } 246 247 if (i < num_args - 1) 248 result.AppendMessage(""); 249 } 250 } 251 return result.Succeeded(); 252 } 253 protected: 254 CommandOptions m_options; 255 }; 256 257 OptionDefinition 258 CommandObjectThreadBacktrace::CommandOptions::g_option_table[] = 259 { 260 { LLDB_OPT_SET_1, false, "count", 'c', required_argument, NULL, 0, eArgTypeCount, "How many frames to display (-1 for all)"}, 261 { LLDB_OPT_SET_1, false, "start", 's', required_argument, NULL, 0, eArgTypeFrameIndex, "Frame in which to start the backtrace"}, 262 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL } 263 }; 264 265 enum StepScope 266 { 267 eStepScopeSource, 268 eStepScopeInstruction 269 }; 270 271 class CommandObjectThreadStepWithTypeAndScope : public CommandObject 272 { 273 public: 274 275 class CommandOptions : public Options 276 { 277 public: 278 279 CommandOptions (CommandInterpreter &interpreter) : 280 Options (interpreter) 281 { 282 // Keep default values of all options in one place: OptionParsingStarting () 283 OptionParsingStarting (); 284 } 285 286 virtual 287 ~CommandOptions () 288 { 289 } 290 291 virtual Error 292 SetOptionValue (uint32_t option_idx, const char *option_arg) 293 { 294 Error error; 295 char short_option = (char) m_getopt_table[option_idx].val; 296 297 switch (short_option) 298 { 299 case 'a': 300 { 301 bool success; 302 m_avoid_no_debug = Args::StringToBoolean (option_arg, true, &success); 303 if (!success) 304 error.SetErrorStringWithFormat("invalid boolean value for option '%c'", short_option); 305 } 306 break; 307 308 case 'm': 309 { 310 OptionEnumValueElement *enum_values = g_option_table[option_idx].enum_values; 311 m_run_mode = (lldb::RunMode) Args::StringToOptionEnum(option_arg, enum_values, eOnlyDuringStepping, error); 312 } 313 break; 314 315 case 'r': 316 { 317 m_avoid_regexp.clear(); 318 m_avoid_regexp.assign(option_arg); 319 } 320 break; 321 322 default: 323 error.SetErrorStringWithFormat("invalid short option character '%c'", short_option); 324 break; 325 326 } 327 return error; 328 } 329 330 void 331 OptionParsingStarting () 332 { 333 m_avoid_no_debug = true; 334 m_run_mode = eOnlyDuringStepping; 335 m_avoid_regexp.clear(); 336 } 337 338 const OptionDefinition* 339 GetDefinitions () 340 { 341 return g_option_table; 342 } 343 344 // Options table: Required for subclasses of Options. 345 346 static OptionDefinition g_option_table[]; 347 348 // Instance variables to hold the values for command options. 349 bool m_avoid_no_debug; 350 RunMode m_run_mode; 351 std::string m_avoid_regexp; 352 }; 353 354 CommandObjectThreadStepWithTypeAndScope (CommandInterpreter &interpreter, 355 const char *name, 356 const char *help, 357 const char *syntax, 358 uint32_t flags, 359 StepType step_type, 360 StepScope step_scope) : 361 CommandObject (interpreter, name, help, syntax, flags), 362 m_step_type (step_type), 363 m_step_scope (step_scope), 364 m_options (interpreter) 365 { 366 CommandArgumentEntry arg; 367 CommandArgumentData thread_id_arg; 368 369 // Define the first (and only) variant of this arg. 370 thread_id_arg.arg_type = eArgTypeThreadID; 371 thread_id_arg.arg_repetition = eArgRepeatOptional; 372 373 // There is only one variant this argument could be; put it into the argument entry. 374 arg.push_back (thread_id_arg); 375 376 // Push the data for the first argument into the m_arguments vector. 377 m_arguments.push_back (arg); 378 } 379 380 virtual 381 ~CommandObjectThreadStepWithTypeAndScope () 382 { 383 } 384 385 virtual 386 Options * 387 GetOptions () 388 { 389 return &m_options; 390 } 391 392 virtual bool 393 Execute 394 ( 395 Args& command, 396 CommandReturnObject &result 397 ) 398 { 399 Process *process = m_interpreter.GetExecutionContext().GetProcessPtr(); 400 bool synchronous_execution = m_interpreter.GetSynchronous(); 401 402 if (process == NULL) 403 { 404 result.AppendError ("need a valid process to step"); 405 result.SetStatus (eReturnStatusFailed); 406 407 } 408 else 409 { 410 const uint32_t num_threads = process->GetThreadList().GetSize(); 411 Thread *thread = NULL; 412 413 if (command.GetArgumentCount() == 0) 414 { 415 thread = process->GetThreadList().GetSelectedThread().get(); 416 if (thread == NULL) 417 { 418 result.AppendError ("no selected thread in process"); 419 result.SetStatus (eReturnStatusFailed); 420 return false; 421 } 422 } 423 else 424 { 425 const char *thread_idx_cstr = command.GetArgumentAtIndex(0); 426 uint32_t step_thread_idx = Args::StringToUInt32 (thread_idx_cstr, LLDB_INVALID_INDEX32); 427 if (step_thread_idx == LLDB_INVALID_INDEX32) 428 { 429 result.AppendErrorWithFormat ("invalid thread index '%s'.\n", thread_idx_cstr); 430 result.SetStatus (eReturnStatusFailed); 431 return false; 432 } 433 thread = process->GetThreadList().FindThreadByIndexID(step_thread_idx).get(); 434 if (thread == NULL) 435 { 436 result.AppendErrorWithFormat ("Thread index %u is out of range (valid values are 0 - %u).\n", 437 step_thread_idx, num_threads); 438 result.SetStatus (eReturnStatusFailed); 439 return false; 440 } 441 } 442 443 const bool abort_other_plans = false; 444 const lldb::RunMode stop_other_threads = m_options.m_run_mode; 445 446 // This is a bit unfortunate, but not all the commands in this command object support 447 // only while stepping, so I use the bool for them. 448 bool bool_stop_other_threads; 449 if (m_options.m_run_mode == eAllThreads) 450 bool_stop_other_threads = false; 451 else 452 bool_stop_other_threads = true; 453 454 ThreadPlan *new_plan = NULL; 455 456 if (m_step_type == eStepTypeInto) 457 { 458 StackFrame *frame = thread->GetStackFrameAtIndex(0).get(); 459 460 if (frame->HasDebugInformation ()) 461 { 462 new_plan = thread->QueueThreadPlanForStepRange (abort_other_plans, m_step_type, 463 frame->GetSymbolContext(eSymbolContextEverything).line_entry.range, 464 frame->GetSymbolContext(eSymbolContextEverything), 465 stop_other_threads, 466 m_options.m_avoid_no_debug); 467 if (new_plan && !m_options.m_avoid_regexp.empty()) 468 { 469 ThreadPlanStepInRange *step_in_range_plan = static_cast<ThreadPlanStepInRange *> (new_plan); 470 step_in_range_plan->SetAvoidRegexp(m_options.m_avoid_regexp.c_str()); 471 } 472 } 473 else 474 new_plan = thread->QueueThreadPlanForStepSingleInstruction (false, abort_other_plans, bool_stop_other_threads); 475 476 } 477 else if (m_step_type == eStepTypeOver) 478 { 479 StackFrame *frame = thread->GetStackFrameAtIndex(0).get(); 480 481 if (frame->HasDebugInformation()) 482 new_plan = thread->QueueThreadPlanForStepRange (abort_other_plans, 483 m_step_type, 484 frame->GetSymbolContext(eSymbolContextEverything).line_entry.range, 485 frame->GetSymbolContext(eSymbolContextEverything), 486 stop_other_threads, 487 false); 488 else 489 new_plan = thread->QueueThreadPlanForStepSingleInstruction (true, 490 abort_other_plans, 491 bool_stop_other_threads); 492 493 } 494 else if (m_step_type == eStepTypeTrace) 495 { 496 new_plan = thread->QueueThreadPlanForStepSingleInstruction (false, abort_other_plans, bool_stop_other_threads); 497 } 498 else if (m_step_type == eStepTypeTraceOver) 499 { 500 new_plan = thread->QueueThreadPlanForStepSingleInstruction (true, abort_other_plans, bool_stop_other_threads); 501 } 502 else if (m_step_type == eStepTypeOut) 503 { 504 new_plan = thread->QueueThreadPlanForStepOut (abort_other_plans, 505 NULL, 506 false, 507 bool_stop_other_threads, 508 eVoteYes, 509 eVoteNoOpinion, 510 thread->GetSelectedFrameIndex()); 511 } 512 else 513 { 514 result.AppendError ("step type is not supported"); 515 result.SetStatus (eReturnStatusFailed); 516 return false; 517 } 518 519 // If we got a new plan, then set it to be a master plan (User level Plans should be master plans 520 // so that they can be interruptible). Then resume the process. 521 522 if (new_plan != NULL) 523 { 524 new_plan->SetIsMasterPlan (true); 525 new_plan->SetOkayToDiscard (false); 526 527 process->GetThreadList().SetSelectedThreadByID (thread->GetID()); 528 process->Resume (); 529 530 531 if (synchronous_execution) 532 { 533 StateType state = process->WaitForProcessToStop (NULL); 534 535 //EventSP event_sp; 536 //StateType state = process->WaitForStateChangedEvents (NULL, event_sp); 537 //while (! StateIsStoppedState (state)) 538 // { 539 // state = process->WaitForStateChangedEvents (NULL, event_sp); 540 // } 541 process->GetThreadList().SetSelectedThreadByID (thread->GetID()); 542 result.SetDidChangeProcessState (true); 543 result.AppendMessageWithFormat ("Process %llu %s\n", process->GetID(), StateAsCString (state)); 544 result.SetStatus (eReturnStatusSuccessFinishNoResult); 545 } 546 else 547 { 548 result.SetStatus (eReturnStatusSuccessContinuingNoResult); 549 } 550 } 551 else 552 { 553 result.AppendError ("Couldn't find thread plan to implement step type."); 554 result.SetStatus (eReturnStatusFailed); 555 } 556 } 557 return result.Succeeded(); 558 } 559 560 protected: 561 StepType m_step_type; 562 StepScope m_step_scope; 563 CommandOptions m_options; 564 }; 565 566 static OptionEnumValueElement 567 g_tri_running_mode[] = 568 { 569 { eOnlyThisThread, "this-thread", "Run only this thread"}, 570 { eAllThreads, "all-threads", "Run all threads"}, 571 { eOnlyDuringStepping, "while-stepping", "Run only this thread while stepping"}, 572 { 0, NULL, NULL } 573 }; 574 575 static OptionEnumValueElement 576 g_duo_running_mode[] = 577 { 578 { eOnlyThisThread, "this-thread", "Run only this thread"}, 579 { eAllThreads, "all-threads", "Run all threads"}, 580 { 0, NULL, NULL } 581 }; 582 583 OptionDefinition 584 CommandObjectThreadStepWithTypeAndScope::CommandOptions::g_option_table[] = 585 { 586 { LLDB_OPT_SET_1, false, "avoid-no-debug", 'a', required_argument, NULL, 0, eArgTypeBoolean, "A boolean value that sets whether step-in will step over functions with no debug information."}, 587 { LLDB_OPT_SET_1, false, "run-mode", 'm', required_argument, g_tri_running_mode, 0, eArgTypeRunMode, "Determine how to run other threads while stepping the current thread."}, 588 { LLDB_OPT_SET_1, false, "step-over-regexp",'r', required_argument, NULL, 0, eArgTypeRegularExpression, "A regular expression that defines function names to step over."}, 589 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL } 590 }; 591 592 593 //------------------------------------------------------------------------- 594 // CommandObjectThreadContinue 595 //------------------------------------------------------------------------- 596 597 class CommandObjectThreadContinue : public CommandObject 598 { 599 public: 600 601 CommandObjectThreadContinue (CommandInterpreter &interpreter) : 602 CommandObject (interpreter, 603 "thread continue", 604 "Continue execution of one or more threads in an active process.", 605 NULL, 606 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 607 { 608 CommandArgumentEntry arg; 609 CommandArgumentData thread_idx_arg; 610 611 // Define the first (and only) variant of this arg. 612 thread_idx_arg.arg_type = eArgTypeThreadIndex; 613 thread_idx_arg.arg_repetition = eArgRepeatPlus; 614 615 // There is only one variant this argument could be; put it into the argument entry. 616 arg.push_back (thread_idx_arg); 617 618 // Push the data for the first argument into the m_arguments vector. 619 m_arguments.push_back (arg); 620 } 621 622 623 virtual 624 ~CommandObjectThreadContinue () 625 { 626 } 627 628 virtual bool 629 Execute 630 ( 631 Args& command, 632 CommandReturnObject &result 633 ) 634 { 635 bool synchronous_execution = m_interpreter.GetSynchronous (); 636 637 if (!m_interpreter.GetDebugger().GetSelectedTarget().get()) 638 { 639 result.AppendError ("invalid target, create a debug target using the 'target create' command"); 640 result.SetStatus (eReturnStatusFailed); 641 return false; 642 } 643 644 Process *process = m_interpreter.GetExecutionContext().GetProcessPtr(); 645 if (process == NULL) 646 { 647 result.AppendError ("no process exists. Cannot continue"); 648 result.SetStatus (eReturnStatusFailed); 649 return false; 650 } 651 652 StateType state = process->GetState(); 653 if ((state == eStateCrashed) || (state == eStateStopped) || (state == eStateSuspended)) 654 { 655 const uint32_t num_threads = process->GetThreadList().GetSize(); 656 uint32_t idx; 657 const size_t argc = command.GetArgumentCount(); 658 if (argc > 0) 659 { 660 std::vector<uint32_t> resume_thread_indexes; 661 for (uint32_t i=0; i<argc; ++i) 662 { 663 bool success; 664 const int base = 0; 665 idx = Args::StringToUInt32 (command.GetArgumentAtIndex(i), LLDB_INVALID_INDEX32, base, &success); 666 if (!success) 667 { 668 result.AppendErrorWithFormat ("invalid value for thread index: %s.", command.GetArgumentAtIndex(i)); 669 result.SetStatus (eReturnStatusFailed); 670 return false; 671 } 672 else if (process->GetThreadList().FindThreadByIndexID(idx)) 673 { 674 if (find(resume_thread_indexes.begin(), resume_thread_indexes.end(), idx) == resume_thread_indexes.end()) 675 resume_thread_indexes.push_back(idx); 676 } 677 else 678 { 679 result.AppendErrorWithFormat("thread index %u out of range.\n", idx); 680 result.SetStatus (eReturnStatusFailed); 681 return false; 682 } 683 } 684 685 if (resume_thread_indexes.empty()) 686 { 687 result.AppendError ("no valid thread indexes were specified"); 688 result.SetStatus (eReturnStatusFailed); 689 return false; 690 } 691 else 692 { 693 if (resume_thread_indexes.size() == 1) 694 result.AppendMessageWithFormat ("Resuming thread: "); 695 else 696 result.AppendMessageWithFormat ("Resuming threads: "); 697 698 for (idx=0; idx<num_threads; ++idx) 699 { 700 Thread *thread = process->GetThreadList().FindThreadByIndexID(idx).get(); 701 std::vector<uint32_t>::iterator this_thread_pos = find(resume_thread_indexes.begin(), resume_thread_indexes.end(), thread->GetIndexID()); 702 703 if (this_thread_pos != resume_thread_indexes.end()) 704 { 705 resume_thread_indexes.erase(this_thread_pos); 706 if (resume_thread_indexes.size() > 0) 707 result.AppendMessageWithFormat ("%u, ", thread->GetIndexID()); 708 else 709 result.AppendMessageWithFormat ("%u ", thread->GetIndexID()); 710 711 thread->SetResumeState (eStateRunning); 712 } 713 else 714 { 715 thread->SetResumeState (eStateSuspended); 716 } 717 } 718 result.AppendMessageWithFormat ("in process %llu\n", process->GetID()); 719 } 720 } 721 else 722 { 723 Thread *current_thread = process->GetThreadList().GetSelectedThread().get(); 724 if (current_thread == NULL) 725 { 726 result.AppendError ("the process doesn't have a current thread"); 727 result.SetStatus (eReturnStatusFailed); 728 return false; 729 } 730 // Set the actions that the threads should each take when resuming 731 for (idx=0; idx<num_threads; ++idx) 732 { 733 Thread *thread = process->GetThreadList().FindThreadByIndexID(idx).get(); 734 if (thread == current_thread) 735 { 736 result.AppendMessageWithFormat ("Resuming thread 0x%4.4llx in process %llu\n", thread->GetID(), process->GetID()); 737 thread->SetResumeState (eStateRunning); 738 } 739 else 740 { 741 thread->SetResumeState (eStateSuspended); 742 } 743 } 744 } 745 746 Error error (process->Resume()); 747 if (error.Success()) 748 { 749 result.AppendMessageWithFormat ("Process %llu resuming\n", process->GetID()); 750 if (synchronous_execution) 751 { 752 state = process->WaitForProcessToStop (NULL); 753 754 result.SetDidChangeProcessState (true); 755 result.AppendMessageWithFormat ("Process %llu %s\n", process->GetID(), StateAsCString (state)); 756 result.SetStatus (eReturnStatusSuccessFinishNoResult); 757 } 758 else 759 { 760 result.SetStatus (eReturnStatusSuccessContinuingNoResult); 761 } 762 } 763 else 764 { 765 result.AppendErrorWithFormat("Failed to resume process: %s\n", error.AsCString()); 766 result.SetStatus (eReturnStatusFailed); 767 } 768 } 769 else 770 { 771 result.AppendErrorWithFormat ("Process cannot be continued from its current state (%s).\n", 772 StateAsCString(state)); 773 result.SetStatus (eReturnStatusFailed); 774 } 775 776 return result.Succeeded(); 777 } 778 779 }; 780 781 //------------------------------------------------------------------------- 782 // CommandObjectThreadUntil 783 //------------------------------------------------------------------------- 784 785 class CommandObjectThreadUntil : public CommandObject 786 { 787 public: 788 789 class CommandOptions : public Options 790 { 791 public: 792 uint32_t m_thread_idx; 793 uint32_t m_frame_idx; 794 795 CommandOptions (CommandInterpreter &interpreter) : 796 Options (interpreter), 797 m_thread_idx(LLDB_INVALID_THREAD_ID), 798 m_frame_idx(LLDB_INVALID_FRAME_ID) 799 { 800 // Keep default values of all options in one place: OptionParsingStarting () 801 OptionParsingStarting (); 802 } 803 804 virtual 805 ~CommandOptions () 806 { 807 } 808 809 virtual Error 810 SetOptionValue (uint32_t option_idx, const char *option_arg) 811 { 812 Error error; 813 char short_option = (char) m_getopt_table[option_idx].val; 814 815 switch (short_option) 816 { 817 case 't': 818 { 819 m_thread_idx = Args::StringToUInt32 (option_arg, LLDB_INVALID_INDEX32); 820 if (m_thread_idx == LLDB_INVALID_INDEX32) 821 { 822 error.SetErrorStringWithFormat ("invalid thread index '%s'", option_arg); 823 } 824 } 825 break; 826 case 'f': 827 { 828 m_frame_idx = Args::StringToUInt32 (option_arg, LLDB_INVALID_FRAME_ID); 829 if (m_frame_idx == LLDB_INVALID_FRAME_ID) 830 { 831 error.SetErrorStringWithFormat ("invalid frame index '%s'", option_arg); 832 } 833 } 834 break; 835 case 'm': 836 { 837 OptionEnumValueElement *enum_values = g_option_table[option_idx].enum_values; 838 lldb::RunMode run_mode = (lldb::RunMode) Args::StringToOptionEnum(option_arg, enum_values, eOnlyDuringStepping, error); 839 840 if (error.Success()) 841 { 842 if (run_mode == eAllThreads) 843 m_stop_others = false; 844 else 845 m_stop_others = true; 846 } 847 } 848 break; 849 default: 850 error.SetErrorStringWithFormat("invalid short option character '%c'", short_option); 851 break; 852 853 } 854 return error; 855 } 856 857 void 858 OptionParsingStarting () 859 { 860 m_thread_idx = LLDB_INVALID_THREAD_ID; 861 m_frame_idx = 0; 862 m_stop_others = false; 863 } 864 865 const OptionDefinition* 866 GetDefinitions () 867 { 868 return g_option_table; 869 } 870 871 uint32_t m_step_thread_idx; 872 bool m_stop_others; 873 874 // Options table: Required for subclasses of Options. 875 876 static OptionDefinition g_option_table[]; 877 878 // Instance variables to hold the values for command options. 879 }; 880 881 CommandObjectThreadUntil (CommandInterpreter &interpreter) : 882 CommandObject (interpreter, 883 "thread until", 884 "Run the current or specified thread until it reaches a given line number or leaves the current function.", 885 NULL, 886 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused), 887 m_options (interpreter) 888 { 889 CommandArgumentEntry arg; 890 CommandArgumentData line_num_arg; 891 892 // Define the first (and only) variant of this arg. 893 line_num_arg.arg_type = eArgTypeLineNum; 894 line_num_arg.arg_repetition = eArgRepeatPlain; 895 896 // There is only one variant this argument could be; put it into the argument entry. 897 arg.push_back (line_num_arg); 898 899 // Push the data for the first argument into the m_arguments vector. 900 m_arguments.push_back (arg); 901 } 902 903 904 virtual 905 ~CommandObjectThreadUntil () 906 { 907 } 908 909 virtual 910 Options * 911 GetOptions () 912 { 913 return &m_options; 914 } 915 916 virtual bool 917 Execute 918 ( 919 Args& command, 920 CommandReturnObject &result 921 ) 922 { 923 bool synchronous_execution = m_interpreter.GetSynchronous (); 924 925 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get(); 926 if (target == NULL) 927 { 928 result.AppendError ("invalid target, create a debug target using the 'target create' command"); 929 result.SetStatus (eReturnStatusFailed); 930 return false; 931 } 932 933 Process *process = m_interpreter.GetExecutionContext().GetProcessPtr(); 934 if (process == NULL) 935 { 936 result.AppendError ("need a valid process to step"); 937 result.SetStatus (eReturnStatusFailed); 938 939 } 940 else 941 { 942 Thread *thread = NULL; 943 uint32_t line_number; 944 945 if (command.GetArgumentCount() != 1) 946 { 947 result.AppendErrorWithFormat ("No line number provided:\n%s", GetSyntax()); 948 result.SetStatus (eReturnStatusFailed); 949 return false; 950 } 951 952 line_number = Args::StringToUInt32 (command.GetArgumentAtIndex(0), UINT32_MAX); 953 if (line_number == UINT32_MAX) 954 { 955 result.AppendErrorWithFormat ("invalid line number: '%s'.\n", command.GetArgumentAtIndex(0)); 956 result.SetStatus (eReturnStatusFailed); 957 return false; 958 } 959 960 if (m_options.m_thread_idx == LLDB_INVALID_THREAD_ID) 961 { 962 thread = process->GetThreadList().GetSelectedThread().get(); 963 } 964 else 965 { 966 thread = process->GetThreadList().FindThreadByIndexID(m_options.m_thread_idx).get(); 967 } 968 969 if (thread == NULL) 970 { 971 const uint32_t num_threads = process->GetThreadList().GetSize(); 972 result.AppendErrorWithFormat ("Thread index %u is out of range (valid values are 0 - %u).\n", 973 m_options.m_thread_idx, 974 num_threads); 975 result.SetStatus (eReturnStatusFailed); 976 return false; 977 } 978 979 const bool abort_other_plans = false; 980 981 StackFrame *frame = thread->GetStackFrameAtIndex(m_options.m_frame_idx).get(); 982 if (frame == NULL) 983 { 984 985 result.AppendErrorWithFormat ("Frame index %u is out of range for thread %u.\n", 986 m_options.m_frame_idx, 987 m_options.m_thread_idx); 988 result.SetStatus (eReturnStatusFailed); 989 return false; 990 } 991 992 ThreadPlan *new_plan = NULL; 993 994 if (frame->HasDebugInformation ()) 995 { 996 // Finally we got here... Translate the given line number to a bunch of addresses: 997 SymbolContext sc(frame->GetSymbolContext (eSymbolContextCompUnit)); 998 LineTable *line_table = NULL; 999 if (sc.comp_unit) 1000 line_table = sc.comp_unit->GetLineTable(); 1001 1002 if (line_table == NULL) 1003 { 1004 result.AppendErrorWithFormat ("Failed to resolve the line table for frame %u of thread index %u.\n", 1005 m_options.m_frame_idx, m_options.m_thread_idx); 1006 result.SetStatus (eReturnStatusFailed); 1007 return false; 1008 } 1009 1010 LineEntry function_start; 1011 uint32_t index_ptr = 0, end_ptr; 1012 std::vector<addr_t> address_list; 1013 1014 // Find the beginning & end index of the 1015 AddressRange fun_addr_range = sc.function->GetAddressRange(); 1016 Address fun_start_addr = fun_addr_range.GetBaseAddress(); 1017 line_table->FindLineEntryByAddress (fun_start_addr, function_start, &index_ptr); 1018 1019 Address fun_end_addr(fun_start_addr.GetSection(), 1020 fun_start_addr.GetOffset() + fun_addr_range.GetByteSize()); 1021 line_table->FindLineEntryByAddress (fun_end_addr, function_start, &end_ptr); 1022 1023 bool all_in_function = true; 1024 1025 while (index_ptr <= end_ptr) 1026 { 1027 LineEntry line_entry; 1028 const bool exact = false; 1029 index_ptr = sc.comp_unit->FindLineEntry(index_ptr, line_number, sc.comp_unit, exact, &line_entry); 1030 if (index_ptr == UINT32_MAX) 1031 break; 1032 1033 addr_t address = line_entry.range.GetBaseAddress().GetLoadAddress(target); 1034 if (address != LLDB_INVALID_ADDRESS) 1035 { 1036 if (fun_addr_range.ContainsLoadAddress (address, target)) 1037 address_list.push_back (address); 1038 else 1039 all_in_function = false; 1040 } 1041 index_ptr++; 1042 } 1043 1044 if (address_list.size() == 0) 1045 { 1046 if (all_in_function) 1047 result.AppendErrorWithFormat ("No line entries matching until target.\n"); 1048 else 1049 result.AppendErrorWithFormat ("Until target outside of the current function.\n"); 1050 1051 result.SetStatus (eReturnStatusFailed); 1052 return false; 1053 } 1054 1055 new_plan = thread->QueueThreadPlanForStepUntil (abort_other_plans, 1056 &address_list.front(), 1057 address_list.size(), 1058 m_options.m_stop_others, 1059 thread->GetSelectedFrameIndex ()); 1060 // User level plans should be master plans so they can be interrupted (e.g. by hitting a breakpoint) 1061 // and other plans executed by the user (stepping around the breakpoint) and then a "continue" 1062 // will resume the original plan. 1063 new_plan->SetIsMasterPlan (true); 1064 new_plan->SetOkayToDiscard(false); 1065 } 1066 else 1067 { 1068 result.AppendErrorWithFormat ("Frame index %u of thread %u has no debug information.\n", 1069 m_options.m_frame_idx, 1070 m_options.m_thread_idx); 1071 result.SetStatus (eReturnStatusFailed); 1072 return false; 1073 1074 } 1075 1076 process->GetThreadList().SetSelectedThreadByID (m_options.m_thread_idx); 1077 Error error (process->Resume ()); 1078 if (error.Success()) 1079 { 1080 result.AppendMessageWithFormat ("Process %llu resuming\n", process->GetID()); 1081 if (synchronous_execution) 1082 { 1083 StateType state = process->WaitForProcessToStop (NULL); 1084 1085 result.SetDidChangeProcessState (true); 1086 result.AppendMessageWithFormat ("Process %llu %s\n", process->GetID(), StateAsCString (state)); 1087 result.SetStatus (eReturnStatusSuccessFinishNoResult); 1088 } 1089 else 1090 { 1091 result.SetStatus (eReturnStatusSuccessContinuingNoResult); 1092 } 1093 } 1094 else 1095 { 1096 result.AppendErrorWithFormat("Failed to resume process: %s.\n", error.AsCString()); 1097 result.SetStatus (eReturnStatusFailed); 1098 } 1099 1100 } 1101 return result.Succeeded(); 1102 } 1103 protected: 1104 CommandOptions m_options; 1105 1106 }; 1107 1108 OptionDefinition 1109 CommandObjectThreadUntil::CommandOptions::g_option_table[] = 1110 { 1111 { LLDB_OPT_SET_1, false, "frame", 'f', required_argument, NULL, 0, eArgTypeFrameIndex, "Frame index for until operation - defaults to 0"}, 1112 { LLDB_OPT_SET_1, false, "thread", 't', required_argument, NULL, 0, eArgTypeThreadIndex, "Thread index for the thread for until operation"}, 1113 { LLDB_OPT_SET_1, false, "run-mode",'m', required_argument, g_duo_running_mode, 0, eArgTypeRunMode,"Determine how to run other threads while stepping this one"}, 1114 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL } 1115 }; 1116 1117 1118 //------------------------------------------------------------------------- 1119 // CommandObjectThreadSelect 1120 //------------------------------------------------------------------------- 1121 1122 class CommandObjectThreadSelect : public CommandObject 1123 { 1124 public: 1125 1126 CommandObjectThreadSelect (CommandInterpreter &interpreter) : 1127 CommandObject (interpreter, 1128 "thread select", 1129 "Select a thread as the currently active thread.", 1130 NULL, 1131 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 1132 { 1133 CommandArgumentEntry arg; 1134 CommandArgumentData thread_idx_arg; 1135 1136 // Define the first (and only) variant of this arg. 1137 thread_idx_arg.arg_type = eArgTypeThreadIndex; 1138 thread_idx_arg.arg_repetition = eArgRepeatPlain; 1139 1140 // There is only one variant this argument could be; put it into the argument entry. 1141 arg.push_back (thread_idx_arg); 1142 1143 // Push the data for the first argument into the m_arguments vector. 1144 m_arguments.push_back (arg); 1145 } 1146 1147 1148 virtual 1149 ~CommandObjectThreadSelect () 1150 { 1151 } 1152 1153 virtual bool 1154 Execute 1155 ( 1156 Args& command, 1157 CommandReturnObject &result 1158 ) 1159 { 1160 Process *process = m_interpreter.GetExecutionContext().GetProcessPtr(); 1161 if (process == NULL) 1162 { 1163 result.AppendError ("no process"); 1164 result.SetStatus (eReturnStatusFailed); 1165 return false; 1166 } 1167 else if (command.GetArgumentCount() != 1) 1168 { 1169 result.AppendErrorWithFormat("'%s' takes exactly one thread index argument:\nUsage: %s\n", m_cmd_name.c_str(), m_cmd_syntax.c_str()); 1170 result.SetStatus (eReturnStatusFailed); 1171 return false; 1172 } 1173 1174 uint32_t index_id = Args::StringToUInt32(command.GetArgumentAtIndex(0), 0, 0); 1175 1176 Thread *new_thread = process->GetThreadList().FindThreadByIndexID(index_id).get(); 1177 if (new_thread == NULL) 1178 { 1179 result.AppendErrorWithFormat ("invalid thread #%s.\n", command.GetArgumentAtIndex(0)); 1180 result.SetStatus (eReturnStatusFailed); 1181 return false; 1182 } 1183 1184 process->GetThreadList().SetSelectedThreadByID(new_thread->GetID()); 1185 result.SetStatus (eReturnStatusSuccessFinishNoResult); 1186 1187 const uint32_t start_frame = 0; 1188 const uint32_t num_frames = 1; 1189 const uint32_t num_frames_with_source = 1; 1190 new_thread->GetStatus (result.GetOutputStream(), 1191 start_frame, 1192 num_frames, 1193 num_frames_with_source); 1194 1195 return result.Succeeded(); 1196 } 1197 1198 }; 1199 1200 1201 //------------------------------------------------------------------------- 1202 // CommandObjectThreadList 1203 //------------------------------------------------------------------------- 1204 1205 class CommandObjectThreadList : public CommandObject 1206 { 1207 public: 1208 1209 1210 CommandObjectThreadList (CommandInterpreter &interpreter): 1211 CommandObject (interpreter, 1212 "thread list", 1213 "Show a summary of all current threads in a process.", 1214 "thread list", 1215 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 1216 { 1217 } 1218 1219 ~CommandObjectThreadList() 1220 { 1221 } 1222 1223 bool 1224 Execute 1225 ( 1226 Args& command, 1227 CommandReturnObject &result 1228 ) 1229 { 1230 Stream &strm = result.GetOutputStream(); 1231 result.SetStatus (eReturnStatusSuccessFinishNoResult); 1232 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 1233 Process *process = exe_ctx.GetProcessPtr(); 1234 if (process) 1235 { 1236 const bool only_threads_with_stop_reason = false; 1237 const uint32_t start_frame = 0; 1238 const uint32_t num_frames = 0; 1239 const uint32_t num_frames_with_source = 0; 1240 process->GetStatus(strm); 1241 process->GetThreadStatus (strm, 1242 only_threads_with_stop_reason, 1243 start_frame, 1244 num_frames, 1245 num_frames_with_source); 1246 } 1247 else 1248 { 1249 result.AppendError ("no current location or status available"); 1250 result.SetStatus (eReturnStatusFailed); 1251 } 1252 return result.Succeeded(); 1253 } 1254 }; 1255 1256 //------------------------------------------------------------------------- 1257 // CommandObjectMultiwordThread 1258 //------------------------------------------------------------------------- 1259 1260 CommandObjectMultiwordThread::CommandObjectMultiwordThread (CommandInterpreter &interpreter) : 1261 CommandObjectMultiword (interpreter, 1262 "thread", 1263 "A set of commands for operating on one or more threads within a running process.", 1264 "thread <subcommand> [<subcommand-options>]") 1265 { 1266 LoadSubCommand ("backtrace", CommandObjectSP (new CommandObjectThreadBacktrace (interpreter))); 1267 LoadSubCommand ("continue", CommandObjectSP (new CommandObjectThreadContinue (interpreter))); 1268 LoadSubCommand ("list", CommandObjectSP (new CommandObjectThreadList (interpreter))); 1269 LoadSubCommand ("select", CommandObjectSP (new CommandObjectThreadSelect (interpreter))); 1270 LoadSubCommand ("until", CommandObjectSP (new CommandObjectThreadUntil (interpreter))); 1271 LoadSubCommand ("step-in", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( 1272 interpreter, 1273 "thread step-in", 1274 "Source level single step in specified thread (current thread, if none specified).", 1275 NULL, 1276 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused, 1277 eStepTypeInto, 1278 eStepScopeSource))); 1279 1280 LoadSubCommand ("step-out", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( 1281 interpreter, 1282 "thread step-out", 1283 "Finish executing the function of the currently selected frame and return to its call site in specified thread (current thread, if none specified).", 1284 NULL, 1285 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused, 1286 eStepTypeOut, 1287 eStepScopeSource))); 1288 1289 LoadSubCommand ("step-over", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( 1290 interpreter, 1291 "thread step-over", 1292 "Source level single step in specified thread (current thread, if none specified), stepping over calls.", 1293 NULL, 1294 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused, 1295 eStepTypeOver, 1296 eStepScopeSource))); 1297 1298 LoadSubCommand ("step-inst", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( 1299 interpreter, 1300 "thread step-inst", 1301 "Single step one instruction in specified thread (current thread, if none specified).", 1302 NULL, 1303 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused, 1304 eStepTypeTrace, 1305 eStepScopeInstruction))); 1306 1307 LoadSubCommand ("step-inst-over", CommandObjectSP (new CommandObjectThreadStepWithTypeAndScope ( 1308 interpreter, 1309 "thread step-inst-over", 1310 "Single step one instruction in specified thread (current thread, if none specified), stepping over calls.", 1311 NULL, 1312 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused, 1313 eStepTypeTraceOver, 1314 eStepScopeInstruction))); 1315 } 1316 1317 CommandObjectMultiwordThread::~CommandObjectMultiwordThread () 1318 { 1319 } 1320 1321 1322