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