1 //===-- CommandObjectBreakpointCommand.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 // C Includes 11 // C++ Includes 12 // Other libraries and framework includes 13 // Project includes 14 #include "CommandObjectBreakpointCommand.h" 15 #include "CommandObjectBreakpoint.h" 16 #include "lldb/Core/IOHandler.h" 17 #include "lldb/Interpreter/CommandInterpreter.h" 18 #include "lldb/Interpreter/CommandReturnObject.h" 19 #include "lldb/Target/Target.h" 20 #include "lldb/Target/Thread.h" 21 #include "lldb/Breakpoint/BreakpointIDList.h" 22 #include "lldb/Breakpoint/Breakpoint.h" 23 #include "lldb/Breakpoint/BreakpointLocation.h" 24 #include "lldb/Breakpoint/StoppointCallbackContext.h" 25 #include "lldb/Core/State.h" 26 27 using namespace lldb; 28 using namespace lldb_private; 29 30 //------------------------------------------------------------------------- 31 // CommandObjectBreakpointCommandAdd 32 //------------------------------------------------------------------------- 33 34 class CommandObjectBreakpointCommandAdd : 35 public CommandObjectParsed, 36 public IOHandlerDelegateMultiline 37 { 38 public: 39 CommandObjectBreakpointCommandAdd(CommandInterpreter &interpreter) 40 : CommandObjectParsed(interpreter, "add", 41 "Add LLDB commands to a breakpoint, to be executed whenever the breakpoint is hit." 42 " If no breakpoint is specified, adds the commands to the last created breakpoint.", 43 nullptr), 44 IOHandlerDelegateMultiline("DONE", IOHandlerDelegate::Completion::LLDBCommand), 45 m_options() 46 { 47 SetHelpLong ( 48 R"( 49 General information about entering breakpoint commands 50 ------------------------------------------------------ 51 52 )" "This command will prompt for commands to be executed when the specified \ 53 breakpoint is hit. Each command is typed on its own line following the '> ' \ 54 prompt until 'DONE' is entered." R"( 55 56 )" "Syntactic errors may not be detected when initially entered, and many \ 57 malformed commands can silently fail when executed. If your breakpoint commands \ 58 do not appear to be executing, double-check the command syntax." R"( 59 60 )" "Note: You may enter any debugger command exactly as you would at the debugger \ 61 prompt. There is no limit to the number of commands supplied, but do NOT enter \ 62 more than one command per line." R"( 63 64 Special information about PYTHON breakpoint commands 65 ---------------------------------------------------- 66 67 )" "You may enter either one or more lines of Python, including function \ 68 definitions or calls to functions that will have been imported by the time \ 69 the code executes. Single line breakpoint commands will be interpreted 'as is' \ 70 when the breakpoint is hit. Multiple lines of Python will be wrapped in a \ 71 generated function, and a call to the function will be attached to the breakpoint." R"( 72 73 This auto-generated function is passed in three arguments: 74 75 frame: an lldb.SBFrame object for the frame which hit breakpoint. 76 77 bp_loc: an lldb.SBBreakpointLocation object that represents the breakpoint location that was hit. 78 79 dict: the python session dictionary hit. 80 81 )" "When specifying a python function with the --python-function option, you need \ 82 to supply the function name prepended by the module name:" R"( 83 84 --python-function myutils.breakpoint_callback 85 86 The function itself must have the following prototype: 87 88 def breakpoint_callback(frame, bp_loc, dict): 89 # Your code goes here 90 91 )" "The arguments are the same as the arguments passed to generated functions as \ 92 described above. Note that the global variable 'lldb.frame' will NOT be updated when \ 93 this function is called, so be sure to use the 'frame' argument. The 'frame' argument \ 94 can get you to the thread via frame.GetThread(), the thread can get you to the \ 95 process via thread.GetProcess(), and the process can get you back to the target \ 96 via process.GetTarget()." R"( 97 98 )" "Important Note: As Python code gets collected into functions, access to global \ 99 variables requires explicit scoping using the 'global' keyword. Be sure to use correct \ 100 Python syntax, including indentation, when entering Python breakpoint commands." R"( 101 102 Example Python one-line breakpoint command: 103 104 (lldb) breakpoint command add -s python 1 105 Enter your Python command(s). Type 'DONE' to end. 106 > print "Hit this breakpoint!" 107 > DONE 108 109 As a convenience, this also works for a short Python one-liner: 110 111 (lldb) breakpoint command add -s python 1 -o 'import time; print time.asctime()' 112 (lldb) run 113 Launching '.../a.out' (x86_64) 114 (lldb) Fri Sep 10 12:17:45 2010 115 Process 21778 Stopped 116 * thread #1: tid = 0x2e03, 0x0000000100000de8 a.out`c + 7 at main.c:39, stop reason = breakpoint 1.1, queue = com.apple.main-thread 117 36 118 37 int c(int val) 119 38 { 120 39 -> return val + 3; 121 40 } 122 41 123 42 int main (int argc, char const *argv[]) 124 125 Example multiple line Python breakpoint command: 126 127 (lldb) breakpoint command add -s p 1 128 Enter your Python command(s). Type 'DONE' to end. 129 > global bp_count 130 > bp_count = bp_count + 1 131 > print "Hit this breakpoint " + repr(bp_count) + " times!" 132 > DONE 133 134 Example multiple line Python breakpoint command, using function definition: 135 136 (lldb) breakpoint command add -s python 1 137 Enter your Python command(s). Type 'DONE' to end. 138 > def breakpoint_output (bp_no): 139 > out_string = "Hit breakpoint number " + repr (bp_no) 140 > print out_string 141 > return True 142 > breakpoint_output (1) 143 > DONE 144 145 )" "In this case, since there is a reference to a global variable, \ 146 'bp_count', you will also need to make sure 'bp_count' exists and is \ 147 initialized:" R"( 148 149 (lldb) script 150 >>> bp_count = 0 151 >>> quit() 152 153 )" "Your Python code, however organized, can optionally return a value. \ 154 If the returned value is False, that tells LLDB not to stop at the breakpoint \ 155 to which the code is associated. Returning anything other than False, or even \ 156 returning None, or even omitting a return statement entirely, will cause \ 157 LLDB to stop." R"( 158 159 )" "Final Note: A warning that no breakpoint command was generated when there \ 160 are no syntax errors may indicate that a function was declared but never called." 161 ); 162 163 CommandArgumentEntry arg; 164 CommandArgumentData bp_id_arg; 165 166 // Define the first (and only) variant of this arg. 167 bp_id_arg.arg_type = eArgTypeBreakpointID; 168 bp_id_arg.arg_repetition = eArgRepeatOptional; 169 170 // There is only one variant this argument could be; put it into the argument entry. 171 arg.push_back (bp_id_arg); 172 173 // Push the data for the first argument into the m_arguments vector. 174 m_arguments.push_back (arg); 175 } 176 177 ~CommandObjectBreakpointCommandAdd() override = default; 178 179 Options * 180 GetOptions () override 181 { 182 return &m_options; 183 } 184 185 void 186 IOHandlerActivated (IOHandler &io_handler) override 187 { 188 StreamFileSP output_sp(io_handler.GetOutputStreamFile()); 189 if (output_sp) 190 { 191 output_sp->PutCString(g_reader_instructions); 192 output_sp->Flush(); 193 } 194 } 195 196 void 197 IOHandlerInputComplete (IOHandler &io_handler, std::string &line) override 198 { 199 io_handler.SetIsDone(true); 200 201 std::vector<BreakpointOptions *> *bp_options_vec = (std::vector<BreakpointOptions *> *)io_handler.GetUserData(); 202 for (BreakpointOptions *bp_options : *bp_options_vec) 203 { 204 if (!bp_options) 205 continue; 206 207 std::unique_ptr<BreakpointOptions::CommandData> data_ap(new BreakpointOptions::CommandData()); 208 if (data_ap) 209 { 210 data_ap->user_source.SplitIntoLines (line.c_str(), line.size()); 211 BatonSP baton_sp (new BreakpointOptions::CommandBaton (data_ap.release())); 212 bp_options->SetCallback (BreakpointOptionsCallbackFunction, baton_sp); 213 } 214 } 215 } 216 217 void 218 CollectDataForBreakpointCommandCallback (std::vector<BreakpointOptions *> &bp_options_vec, 219 CommandReturnObject &result) 220 { 221 m_interpreter.GetLLDBCommandsFromIOHandler ("> ", // Prompt 222 *this, // IOHandlerDelegate 223 true, // Run IOHandler in async mode 224 &bp_options_vec); // Baton for the "io_handler" that will be passed back into our IOHandlerDelegate functions 225 } 226 227 /// Set a one-liner as the callback for the breakpoint. 228 void 229 SetBreakpointCommandCallback (std::vector<BreakpointOptions *> &bp_options_vec, 230 const char *oneliner) 231 { 232 for (auto bp_options : bp_options_vec) 233 { 234 std::unique_ptr<BreakpointOptions::CommandData> data_ap(new BreakpointOptions::CommandData()); 235 236 // It's necessary to set both user_source and script_source to the oneliner. 237 // The former is used to generate callback description (as in breakpoint command list) 238 // while the latter is used for Python to interpret during the actual callback. 239 data_ap->user_source.AppendString (oneliner); 240 data_ap->script_source.assign (oneliner); 241 data_ap->stop_on_error = m_options.m_stop_on_error; 242 243 BatonSP baton_sp (new BreakpointOptions::CommandBaton (data_ap.release())); 244 bp_options->SetCallback (BreakpointOptionsCallbackFunction, baton_sp); 245 } 246 } 247 248 static bool 249 BreakpointOptionsCallbackFunction (void *baton, 250 StoppointCallbackContext *context, 251 lldb::user_id_t break_id, 252 lldb::user_id_t break_loc_id) 253 { 254 bool ret_value = true; 255 if (baton == nullptr) 256 return true; 257 258 BreakpointOptions::CommandData *data = (BreakpointOptions::CommandData *) baton; 259 StringList &commands = data->user_source; 260 261 if (commands.GetSize() > 0) 262 { 263 ExecutionContext exe_ctx (context->exe_ctx_ref); 264 Target *target = exe_ctx.GetTargetPtr(); 265 if (target) 266 { 267 CommandReturnObject result; 268 Debugger &debugger = target->GetDebugger(); 269 // Rig up the results secondary output stream to the debugger's, so the output will come out synchronously 270 // if the debugger is set up that way. 271 272 StreamSP output_stream (debugger.GetAsyncOutputStream()); 273 StreamSP error_stream (debugger.GetAsyncErrorStream()); 274 result.SetImmediateOutputStream (output_stream); 275 result.SetImmediateErrorStream (error_stream); 276 277 CommandInterpreterRunOptions options; 278 options.SetStopOnContinue(true); 279 options.SetStopOnError (data->stop_on_error); 280 options.SetEchoCommands (true); 281 options.SetPrintResults (true); 282 options.SetAddToHistory (false); 283 284 debugger.GetCommandInterpreter().HandleCommands (commands, 285 &exe_ctx, 286 options, 287 result); 288 result.GetImmediateOutputStream()->Flush(); 289 result.GetImmediateErrorStream()->Flush(); 290 } 291 } 292 return ret_value; 293 } 294 295 class CommandOptions : public Options 296 { 297 public: 298 CommandOptions () : 299 Options (), 300 m_use_commands (false), 301 m_use_script_language (false), 302 m_script_language (eScriptLanguageNone), 303 m_use_one_liner (false), 304 m_one_liner(), 305 m_function_name() 306 { 307 } 308 309 ~CommandOptions() override = default; 310 311 Error 312 SetOptionValue (uint32_t option_idx, const char *option_arg, 313 ExecutionContext *execution_context) override 314 { 315 Error error; 316 const int short_option = m_getopt_table[option_idx].val; 317 318 switch (short_option) 319 { 320 case 'o': 321 m_use_one_liner = true; 322 m_one_liner = option_arg; 323 break; 324 325 case 's': 326 m_script_language = (lldb::ScriptLanguage) Args::StringToOptionEnum (option_arg, 327 g_option_table[option_idx].enum_values, 328 eScriptLanguageNone, 329 error); 330 331 if (m_script_language == eScriptLanguagePython || m_script_language == eScriptLanguageDefault) 332 { 333 m_use_script_language = true; 334 } 335 else 336 { 337 m_use_script_language = false; 338 } 339 break; 340 341 case 'e': 342 { 343 bool success = false; 344 m_stop_on_error = Args::StringToBoolean(option_arg, false, &success); 345 if (!success) 346 error.SetErrorStringWithFormat("invalid value for stop-on-error: \"%s\"", option_arg); 347 } 348 break; 349 350 case 'F': 351 m_use_one_liner = false; 352 m_use_script_language = true; 353 m_function_name.assign(option_arg); 354 break; 355 356 case 'D': 357 m_use_dummy = true; 358 break; 359 360 default: 361 break; 362 } 363 return error; 364 } 365 366 void 367 OptionParsingStarting (ExecutionContext *execution_context) override 368 { 369 m_use_commands = true; 370 m_use_script_language = false; 371 m_script_language = eScriptLanguageNone; 372 373 m_use_one_liner = false; 374 m_stop_on_error = true; 375 m_one_liner.clear(); 376 m_function_name.clear(); 377 m_use_dummy = false; 378 } 379 380 const OptionDefinition* 381 GetDefinitions () override 382 { 383 return g_option_table; 384 } 385 386 // Options table: Required for subclasses of Options. 387 388 static OptionDefinition g_option_table[]; 389 390 // Instance variables to hold the values for command options. 391 392 bool m_use_commands; 393 bool m_use_script_language; 394 lldb::ScriptLanguage m_script_language; 395 396 // Instance variables to hold the values for one_liner options. 397 bool m_use_one_liner; 398 std::string m_one_liner; 399 bool m_stop_on_error; 400 std::string m_function_name; 401 bool m_use_dummy; 402 }; 403 404 protected: 405 bool 406 DoExecute (Args& command, CommandReturnObject &result) override 407 { 408 Target *target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 409 410 if (target == nullptr) 411 { 412 result.AppendError ("There is not a current executable; there are no breakpoints to which to add commands"); 413 result.SetStatus (eReturnStatusFailed); 414 return false; 415 } 416 417 const BreakpointList &breakpoints = target->GetBreakpointList(); 418 size_t num_breakpoints = breakpoints.GetSize(); 419 420 if (num_breakpoints == 0) 421 { 422 result.AppendError ("No breakpoints exist to have commands added"); 423 result.SetStatus (eReturnStatusFailed); 424 return false; 425 } 426 427 if (!m_options.m_use_script_language && !m_options.m_function_name.empty()) 428 { 429 result.AppendError ("need to enable scripting to have a function run as a breakpoint command"); 430 result.SetStatus (eReturnStatusFailed); 431 return false; 432 } 433 434 BreakpointIDList valid_bp_ids; 435 CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs (command, target, result, &valid_bp_ids); 436 437 m_bp_options_vec.clear(); 438 439 if (result.Succeeded()) 440 { 441 const size_t count = valid_bp_ids.GetSize(); 442 443 for (size_t i = 0; i < count; ++i) 444 { 445 BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex (i); 446 if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) 447 { 448 Breakpoint *bp = target->GetBreakpointByID (cur_bp_id.GetBreakpointID()).get(); 449 BreakpointOptions *bp_options = nullptr; 450 if (cur_bp_id.GetLocationID() == LLDB_INVALID_BREAK_ID) 451 { 452 // This breakpoint does not have an associated location. 453 bp_options = bp->GetOptions(); 454 } 455 else 456 { 457 BreakpointLocationSP bp_loc_sp(bp->FindLocationByID (cur_bp_id.GetLocationID())); 458 // This breakpoint does have an associated location. 459 // Get its breakpoint options. 460 if (bp_loc_sp) 461 bp_options = bp_loc_sp->GetLocationOptions(); 462 } 463 if (bp_options) 464 m_bp_options_vec.push_back (bp_options); 465 } 466 } 467 468 // If we are using script language, get the script interpreter 469 // in order to set or collect command callback. Otherwise, call 470 // the methods associated with this object. 471 if (m_options.m_use_script_language) 472 { 473 ScriptInterpreter *script_interp = m_interpreter.GetScriptInterpreter(); 474 // Special handling for one-liner specified inline. 475 if (m_options.m_use_one_liner) 476 { 477 script_interp->SetBreakpointCommandCallback (m_bp_options_vec, 478 m_options.m_one_liner.c_str()); 479 } 480 else if (!m_options.m_function_name.empty()) 481 { 482 script_interp->SetBreakpointCommandCallbackFunction (m_bp_options_vec, 483 m_options.m_function_name.c_str()); 484 } 485 else 486 { 487 script_interp->CollectDataForBreakpointCommandCallback (m_bp_options_vec, 488 result); 489 } 490 } 491 else 492 { 493 // Special handling for one-liner specified inline. 494 if (m_options.m_use_one_liner) 495 SetBreakpointCommandCallback (m_bp_options_vec, 496 m_options.m_one_liner.c_str()); 497 else 498 CollectDataForBreakpointCommandCallback (m_bp_options_vec, 499 result); 500 } 501 } 502 503 return result.Succeeded(); 504 } 505 506 private: 507 CommandOptions m_options; 508 std::vector<BreakpointOptions *> m_bp_options_vec; // This stores the breakpoint options that we are currently 509 // collecting commands for. In the CollectData... calls we need 510 // to hand this off to the IOHandler, which may run asynchronously. 511 // So we have to have some way to keep it alive, and not leak it. 512 // Making it an ivar of the command object, which never goes away 513 // achieves this. Note that if we were able to run 514 // the same command concurrently in one interpreter we'd have to 515 // make this "per invocation". But there are many more reasons 516 // why it is not in general safe to do that in lldb at present, 517 // so it isn't worthwhile to come up with a more complex mechanism 518 // to address this particular weakness right now. 519 static const char *g_reader_instructions; 520 }; 521 522 const char * 523 CommandObjectBreakpointCommandAdd::g_reader_instructions = "Enter your debugger command(s). Type 'DONE' to end.\n"; 524 525 // FIXME: "script-type" needs to have its contents determined dynamically, so somebody can add a new scripting 526 // language to lldb and have it pickable here without having to change this enumeration by hand and rebuild lldb proper. 527 528 static OptionEnumValueElement 529 g_script_option_enumeration[4] = 530 { 531 { eScriptLanguageNone, "command", "Commands are in the lldb command interpreter language"}, 532 { eScriptLanguagePython, "python", "Commands are in the Python language."}, 533 { eSortOrderByName, "default-script", "Commands are in the default scripting language."}, 534 { 0, nullptr, nullptr } 535 }; 536 537 OptionDefinition 538 CommandObjectBreakpointCommandAdd::CommandOptions::g_option_table[] = 539 { 540 // clang-format off 541 {LLDB_OPT_SET_1, false, "one-liner", 'o', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeOneLiner, "Specify a one-line breakpoint command inline. Be sure to surround it with quotes." }, 542 {LLDB_OPT_SET_ALL, false, "stop-on-error", 'e', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeBoolean, "Specify whether breakpoint command execution should terminate on error." }, 543 {LLDB_OPT_SET_ALL, false, "script-type", 's', OptionParser::eRequiredArgument, nullptr, g_script_option_enumeration, 0, eArgTypeNone, "Specify the language for the commands - if none is specified, the lldb command interpreter will be used."}, 544 {LLDB_OPT_SET_2, false, "python-function", 'F', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypePythonFunction, "Give the name of a Python function to run as command for this breakpoint. Be sure to give a module name if appropriate."}, 545 {LLDB_OPT_SET_ALL, false, "dummy-breakpoints", 'D', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, "Sets Dummy breakpoints - i.e. breakpoints set before a file is provided, which prime new targets."}, 546 {0, false, nullptr, 0, 0, nullptr, nullptr, 0, eArgTypeNone, nullptr} 547 // clang-format on 548 }; 549 550 //------------------------------------------------------------------------- 551 // CommandObjectBreakpointCommandDelete 552 //------------------------------------------------------------------------- 553 554 class CommandObjectBreakpointCommandDelete : public CommandObjectParsed 555 { 556 public: 557 CommandObjectBreakpointCommandDelete (CommandInterpreter &interpreter) : 558 CommandObjectParsed(interpreter, 559 "delete", 560 "Delete the set of commands from a breakpoint.", 561 nullptr), 562 m_options() 563 { 564 CommandArgumentEntry arg; 565 CommandArgumentData bp_id_arg; 566 567 // Define the first (and only) variant of this arg. 568 bp_id_arg.arg_type = eArgTypeBreakpointID; 569 bp_id_arg.arg_repetition = eArgRepeatPlain; 570 571 // There is only one variant this argument could be; put it into the argument entry. 572 arg.push_back (bp_id_arg); 573 574 // Push the data for the first argument into the m_arguments vector. 575 m_arguments.push_back (arg); 576 } 577 578 ~CommandObjectBreakpointCommandDelete() override = default; 579 580 Options * 581 GetOptions () override 582 { 583 return &m_options; 584 } 585 586 class CommandOptions : public Options 587 { 588 public: 589 CommandOptions() : 590 Options(), 591 m_use_dummy(false) 592 { 593 } 594 595 ~CommandOptions() override = default; 596 597 Error 598 SetOptionValue (uint32_t option_idx, const char *option_arg, 599 ExecutionContext *execution_context) override 600 { 601 Error error; 602 const int short_option = m_getopt_table[option_idx].val; 603 604 switch (short_option) 605 { 606 case 'D': 607 m_use_dummy = true; 608 break; 609 610 default: 611 error.SetErrorStringWithFormat ("unrecognized option '%c'", short_option); 612 break; 613 } 614 615 return error; 616 } 617 618 void 619 OptionParsingStarting (ExecutionContext *execution_context) override 620 { 621 m_use_dummy = false; 622 } 623 624 const OptionDefinition* 625 GetDefinitions () override 626 { 627 return g_option_table; 628 } 629 630 // Options table: Required for subclasses of Options. 631 632 static OptionDefinition g_option_table[]; 633 634 // Instance variables to hold the values for command options. 635 bool m_use_dummy; 636 }; 637 638 protected: 639 bool 640 DoExecute (Args& command, CommandReturnObject &result) override 641 { 642 Target *target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 643 644 if (target == nullptr) 645 { 646 result.AppendError ("There is not a current executable; there are no breakpoints from which to delete commands"); 647 result.SetStatus (eReturnStatusFailed); 648 return false; 649 } 650 651 const BreakpointList &breakpoints = target->GetBreakpointList(); 652 size_t num_breakpoints = breakpoints.GetSize(); 653 654 if (num_breakpoints == 0) 655 { 656 result.AppendError ("No breakpoints exist to have commands deleted"); 657 result.SetStatus (eReturnStatusFailed); 658 return false; 659 } 660 661 if (command.GetArgumentCount() == 0) 662 { 663 result.AppendError ("No breakpoint specified from which to delete the commands"); 664 result.SetStatus (eReturnStatusFailed); 665 return false; 666 } 667 668 BreakpointIDList valid_bp_ids; 669 CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs (command, target, result, &valid_bp_ids); 670 671 if (result.Succeeded()) 672 { 673 const size_t count = valid_bp_ids.GetSize(); 674 for (size_t i = 0; i < count; ++i) 675 { 676 BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex (i); 677 if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) 678 { 679 Breakpoint *bp = target->GetBreakpointByID (cur_bp_id.GetBreakpointID()).get(); 680 if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) 681 { 682 BreakpointLocationSP bp_loc_sp (bp->FindLocationByID (cur_bp_id.GetLocationID())); 683 if (bp_loc_sp) 684 bp_loc_sp->ClearCallback(); 685 else 686 { 687 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 688 cur_bp_id.GetBreakpointID(), 689 cur_bp_id.GetLocationID()); 690 result.SetStatus (eReturnStatusFailed); 691 return false; 692 } 693 } 694 else 695 { 696 bp->ClearCallback(); 697 } 698 } 699 } 700 } 701 return result.Succeeded(); 702 } 703 704 private: 705 CommandOptions m_options; 706 }; 707 708 OptionDefinition 709 CommandObjectBreakpointCommandDelete::CommandOptions::g_option_table[] = 710 { 711 // clang-format off 712 {LLDB_OPT_SET_1, false, "dummy-breakpoints", 'D', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, "Delete commands from Dummy breakpoints - i.e. breakpoints set before a file is provided, which prime new targets."}, 713 {0, false, nullptr, 0, 0, nullptr, nullptr, 0, eArgTypeNone, nullptr} 714 // clang-format on 715 }; 716 717 //------------------------------------------------------------------------- 718 // CommandObjectBreakpointCommandList 719 //------------------------------------------------------------------------- 720 721 class CommandObjectBreakpointCommandList : public CommandObjectParsed 722 { 723 public: 724 CommandObjectBreakpointCommandList (CommandInterpreter &interpreter) : 725 CommandObjectParsed(interpreter, 726 "list", 727 "List the script or set of commands to be executed when the breakpoint is hit.", 728 nullptr) 729 { 730 CommandArgumentEntry arg; 731 CommandArgumentData bp_id_arg; 732 733 // Define the first (and only) variant of this arg. 734 bp_id_arg.arg_type = eArgTypeBreakpointID; 735 bp_id_arg.arg_repetition = eArgRepeatPlain; 736 737 // There is only one variant this argument could be; put it into the argument entry. 738 arg.push_back (bp_id_arg); 739 740 // Push the data for the first argument into the m_arguments vector. 741 m_arguments.push_back (arg); 742 } 743 744 ~CommandObjectBreakpointCommandList() override = default; 745 746 protected: 747 bool 748 DoExecute (Args& command, 749 CommandReturnObject &result) override 750 { 751 Target *target = m_interpreter.GetDebugger().GetSelectedTarget().get(); 752 753 if (target == nullptr) 754 { 755 result.AppendError ("There is not a current executable; there are no breakpoints for which to list commands"); 756 result.SetStatus (eReturnStatusFailed); 757 return false; 758 } 759 760 const BreakpointList &breakpoints = target->GetBreakpointList(); 761 size_t num_breakpoints = breakpoints.GetSize(); 762 763 if (num_breakpoints == 0) 764 { 765 result.AppendError ("No breakpoints exist for which to list commands"); 766 result.SetStatus (eReturnStatusFailed); 767 return false; 768 } 769 770 if (command.GetArgumentCount() == 0) 771 { 772 result.AppendError ("No breakpoint specified for which to list the commands"); 773 result.SetStatus (eReturnStatusFailed); 774 return false; 775 } 776 777 BreakpointIDList valid_bp_ids; 778 CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs (command, target, result, &valid_bp_ids); 779 780 if (result.Succeeded()) 781 { 782 const size_t count = valid_bp_ids.GetSize(); 783 for (size_t i = 0; i < count; ++i) 784 { 785 BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex (i); 786 if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) 787 { 788 Breakpoint *bp = target->GetBreakpointByID (cur_bp_id.GetBreakpointID()).get(); 789 790 if (bp) 791 { 792 const BreakpointOptions *bp_options = nullptr; 793 if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) 794 { 795 BreakpointLocationSP bp_loc_sp(bp->FindLocationByID (cur_bp_id.GetLocationID())); 796 if (bp_loc_sp) 797 bp_options = bp_loc_sp->GetOptionsNoCreate(); 798 else 799 { 800 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 801 cur_bp_id.GetBreakpointID(), 802 cur_bp_id.GetLocationID()); 803 result.SetStatus (eReturnStatusFailed); 804 return false; 805 } 806 } 807 else 808 { 809 bp_options = bp->GetOptions(); 810 } 811 812 if (bp_options) 813 { 814 StreamString id_str; 815 BreakpointID::GetCanonicalReference (&id_str, 816 cur_bp_id.GetBreakpointID(), 817 cur_bp_id.GetLocationID()); 818 const Baton *baton = bp_options->GetBaton(); 819 if (baton) 820 { 821 result.GetOutputStream().Printf ("Breakpoint %s:\n", id_str.GetData()); 822 result.GetOutputStream().IndentMore (); 823 baton->GetDescription(&result.GetOutputStream(), eDescriptionLevelFull); 824 result.GetOutputStream().IndentLess (); 825 } 826 else 827 { 828 result.AppendMessageWithFormat ("Breakpoint %s does not have an associated command.\n", 829 id_str.GetData()); 830 } 831 } 832 result.SetStatus (eReturnStatusSuccessFinishResult); 833 } 834 else 835 { 836 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.\n", cur_bp_id.GetBreakpointID()); 837 result.SetStatus (eReturnStatusFailed); 838 } 839 } 840 } 841 } 842 843 return result.Succeeded(); 844 } 845 }; 846 847 //------------------------------------------------------------------------- 848 // CommandObjectBreakpointCommand 849 //------------------------------------------------------------------------- 850 851 CommandObjectBreakpointCommand::CommandObjectBreakpointCommand(CommandInterpreter &interpreter) 852 : CommandObjectMultiword( 853 interpreter, "command", 854 "Commands for adding, removing and listing LLDB commands executed when a breakpoint is hit.", 855 "command <sub-command> [<sub-command-options>] <breakpoint-id>") 856 { 857 CommandObjectSP add_command_object (new CommandObjectBreakpointCommandAdd (interpreter)); 858 CommandObjectSP delete_command_object (new CommandObjectBreakpointCommandDelete (interpreter)); 859 CommandObjectSP list_command_object (new CommandObjectBreakpointCommandList (interpreter)); 860 861 add_command_object->SetCommandName ("breakpoint command add"); 862 delete_command_object->SetCommandName ("breakpoint command delete"); 863 list_command_object->SetCommandName ("breakpoint command list"); 864 865 LoadSubCommand ("add", add_command_object); 866 LoadSubCommand ("delete", delete_command_object); 867 LoadSubCommand ("list", list_command_object); 868 } 869 870 CommandObjectBreakpointCommand::~CommandObjectBreakpointCommand() = default; 871