xref: /llvm-project/lldb/source/Commands/CommandObjectBreakpointCommand.cpp (revision acdda1344a0e1b45bd3ba7feb0e8cd398bee0179)
1 //===-- CommandObjectBreakpointCommand.cpp ----------------------*- C++ -*-===//
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 > print "Hit this breakpoint!"
145 > DONE
146 
147 As a convenience, this also works for a short Python one-liner:
148 
149 (lldb) breakpoint command add -s python 1 -o 'import time; print time.asctime()'
150 (lldb) run
151 Launching '.../a.out'  (x86_64)
152 (lldb) Fri Sep 10 12:17:45 2010
153 Process 21778 Stopped
154 * thread #1: tid = 0x2e03, 0x0000000100000de8 a.out`c + 7 at main.c:39, stop reason = breakpoint 1.1, queue = com.apple.main-thread
155   36
156   37   	int c(int val)
157   38   	{
158   39 ->	    return val + 3;
159   40   	}
160   41
161   42   	int main (int argc, char const *argv[])
162 
163 Example multiple line Python breakpoint command:
164 
165 (lldb) breakpoint command add -s p 1
166 Enter your Python command(s). Type 'DONE' to end.
167 > global bp_count
168 > bp_count = bp_count + 1
169 > print "Hit this breakpoint " + repr(bp_count) + " times!"
170 > DONE
171 
172 Example multiple line Python breakpoint command, using function definition:
173 
174 (lldb) breakpoint command add -s python 1
175 Enter your Python command(s). Type 'DONE' to end.
176 > def breakpoint_output (bp_no):
177 >     out_string = "Hit breakpoint number " + repr (bp_no)
178 >     print out_string
179 >     return True
180 > breakpoint_output (1)
181 > DONE
182 
183 )"
184         "In this case, since there is a reference to a global variable, \
185 'bp_count', you will also need to make sure 'bp_count' exists and is \
186 initialized:"
187         R"(
188 
189 (lldb) script
190 >>> bp_count = 0
191 >>> quit()
192 
193 )"
194         "Your Python code, however organized, can optionally return a value.  \
195 If the returned value is False, that tells LLDB not to stop at the breakpoint \
196 to which the code is associated. Returning anything other than False, or even \
197 returning None, or even omitting a return statement entirely, will cause \
198 LLDB to stop."
199         R"(
200 
201 )"
202         "Final Note: A warning that no breakpoint command was generated when there \
203 are no syntax errors may indicate that a function was declared but never called.");
204 
205     m_all_options.Append(&m_options);
206     m_all_options.Append(&m_func_options, LLDB_OPT_SET_2 | LLDB_OPT_SET_3,
207                          LLDB_OPT_SET_2);
208     m_all_options.Finalize();
209 
210     CommandArgumentEntry arg;
211     CommandArgumentData bp_id_arg;
212 
213     // Define the first (and only) variant of this arg.
214     bp_id_arg.arg_type = eArgTypeBreakpointID;
215     bp_id_arg.arg_repetition = eArgRepeatOptional;
216 
217     // There is only one variant this argument could be; put it into the
218     // argument entry.
219     arg.push_back(bp_id_arg);
220 
221     // Push the data for the first argument into the m_arguments vector.
222     m_arguments.push_back(arg);
223   }
224 
225   ~CommandObjectBreakpointCommandAdd() override = default;
226 
227   Options *GetOptions() override { return &m_all_options; }
228 
229   void IOHandlerActivated(IOHandler &io_handler, bool interactive) override {
230     StreamFileSP output_sp(io_handler.GetOutputStreamFileSP());
231     if (output_sp && interactive) {
232       output_sp->PutCString(g_reader_instructions);
233       output_sp->Flush();
234     }
235   }
236 
237   void IOHandlerInputComplete(IOHandler &io_handler,
238                               std::string &line) override {
239     io_handler.SetIsDone(true);
240 
241     std::vector<BreakpointOptions *> *bp_options_vec =
242         (std::vector<BreakpointOptions *> *)io_handler.GetUserData();
243     for (BreakpointOptions *bp_options : *bp_options_vec) {
244       if (!bp_options)
245         continue;
246 
247       auto cmd_data = std::make_unique<BreakpointOptions::CommandData>();
248       cmd_data->user_source.SplitIntoLines(line.c_str(), line.size());
249       bp_options->SetCommandDataCallback(cmd_data);
250     }
251   }
252 
253   void CollectDataForBreakpointCommandCallback(
254       std::vector<BreakpointOptions *> &bp_options_vec,
255       CommandReturnObject &result) {
256     m_interpreter.GetLLDBCommandsFromIOHandler(
257         "> ",             // Prompt
258         *this,            // IOHandlerDelegate
259         true,             // Run IOHandler in async mode
260         &bp_options_vec); // Baton for the "io_handler" that will be passed back
261                           // into our IOHandlerDelegate functions
262   }
263 
264   /// Set a one-liner as the callback for the breakpoint.
265   void
266   SetBreakpointCommandCallback(std::vector<BreakpointOptions *> &bp_options_vec,
267                                const char *oneliner) {
268     for (auto bp_options : bp_options_vec) {
269       auto cmd_data = std::make_unique<BreakpointOptions::CommandData>();
270 
271       cmd_data->user_source.AppendString(oneliner);
272       cmd_data->stop_on_error = m_options.m_stop_on_error;
273 
274       bp_options->SetCommandDataCallback(cmd_data);
275     }
276   }
277 
278   class CommandOptions : public OptionGroup {
279   public:
280     CommandOptions()
281         : OptionGroup(), m_use_commands(false), m_use_script_language(false),
282           m_script_language(eScriptLanguageNone), m_use_one_liner(false),
283           m_one_liner() {}
284 
285     ~CommandOptions() override = default;
286 
287     Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg,
288                           ExecutionContext *execution_context) override {
289       Status error;
290       const int short_option =
291           g_breakpoint_command_add_options[option_idx].short_option;
292 
293       switch (short_option) {
294       case 'o':
295         m_use_one_liner = true;
296         m_one_liner = option_arg;
297         break;
298 
299       case 's':
300         m_script_language = (lldb::ScriptLanguage)OptionArgParser::ToOptionEnum(
301             option_arg,
302             g_breakpoint_command_add_options[option_idx].enum_values,
303             eScriptLanguageNone, error);
304         switch (m_script_language) {
305         case eScriptLanguagePython:
306         case eScriptLanguageLua:
307           m_use_script_language = true;
308           break;
309         case eScriptLanguageNone:
310         case eScriptLanguageUnknown:
311           m_use_script_language = false;
312           break;
313         }
314         break;
315 
316       case 'e': {
317         bool success = false;
318         m_stop_on_error =
319             OptionArgParser::ToBoolean(option_arg, false, &success);
320         if (!success)
321           error.SetErrorStringWithFormat(
322               "invalid value for stop-on-error: \"%s\"",
323               option_arg.str().c_str());
324       } break;
325 
326       case 'D':
327         m_use_dummy = true;
328         break;
329 
330       default:
331         llvm_unreachable("Unimplemented option");
332       }
333       return error;
334     }
335 
336     void OptionParsingStarting(ExecutionContext *execution_context) override {
337       m_use_commands = true;
338       m_use_script_language = false;
339       m_script_language = eScriptLanguageNone;
340 
341       m_use_one_liner = false;
342       m_stop_on_error = true;
343       m_one_liner.clear();
344       m_use_dummy = false;
345     }
346 
347     llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
348       return llvm::makeArrayRef(g_breakpoint_command_add_options);
349     }
350 
351     // Instance variables to hold the values for command options.
352 
353     bool m_use_commands;
354     bool m_use_script_language;
355     lldb::ScriptLanguage m_script_language;
356 
357     // Instance variables to hold the values for one_liner options.
358     bool m_use_one_liner;
359     std::string m_one_liner;
360     bool m_stop_on_error;
361     bool m_use_dummy;
362   };
363 
364 protected:
365   bool DoExecute(Args &command, CommandReturnObject &result) override {
366     Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy);
367 
368     const BreakpointList &breakpoints = target.GetBreakpointList();
369     size_t num_breakpoints = breakpoints.GetSize();
370 
371     if (num_breakpoints == 0) {
372       result.AppendError("No breakpoints exist to have commands added");
373       result.SetStatus(eReturnStatusFailed);
374       return false;
375     }
376 
377     if (!m_func_options.GetName().empty()) {
378       m_options.m_use_one_liner = false;
379       if (!m_options.m_use_script_language) {
380         m_options.m_script_language = GetDebugger().GetScriptLanguage();
381         m_options.m_use_script_language = true;
382       }
383     }
384 
385     BreakpointIDList valid_bp_ids;
386     CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs(
387         command, &target, result, &valid_bp_ids,
388         BreakpointName::Permissions::PermissionKinds::listPerm);
389 
390     m_bp_options_vec.clear();
391 
392     if (result.Succeeded()) {
393       const size_t count = valid_bp_ids.GetSize();
394 
395       for (size_t i = 0; i < count; ++i) {
396         BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i);
397         if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) {
398           Breakpoint *bp =
399               target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get();
400           BreakpointOptions *bp_options = nullptr;
401           if (cur_bp_id.GetLocationID() == LLDB_INVALID_BREAK_ID) {
402             // This breakpoint does not have an associated location.
403             bp_options = 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               bp_options = bp_loc_sp->GetLocationOptions();
411           }
412           if (bp_options)
413             m_bp_options_vec.push_back(bp_options);
414         }
415       }
416 
417       // If we are using script language, get the script interpreter in order
418       // to set or collect command callback.  Otherwise, call the methods
419       // associated with this object.
420       if (m_options.m_use_script_language) {
421         ScriptInterpreter *script_interp = GetDebugger().GetScriptInterpreter(
422             /*can_create=*/true, m_options.m_script_language);
423         // Special handling for one-liner specified inline.
424         if (m_options.m_use_one_liner) {
425           script_interp->SetBreakpointCommandCallback(
426               m_bp_options_vec, m_options.m_one_liner.c_str());
427         } else if (!m_func_options.GetName().empty()) {
428           Status error = script_interp->SetBreakpointCommandCallbackFunction(
429               m_bp_options_vec, m_func_options.GetName().c_str(),
430               m_func_options.GetStructuredData());
431           if (!error.Success())
432             result.SetError(error);
433         } else {
434           script_interp->CollectDataForBreakpointCommandCallback(
435               m_bp_options_vec, result);
436         }
437       } else {
438         // Special handling for one-liner specified inline.
439         if (m_options.m_use_one_liner)
440           SetBreakpointCommandCallback(m_bp_options_vec,
441                                        m_options.m_one_liner.c_str());
442         else
443           CollectDataForBreakpointCommandCallback(m_bp_options_vec, result);
444       }
445     }
446 
447     return result.Succeeded();
448   }
449 
450 private:
451   CommandOptions m_options;
452   OptionGroupPythonClassWithDict m_func_options;
453   OptionGroupOptions m_all_options;
454 
455   std::vector<BreakpointOptions *> 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(), m_use_dummy(false) {}
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;
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