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