180814287SRaphael Isemann //===-- CommandObjectBreakpointCommand.cpp --------------------------------===// 230fdc8d8SChris Lattner // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 630fdc8d8SChris Lattner // 730fdc8d8SChris Lattner //===----------------------------------------------------------------------===// 830fdc8d8SChris Lattner 930fdc8d8SChris Lattner #include "CommandObjectBreakpointCommand.h" 1030fdc8d8SChris Lattner #include "CommandObjectBreakpoint.h" 11b9c1b51eSKate Stone #include "lldb/Breakpoint/Breakpoint.h" 12b9c1b51eSKate Stone #include "lldb/Breakpoint/BreakpointIDList.h" 13b9c1b51eSKate Stone #include "lldb/Breakpoint/BreakpointLocation.h" 1444d93782SGreg Clayton #include "lldb/Core/IOHandler.h" 153eb2b44dSZachary Turner #include "lldb/Host/OptionParser.h" 1630fdc8d8SChris Lattner #include "lldb/Interpreter/CommandInterpreter.h" 1730fdc8d8SChris Lattner #include "lldb/Interpreter/CommandReturnObject.h" 1847cbf4a0SPavel Labath #include "lldb/Interpreter/OptionArgParser.h" 19738af7a6SJim Ingham #include "lldb/Interpreter/OptionGroupPythonClassWithDict.h" 2030fdc8d8SChris Lattner #include "lldb/Target/Target.h" 2130fdc8d8SChris Lattner 2230fdc8d8SChris Lattner using namespace lldb; 2330fdc8d8SChris Lattner using namespace lldb_private; 2430fdc8d8SChris Lattner 251f0f5b5bSZachary Turner // FIXME: "script-type" needs to have its contents determined dynamically, so 26e063ecccSJonas Devlieghere // somebody can add a new scripting language to lldb and have it pickable here 27e063ecccSJonas Devlieghere // without having to change this enumeration by hand and rebuild lldb proper. 288fe53c49STatyana Krasnukha static constexpr OptionEnumValueElement g_script_option_enumeration[] = { 29e063ecccSJonas Devlieghere { 30e063ecccSJonas Devlieghere eScriptLanguageNone, 31e063ecccSJonas Devlieghere "command", 32e063ecccSJonas Devlieghere "Commands are in the lldb command interpreter language", 33e063ecccSJonas Devlieghere }, 34e063ecccSJonas Devlieghere { 35e063ecccSJonas Devlieghere eScriptLanguagePython, 36e063ecccSJonas Devlieghere "python", 37e063ecccSJonas Devlieghere "Commands are in the Python language.", 38e063ecccSJonas Devlieghere }, 39e063ecccSJonas Devlieghere { 408983d691SJonas Devlieghere eScriptLanguageLua, 418983d691SJonas Devlieghere "lua", 428983d691SJonas Devlieghere "Commands are in the Lua language.", 438983d691SJonas Devlieghere }, 448983d691SJonas Devlieghere { 458983d691SJonas Devlieghere eScriptLanguageDefault, 46e063ecccSJonas Devlieghere "default-script", 47e063ecccSJonas Devlieghere "Commands are in the default scripting language.", 48e063ecccSJonas Devlieghere }, 49e063ecccSJonas Devlieghere }; 501f0f5b5bSZachary Turner 518fe53c49STatyana Krasnukha static constexpr OptionEnumValues ScriptOptionEnum() { 528fe53c49STatyana Krasnukha return OptionEnumValues(g_script_option_enumeration); 538fe53c49STatyana Krasnukha } 548fe53c49STatyana Krasnukha 55f94668e3SRaphael Isemann #define LLDB_OPTIONS_breakpoint_command_add 56f94668e3SRaphael Isemann #include "CommandOptions.inc" 571f0f5b5bSZachary Turner 58b9c1b51eSKate Stone class CommandObjectBreakpointCommandAdd : public CommandObjectParsed, 59b9c1b51eSKate Stone public IOHandlerDelegateMultiline { 605a988416SJim Ingham public: 617428a18cSKate Stone CommandObjectBreakpointCommandAdd(CommandInterpreter &interpreter) 627428a18cSKate Stone : CommandObjectParsed(interpreter, "add", 63b9c1b51eSKate Stone "Add LLDB commands to a breakpoint, to be executed " 64b9c1b51eSKate Stone "whenever the breakpoint is hit." 65b9c1b51eSKate Stone " If no breakpoint is specified, adds the " 66b9c1b51eSKate Stone "commands to the last created breakpoint.", 67c8ecc2a9SEugene Zelenko nullptr), 68b9c1b51eSKate Stone IOHandlerDelegateMultiline("DONE", 69b9c1b51eSKate Stone IOHandlerDelegate::Completion::LLDBCommand), 70738af7a6SJim Ingham m_options(), m_func_options("breakpoint command", false, 'F') { 7130fdc8d8SChris Lattner SetHelpLong( 72ea671fbdSKate Stone R"( 73ea671fbdSKate Stone General information about entering breakpoint commands 74ea671fbdSKate Stone ------------------------------------------------------ 75ea671fbdSKate Stone 76b9c1b51eSKate Stone )" 77b9c1b51eSKate Stone "This command will prompt for commands to be executed when the specified \ 78ea671fbdSKate Stone breakpoint is hit. Each command is typed on its own line following the '> ' \ 79b9c1b51eSKate Stone prompt until 'DONE' is entered." 80b9c1b51eSKate Stone R"( 81ea671fbdSKate Stone 82b9c1b51eSKate Stone )" 83b9c1b51eSKate Stone "Syntactic errors may not be detected when initially entered, and many \ 84ea671fbdSKate Stone malformed commands can silently fail when executed. If your breakpoint commands \ 85b9c1b51eSKate Stone do not appear to be executing, double-check the command syntax." 86b9c1b51eSKate Stone R"( 87ea671fbdSKate Stone 88b9c1b51eSKate Stone )" 89b9c1b51eSKate Stone "Note: You may enter any debugger command exactly as you would at the debugger \ 90ea671fbdSKate Stone prompt. There is no limit to the number of commands supplied, but do NOT enter \ 91b9c1b51eSKate Stone more than one command per line." 92b9c1b51eSKate Stone R"( 93ea671fbdSKate Stone 94ea671fbdSKate Stone Special information about PYTHON breakpoint commands 95ea671fbdSKate Stone ---------------------------------------------------- 96ea671fbdSKate Stone 97b9c1b51eSKate Stone )" 98b9c1b51eSKate Stone "You may enter either one or more lines of Python, including function \ 99ea671fbdSKate Stone definitions or calls to functions that will have been imported by the time \ 100ea671fbdSKate Stone the code executes. Single line breakpoint commands will be interpreted 'as is' \ 101ea671fbdSKate Stone when the breakpoint is hit. Multiple lines of Python will be wrapped in a \ 102b9c1b51eSKate Stone generated function, and a call to the function will be attached to the breakpoint." 103b9c1b51eSKate Stone R"( 104ea671fbdSKate Stone 105ea671fbdSKate Stone This auto-generated function is passed in three arguments: 106ea671fbdSKate Stone 107ea671fbdSKate Stone frame: an lldb.SBFrame object for the frame which hit breakpoint. 108ea671fbdSKate Stone 109ea671fbdSKate Stone bp_loc: an lldb.SBBreakpointLocation object that represents the breakpoint location that was hit. 110ea671fbdSKate Stone 111ea671fbdSKate Stone dict: the python session dictionary hit. 112ea671fbdSKate Stone 113b9c1b51eSKate Stone )" 114b9c1b51eSKate Stone "When specifying a python function with the --python-function option, you need \ 115b9c1b51eSKate Stone to supply the function name prepended by the module name:" 116b9c1b51eSKate Stone R"( 117ea671fbdSKate Stone 118ea671fbdSKate Stone --python-function myutils.breakpoint_callback 119ea671fbdSKate Stone 120365b186cSJim Ingham The function itself must have either of the following prototypes: 121ea671fbdSKate Stone 122*483ec136SJim Ingham def breakpoint_callback(frame, bp_loc, internal_dict): 123ea671fbdSKate Stone # Your code goes here 124ea671fbdSKate Stone 125365b186cSJim Ingham or: 126365b186cSJim Ingham 127*483ec136SJim Ingham def breakpoint_callback(frame, bp_loc, extra_args, internal_dict): 128365b186cSJim Ingham # Your code goes here 129365b186cSJim Ingham 130b9c1b51eSKate Stone )" 131b9c1b51eSKate Stone "The arguments are the same as the arguments passed to generated functions as \ 132365b186cSJim Ingham described above. In the second form, any -k and -v pairs provided to the command will \ 133365b186cSJim Ingham be packaged into a SBDictionary in an SBStructuredData and passed as the extra_args parameter. \ 134365b186cSJim Ingham \n\n\ 135365b186cSJim Ingham Note that the global variable 'lldb.frame' will NOT be updated when \ 136ea671fbdSKate Stone this function is called, so be sure to use the 'frame' argument. The 'frame' argument \ 137ea671fbdSKate Stone can get you to the thread via frame.GetThread(), the thread can get you to the \ 138ea671fbdSKate Stone process via thread.GetProcess(), and the process can get you back to the target \ 139b9c1b51eSKate Stone via process.GetTarget()." 140b9c1b51eSKate Stone R"( 141ea671fbdSKate Stone 142b9c1b51eSKate Stone )" 143b9c1b51eSKate Stone "Important Note: As Python code gets collected into functions, access to global \ 144ea671fbdSKate Stone variables requires explicit scoping using the 'global' keyword. Be sure to use correct \ 145b9c1b51eSKate Stone Python syntax, including indentation, when entering Python breakpoint commands." 146b9c1b51eSKate Stone R"( 147ea671fbdSKate Stone 148ea671fbdSKate Stone Example Python one-line breakpoint command: 149ea671fbdSKate Stone 150ea671fbdSKate Stone (lldb) breakpoint command add -s python 1 151ea671fbdSKate Stone Enter your Python command(s). Type 'DONE' to end. 1523b3b9ba1SDave Lee def function (frame, bp_loc, internal_dict): 1533b3b9ba1SDave Lee """frame: the lldb.SBFrame for the location at which you stopped 1543b3b9ba1SDave Lee bp_loc: an lldb.SBBreakpointLocation for the breakpoint location information 1553b3b9ba1SDave Lee internal_dict: an LLDB support object not to be used""" 1563b3b9ba1SDave Lee print("Hit this breakpoint!") 1573b3b9ba1SDave Lee DONE 158ea671fbdSKate Stone 159ea671fbdSKate Stone As a convenience, this also works for a short Python one-liner: 160ea671fbdSKate Stone 1613b3b9ba1SDave Lee (lldb) breakpoint command add -s python 1 -o 'import time; print(time.asctime())' 162ea671fbdSKate Stone (lldb) run 163ea671fbdSKate Stone Launching '.../a.out' (x86_64) 164ea671fbdSKate Stone (lldb) Fri Sep 10 12:17:45 2010 165ea671fbdSKate Stone Process 21778 Stopped 166ea671fbdSKate Stone * thread #1: tid = 0x2e03, 0x0000000100000de8 a.out`c + 7 at main.c:39, stop reason = breakpoint 1.1, queue = com.apple.main-thread 167ea671fbdSKate Stone 36 168ea671fbdSKate Stone 37 int c(int val) 169ea671fbdSKate Stone 38 { 170ea671fbdSKate Stone 39 -> return val + 3; 171ea671fbdSKate Stone 40 } 172ea671fbdSKate Stone 41 173ea671fbdSKate Stone 42 int main (int argc, char const *argv[]) 174ea671fbdSKate Stone 175ea671fbdSKate Stone Example multiple line Python breakpoint command: 176ea671fbdSKate Stone 177ea671fbdSKate Stone (lldb) breakpoint command add -s p 1 178ea671fbdSKate Stone Enter your Python command(s). Type 'DONE' to end. 1793b3b9ba1SDave Lee def function (frame, bp_loc, internal_dict): 1803b3b9ba1SDave Lee """frame: the lldb.SBFrame for the location at which you stopped 1813b3b9ba1SDave Lee bp_loc: an lldb.SBBreakpointLocation for the breakpoint location information 1823b3b9ba1SDave Lee internal_dict: an LLDB support object not to be used""" 1833b3b9ba1SDave Lee global bp_count 1843b3b9ba1SDave Lee bp_count = bp_count + 1 1853b3b9ba1SDave Lee print("Hit this breakpoint " + repr(bp_count) + " times!") 1863b3b9ba1SDave Lee DONE 187ea671fbdSKate Stone 188b9c1b51eSKate Stone )" 189b9c1b51eSKate Stone "In this case, since there is a reference to a global variable, \ 190ea671fbdSKate Stone 'bp_count', you will also need to make sure 'bp_count' exists and is \ 191b9c1b51eSKate Stone initialized:" 192b9c1b51eSKate Stone R"( 193ea671fbdSKate Stone 194ea671fbdSKate Stone (lldb) script 195ea671fbdSKate Stone >>> bp_count = 0 196ea671fbdSKate Stone >>> quit() 197ea671fbdSKate Stone 198b9c1b51eSKate Stone )" 199b9c1b51eSKate Stone "Your Python code, however organized, can optionally return a value. \ 200ea671fbdSKate Stone If the returned value is False, that tells LLDB not to stop at the breakpoint \ 201ea671fbdSKate Stone to which the code is associated. Returning anything other than False, or even \ 202ea671fbdSKate Stone returning None, or even omitting a return statement entirely, will cause \ 203b9c1b51eSKate Stone LLDB to stop." 204b9c1b51eSKate Stone R"( 205ea671fbdSKate Stone 206b9c1b51eSKate Stone )" 207b9c1b51eSKate Stone "Final Note: A warning that no breakpoint command was generated when there \ 208b9c1b51eSKate Stone are no syntax errors may indicate that a function was declared but never called."); 209405fe67fSCaroline Tice 210738af7a6SJim Ingham m_all_options.Append(&m_options); 211738af7a6SJim Ingham m_all_options.Append(&m_func_options, LLDB_OPT_SET_2 | LLDB_OPT_SET_3, 212738af7a6SJim Ingham LLDB_OPT_SET_2); 213738af7a6SJim Ingham m_all_options.Finalize(); 214738af7a6SJim Ingham 215405fe67fSCaroline Tice CommandArgumentEntry arg; 216405fe67fSCaroline Tice CommandArgumentData bp_id_arg; 217405fe67fSCaroline Tice 218405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 219405fe67fSCaroline Tice bp_id_arg.arg_type = eArgTypeBreakpointID; 2201bb0750bSJim Ingham bp_id_arg.arg_repetition = eArgRepeatOptional; 221405fe67fSCaroline Tice 222b9c1b51eSKate Stone // There is only one variant this argument could be; put it into the 223b9c1b51eSKate Stone // argument entry. 224405fe67fSCaroline Tice arg.push_back(bp_id_arg); 225405fe67fSCaroline Tice 226405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 227405fe67fSCaroline Tice m_arguments.push_back(arg); 22830fdc8d8SChris Lattner } 22930fdc8d8SChris Lattner 230c8ecc2a9SEugene Zelenko ~CommandObjectBreakpointCommandAdd() override = default; 2315a988416SJim Ingham 232738af7a6SJim Ingham Options *GetOptions() override { return &m_all_options; } 2335a988416SJim Ingham 2340affb582SDave Lee void IOHandlerActivated(IOHandler &io_handler, bool interactive) override { 2357ca15ba7SLawrence D'Anna StreamFileSP output_sp(io_handler.GetOutputStreamFileSP()); 2360affb582SDave Lee if (output_sp && interactive) { 23744d93782SGreg Clayton output_sp->PutCString(g_reader_instructions); 23844d93782SGreg Clayton output_sp->Flush(); 23944d93782SGreg Clayton } 24044d93782SGreg Clayton } 24144d93782SGreg Clayton 242b9c1b51eSKate Stone void IOHandlerInputComplete(IOHandler &io_handler, 243b9c1b51eSKate Stone std::string &line) override { 24444d93782SGreg Clayton io_handler.SetIsDone(true); 24544d93782SGreg Clayton 246b9c1b51eSKate Stone std::vector<BreakpointOptions *> *bp_options_vec = 247b9c1b51eSKate Stone (std::vector<BreakpointOptions *> *)io_handler.GetUserData(); 248b9c1b51eSKate Stone for (BreakpointOptions *bp_options : *bp_options_vec) { 249b5796cb4SJim Ingham if (!bp_options) 250b5796cb4SJim Ingham continue; 251b5796cb4SJim Ingham 252a8f3ae7cSJonas Devlieghere auto cmd_data = std::make_unique<BreakpointOptions::CommandData>(); 253e14dc268SJim Ingham cmd_data->user_source.SplitIntoLines(line.c_str(), line.size()); 25492d1960eSJim Ingham bp_options->SetCommandDataCallback(cmd_data); 25544d93782SGreg Clayton } 25644d93782SGreg Clayton } 25744d93782SGreg Clayton 258b9c1b51eSKate Stone void CollectDataForBreakpointCommandCallback( 259b9c1b51eSKate Stone std::vector<BreakpointOptions *> &bp_options_vec, 260b9c1b51eSKate Stone CommandReturnObject &result) { 261b9c1b51eSKate Stone m_interpreter.GetLLDBCommandsFromIOHandler( 262b9c1b51eSKate Stone "> ", // Prompt 26344d93782SGreg Clayton *this, // IOHandlerDelegate 264b9c1b51eSKate Stone &bp_options_vec); // Baton for the "io_handler" that will be passed back 265b9c1b51eSKate Stone // into our IOHandlerDelegate functions 2665a988416SJim Ingham } 2675a988416SJim Ingham 2685a988416SJim Ingham /// Set a one-liner as the callback for the breakpoint. 2695a988416SJim Ingham void 270b5796cb4SJim Ingham SetBreakpointCommandCallback(std::vector<BreakpointOptions *> &bp_options_vec, 271b9c1b51eSKate Stone const char *oneliner) { 272b9c1b51eSKate Stone for (auto bp_options : bp_options_vec) { 273a8f3ae7cSJonas Devlieghere auto cmd_data = std::make_unique<BreakpointOptions::CommandData>(); 2745a988416SJim Ingham 275e14dc268SJim Ingham cmd_data->user_source.AppendString(oneliner); 276e14dc268SJim Ingham cmd_data->stop_on_error = m_options.m_stop_on_error; 2775a988416SJim Ingham 27892d1960eSJim Ingham bp_options->SetCommandDataCallback(cmd_data); 279b5796cb4SJim Ingham } 2805a988416SJim Ingham } 2815a988416SJim Ingham 282738af7a6SJim Ingham class CommandOptions : public OptionGroup { 2835a988416SJim Ingham public: 284b9c1b51eSKate Stone CommandOptions() 285738af7a6SJim Ingham : OptionGroup(), m_use_commands(false), m_use_script_language(false), 286b9c1b51eSKate Stone m_script_language(eScriptLanguageNone), m_use_one_liner(false), 287738af7a6SJim Ingham m_one_liner() {} 28830fdc8d8SChris Lattner 289c8ecc2a9SEugene Zelenko ~CommandOptions() override = default; 2905a988416SJim Ingham 29197206d57SZachary Turner Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 292b9c1b51eSKate Stone ExecutionContext *execution_context) override { 29397206d57SZachary Turner Status error; 294a925974bSAdrian Prantl const int short_option = 295a925974bSAdrian Prantl g_breakpoint_command_add_options[option_idx].short_option; 2965a988416SJim Ingham 297b9c1b51eSKate Stone switch (short_option) { 2985a988416SJim Ingham case 'o': 2995a988416SJim Ingham m_use_one_liner = true; 300adcd0268SBenjamin Kramer m_one_liner = std::string(option_arg); 3015a988416SJim Ingham break; 3025a988416SJim Ingham 3035a988416SJim Ingham case 's': 30447cbf4a0SPavel Labath m_script_language = (lldb::ScriptLanguage)OptionArgParser::ToOptionEnum( 305bd68a052SRaphael Isemann option_arg, 306bd68a052SRaphael Isemann g_breakpoint_command_add_options[option_idx].enum_values, 307b9c1b51eSKate Stone eScriptLanguageNone, error); 3088983d691SJonas Devlieghere switch (m_script_language) { 3098983d691SJonas Devlieghere case eScriptLanguagePython: 3108983d691SJonas Devlieghere case eScriptLanguageLua: 3115a988416SJim Ingham m_use_script_language = true; 3128983d691SJonas Devlieghere break; 3138983d691SJonas Devlieghere case eScriptLanguageNone: 314acdda134SJonas Devlieghere case eScriptLanguageUnknown: 3155a988416SJim Ingham m_use_script_language = false; 3168983d691SJonas Devlieghere break; 3175a988416SJim Ingham } 3185a988416SJim Ingham break; 3195a988416SJim Ingham 320b9c1b51eSKate Stone case 'e': { 3215a988416SJim Ingham bool success = false; 32247cbf4a0SPavel Labath m_stop_on_error = 32347cbf4a0SPavel Labath OptionArgParser::ToBoolean(option_arg, false, &success); 3245a988416SJim Ingham if (!success) 325b9c1b51eSKate Stone error.SetErrorStringWithFormat( 326fe11483bSZachary Turner "invalid value for stop-on-error: \"%s\"", 327fe11483bSZachary Turner option_arg.str().c_str()); 328b9c1b51eSKate Stone } break; 3295a988416SJim Ingham 33033df7cd3SJim Ingham case 'D': 33133df7cd3SJim Ingham m_use_dummy = true; 33233df7cd3SJim Ingham break; 33333df7cd3SJim Ingham 3345a988416SJim Ingham default: 33536162014SRaphael Isemann llvm_unreachable("Unimplemented option"); 3365a988416SJim Ingham } 3375a988416SJim Ingham return error; 3385a988416SJim Ingham } 339c8ecc2a9SEugene Zelenko 340b9c1b51eSKate Stone void OptionParsingStarting(ExecutionContext *execution_context) override { 3415a988416SJim Ingham m_use_commands = true; 3425a988416SJim Ingham m_use_script_language = false; 3435a988416SJim Ingham m_script_language = eScriptLanguageNone; 3445a988416SJim Ingham 3455a988416SJim Ingham m_use_one_liner = false; 3465a988416SJim Ingham m_stop_on_error = true; 3475a988416SJim Ingham m_one_liner.clear(); 34833df7cd3SJim Ingham m_use_dummy = false; 3495a988416SJim Ingham } 3505a988416SJim Ingham 3511f0f5b5bSZachary Turner llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 352bd68a052SRaphael Isemann return llvm::makeArrayRef(g_breakpoint_command_add_options); 3531f0f5b5bSZachary Turner } 3545a988416SJim Ingham 3555a988416SJim Ingham // Instance variables to hold the values for command options. 3565a988416SJim Ingham 3575a988416SJim Ingham bool m_use_commands; 3585a988416SJim Ingham bool m_use_script_language; 3595a988416SJim Ingham lldb::ScriptLanguage m_script_language; 3605a988416SJim Ingham 3615a988416SJim Ingham // Instance variables to hold the values for one_liner options. 3625a988416SJim Ingham bool m_use_one_liner; 3635a988416SJim Ingham std::string m_one_liner; 3645a988416SJim Ingham bool m_stop_on_error; 36533df7cd3SJim Ingham bool m_use_dummy; 3665a988416SJim Ingham }; 3675a988416SJim Ingham 3685a988416SJim Ingham protected: 369b9c1b51eSKate Stone bool DoExecute(Args &command, CommandReturnObject &result) override { 370cb2380c9SRaphael Isemann Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 37130fdc8d8SChris Lattner 372cb2380c9SRaphael Isemann const BreakpointList &breakpoints = target.GetBreakpointList(); 37330fdc8d8SChris Lattner size_t num_breakpoints = breakpoints.GetSize(); 37430fdc8d8SChris Lattner 375b9c1b51eSKate Stone if (num_breakpoints == 0) { 37630fdc8d8SChris Lattner result.AppendError("No breakpoints exist to have commands added"); 37730fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 37830fdc8d8SChris Lattner return false; 37930fdc8d8SChris Lattner } 38030fdc8d8SChris Lattner 381738af7a6SJim Ingham if (!m_func_options.GetName().empty()) { 382738af7a6SJim Ingham m_options.m_use_one_liner = false; 3831ff01cfeSJonas Devlieghere if (!m_options.m_use_script_language) { 3841ff01cfeSJonas Devlieghere m_options.m_script_language = GetDebugger().GetScriptLanguage(); 385738af7a6SJim Ingham m_options.m_use_script_language = true; 3868d4a8010SEnrico Granata } 3871ff01cfeSJonas Devlieghere } 3888d4a8010SEnrico Granata 38930fdc8d8SChris Lattner BreakpointIDList valid_bp_ids; 390b9c1b51eSKate Stone CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 391cb2380c9SRaphael Isemann command, &target, result, &valid_bp_ids, 392b842f2ecSJim Ingham BreakpointName::Permissions::PermissionKinds::listPerm); 39330fdc8d8SChris Lattner 394b5796cb4SJim Ingham m_bp_options_vec.clear(); 395b5796cb4SJim Ingham 396b9c1b51eSKate Stone if (result.Succeeded()) { 397c982c768SGreg Clayton const size_t count = valid_bp_ids.GetSize(); 398d9916eaeSJim Ingham 399b9c1b51eSKate Stone for (size_t i = 0; i < count; ++i) { 40030fdc8d8SChris Lattner BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 401b9c1b51eSKate Stone if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 402b9c1b51eSKate Stone Breakpoint *bp = 403cb2380c9SRaphael Isemann target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 404c8ecc2a9SEugene Zelenko BreakpointOptions *bp_options = nullptr; 405b9c1b51eSKate Stone if (cur_bp_id.GetLocationID() == LLDB_INVALID_BREAK_ID) { 40639d7d4f0SJohnny Chen // This breakpoint does not have an associated location. 40739d7d4f0SJohnny Chen bp_options = bp->GetOptions(); 408b9c1b51eSKate Stone } else { 409b9c1b51eSKate Stone BreakpointLocationSP bp_loc_sp( 410b9c1b51eSKate Stone bp->FindLocationByID(cur_bp_id.GetLocationID())); 41105097246SAdrian Prantl // This breakpoint does have an associated location. Get its 41205097246SAdrian Prantl // breakpoint options. 41330fdc8d8SChris Lattner if (bp_loc_sp) 41439d7d4f0SJohnny Chen bp_options = bp_loc_sp->GetLocationOptions(); 41539d7d4f0SJohnny Chen } 416b5796cb4SJim Ingham if (bp_options) 417b5796cb4SJim Ingham m_bp_options_vec.push_back(bp_options); 418b5796cb4SJim Ingham } 419b5796cb4SJim Ingham } 42039d7d4f0SJohnny Chen 42105097246SAdrian Prantl // If we are using script language, get the script interpreter in order 42205097246SAdrian Prantl // to set or collect command callback. Otherwise, call the methods 42305097246SAdrian Prantl // associated with this object. 424b9c1b51eSKate Stone if (m_options.m_use_script_language) { 425280ae107SPedro Tammela Status error; 4265e32eb1cSJonas Devlieghere ScriptInterpreter *script_interp = GetDebugger().GetScriptInterpreter( 4275e32eb1cSJonas Devlieghere /*can_create=*/true, m_options.m_script_language); 42839d7d4f0SJohnny Chen // Special handling for one-liner specified inline. 429b9c1b51eSKate Stone if (m_options.m_use_one_liner) { 430280ae107SPedro Tammela error = script_interp->SetBreakpointCommandCallback( 431b9c1b51eSKate Stone m_bp_options_vec, m_options.m_one_liner.c_str()); 432738af7a6SJim Ingham } else if (!m_func_options.GetName().empty()) { 433280ae107SPedro Tammela error = script_interp->SetBreakpointCommandCallbackFunction( 434738af7a6SJim Ingham m_bp_options_vec, m_func_options.GetName().c_str(), 435738af7a6SJim Ingham m_func_options.GetStructuredData()); 436b9c1b51eSKate Stone } else { 437b9c1b51eSKate Stone script_interp->CollectDataForBreakpointCommandCallback( 438b9c1b51eSKate Stone m_bp_options_vec, result); 4398d4a8010SEnrico Granata } 440280ae107SPedro Tammela if (!error.Success()) 441280ae107SPedro Tammela result.SetError(error); 442b9c1b51eSKate Stone } else { 44339d7d4f0SJohnny Chen // Special handling for one-liner specified inline. 44439d7d4f0SJohnny Chen if (m_options.m_use_one_liner) 445b5796cb4SJim Ingham SetBreakpointCommandCallback(m_bp_options_vec, 44639d7d4f0SJohnny Chen m_options.m_one_liner.c_str()); 44739d7d4f0SJohnny Chen else 448b9c1b51eSKate Stone CollectDataForBreakpointCommandCallback(m_bp_options_vec, result); 44930fdc8d8SChris Lattner } 45030fdc8d8SChris Lattner } 45130fdc8d8SChris Lattner 45230fdc8d8SChris Lattner return result.Succeeded(); 45330fdc8d8SChris Lattner } 45430fdc8d8SChris Lattner 4555a988416SJim Ingham private: 4565a988416SJim Ingham CommandOptions m_options; 457738af7a6SJim Ingham OptionGroupPythonClassWithDict m_func_options; 458738af7a6SJim Ingham OptionGroupOptions m_all_options; 459738af7a6SJim Ingham 460b9c1b51eSKate Stone std::vector<BreakpointOptions *> m_bp_options_vec; // This stores the 461b9c1b51eSKate Stone // breakpoint options that 462b9c1b51eSKate Stone // we are currently 46305097246SAdrian Prantl // collecting commands for. In the CollectData... calls we need to hand this 46405097246SAdrian Prantl // off to the IOHandler, which may run asynchronously. So we have to have 46505097246SAdrian Prantl // some way to keep it alive, and not leak it. Making it an ivar of the 46605097246SAdrian Prantl // command object, which never goes away achieves this. Note that if we were 46705097246SAdrian Prantl // able to run the same command concurrently in one interpreter we'd have to 46805097246SAdrian Prantl // make this "per invocation". But there are many more reasons why it is not 46905097246SAdrian Prantl // in general safe to do that in lldb at present, so it isn't worthwhile to 47005097246SAdrian Prantl // come up with a more complex mechanism to address this particular weakness 47105097246SAdrian Prantl // right now. 4725a988416SJim Ingham static const char *g_reader_instructions; 4735a988416SJim Ingham }; 4745a988416SJim Ingham 475b9c1b51eSKate Stone const char *CommandObjectBreakpointCommandAdd::g_reader_instructions = 476b9c1b51eSKate Stone "Enter your debugger command(s). Type 'DONE' to end.\n"; 4775a988416SJim Ingham 47893e0f19fSCaroline Tice // CommandObjectBreakpointCommandDelete 47930fdc8d8SChris Lattner 480f94668e3SRaphael Isemann #define LLDB_OPTIONS_breakpoint_command_delete 481f94668e3SRaphael Isemann #include "CommandOptions.inc" 4821f0f5b5bSZachary Turner 483b9c1b51eSKate Stone class CommandObjectBreakpointCommandDelete : public CommandObjectParsed { 4845a988416SJim Ingham public: 485b9c1b51eSKate Stone CommandObjectBreakpointCommandDelete(CommandInterpreter &interpreter) 486b9c1b51eSKate Stone : CommandObjectParsed(interpreter, "delete", 48793e0f19fSCaroline Tice "Delete the set of commands from a breakpoint.", 488c8ecc2a9SEugene Zelenko nullptr), 489b9c1b51eSKate Stone m_options() { 490405fe67fSCaroline Tice CommandArgumentEntry arg; 491405fe67fSCaroline Tice CommandArgumentData bp_id_arg; 492405fe67fSCaroline Tice 493405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 494405fe67fSCaroline Tice bp_id_arg.arg_type = eArgTypeBreakpointID; 495405fe67fSCaroline Tice bp_id_arg.arg_repetition = eArgRepeatPlain; 496405fe67fSCaroline Tice 497b9c1b51eSKate Stone // There is only one variant this argument could be; put it into the 498b9c1b51eSKate Stone // argument entry. 499405fe67fSCaroline Tice arg.push_back(bp_id_arg); 500405fe67fSCaroline Tice 501405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 502405fe67fSCaroline Tice m_arguments.push_back(arg); 50330fdc8d8SChris Lattner } 50430fdc8d8SChris Lattner 505c8ecc2a9SEugene Zelenko ~CommandObjectBreakpointCommandDelete() override = default; 5065a988416SJim Ingham 507b9c1b51eSKate Stone Options *GetOptions() override { return &m_options; } 50833df7cd3SJim Ingham 509b9c1b51eSKate Stone class CommandOptions : public Options { 51033df7cd3SJim Ingham public: 511b9c1b51eSKate Stone CommandOptions() : Options(), m_use_dummy(false) {} 51233df7cd3SJim Ingham 513c8ecc2a9SEugene Zelenko ~CommandOptions() override = default; 51433df7cd3SJim Ingham 51597206d57SZachary Turner Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 516b9c1b51eSKate Stone ExecutionContext *execution_context) override { 51797206d57SZachary Turner Status error; 51833df7cd3SJim Ingham const int short_option = m_getopt_table[option_idx].val; 51933df7cd3SJim Ingham 520b9c1b51eSKate Stone switch (short_option) { 52133df7cd3SJim Ingham case 'D': 52233df7cd3SJim Ingham m_use_dummy = true; 52333df7cd3SJim Ingham break; 52433df7cd3SJim Ingham 52533df7cd3SJim Ingham default: 52636162014SRaphael Isemann llvm_unreachable("Unimplemented option"); 52733df7cd3SJim Ingham } 52833df7cd3SJim Ingham 52933df7cd3SJim Ingham return error; 53033df7cd3SJim Ingham } 53133df7cd3SJim Ingham 532b9c1b51eSKate Stone void OptionParsingStarting(ExecutionContext *execution_context) override { 53333df7cd3SJim Ingham m_use_dummy = false; 53433df7cd3SJim Ingham } 53533df7cd3SJim Ingham 5361f0f5b5bSZachary Turner llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 537bd68a052SRaphael Isemann return llvm::makeArrayRef(g_breakpoint_command_delete_options); 5381f0f5b5bSZachary Turner } 53933df7cd3SJim Ingham 54033df7cd3SJim Ingham // Instance variables to hold the values for command options. 54133df7cd3SJim Ingham bool m_use_dummy; 54233df7cd3SJim Ingham }; 54333df7cd3SJim Ingham 5445a988416SJim Ingham protected: 545b9c1b51eSKate Stone bool DoExecute(Args &command, CommandReturnObject &result) override { 546cb2380c9SRaphael Isemann Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 54730fdc8d8SChris Lattner 548cb2380c9SRaphael Isemann const BreakpointList &breakpoints = target.GetBreakpointList(); 54930fdc8d8SChris Lattner size_t num_breakpoints = breakpoints.GetSize(); 55030fdc8d8SChris Lattner 551b9c1b51eSKate Stone if (num_breakpoints == 0) { 55293e0f19fSCaroline Tice result.AppendError("No breakpoints exist to have commands deleted"); 55330fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 55430fdc8d8SChris Lattner return false; 55530fdc8d8SChris Lattner } 55630fdc8d8SChris Lattner 55711eb9c64SZachary Turner if (command.empty()) { 558b9c1b51eSKate Stone result.AppendError( 559b9c1b51eSKate Stone "No breakpoint specified from which to delete the commands"); 56030fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 56130fdc8d8SChris Lattner return false; 56230fdc8d8SChris Lattner } 56330fdc8d8SChris Lattner 56430fdc8d8SChris Lattner BreakpointIDList valid_bp_ids; 565b9c1b51eSKate Stone CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 566cb2380c9SRaphael Isemann command, &target, result, &valid_bp_ids, 567b842f2ecSJim Ingham BreakpointName::Permissions::PermissionKinds::listPerm); 56830fdc8d8SChris Lattner 569b9c1b51eSKate Stone if (result.Succeeded()) { 570c982c768SGreg Clayton const size_t count = valid_bp_ids.GetSize(); 571b9c1b51eSKate Stone for (size_t i = 0; i < count; ++i) { 57230fdc8d8SChris Lattner BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 573b9c1b51eSKate Stone if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 574b9c1b51eSKate Stone Breakpoint *bp = 575cb2380c9SRaphael Isemann target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 576b9c1b51eSKate Stone if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) { 577b9c1b51eSKate Stone BreakpointLocationSP bp_loc_sp( 578b9c1b51eSKate Stone bp->FindLocationByID(cur_bp_id.GetLocationID())); 57930fdc8d8SChris Lattner if (bp_loc_sp) 58030fdc8d8SChris Lattner bp_loc_sp->ClearCallback(); 581b9c1b51eSKate Stone else { 58230fdc8d8SChris Lattner result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 58330fdc8d8SChris Lattner cur_bp_id.GetBreakpointID(), 58430fdc8d8SChris Lattner cur_bp_id.GetLocationID()); 58530fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 58630fdc8d8SChris Lattner return false; 58730fdc8d8SChris Lattner } 588b9c1b51eSKate Stone } else { 58930fdc8d8SChris Lattner bp->ClearCallback(); 59030fdc8d8SChris Lattner } 59130fdc8d8SChris Lattner } 59230fdc8d8SChris Lattner } 59330fdc8d8SChris Lattner } 59430fdc8d8SChris Lattner return result.Succeeded(); 59530fdc8d8SChris Lattner } 596c8ecc2a9SEugene Zelenko 59733df7cd3SJim Ingham private: 59833df7cd3SJim Ingham CommandOptions m_options; 5995a988416SJim Ingham }; 60030fdc8d8SChris Lattner 60130fdc8d8SChris Lattner // CommandObjectBreakpointCommandList 60230fdc8d8SChris Lattner 603b9c1b51eSKate Stone class CommandObjectBreakpointCommandList : public CommandObjectParsed { 6045a988416SJim Ingham public: 605b9c1b51eSKate Stone CommandObjectBreakpointCommandList(CommandInterpreter &interpreter) 60604a4c091SRaphael Isemann : CommandObjectParsed(interpreter, "list", 60704a4c091SRaphael Isemann "List the script or set of commands to be " 60804a4c091SRaphael Isemann "executed when the breakpoint is hit.", 60904a4c091SRaphael Isemann nullptr, eCommandRequiresTarget) { 610405fe67fSCaroline Tice CommandArgumentEntry arg; 611405fe67fSCaroline Tice CommandArgumentData bp_id_arg; 612405fe67fSCaroline Tice 613405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 614405fe67fSCaroline Tice bp_id_arg.arg_type = eArgTypeBreakpointID; 615405fe67fSCaroline Tice bp_id_arg.arg_repetition = eArgRepeatPlain; 616405fe67fSCaroline Tice 617b9c1b51eSKate Stone // There is only one variant this argument could be; put it into the 618b9c1b51eSKate Stone // argument entry. 619405fe67fSCaroline Tice arg.push_back(bp_id_arg); 620405fe67fSCaroline Tice 621405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 622405fe67fSCaroline Tice m_arguments.push_back(arg); 62330fdc8d8SChris Lattner } 62430fdc8d8SChris Lattner 625c8ecc2a9SEugene Zelenko ~CommandObjectBreakpointCommandList() override = default; 62630fdc8d8SChris Lattner 6275a988416SJim Ingham protected: 628b9c1b51eSKate Stone bool DoExecute(Args &command, CommandReturnObject &result) override { 62904a4c091SRaphael Isemann Target *target = &GetSelectedTarget(); 63030fdc8d8SChris Lattner 63130fdc8d8SChris Lattner const BreakpointList &breakpoints = target->GetBreakpointList(); 63230fdc8d8SChris Lattner size_t num_breakpoints = breakpoints.GetSize(); 63330fdc8d8SChris Lattner 634b9c1b51eSKate Stone if (num_breakpoints == 0) { 63530fdc8d8SChris Lattner result.AppendError("No breakpoints exist for which to list commands"); 63630fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 63730fdc8d8SChris Lattner return false; 63830fdc8d8SChris Lattner } 63930fdc8d8SChris Lattner 64011eb9c64SZachary Turner if (command.empty()) { 641b9c1b51eSKate Stone result.AppendError( 642b9c1b51eSKate Stone "No breakpoint specified for which to list the commands"); 64330fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 64430fdc8d8SChris Lattner return false; 64530fdc8d8SChris Lattner } 64630fdc8d8SChris Lattner 64730fdc8d8SChris Lattner BreakpointIDList valid_bp_ids; 648b9c1b51eSKate Stone CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 649b842f2ecSJim Ingham command, target, result, &valid_bp_ids, 650b842f2ecSJim Ingham BreakpointName::Permissions::PermissionKinds::listPerm); 65130fdc8d8SChris Lattner 652b9c1b51eSKate Stone if (result.Succeeded()) { 653c982c768SGreg Clayton const size_t count = valid_bp_ids.GetSize(); 654b9c1b51eSKate Stone for (size_t i = 0; i < count; ++i) { 65530fdc8d8SChris Lattner BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 656b9c1b51eSKate Stone if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 657b9c1b51eSKate Stone Breakpoint *bp = 658b9c1b51eSKate Stone target->GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 65930fdc8d8SChris Lattner 660b9c1b51eSKate Stone if (bp) { 661af26b22cSJim Ingham BreakpointLocationSP bp_loc_sp; 662b9c1b51eSKate Stone if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) { 663af26b22cSJim Ingham bp_loc_sp = bp->FindLocationByID(cur_bp_id.GetLocationID()); 664a925974bSAdrian Prantl if (!bp_loc_sp) { 66530fdc8d8SChris Lattner result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 66630fdc8d8SChris Lattner cur_bp_id.GetBreakpointID(), 66730fdc8d8SChris Lattner cur_bp_id.GetLocationID()); 66830fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 66930fdc8d8SChris Lattner return false; 67030fdc8d8SChris Lattner } 67130fdc8d8SChris Lattner } 67230fdc8d8SChris Lattner 67330fdc8d8SChris Lattner StreamString id_str; 674e16c50a1SJim Ingham BreakpointID::GetCanonicalReference(&id_str, 675e16c50a1SJim Ingham cur_bp_id.GetBreakpointID(), 676e16c50a1SJim Ingham cur_bp_id.GetLocationID()); 677af26b22cSJim Ingham const Baton *baton = nullptr; 678af26b22cSJim Ingham if (bp_loc_sp) 679a925974bSAdrian Prantl baton = 680a925974bSAdrian Prantl bp_loc_sp 681af26b22cSJim Ingham ->GetOptionsSpecifyingKind(BreakpointOptions::eCallback) 682af26b22cSJim Ingham ->GetBaton(); 683af26b22cSJim Ingham else 684af26b22cSJim Ingham baton = bp->GetOptions()->GetBaton(); 685af26b22cSJim Ingham 686b9c1b51eSKate Stone if (baton) { 687b9c1b51eSKate Stone result.GetOutputStream().Printf("Breakpoint %s:\n", 688b9c1b51eSKate Stone id_str.GetData()); 6894f728bfcSRaphael Isemann baton->GetDescription(result.GetOutputStream().AsRawOstream(), 6904f728bfcSRaphael Isemann eDescriptionLevelFull, 6914f728bfcSRaphael Isemann result.GetOutputStream().GetIndentLevel() + 6924f728bfcSRaphael Isemann 2); 693b9c1b51eSKate Stone } else { 694b9c1b51eSKate Stone result.AppendMessageWithFormat( 695b9c1b51eSKate Stone "Breakpoint %s does not have an associated command.\n", 696e16c50a1SJim Ingham id_str.GetData()); 69730fdc8d8SChris Lattner } 69830fdc8d8SChris Lattner } 69930fdc8d8SChris Lattner result.SetStatus(eReturnStatusSuccessFinishResult); 700b9c1b51eSKate Stone } else { 701b9c1b51eSKate Stone result.AppendErrorWithFormat("Invalid breakpoint ID: %u.\n", 702b9c1b51eSKate Stone cur_bp_id.GetBreakpointID()); 70330fdc8d8SChris Lattner result.SetStatus(eReturnStatusFailed); 70430fdc8d8SChris Lattner } 70530fdc8d8SChris Lattner } 70630fdc8d8SChris Lattner } 70730fdc8d8SChris Lattner 70830fdc8d8SChris Lattner return result.Succeeded(); 70930fdc8d8SChris Lattner } 7105a988416SJim Ingham }; 71130fdc8d8SChris Lattner 71230fdc8d8SChris Lattner // CommandObjectBreakpointCommand 71330fdc8d8SChris Lattner 714b9c1b51eSKate Stone CommandObjectBreakpointCommand::CommandObjectBreakpointCommand( 715b9c1b51eSKate Stone CommandInterpreter &interpreter) 7167428a18cSKate Stone : CommandObjectMultiword( 717a925974bSAdrian Prantl interpreter, "command", 718a925974bSAdrian Prantl "Commands for adding, removing and listing " 719b9c1b51eSKate Stone "LLDB commands executed when a breakpoint is " 720b9c1b51eSKate Stone "hit.", 721b9c1b51eSKate Stone "command <sub-command> [<sub-command-options>] <breakpoint-id>") { 722b9c1b51eSKate Stone CommandObjectSP add_command_object( 723b9c1b51eSKate Stone new CommandObjectBreakpointCommandAdd(interpreter)); 724b9c1b51eSKate Stone CommandObjectSP delete_command_object( 725b9c1b51eSKate Stone new CommandObjectBreakpointCommandDelete(interpreter)); 726b9c1b51eSKate Stone CommandObjectSP list_command_object( 727b9c1b51eSKate Stone new CommandObjectBreakpointCommandList(interpreter)); 72830fdc8d8SChris Lattner 72930fdc8d8SChris Lattner add_command_object->SetCommandName("breakpoint command add"); 73093e0f19fSCaroline Tice delete_command_object->SetCommandName("breakpoint command delete"); 73130fdc8d8SChris Lattner list_command_object->SetCommandName("breakpoint command list"); 73230fdc8d8SChris Lattner 73323f59509SGreg Clayton LoadSubCommand("add", add_command_object); 73423f59509SGreg Clayton LoadSubCommand("delete", delete_command_object); 73523f59509SGreg Clayton LoadSubCommand("list", list_command_object); 73630fdc8d8SChris Lattner } 73730fdc8d8SChris Lattner 738c8ecc2a9SEugene Zelenko CommandObjectBreakpointCommand::~CommandObjectBreakpointCommand() = default; 739