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<std::reference_wrapper<BreakpointOptions>> *bp_options_vec = 249 (std::vector<std::reference_wrapper<BreakpointOptions>> *) 250 io_handler.GetUserData(); 251 for (BreakpointOptions &bp_options : *bp_options_vec) { 252 auto cmd_data = std::make_unique<BreakpointOptions::CommandData>(); 253 cmd_data->user_source.SplitIntoLines(line.c_str(), line.size()); 254 bp_options.SetCommandDataCallback(cmd_data); 255 } 256 } 257 258 void CollectDataForBreakpointCommandCallback( 259 std::vector<std::reference_wrapper<BreakpointOptions>> &bp_options_vec, 260 CommandReturnObject &result) { 261 m_interpreter.GetLLDBCommandsFromIOHandler( 262 "> ", // Prompt 263 *this, // IOHandlerDelegate 264 &bp_options_vec); // Baton for the "io_handler" that will be passed back 265 // into our IOHandlerDelegate functions 266 } 267 268 /// Set a one-liner as the callback for the breakpoint. 269 void SetBreakpointCommandCallback( 270 std::vector<std::reference_wrapper<BreakpointOptions>> &bp_options_vec, 271 const char *oneliner) { 272 for (BreakpointOptions &bp_options : bp_options_vec) { 273 auto cmd_data = std::make_unique<BreakpointOptions::CommandData>(); 274 275 cmd_data->user_source.AppendString(oneliner); 276 cmd_data->stop_on_error = m_options.m_stop_on_error; 277 278 bp_options.SetCommandDataCallback(cmd_data); 279 } 280 } 281 282 class CommandOptions : public OptionGroup { 283 public: 284 CommandOptions() : OptionGroup(), m_one_liner() {} 285 286 ~CommandOptions() override = default; 287 288 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 289 ExecutionContext *execution_context) override { 290 Status error; 291 const int short_option = 292 g_breakpoint_command_add_options[option_idx].short_option; 293 294 switch (short_option) { 295 case 'o': 296 m_use_one_liner = true; 297 m_one_liner = std::string(option_arg); 298 break; 299 300 case 's': 301 m_script_language = (lldb::ScriptLanguage)OptionArgParser::ToOptionEnum( 302 option_arg, 303 g_breakpoint_command_add_options[option_idx].enum_values, 304 eScriptLanguageNone, error); 305 switch (m_script_language) { 306 case eScriptLanguagePython: 307 case eScriptLanguageLua: 308 m_use_script_language = true; 309 break; 310 case eScriptLanguageNone: 311 case eScriptLanguageUnknown: 312 m_use_script_language = false; 313 break; 314 } 315 break; 316 317 case 'e': { 318 bool success = false; 319 m_stop_on_error = 320 OptionArgParser::ToBoolean(option_arg, false, &success); 321 if (!success) 322 error.SetErrorStringWithFormat( 323 "invalid value for stop-on-error: \"%s\"", 324 option_arg.str().c_str()); 325 } break; 326 327 case 'D': 328 m_use_dummy = true; 329 break; 330 331 default: 332 llvm_unreachable("Unimplemented option"); 333 } 334 return error; 335 } 336 337 void OptionParsingStarting(ExecutionContext *execution_context) override { 338 m_use_commands = true; 339 m_use_script_language = false; 340 m_script_language = eScriptLanguageNone; 341 342 m_use_one_liner = false; 343 m_stop_on_error = true; 344 m_one_liner.clear(); 345 m_use_dummy = false; 346 } 347 348 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 349 return llvm::makeArrayRef(g_breakpoint_command_add_options); 350 } 351 352 // Instance variables to hold the values for command options. 353 354 bool m_use_commands = false; 355 bool m_use_script_language = false; 356 lldb::ScriptLanguage m_script_language = eScriptLanguageNone; 357 358 // Instance variables to hold the values for one_liner options. 359 bool m_use_one_liner = false; 360 std::string m_one_liner; 361 bool m_stop_on_error; 362 bool m_use_dummy; 363 }; 364 365 protected: 366 bool DoExecute(Args &command, CommandReturnObject &result) override { 367 Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 368 369 const BreakpointList &breakpoints = target.GetBreakpointList(); 370 size_t num_breakpoints = breakpoints.GetSize(); 371 372 if (num_breakpoints == 0) { 373 result.AppendError("No breakpoints exist to have commands added"); 374 result.SetStatus(eReturnStatusFailed); 375 return false; 376 } 377 378 if (!m_func_options.GetName().empty()) { 379 m_options.m_use_one_liner = false; 380 if (!m_options.m_use_script_language) { 381 m_options.m_script_language = GetDebugger().GetScriptLanguage(); 382 m_options.m_use_script_language = true; 383 } 384 } 385 386 BreakpointIDList valid_bp_ids; 387 CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 388 command, &target, result, &valid_bp_ids, 389 BreakpointName::Permissions::PermissionKinds::listPerm); 390 391 m_bp_options_vec.clear(); 392 393 if (result.Succeeded()) { 394 const size_t count = valid_bp_ids.GetSize(); 395 396 for (size_t i = 0; i < count; ++i) { 397 BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 398 if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 399 Breakpoint *bp = 400 target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 401 if (cur_bp_id.GetLocationID() == LLDB_INVALID_BREAK_ID) { 402 // This breakpoint does not have an associated location. 403 m_bp_options_vec.push_back(bp->GetOptions()); 404 } else { 405 BreakpointLocationSP bp_loc_sp( 406 bp->FindLocationByID(cur_bp_id.GetLocationID())); 407 // This breakpoint does have an associated location. Get its 408 // breakpoint options. 409 if (bp_loc_sp) 410 m_bp_options_vec.push_back(bp_loc_sp->GetLocationOptions()); 411 } 412 } 413 } 414 415 // If we are using script language, get the script interpreter in order 416 // to set or collect command callback. Otherwise, call the methods 417 // associated with this object. 418 if (m_options.m_use_script_language) { 419 Status error; 420 ScriptInterpreter *script_interp = GetDebugger().GetScriptInterpreter( 421 /*can_create=*/true, m_options.m_script_language); 422 // Special handling for one-liner specified inline. 423 if (m_options.m_use_one_liner) { 424 error = script_interp->SetBreakpointCommandCallback( 425 m_bp_options_vec, m_options.m_one_liner.c_str()); 426 } else if (!m_func_options.GetName().empty()) { 427 error = script_interp->SetBreakpointCommandCallbackFunction( 428 m_bp_options_vec, m_func_options.GetName().c_str(), 429 m_func_options.GetStructuredData()); 430 } else { 431 script_interp->CollectDataForBreakpointCommandCallback( 432 m_bp_options_vec, result); 433 } 434 if (!error.Success()) 435 result.SetError(error); 436 } else { 437 // Special handling for one-liner specified inline. 438 if (m_options.m_use_one_liner) 439 SetBreakpointCommandCallback(m_bp_options_vec, 440 m_options.m_one_liner.c_str()); 441 else 442 CollectDataForBreakpointCommandCallback(m_bp_options_vec, result); 443 } 444 } 445 446 return result.Succeeded(); 447 } 448 449 private: 450 CommandOptions m_options; 451 OptionGroupPythonClassWithDict m_func_options; 452 OptionGroupOptions m_all_options; 453 454 std::vector<std::reference_wrapper<BreakpointOptions>> 455 m_bp_options_vec; // This stores the 456 // breakpoint options that 457 // we are currently 458 // collecting commands for. In the CollectData... calls we need to hand this 459 // off to the IOHandler, which may run asynchronously. So we have to have 460 // some way to keep it alive, and not leak it. Making it an ivar of the 461 // command object, which never goes away achieves this. Note that if we were 462 // able to run the same command concurrently in one interpreter we'd have to 463 // make this "per invocation". But there are many more reasons why it is not 464 // in general safe to do that in lldb at present, so it isn't worthwhile to 465 // come up with a more complex mechanism to address this particular weakness 466 // right now. 467 static const char *g_reader_instructions; 468 }; 469 470 const char *CommandObjectBreakpointCommandAdd::g_reader_instructions = 471 "Enter your debugger command(s). Type 'DONE' to end.\n"; 472 473 // CommandObjectBreakpointCommandDelete 474 475 #define LLDB_OPTIONS_breakpoint_command_delete 476 #include "CommandOptions.inc" 477 478 class CommandObjectBreakpointCommandDelete : public CommandObjectParsed { 479 public: 480 CommandObjectBreakpointCommandDelete(CommandInterpreter &interpreter) 481 : CommandObjectParsed(interpreter, "delete", 482 "Delete the set of commands from a breakpoint.", 483 nullptr), 484 m_options() { 485 CommandArgumentEntry arg; 486 CommandArgumentData bp_id_arg; 487 488 // Define the first (and only) variant of this arg. 489 bp_id_arg.arg_type = eArgTypeBreakpointID; 490 bp_id_arg.arg_repetition = eArgRepeatPlain; 491 492 // There is only one variant this argument could be; put it into the 493 // argument entry. 494 arg.push_back(bp_id_arg); 495 496 // Push the data for the first argument into the m_arguments vector. 497 m_arguments.push_back(arg); 498 } 499 500 ~CommandObjectBreakpointCommandDelete() override = default; 501 502 Options *GetOptions() override { return &m_options; } 503 504 class CommandOptions : public Options { 505 public: 506 CommandOptions() : Options() {} 507 508 ~CommandOptions() override = default; 509 510 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 511 ExecutionContext *execution_context) override { 512 Status error; 513 const int short_option = m_getopt_table[option_idx].val; 514 515 switch (short_option) { 516 case 'D': 517 m_use_dummy = true; 518 break; 519 520 default: 521 llvm_unreachable("Unimplemented option"); 522 } 523 524 return error; 525 } 526 527 void OptionParsingStarting(ExecutionContext *execution_context) override { 528 m_use_dummy = false; 529 } 530 531 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 532 return llvm::makeArrayRef(g_breakpoint_command_delete_options); 533 } 534 535 // Instance variables to hold the values for command options. 536 bool m_use_dummy = false; 537 }; 538 539 protected: 540 bool DoExecute(Args &command, CommandReturnObject &result) override { 541 Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 542 543 const BreakpointList &breakpoints = target.GetBreakpointList(); 544 size_t num_breakpoints = breakpoints.GetSize(); 545 546 if (num_breakpoints == 0) { 547 result.AppendError("No breakpoints exist to have commands deleted"); 548 result.SetStatus(eReturnStatusFailed); 549 return false; 550 } 551 552 if (command.empty()) { 553 result.AppendError( 554 "No breakpoint specified from which to delete the commands"); 555 result.SetStatus(eReturnStatusFailed); 556 return false; 557 } 558 559 BreakpointIDList valid_bp_ids; 560 CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 561 command, &target, result, &valid_bp_ids, 562 BreakpointName::Permissions::PermissionKinds::listPerm); 563 564 if (result.Succeeded()) { 565 const size_t count = valid_bp_ids.GetSize(); 566 for (size_t i = 0; i < count; ++i) { 567 BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 568 if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 569 Breakpoint *bp = 570 target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 571 if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) { 572 BreakpointLocationSP bp_loc_sp( 573 bp->FindLocationByID(cur_bp_id.GetLocationID())); 574 if (bp_loc_sp) 575 bp_loc_sp->ClearCallback(); 576 else { 577 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 578 cur_bp_id.GetBreakpointID(), 579 cur_bp_id.GetLocationID()); 580 result.SetStatus(eReturnStatusFailed); 581 return false; 582 } 583 } else { 584 bp->ClearCallback(); 585 } 586 } 587 } 588 } 589 return result.Succeeded(); 590 } 591 592 private: 593 CommandOptions m_options; 594 }; 595 596 // CommandObjectBreakpointCommandList 597 598 class CommandObjectBreakpointCommandList : public CommandObjectParsed { 599 public: 600 CommandObjectBreakpointCommandList(CommandInterpreter &interpreter) 601 : CommandObjectParsed(interpreter, "list", 602 "List the script or set of commands to be " 603 "executed when the breakpoint is hit.", 604 nullptr, eCommandRequiresTarget) { 605 CommandArgumentEntry arg; 606 CommandArgumentData bp_id_arg; 607 608 // Define the first (and only) variant of this arg. 609 bp_id_arg.arg_type = eArgTypeBreakpointID; 610 bp_id_arg.arg_repetition = eArgRepeatPlain; 611 612 // There is only one variant this argument could be; put it into the 613 // argument entry. 614 arg.push_back(bp_id_arg); 615 616 // Push the data for the first argument into the m_arguments vector. 617 m_arguments.push_back(arg); 618 } 619 620 ~CommandObjectBreakpointCommandList() override = default; 621 622 protected: 623 bool DoExecute(Args &command, CommandReturnObject &result) override { 624 Target *target = &GetSelectedTarget(); 625 626 const BreakpointList &breakpoints = target->GetBreakpointList(); 627 size_t num_breakpoints = breakpoints.GetSize(); 628 629 if (num_breakpoints == 0) { 630 result.AppendError("No breakpoints exist for which to list commands"); 631 result.SetStatus(eReturnStatusFailed); 632 return false; 633 } 634 635 if (command.empty()) { 636 result.AppendError( 637 "No breakpoint specified for which to list the commands"); 638 result.SetStatus(eReturnStatusFailed); 639 return false; 640 } 641 642 BreakpointIDList valid_bp_ids; 643 CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 644 command, target, result, &valid_bp_ids, 645 BreakpointName::Permissions::PermissionKinds::listPerm); 646 647 if (result.Succeeded()) { 648 const size_t count = valid_bp_ids.GetSize(); 649 for (size_t i = 0; i < count; ++i) { 650 BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 651 if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 652 Breakpoint *bp = 653 target->GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 654 655 if (bp) { 656 BreakpointLocationSP bp_loc_sp; 657 if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) { 658 bp_loc_sp = bp->FindLocationByID(cur_bp_id.GetLocationID()); 659 if (!bp_loc_sp) { 660 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 661 cur_bp_id.GetBreakpointID(), 662 cur_bp_id.GetLocationID()); 663 result.SetStatus(eReturnStatusFailed); 664 return false; 665 } 666 } 667 668 StreamString id_str; 669 BreakpointID::GetCanonicalReference(&id_str, 670 cur_bp_id.GetBreakpointID(), 671 cur_bp_id.GetLocationID()); 672 const Baton *baton = nullptr; 673 if (bp_loc_sp) 674 baton = 675 bp_loc_sp 676 ->GetOptionsSpecifyingKind(BreakpointOptions::eCallback) 677 .GetBaton(); 678 else 679 baton = bp->GetOptions().GetBaton(); 680 681 if (baton) { 682 result.GetOutputStream().Printf("Breakpoint %s:\n", 683 id_str.GetData()); 684 baton->GetDescription(result.GetOutputStream().AsRawOstream(), 685 eDescriptionLevelFull, 686 result.GetOutputStream().GetIndentLevel() + 687 2); 688 } else { 689 result.AppendMessageWithFormat( 690 "Breakpoint %s does not have an associated command.\n", 691 id_str.GetData()); 692 } 693 } 694 result.SetStatus(eReturnStatusSuccessFinishResult); 695 } else { 696 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.\n", 697 cur_bp_id.GetBreakpointID()); 698 result.SetStatus(eReturnStatusFailed); 699 } 700 } 701 } 702 703 return result.Succeeded(); 704 } 705 }; 706 707 // CommandObjectBreakpointCommand 708 709 CommandObjectBreakpointCommand::CommandObjectBreakpointCommand( 710 CommandInterpreter &interpreter) 711 : CommandObjectMultiword( 712 interpreter, "command", 713 "Commands for adding, removing and listing " 714 "LLDB commands executed when a breakpoint is " 715 "hit.", 716 "command <sub-command> [<sub-command-options>] <breakpoint-id>") { 717 CommandObjectSP add_command_object( 718 new CommandObjectBreakpointCommandAdd(interpreter)); 719 CommandObjectSP delete_command_object( 720 new CommandObjectBreakpointCommandDelete(interpreter)); 721 CommandObjectSP list_command_object( 722 new CommandObjectBreakpointCommandList(interpreter)); 723 724 add_command_object->SetCommandName("breakpoint command add"); 725 delete_command_object->SetCommandName("breakpoint command delete"); 726 list_command_object->SetCommandName("breakpoint command list"); 727 728 LoadSubCommand("add", add_command_object); 729 LoadSubCommand("delete", delete_command_object); 730 LoadSubCommand("list", list_command_object); 731 } 732 733 CommandObjectBreakpointCommand::~CommandObjectBreakpointCommand() = default; 734