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. " 6560ad0fd3SJim Ingham "The commands added to the breakpoint replace any " 6660ad0fd3SJim Ingham "commands previously added to it." 67b9c1b51eSKate Stone " If no breakpoint is specified, adds the " 68b9c1b51eSKate Stone "commands to the last created breakpoint.", 69c8ecc2a9SEugene Zelenko nullptr), 70b9c1b51eSKate Stone IOHandlerDelegateMultiline("DONE", 71b9c1b51eSKate Stone IOHandlerDelegate::Completion::LLDBCommand), 72*abb0ed44SKazu Hirata m_func_options("breakpoint command", false, 'F') { 7330fdc8d8SChris Lattner SetHelpLong( 74ea671fbdSKate Stone R"( 75ea671fbdSKate Stone General information about entering breakpoint commands 76ea671fbdSKate Stone ------------------------------------------------------ 77ea671fbdSKate Stone 78b9c1b51eSKate Stone )" 79b9c1b51eSKate Stone "This command will prompt for commands to be executed when the specified \ 80ea671fbdSKate Stone breakpoint is hit. Each command is typed on its own line following the '> ' \ 81b9c1b51eSKate Stone prompt until 'DONE' is entered." 82b9c1b51eSKate Stone R"( 83ea671fbdSKate Stone 84b9c1b51eSKate Stone )" 85b9c1b51eSKate Stone "Syntactic errors may not be detected when initially entered, and many \ 86ea671fbdSKate Stone malformed commands can silently fail when executed. If your breakpoint commands \ 87b9c1b51eSKate Stone do not appear to be executing, double-check the command syntax." 88b9c1b51eSKate Stone R"( 89ea671fbdSKate Stone 90b9c1b51eSKate Stone )" 91b9c1b51eSKate Stone "Note: You may enter any debugger command exactly as you would at the debugger \ 92ea671fbdSKate Stone prompt. There is no limit to the number of commands supplied, but do NOT enter \ 93b9c1b51eSKate Stone more than one command per line." 94b9c1b51eSKate Stone R"( 95ea671fbdSKate Stone 96ea671fbdSKate Stone Special information about PYTHON breakpoint commands 97ea671fbdSKate Stone ---------------------------------------------------- 98ea671fbdSKate Stone 99b9c1b51eSKate Stone )" 100b9c1b51eSKate Stone "You may enter either one or more lines of Python, including function \ 101ea671fbdSKate Stone definitions or calls to functions that will have been imported by the time \ 102ea671fbdSKate Stone the code executes. Single line breakpoint commands will be interpreted 'as is' \ 103ea671fbdSKate Stone when the breakpoint is hit. Multiple lines of Python will be wrapped in a \ 104b9c1b51eSKate Stone generated function, and a call to the function will be attached to the breakpoint." 105b9c1b51eSKate Stone R"( 106ea671fbdSKate Stone 107ea671fbdSKate Stone This auto-generated function is passed in three arguments: 108ea671fbdSKate Stone 109ea671fbdSKate Stone frame: an lldb.SBFrame object for the frame which hit breakpoint. 110ea671fbdSKate Stone 111ea671fbdSKate Stone bp_loc: an lldb.SBBreakpointLocation object that represents the breakpoint location that was hit. 112ea671fbdSKate Stone 113ea671fbdSKate Stone dict: the python session dictionary hit. 114ea671fbdSKate Stone 115b9c1b51eSKate Stone )" 116b9c1b51eSKate Stone "When specifying a python function with the --python-function option, you need \ 117b9c1b51eSKate Stone to supply the function name prepended by the module name:" 118b9c1b51eSKate Stone R"( 119ea671fbdSKate Stone 120ea671fbdSKate Stone --python-function myutils.breakpoint_callback 121ea671fbdSKate Stone 122365b186cSJim Ingham The function itself must have either of the following prototypes: 123ea671fbdSKate Stone 124483ec136SJim Ingham def breakpoint_callback(frame, bp_loc, internal_dict): 125ea671fbdSKate Stone # Your code goes here 126ea671fbdSKate Stone 127365b186cSJim Ingham or: 128365b186cSJim Ingham 129483ec136SJim Ingham def breakpoint_callback(frame, bp_loc, extra_args, internal_dict): 130365b186cSJim Ingham # Your code goes here 131365b186cSJim Ingham 132b9c1b51eSKate Stone )" 133b9c1b51eSKate Stone "The arguments are the same as the arguments passed to generated functions as \ 134365b186cSJim Ingham described above. In the second form, any -k and -v pairs provided to the command will \ 135365b186cSJim Ingham be packaged into a SBDictionary in an SBStructuredData and passed as the extra_args parameter. \ 136365b186cSJim Ingham \n\n\ 137365b186cSJim Ingham Note that the global variable 'lldb.frame' will NOT be updated when \ 138ea671fbdSKate Stone this function is called, so be sure to use the 'frame' argument. The 'frame' argument \ 139ea671fbdSKate Stone can get you to the thread via frame.GetThread(), the thread can get you to the \ 140ea671fbdSKate Stone process via thread.GetProcess(), and the process can get you back to the target \ 141b9c1b51eSKate Stone via process.GetTarget()." 142b9c1b51eSKate Stone R"( 143ea671fbdSKate Stone 144b9c1b51eSKate Stone )" 145b9c1b51eSKate Stone "Important Note: As Python code gets collected into functions, access to global \ 146ea671fbdSKate Stone variables requires explicit scoping using the 'global' keyword. Be sure to use correct \ 147b9c1b51eSKate Stone Python syntax, including indentation, when entering Python breakpoint commands." 148b9c1b51eSKate Stone R"( 149ea671fbdSKate Stone 150ea671fbdSKate Stone Example Python one-line breakpoint command: 151ea671fbdSKate Stone 152ea671fbdSKate Stone (lldb) breakpoint command add -s python 1 153ea671fbdSKate Stone Enter your Python command(s). Type 'DONE' to end. 1543b3b9ba1SDave Lee def function (frame, bp_loc, internal_dict): 1553b3b9ba1SDave Lee """frame: the lldb.SBFrame for the location at which you stopped 1563b3b9ba1SDave Lee bp_loc: an lldb.SBBreakpointLocation for the breakpoint location information 1573b3b9ba1SDave Lee internal_dict: an LLDB support object not to be used""" 1583b3b9ba1SDave Lee print("Hit this breakpoint!") 1593b3b9ba1SDave Lee DONE 160ea671fbdSKate Stone 161ea671fbdSKate Stone As a convenience, this also works for a short Python one-liner: 162ea671fbdSKate Stone 1633b3b9ba1SDave Lee (lldb) breakpoint command add -s python 1 -o 'import time; print(time.asctime())' 164ea671fbdSKate Stone (lldb) run 165ea671fbdSKate Stone Launching '.../a.out' (x86_64) 166ea671fbdSKate Stone (lldb) Fri Sep 10 12:17:45 2010 167ea671fbdSKate Stone Process 21778 Stopped 168ea671fbdSKate Stone * thread #1: tid = 0x2e03, 0x0000000100000de8 a.out`c + 7 at main.c:39, stop reason = breakpoint 1.1, queue = com.apple.main-thread 169ea671fbdSKate Stone 36 170ea671fbdSKate Stone 37 int c(int val) 171ea671fbdSKate Stone 38 { 172ea671fbdSKate Stone 39 -> return val + 3; 173ea671fbdSKate Stone 40 } 174ea671fbdSKate Stone 41 175ea671fbdSKate Stone 42 int main (int argc, char const *argv[]) 176ea671fbdSKate Stone 177ea671fbdSKate Stone Example multiple line Python breakpoint command: 178ea671fbdSKate Stone 179ea671fbdSKate Stone (lldb) breakpoint command add -s p 1 180ea671fbdSKate Stone Enter your Python command(s). Type 'DONE' to end. 1813b3b9ba1SDave Lee def function (frame, bp_loc, internal_dict): 1823b3b9ba1SDave Lee """frame: the lldb.SBFrame for the location at which you stopped 1833b3b9ba1SDave Lee bp_loc: an lldb.SBBreakpointLocation for the breakpoint location information 1843b3b9ba1SDave Lee internal_dict: an LLDB support object not to be used""" 1853b3b9ba1SDave Lee global bp_count 1863b3b9ba1SDave Lee bp_count = bp_count + 1 1873b3b9ba1SDave Lee print("Hit this breakpoint " + repr(bp_count) + " times!") 1883b3b9ba1SDave Lee DONE 189ea671fbdSKate Stone 190b9c1b51eSKate Stone )" 191b9c1b51eSKate Stone "In this case, since there is a reference to a global variable, \ 192ea671fbdSKate Stone 'bp_count', you will also need to make sure 'bp_count' exists and is \ 193b9c1b51eSKate Stone initialized:" 194b9c1b51eSKate Stone R"( 195ea671fbdSKate Stone 196ea671fbdSKate Stone (lldb) script 197ea671fbdSKate Stone >>> bp_count = 0 198ea671fbdSKate Stone >>> quit() 199ea671fbdSKate Stone 200b9c1b51eSKate Stone )" 201b9c1b51eSKate Stone "Your Python code, however organized, can optionally return a value. \ 202ea671fbdSKate Stone If the returned value is False, that tells LLDB not to stop at the breakpoint \ 203ea671fbdSKate Stone to which the code is associated. Returning anything other than False, or even \ 204ea671fbdSKate Stone returning None, or even omitting a return statement entirely, will cause \ 205b9c1b51eSKate Stone LLDB to stop." 206b9c1b51eSKate Stone R"( 207ea671fbdSKate Stone 208b9c1b51eSKate Stone )" 209b9c1b51eSKate Stone "Final Note: A warning that no breakpoint command was generated when there \ 210b9c1b51eSKate Stone are no syntax errors may indicate that a function was declared but never called."); 211405fe67fSCaroline Tice 212738af7a6SJim Ingham m_all_options.Append(&m_options); 213738af7a6SJim Ingham m_all_options.Append(&m_func_options, LLDB_OPT_SET_2 | LLDB_OPT_SET_3, 214738af7a6SJim Ingham LLDB_OPT_SET_2); 215738af7a6SJim Ingham m_all_options.Finalize(); 216738af7a6SJim Ingham 217405fe67fSCaroline Tice CommandArgumentEntry arg; 218405fe67fSCaroline Tice CommandArgumentData bp_id_arg; 219405fe67fSCaroline Tice 220405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 221405fe67fSCaroline Tice bp_id_arg.arg_type = eArgTypeBreakpointID; 2221bb0750bSJim Ingham bp_id_arg.arg_repetition = eArgRepeatOptional; 223405fe67fSCaroline Tice 224b9c1b51eSKate Stone // There is only one variant this argument could be; put it into the 225b9c1b51eSKate Stone // argument entry. 226405fe67fSCaroline Tice arg.push_back(bp_id_arg); 227405fe67fSCaroline Tice 228405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 229405fe67fSCaroline Tice m_arguments.push_back(arg); 23030fdc8d8SChris Lattner } 23130fdc8d8SChris Lattner 232c8ecc2a9SEugene Zelenko ~CommandObjectBreakpointCommandAdd() override = default; 2335a988416SJim Ingham 234738af7a6SJim Ingham Options *GetOptions() override { return &m_all_options; } 2355a988416SJim Ingham 2360affb582SDave Lee void IOHandlerActivated(IOHandler &io_handler, bool interactive) override { 2377ca15ba7SLawrence D'Anna StreamFileSP output_sp(io_handler.GetOutputStreamFileSP()); 2380affb582SDave Lee if (output_sp && interactive) { 23944d93782SGreg Clayton output_sp->PutCString(g_reader_instructions); 24044d93782SGreg Clayton output_sp->Flush(); 24144d93782SGreg Clayton } 24244d93782SGreg Clayton } 24344d93782SGreg Clayton 244b9c1b51eSKate Stone void IOHandlerInputComplete(IOHandler &io_handler, 245b9c1b51eSKate Stone std::string &line) override { 24644d93782SGreg Clayton io_handler.SetIsDone(true); 24744d93782SGreg Clayton 248cfb96d84SJim Ingham std::vector<std::reference_wrapper<BreakpointOptions>> *bp_options_vec = 249cfb96d84SJim Ingham (std::vector<std::reference_wrapper<BreakpointOptions>> *) 250cfb96d84SJim Ingham io_handler.GetUserData(); 251cfb96d84SJim Ingham for (BreakpointOptions &bp_options : *bp_options_vec) { 252a8f3ae7cSJonas Devlieghere auto cmd_data = std::make_unique<BreakpointOptions::CommandData>(); 253e14dc268SJim Ingham cmd_data->user_source.SplitIntoLines(line.c_str(), line.size()); 254cfb96d84SJim Ingham bp_options.SetCommandDataCallback(cmd_data); 25544d93782SGreg Clayton } 25644d93782SGreg Clayton } 25744d93782SGreg Clayton 258b9c1b51eSKate Stone void CollectDataForBreakpointCommandCallback( 259cfb96d84SJim Ingham std::vector<std::reference_wrapper<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. 269cfb96d84SJim Ingham void SetBreakpointCommandCallback( 270cfb96d84SJim Ingham std::vector<std::reference_wrapper<BreakpointOptions>> &bp_options_vec, 271b9c1b51eSKate Stone const char *oneliner) { 272cfb96d84SJim Ingham for (BreakpointOptions &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 278cfb96d84SJim Ingham bp_options.SetCommandDataCallback(cmd_data); 279b5796cb4SJim Ingham } 2805a988416SJim Ingham } 2815a988416SJim Ingham 282738af7a6SJim Ingham class CommandOptions : public OptionGroup { 2835a988416SJim Ingham public: 284*abb0ed44SKazu Hirata CommandOptions() {} 28530fdc8d8SChris Lattner 286c8ecc2a9SEugene Zelenko ~CommandOptions() override = default; 2875a988416SJim Ingham 28897206d57SZachary Turner Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 289b9c1b51eSKate Stone ExecutionContext *execution_context) override { 29097206d57SZachary Turner Status error; 291a925974bSAdrian Prantl const int short_option = 292a925974bSAdrian Prantl g_breakpoint_command_add_options[option_idx].short_option; 2935a988416SJim Ingham 294b9c1b51eSKate Stone switch (short_option) { 2955a988416SJim Ingham case 'o': 2965a988416SJim Ingham m_use_one_liner = true; 297adcd0268SBenjamin Kramer m_one_liner = std::string(option_arg); 2985a988416SJim Ingham break; 2995a988416SJim Ingham 3005a988416SJim Ingham case 's': 30147cbf4a0SPavel Labath m_script_language = (lldb::ScriptLanguage)OptionArgParser::ToOptionEnum( 302bd68a052SRaphael Isemann option_arg, 303bd68a052SRaphael Isemann g_breakpoint_command_add_options[option_idx].enum_values, 304b9c1b51eSKate Stone eScriptLanguageNone, error); 3058983d691SJonas Devlieghere switch (m_script_language) { 3068983d691SJonas Devlieghere case eScriptLanguagePython: 3078983d691SJonas Devlieghere case eScriptLanguageLua: 3085a988416SJim Ingham m_use_script_language = true; 3098983d691SJonas Devlieghere break; 3108983d691SJonas Devlieghere case eScriptLanguageNone: 311acdda134SJonas Devlieghere case eScriptLanguageUnknown: 3125a988416SJim Ingham m_use_script_language = false; 3138983d691SJonas Devlieghere break; 3145a988416SJim Ingham } 3155a988416SJim Ingham break; 3165a988416SJim Ingham 317b9c1b51eSKate Stone case 'e': { 3185a988416SJim Ingham bool success = false; 31947cbf4a0SPavel Labath m_stop_on_error = 32047cbf4a0SPavel Labath OptionArgParser::ToBoolean(option_arg, false, &success); 3215a988416SJim Ingham if (!success) 322b9c1b51eSKate Stone error.SetErrorStringWithFormat( 323fe11483bSZachary Turner "invalid value for stop-on-error: \"%s\"", 324fe11483bSZachary Turner option_arg.str().c_str()); 325b9c1b51eSKate Stone } break; 3265a988416SJim Ingham 32733df7cd3SJim Ingham case 'D': 32833df7cd3SJim Ingham m_use_dummy = true; 32933df7cd3SJim Ingham break; 33033df7cd3SJim Ingham 3315a988416SJim Ingham default: 33236162014SRaphael Isemann llvm_unreachable("Unimplemented option"); 3335a988416SJim Ingham } 3345a988416SJim Ingham return error; 3355a988416SJim Ingham } 336c8ecc2a9SEugene Zelenko 337b9c1b51eSKate Stone void OptionParsingStarting(ExecutionContext *execution_context) override { 3385a988416SJim Ingham m_use_commands = true; 3395a988416SJim Ingham m_use_script_language = false; 3405a988416SJim Ingham m_script_language = eScriptLanguageNone; 3415a988416SJim Ingham 3425a988416SJim Ingham m_use_one_liner = false; 3435a988416SJim Ingham m_stop_on_error = true; 3445a988416SJim Ingham m_one_liner.clear(); 34533df7cd3SJim Ingham m_use_dummy = false; 3465a988416SJim Ingham } 3475a988416SJim Ingham 3481f0f5b5bSZachary Turner llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 349bd68a052SRaphael Isemann return llvm::makeArrayRef(g_breakpoint_command_add_options); 3501f0f5b5bSZachary Turner } 3515a988416SJim Ingham 3525a988416SJim Ingham // Instance variables to hold the values for command options. 3535a988416SJim Ingham 3549494c510SJonas Devlieghere bool m_use_commands = false; 3559494c510SJonas Devlieghere bool m_use_script_language = false; 3569494c510SJonas Devlieghere lldb::ScriptLanguage m_script_language = eScriptLanguageNone; 3575a988416SJim Ingham 3585a988416SJim Ingham // Instance variables to hold the values for one_liner options. 3599494c510SJonas Devlieghere bool m_use_one_liner = false; 3605a988416SJim Ingham std::string m_one_liner; 3615a988416SJim Ingham bool m_stop_on_error; 36233df7cd3SJim Ingham bool m_use_dummy; 3635a988416SJim Ingham }; 3645a988416SJim Ingham 3655a988416SJim Ingham protected: 366b9c1b51eSKate Stone bool DoExecute(Args &command, CommandReturnObject &result) override { 367cb2380c9SRaphael Isemann Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 36830fdc8d8SChris Lattner 369cb2380c9SRaphael Isemann const BreakpointList &breakpoints = target.GetBreakpointList(); 37030fdc8d8SChris Lattner size_t num_breakpoints = breakpoints.GetSize(); 37130fdc8d8SChris Lattner 372b9c1b51eSKate Stone if (num_breakpoints == 0) { 37330fdc8d8SChris Lattner result.AppendError("No breakpoints exist to have commands added"); 37430fdc8d8SChris Lattner return false; 37530fdc8d8SChris Lattner } 37630fdc8d8SChris Lattner 377738af7a6SJim Ingham if (!m_func_options.GetName().empty()) { 378738af7a6SJim Ingham m_options.m_use_one_liner = false; 3791ff01cfeSJonas Devlieghere if (!m_options.m_use_script_language) { 3801ff01cfeSJonas Devlieghere m_options.m_script_language = GetDebugger().GetScriptLanguage(); 381738af7a6SJim Ingham m_options.m_use_script_language = true; 3828d4a8010SEnrico Granata } 3831ff01cfeSJonas Devlieghere } 3848d4a8010SEnrico Granata 38530fdc8d8SChris Lattner BreakpointIDList valid_bp_ids; 386b9c1b51eSKate Stone CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 387cb2380c9SRaphael Isemann command, &target, result, &valid_bp_ids, 388b842f2ecSJim Ingham BreakpointName::Permissions::PermissionKinds::listPerm); 38930fdc8d8SChris Lattner 390b5796cb4SJim Ingham m_bp_options_vec.clear(); 391b5796cb4SJim Ingham 392b9c1b51eSKate Stone if (result.Succeeded()) { 393c982c768SGreg Clayton const size_t count = valid_bp_ids.GetSize(); 394d9916eaeSJim Ingham 395b9c1b51eSKate Stone for (size_t i = 0; i < count; ++i) { 39630fdc8d8SChris Lattner BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 397b9c1b51eSKate Stone if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 398b9c1b51eSKate Stone Breakpoint *bp = 399cb2380c9SRaphael Isemann target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 400b9c1b51eSKate Stone if (cur_bp_id.GetLocationID() == LLDB_INVALID_BREAK_ID) { 40139d7d4f0SJohnny Chen // This breakpoint does not have an associated location. 402cfb96d84SJim Ingham m_bp_options_vec.push_back(bp->GetOptions()); 403b9c1b51eSKate Stone } else { 404b9c1b51eSKate Stone BreakpointLocationSP bp_loc_sp( 405b9c1b51eSKate Stone bp->FindLocationByID(cur_bp_id.GetLocationID())); 40605097246SAdrian Prantl // This breakpoint does have an associated location. Get its 40705097246SAdrian Prantl // breakpoint options. 40830fdc8d8SChris Lattner if (bp_loc_sp) 409cfb96d84SJim Ingham m_bp_options_vec.push_back(bp_loc_sp->GetLocationOptions()); 41039d7d4f0SJohnny Chen } 411b5796cb4SJim Ingham } 412b5796cb4SJim Ingham } 41339d7d4f0SJohnny Chen 41405097246SAdrian Prantl // If we are using script language, get the script interpreter in order 41505097246SAdrian Prantl // to set or collect command callback. Otherwise, call the methods 41605097246SAdrian Prantl // associated with this object. 417b9c1b51eSKate Stone if (m_options.m_use_script_language) { 418280ae107SPedro Tammela Status error; 4195e32eb1cSJonas Devlieghere ScriptInterpreter *script_interp = GetDebugger().GetScriptInterpreter( 4205e32eb1cSJonas Devlieghere /*can_create=*/true, m_options.m_script_language); 42139d7d4f0SJohnny Chen // Special handling for one-liner specified inline. 422b9c1b51eSKate Stone if (m_options.m_use_one_liner) { 423280ae107SPedro Tammela error = script_interp->SetBreakpointCommandCallback( 424b9c1b51eSKate Stone m_bp_options_vec, m_options.m_one_liner.c_str()); 425738af7a6SJim Ingham } else if (!m_func_options.GetName().empty()) { 426280ae107SPedro Tammela error = script_interp->SetBreakpointCommandCallbackFunction( 427738af7a6SJim Ingham m_bp_options_vec, m_func_options.GetName().c_str(), 428738af7a6SJim Ingham m_func_options.GetStructuredData()); 429b9c1b51eSKate Stone } else { 430b9c1b51eSKate Stone script_interp->CollectDataForBreakpointCommandCallback( 431b9c1b51eSKate Stone m_bp_options_vec, result); 4328d4a8010SEnrico Granata } 433280ae107SPedro Tammela if (!error.Success()) 434280ae107SPedro Tammela result.SetError(error); 435b9c1b51eSKate Stone } else { 43639d7d4f0SJohnny Chen // Special handling for one-liner specified inline. 43739d7d4f0SJohnny Chen if (m_options.m_use_one_liner) 438b5796cb4SJim Ingham SetBreakpointCommandCallback(m_bp_options_vec, 43939d7d4f0SJohnny Chen m_options.m_one_liner.c_str()); 44039d7d4f0SJohnny Chen else 441b9c1b51eSKate Stone CollectDataForBreakpointCommandCallback(m_bp_options_vec, result); 44230fdc8d8SChris Lattner } 44330fdc8d8SChris Lattner } 44430fdc8d8SChris Lattner 44530fdc8d8SChris Lattner return result.Succeeded(); 44630fdc8d8SChris Lattner } 44730fdc8d8SChris Lattner 4485a988416SJim Ingham private: 4495a988416SJim Ingham CommandOptions m_options; 450738af7a6SJim Ingham OptionGroupPythonClassWithDict m_func_options; 451738af7a6SJim Ingham OptionGroupOptions m_all_options; 452738af7a6SJim Ingham 453cfb96d84SJim Ingham std::vector<std::reference_wrapper<BreakpointOptions>> 454cfb96d84SJim Ingham m_bp_options_vec; // This stores the 455b9c1b51eSKate Stone // breakpoint options that 456b9c1b51eSKate Stone // we are currently 45705097246SAdrian Prantl // collecting commands for. In the CollectData... calls we need to hand this 45805097246SAdrian Prantl // off to the IOHandler, which may run asynchronously. So we have to have 45905097246SAdrian Prantl // some way to keep it alive, and not leak it. Making it an ivar of the 46005097246SAdrian Prantl // command object, which never goes away achieves this. Note that if we were 46105097246SAdrian Prantl // able to run the same command concurrently in one interpreter we'd have to 46205097246SAdrian Prantl // make this "per invocation". But there are many more reasons why it is not 46305097246SAdrian Prantl // in general safe to do that in lldb at present, so it isn't worthwhile to 46405097246SAdrian Prantl // come up with a more complex mechanism to address this particular weakness 46505097246SAdrian Prantl // right now. 4665a988416SJim Ingham static const char *g_reader_instructions; 4675a988416SJim Ingham }; 4685a988416SJim Ingham 469b9c1b51eSKate Stone const char *CommandObjectBreakpointCommandAdd::g_reader_instructions = 470b9c1b51eSKate Stone "Enter your debugger command(s). Type 'DONE' to end.\n"; 4715a988416SJim Ingham 47293e0f19fSCaroline Tice // CommandObjectBreakpointCommandDelete 47330fdc8d8SChris Lattner 474f94668e3SRaphael Isemann #define LLDB_OPTIONS_breakpoint_command_delete 475f94668e3SRaphael Isemann #include "CommandOptions.inc" 4761f0f5b5bSZachary Turner 477b9c1b51eSKate Stone class CommandObjectBreakpointCommandDelete : public CommandObjectParsed { 4785a988416SJim Ingham public: 479b9c1b51eSKate Stone CommandObjectBreakpointCommandDelete(CommandInterpreter &interpreter) 480b9c1b51eSKate Stone : CommandObjectParsed(interpreter, "delete", 48193e0f19fSCaroline Tice "Delete the set of commands from a breakpoint.", 482*abb0ed44SKazu Hirata nullptr) { 483405fe67fSCaroline Tice CommandArgumentEntry arg; 484405fe67fSCaroline Tice CommandArgumentData bp_id_arg; 485405fe67fSCaroline Tice 486405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 487405fe67fSCaroline Tice bp_id_arg.arg_type = eArgTypeBreakpointID; 488405fe67fSCaroline Tice bp_id_arg.arg_repetition = eArgRepeatPlain; 489405fe67fSCaroline Tice 490b9c1b51eSKate Stone // There is only one variant this argument could be; put it into the 491b9c1b51eSKate Stone // argument entry. 492405fe67fSCaroline Tice arg.push_back(bp_id_arg); 493405fe67fSCaroline Tice 494405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 495405fe67fSCaroline Tice m_arguments.push_back(arg); 49630fdc8d8SChris Lattner } 49730fdc8d8SChris Lattner 498c8ecc2a9SEugene Zelenko ~CommandObjectBreakpointCommandDelete() override = default; 4995a988416SJim Ingham 500b9c1b51eSKate Stone Options *GetOptions() override { return &m_options; } 50133df7cd3SJim Ingham 502b9c1b51eSKate Stone class CommandOptions : public Options { 50333df7cd3SJim Ingham public: 504*abb0ed44SKazu Hirata CommandOptions() {} 50533df7cd3SJim Ingham 506c8ecc2a9SEugene Zelenko ~CommandOptions() override = default; 50733df7cd3SJim Ingham 50897206d57SZachary Turner Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 509b9c1b51eSKate Stone ExecutionContext *execution_context) override { 51097206d57SZachary Turner Status error; 51133df7cd3SJim Ingham const int short_option = m_getopt_table[option_idx].val; 51233df7cd3SJim Ingham 513b9c1b51eSKate Stone switch (short_option) { 51433df7cd3SJim Ingham case 'D': 51533df7cd3SJim Ingham m_use_dummy = true; 51633df7cd3SJim Ingham break; 51733df7cd3SJim Ingham 51833df7cd3SJim Ingham default: 51936162014SRaphael Isemann llvm_unreachable("Unimplemented option"); 52033df7cd3SJim Ingham } 52133df7cd3SJim Ingham 52233df7cd3SJim Ingham return error; 52333df7cd3SJim Ingham } 52433df7cd3SJim Ingham 525b9c1b51eSKate Stone void OptionParsingStarting(ExecutionContext *execution_context) override { 52633df7cd3SJim Ingham m_use_dummy = false; 52733df7cd3SJim Ingham } 52833df7cd3SJim Ingham 5291f0f5b5bSZachary Turner llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 530bd68a052SRaphael Isemann return llvm::makeArrayRef(g_breakpoint_command_delete_options); 5311f0f5b5bSZachary Turner } 53233df7cd3SJim Ingham 53333df7cd3SJim Ingham // Instance variables to hold the values for command options. 5349494c510SJonas Devlieghere bool m_use_dummy = false; 53533df7cd3SJim Ingham }; 53633df7cd3SJim Ingham 5375a988416SJim Ingham protected: 538b9c1b51eSKate Stone bool DoExecute(Args &command, CommandReturnObject &result) override { 539cb2380c9SRaphael Isemann Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy); 54030fdc8d8SChris Lattner 541cb2380c9SRaphael Isemann const BreakpointList &breakpoints = target.GetBreakpointList(); 54230fdc8d8SChris Lattner size_t num_breakpoints = breakpoints.GetSize(); 54330fdc8d8SChris Lattner 544b9c1b51eSKate Stone if (num_breakpoints == 0) { 54593e0f19fSCaroline Tice result.AppendError("No breakpoints exist to have commands deleted"); 54630fdc8d8SChris Lattner return false; 54730fdc8d8SChris Lattner } 54830fdc8d8SChris Lattner 54911eb9c64SZachary Turner if (command.empty()) { 550b9c1b51eSKate Stone result.AppendError( 551b9c1b51eSKate Stone "No breakpoint specified from which to delete the commands"); 55230fdc8d8SChris Lattner return false; 55330fdc8d8SChris Lattner } 55430fdc8d8SChris Lattner 55530fdc8d8SChris Lattner BreakpointIDList valid_bp_ids; 556b9c1b51eSKate Stone CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 557cb2380c9SRaphael Isemann command, &target, result, &valid_bp_ids, 558b842f2ecSJim Ingham BreakpointName::Permissions::PermissionKinds::listPerm); 55930fdc8d8SChris Lattner 560b9c1b51eSKate Stone if (result.Succeeded()) { 561c982c768SGreg Clayton const size_t count = valid_bp_ids.GetSize(); 562b9c1b51eSKate Stone for (size_t i = 0; i < count; ++i) { 56330fdc8d8SChris Lattner BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 564b9c1b51eSKate Stone if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 565b9c1b51eSKate Stone Breakpoint *bp = 566cb2380c9SRaphael Isemann target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 567b9c1b51eSKate Stone if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) { 568b9c1b51eSKate Stone BreakpointLocationSP bp_loc_sp( 569b9c1b51eSKate Stone bp->FindLocationByID(cur_bp_id.GetLocationID())); 57030fdc8d8SChris Lattner if (bp_loc_sp) 57130fdc8d8SChris Lattner bp_loc_sp->ClearCallback(); 572b9c1b51eSKate Stone else { 57330fdc8d8SChris Lattner result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 57430fdc8d8SChris Lattner cur_bp_id.GetBreakpointID(), 57530fdc8d8SChris Lattner cur_bp_id.GetLocationID()); 57630fdc8d8SChris Lattner return false; 57730fdc8d8SChris Lattner } 578b9c1b51eSKate Stone } else { 57930fdc8d8SChris Lattner bp->ClearCallback(); 58030fdc8d8SChris Lattner } 58130fdc8d8SChris Lattner } 58230fdc8d8SChris Lattner } 58330fdc8d8SChris Lattner } 58430fdc8d8SChris Lattner return result.Succeeded(); 58530fdc8d8SChris Lattner } 586c8ecc2a9SEugene Zelenko 58733df7cd3SJim Ingham private: 58833df7cd3SJim Ingham CommandOptions m_options; 5895a988416SJim Ingham }; 59030fdc8d8SChris Lattner 59130fdc8d8SChris Lattner // CommandObjectBreakpointCommandList 59230fdc8d8SChris Lattner 593b9c1b51eSKate Stone class CommandObjectBreakpointCommandList : public CommandObjectParsed { 5945a988416SJim Ingham public: 595b9c1b51eSKate Stone CommandObjectBreakpointCommandList(CommandInterpreter &interpreter) 59604a4c091SRaphael Isemann : CommandObjectParsed(interpreter, "list", 59704a4c091SRaphael Isemann "List the script or set of commands to be " 59804a4c091SRaphael Isemann "executed when the breakpoint is hit.", 59904a4c091SRaphael Isemann nullptr, eCommandRequiresTarget) { 600405fe67fSCaroline Tice CommandArgumentEntry arg; 601405fe67fSCaroline Tice CommandArgumentData bp_id_arg; 602405fe67fSCaroline Tice 603405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 604405fe67fSCaroline Tice bp_id_arg.arg_type = eArgTypeBreakpointID; 605405fe67fSCaroline Tice bp_id_arg.arg_repetition = eArgRepeatPlain; 606405fe67fSCaroline Tice 607b9c1b51eSKate Stone // There is only one variant this argument could be; put it into the 608b9c1b51eSKate Stone // argument entry. 609405fe67fSCaroline Tice arg.push_back(bp_id_arg); 610405fe67fSCaroline Tice 611405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 612405fe67fSCaroline Tice m_arguments.push_back(arg); 61330fdc8d8SChris Lattner } 61430fdc8d8SChris Lattner 615c8ecc2a9SEugene Zelenko ~CommandObjectBreakpointCommandList() override = default; 61630fdc8d8SChris Lattner 6175a988416SJim Ingham protected: 618b9c1b51eSKate Stone bool DoExecute(Args &command, CommandReturnObject &result) override { 61904a4c091SRaphael Isemann Target *target = &GetSelectedTarget(); 62030fdc8d8SChris Lattner 62130fdc8d8SChris Lattner const BreakpointList &breakpoints = target->GetBreakpointList(); 62230fdc8d8SChris Lattner size_t num_breakpoints = breakpoints.GetSize(); 62330fdc8d8SChris Lattner 624b9c1b51eSKate Stone if (num_breakpoints == 0) { 62530fdc8d8SChris Lattner result.AppendError("No breakpoints exist for which to list commands"); 62630fdc8d8SChris Lattner return false; 62730fdc8d8SChris Lattner } 62830fdc8d8SChris Lattner 62911eb9c64SZachary Turner if (command.empty()) { 630b9c1b51eSKate Stone result.AppendError( 631b9c1b51eSKate Stone "No breakpoint specified for which to list the commands"); 63230fdc8d8SChris Lattner return false; 63330fdc8d8SChris Lattner } 63430fdc8d8SChris Lattner 63530fdc8d8SChris Lattner BreakpointIDList valid_bp_ids; 636b9c1b51eSKate Stone CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs( 637b842f2ecSJim Ingham command, target, result, &valid_bp_ids, 638b842f2ecSJim Ingham BreakpointName::Permissions::PermissionKinds::listPerm); 63930fdc8d8SChris Lattner 640b9c1b51eSKate Stone if (result.Succeeded()) { 641c982c768SGreg Clayton const size_t count = valid_bp_ids.GetSize(); 642b9c1b51eSKate Stone for (size_t i = 0; i < count; ++i) { 64330fdc8d8SChris Lattner BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i); 644b9c1b51eSKate Stone if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) { 645b9c1b51eSKate Stone Breakpoint *bp = 646b9c1b51eSKate Stone target->GetBreakpointByID(cur_bp_id.GetBreakpointID()).get(); 64730fdc8d8SChris Lattner 648b9c1b51eSKate Stone if (bp) { 649af26b22cSJim Ingham BreakpointLocationSP bp_loc_sp; 650b9c1b51eSKate Stone if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) { 651af26b22cSJim Ingham bp_loc_sp = bp->FindLocationByID(cur_bp_id.GetLocationID()); 652a925974bSAdrian Prantl if (!bp_loc_sp) { 65330fdc8d8SChris Lattner result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n", 65430fdc8d8SChris Lattner cur_bp_id.GetBreakpointID(), 65530fdc8d8SChris Lattner cur_bp_id.GetLocationID()); 65630fdc8d8SChris Lattner return false; 65730fdc8d8SChris Lattner } 65830fdc8d8SChris Lattner } 65930fdc8d8SChris Lattner 66030fdc8d8SChris Lattner StreamString id_str; 661e16c50a1SJim Ingham BreakpointID::GetCanonicalReference(&id_str, 662e16c50a1SJim Ingham cur_bp_id.GetBreakpointID(), 663e16c50a1SJim Ingham cur_bp_id.GetLocationID()); 664af26b22cSJim Ingham const Baton *baton = nullptr; 665af26b22cSJim Ingham if (bp_loc_sp) 666a925974bSAdrian Prantl baton = 667a925974bSAdrian Prantl bp_loc_sp 668af26b22cSJim Ingham ->GetOptionsSpecifyingKind(BreakpointOptions::eCallback) 669cfb96d84SJim Ingham .GetBaton(); 670af26b22cSJim Ingham else 671cfb96d84SJim Ingham baton = bp->GetOptions().GetBaton(); 672af26b22cSJim Ingham 673b9c1b51eSKate Stone if (baton) { 674b9c1b51eSKate Stone result.GetOutputStream().Printf("Breakpoint %s:\n", 675b9c1b51eSKate Stone id_str.GetData()); 6764f728bfcSRaphael Isemann baton->GetDescription(result.GetOutputStream().AsRawOstream(), 6774f728bfcSRaphael Isemann eDescriptionLevelFull, 6784f728bfcSRaphael Isemann result.GetOutputStream().GetIndentLevel() + 6794f728bfcSRaphael Isemann 2); 680b9c1b51eSKate Stone } else { 681b9c1b51eSKate Stone result.AppendMessageWithFormat( 682b9c1b51eSKate Stone "Breakpoint %s does not have an associated command.\n", 683e16c50a1SJim Ingham id_str.GetData()); 68430fdc8d8SChris Lattner } 68530fdc8d8SChris Lattner } 68630fdc8d8SChris Lattner result.SetStatus(eReturnStatusSuccessFinishResult); 687b9c1b51eSKate Stone } else { 688b9c1b51eSKate Stone result.AppendErrorWithFormat("Invalid breakpoint ID: %u.\n", 689b9c1b51eSKate Stone cur_bp_id.GetBreakpointID()); 69030fdc8d8SChris Lattner } 69130fdc8d8SChris Lattner } 69230fdc8d8SChris Lattner } 69330fdc8d8SChris Lattner 69430fdc8d8SChris Lattner return result.Succeeded(); 69530fdc8d8SChris Lattner } 6965a988416SJim Ingham }; 69730fdc8d8SChris Lattner 69830fdc8d8SChris Lattner // CommandObjectBreakpointCommand 69930fdc8d8SChris Lattner 700b9c1b51eSKate Stone CommandObjectBreakpointCommand::CommandObjectBreakpointCommand( 701b9c1b51eSKate Stone CommandInterpreter &interpreter) 7027428a18cSKate Stone : CommandObjectMultiword( 703a925974bSAdrian Prantl interpreter, "command", 704a925974bSAdrian Prantl "Commands for adding, removing and listing " 705b9c1b51eSKate Stone "LLDB commands executed when a breakpoint is " 706b9c1b51eSKate Stone "hit.", 707b9c1b51eSKate Stone "command <sub-command> [<sub-command-options>] <breakpoint-id>") { 708b9c1b51eSKate Stone CommandObjectSP add_command_object( 709b9c1b51eSKate Stone new CommandObjectBreakpointCommandAdd(interpreter)); 710b9c1b51eSKate Stone CommandObjectSP delete_command_object( 711b9c1b51eSKate Stone new CommandObjectBreakpointCommandDelete(interpreter)); 712b9c1b51eSKate Stone CommandObjectSP list_command_object( 713b9c1b51eSKate Stone new CommandObjectBreakpointCommandList(interpreter)); 71430fdc8d8SChris Lattner 71530fdc8d8SChris Lattner add_command_object->SetCommandName("breakpoint command add"); 71693e0f19fSCaroline Tice delete_command_object->SetCommandName("breakpoint command delete"); 71730fdc8d8SChris Lattner list_command_object->SetCommandName("breakpoint command list"); 71830fdc8d8SChris Lattner 71923f59509SGreg Clayton LoadSubCommand("add", add_command_object); 72023f59509SGreg Clayton LoadSubCommand("delete", delete_command_object); 72123f59509SGreg Clayton LoadSubCommand("list", list_command_object); 72230fdc8d8SChris Lattner } 72330fdc8d8SChris Lattner 724c8ecc2a9SEugene Zelenko CommandObjectBreakpointCommand::~CommandObjectBreakpointCommand() = default; 725