15ffd83dbSDimitry Andric //===-- CommandObjectExpression.cpp ---------------------------------------===// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric 90b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h" 100b57cec5SDimitry Andric 110b57cec5SDimitry Andric #include "CommandObjectExpression.h" 120b57cec5SDimitry Andric #include "lldb/Core/Debugger.h" 130b57cec5SDimitry Andric #include "lldb/Expression/REPL.h" 140b57cec5SDimitry Andric #include "lldb/Expression/UserExpression.h" 150b57cec5SDimitry Andric #include "lldb/Host/OptionParser.h" 160b57cec5SDimitry Andric #include "lldb/Interpreter/CommandInterpreter.h" 170b57cec5SDimitry Andric #include "lldb/Interpreter/CommandReturnObject.h" 180b57cec5SDimitry Andric #include "lldb/Interpreter/OptionArgParser.h" 190b57cec5SDimitry Andric #include "lldb/Target/Language.h" 200b57cec5SDimitry Andric #include "lldb/Target/Process.h" 210b57cec5SDimitry Andric #include "lldb/Target/StackFrame.h" 220b57cec5SDimitry Andric #include "lldb/Target/Target.h" 230b57cec5SDimitry Andric 240b57cec5SDimitry Andric using namespace lldb; 250b57cec5SDimitry Andric using namespace lldb_private; 260b57cec5SDimitry Andric 270b57cec5SDimitry Andric CommandObjectExpression::CommandOptions::CommandOptions() : OptionGroup() {} 280b57cec5SDimitry Andric 290b57cec5SDimitry Andric CommandObjectExpression::CommandOptions::~CommandOptions() = default; 300b57cec5SDimitry Andric 310b57cec5SDimitry Andric static constexpr OptionEnumValueElement g_description_verbosity_type[] = { 329dba64beSDimitry Andric { 339dba64beSDimitry Andric eLanguageRuntimeDescriptionDisplayVerbosityCompact, 349dba64beSDimitry Andric "compact", 359dba64beSDimitry Andric "Only show the description string", 369dba64beSDimitry Andric }, 379dba64beSDimitry Andric { 389dba64beSDimitry Andric eLanguageRuntimeDescriptionDisplayVerbosityFull, 399dba64beSDimitry Andric "full", 409dba64beSDimitry Andric "Show the full output, including persistent variable's name and type", 419dba64beSDimitry Andric }, 429dba64beSDimitry Andric }; 430b57cec5SDimitry Andric 440b57cec5SDimitry Andric static constexpr OptionEnumValues DescriptionVerbosityTypes() { 450b57cec5SDimitry Andric return OptionEnumValues(g_description_verbosity_type); 460b57cec5SDimitry Andric } 470b57cec5SDimitry Andric 489dba64beSDimitry Andric #define LLDB_OPTIONS_expression 499dba64beSDimitry Andric #include "CommandOptions.inc" 500b57cec5SDimitry Andric 510b57cec5SDimitry Andric Status CommandObjectExpression::CommandOptions::SetOptionValue( 520b57cec5SDimitry Andric uint32_t option_idx, llvm::StringRef option_arg, 530b57cec5SDimitry Andric ExecutionContext *execution_context) { 540b57cec5SDimitry Andric Status error; 550b57cec5SDimitry Andric 560b57cec5SDimitry Andric const int short_option = GetDefinitions()[option_idx].short_option; 570b57cec5SDimitry Andric 580b57cec5SDimitry Andric switch (short_option) { 590b57cec5SDimitry Andric case 'l': 600b57cec5SDimitry Andric language = Language::GetLanguageTypeFromString(option_arg); 610b57cec5SDimitry Andric if (language == eLanguageTypeUnknown) 620b57cec5SDimitry Andric error.SetErrorStringWithFormat( 630b57cec5SDimitry Andric "unknown language type: '%s' for expression", 640b57cec5SDimitry Andric option_arg.str().c_str()); 650b57cec5SDimitry Andric break; 660b57cec5SDimitry Andric 670b57cec5SDimitry Andric case 'a': { 680b57cec5SDimitry Andric bool success; 690b57cec5SDimitry Andric bool result; 700b57cec5SDimitry Andric result = OptionArgParser::ToBoolean(option_arg, true, &success); 710b57cec5SDimitry Andric if (!success) 720b57cec5SDimitry Andric error.SetErrorStringWithFormat( 730b57cec5SDimitry Andric "invalid all-threads value setting: \"%s\"", 740b57cec5SDimitry Andric option_arg.str().c_str()); 750b57cec5SDimitry Andric else 760b57cec5SDimitry Andric try_all_threads = result; 770b57cec5SDimitry Andric } break; 780b57cec5SDimitry Andric 790b57cec5SDimitry Andric case 'i': { 800b57cec5SDimitry Andric bool success; 810b57cec5SDimitry Andric bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success); 820b57cec5SDimitry Andric if (success) 830b57cec5SDimitry Andric ignore_breakpoints = tmp_value; 840b57cec5SDimitry Andric else 850b57cec5SDimitry Andric error.SetErrorStringWithFormat( 860b57cec5SDimitry Andric "could not convert \"%s\" to a boolean value.", 870b57cec5SDimitry Andric option_arg.str().c_str()); 880b57cec5SDimitry Andric break; 890b57cec5SDimitry Andric } 900b57cec5SDimitry Andric 910b57cec5SDimitry Andric case 'j': { 920b57cec5SDimitry Andric bool success; 930b57cec5SDimitry Andric bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success); 940b57cec5SDimitry Andric if (success) 950b57cec5SDimitry Andric allow_jit = tmp_value; 960b57cec5SDimitry Andric else 970b57cec5SDimitry Andric error.SetErrorStringWithFormat( 980b57cec5SDimitry Andric "could not convert \"%s\" to a boolean value.", 990b57cec5SDimitry Andric option_arg.str().c_str()); 1000b57cec5SDimitry Andric break; 1010b57cec5SDimitry Andric } 1020b57cec5SDimitry Andric 1030b57cec5SDimitry Andric case 't': 1040b57cec5SDimitry Andric if (option_arg.getAsInteger(0, timeout)) { 1050b57cec5SDimitry Andric timeout = 0; 1060b57cec5SDimitry Andric error.SetErrorStringWithFormat("invalid timeout setting \"%s\"", 1070b57cec5SDimitry Andric option_arg.str().c_str()); 1080b57cec5SDimitry Andric } 1090b57cec5SDimitry Andric break; 1100b57cec5SDimitry Andric 1110b57cec5SDimitry Andric case 'u': { 1120b57cec5SDimitry Andric bool success; 1130b57cec5SDimitry Andric bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success); 1140b57cec5SDimitry Andric if (success) 1150b57cec5SDimitry Andric unwind_on_error = tmp_value; 1160b57cec5SDimitry Andric else 1170b57cec5SDimitry Andric error.SetErrorStringWithFormat( 1180b57cec5SDimitry Andric "could not convert \"%s\" to a boolean value.", 1190b57cec5SDimitry Andric option_arg.str().c_str()); 1200b57cec5SDimitry Andric break; 1210b57cec5SDimitry Andric } 1220b57cec5SDimitry Andric 1230b57cec5SDimitry Andric case 'v': 1240b57cec5SDimitry Andric if (option_arg.empty()) { 1250b57cec5SDimitry Andric m_verbosity = eLanguageRuntimeDescriptionDisplayVerbosityFull; 1260b57cec5SDimitry Andric break; 1270b57cec5SDimitry Andric } 1280b57cec5SDimitry Andric m_verbosity = (LanguageRuntimeDescriptionDisplayVerbosity) 1290b57cec5SDimitry Andric OptionArgParser::ToOptionEnum( 1300b57cec5SDimitry Andric option_arg, GetDefinitions()[option_idx].enum_values, 0, error); 1310b57cec5SDimitry Andric if (!error.Success()) 1320b57cec5SDimitry Andric error.SetErrorStringWithFormat( 1330b57cec5SDimitry Andric "unrecognized value for description-verbosity '%s'", 1340b57cec5SDimitry Andric option_arg.str().c_str()); 1350b57cec5SDimitry Andric break; 1360b57cec5SDimitry Andric 1370b57cec5SDimitry Andric case 'g': 1380b57cec5SDimitry Andric debug = true; 1390b57cec5SDimitry Andric unwind_on_error = false; 1400b57cec5SDimitry Andric ignore_breakpoints = false; 1410b57cec5SDimitry Andric break; 1420b57cec5SDimitry Andric 1430b57cec5SDimitry Andric case 'p': 1440b57cec5SDimitry Andric top_level = true; 1450b57cec5SDimitry Andric break; 1460b57cec5SDimitry Andric 1470b57cec5SDimitry Andric case 'X': { 1480b57cec5SDimitry Andric bool success; 1490b57cec5SDimitry Andric bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success); 1500b57cec5SDimitry Andric if (success) 1510b57cec5SDimitry Andric auto_apply_fixits = tmp_value ? eLazyBoolYes : eLazyBoolNo; 1520b57cec5SDimitry Andric else 1530b57cec5SDimitry Andric error.SetErrorStringWithFormat( 1540b57cec5SDimitry Andric "could not convert \"%s\" to a boolean value.", 1550b57cec5SDimitry Andric option_arg.str().c_str()); 1560b57cec5SDimitry Andric break; 1570b57cec5SDimitry Andric } 1580b57cec5SDimitry Andric 1590b57cec5SDimitry Andric default: 1609dba64beSDimitry Andric llvm_unreachable("Unimplemented option"); 1610b57cec5SDimitry Andric } 1620b57cec5SDimitry Andric 1630b57cec5SDimitry Andric return error; 1640b57cec5SDimitry Andric } 1650b57cec5SDimitry Andric 1660b57cec5SDimitry Andric void CommandObjectExpression::CommandOptions::OptionParsingStarting( 1670b57cec5SDimitry Andric ExecutionContext *execution_context) { 1680b57cec5SDimitry Andric auto process_sp = 1690b57cec5SDimitry Andric execution_context ? execution_context->GetProcessSP() : ProcessSP(); 1700b57cec5SDimitry Andric if (process_sp) { 1710b57cec5SDimitry Andric ignore_breakpoints = process_sp->GetIgnoreBreakpointsInExpressions(); 1720b57cec5SDimitry Andric unwind_on_error = process_sp->GetUnwindOnErrorInExpressions(); 1730b57cec5SDimitry Andric } else { 1740b57cec5SDimitry Andric ignore_breakpoints = true; 1750b57cec5SDimitry Andric unwind_on_error = true; 1760b57cec5SDimitry Andric } 1770b57cec5SDimitry Andric 1780b57cec5SDimitry Andric show_summary = true; 1790b57cec5SDimitry Andric try_all_threads = true; 1800b57cec5SDimitry Andric timeout = 0; 1810b57cec5SDimitry Andric debug = false; 1820b57cec5SDimitry Andric language = eLanguageTypeUnknown; 1830b57cec5SDimitry Andric m_verbosity = eLanguageRuntimeDescriptionDisplayVerbosityCompact; 1840b57cec5SDimitry Andric auto_apply_fixits = eLazyBoolCalculate; 1850b57cec5SDimitry Andric top_level = false; 1860b57cec5SDimitry Andric allow_jit = true; 1870b57cec5SDimitry Andric } 1880b57cec5SDimitry Andric 1890b57cec5SDimitry Andric llvm::ArrayRef<OptionDefinition> 1900b57cec5SDimitry Andric CommandObjectExpression::CommandOptions::GetDefinitions() { 1910b57cec5SDimitry Andric return llvm::makeArrayRef(g_expression_options); 1920b57cec5SDimitry Andric } 1930b57cec5SDimitry Andric 1940b57cec5SDimitry Andric CommandObjectExpression::CommandObjectExpression( 1950b57cec5SDimitry Andric CommandInterpreter &interpreter) 196480093f4SDimitry Andric : CommandObjectRaw(interpreter, "expression", 197480093f4SDimitry Andric "Evaluate an expression on the current " 1980b57cec5SDimitry Andric "thread. Displays any returned value " 1990b57cec5SDimitry Andric "with LLDB's default formatting.", 200480093f4SDimitry Andric "", 201480093f4SDimitry Andric eCommandProcessMustBePaused | eCommandTryTargetAPILock), 2020b57cec5SDimitry Andric IOHandlerDelegate(IOHandlerDelegate::Completion::Expression), 2030b57cec5SDimitry Andric m_option_group(), m_format_options(eFormatDefault), 2040b57cec5SDimitry Andric m_repl_option(LLDB_OPT_SET_1, false, "repl", 'r', "Drop into REPL", false, 2050b57cec5SDimitry Andric true), 2060b57cec5SDimitry Andric m_command_options(), m_expr_line_count(0), m_expr_lines() { 2070b57cec5SDimitry Andric SetHelpLong( 2080b57cec5SDimitry Andric R"( 2090b57cec5SDimitry Andric Single and multi-line expressions: 2100b57cec5SDimitry Andric 2110b57cec5SDimitry Andric )" 2120b57cec5SDimitry Andric " The expression provided on the command line must be a complete expression \ 2130b57cec5SDimitry Andric with no newlines. To evaluate a multi-line expression, \ 2140b57cec5SDimitry Andric hit a return after an empty expression, and lldb will enter the multi-line expression editor. \ 2150b57cec5SDimitry Andric Hit return on an empty line to end the multi-line expression." 2160b57cec5SDimitry Andric 2170b57cec5SDimitry Andric R"( 2180b57cec5SDimitry Andric 2190b57cec5SDimitry Andric Timeouts: 2200b57cec5SDimitry Andric 2210b57cec5SDimitry Andric )" 2220b57cec5SDimitry Andric " If the expression can be evaluated statically (without running code) then it will be. \ 2230b57cec5SDimitry Andric Otherwise, by default the expression will run on the current thread with a short timeout: \ 2240b57cec5SDimitry Andric currently .25 seconds. If it doesn't return in that time, the evaluation will be interrupted \ 2250b57cec5SDimitry Andric and resumed with all threads running. You can use the -a option to disable retrying on all \ 2260b57cec5SDimitry Andric threads. You can use the -t option to set a shorter timeout." 2270b57cec5SDimitry Andric R"( 2280b57cec5SDimitry Andric 2290b57cec5SDimitry Andric User defined variables: 2300b57cec5SDimitry Andric 2310b57cec5SDimitry Andric )" 2320b57cec5SDimitry Andric " You can define your own variables for convenience or to be used in subsequent expressions. \ 2330b57cec5SDimitry Andric You define them the same way you would define variables in C. If the first character of \ 2340b57cec5SDimitry Andric your user defined variable is a $, then the variable's value will be available in future \ 2350b57cec5SDimitry Andric expressions, otherwise it will just be available in the current expression." 2360b57cec5SDimitry Andric R"( 2370b57cec5SDimitry Andric 2380b57cec5SDimitry Andric Continuing evaluation after a breakpoint: 2390b57cec5SDimitry Andric 2400b57cec5SDimitry Andric )" 2410b57cec5SDimitry Andric " If the \"-i false\" option is used, and execution is interrupted by a breakpoint hit, once \ 2420b57cec5SDimitry Andric you are done with your investigation, you can either remove the expression execution frames \ 2430b57cec5SDimitry Andric from the stack with \"thread return -x\" or if you are still interested in the expression result \ 2440b57cec5SDimitry Andric you can issue the \"continue\" command and the expression evaluation will complete and the \ 2450b57cec5SDimitry Andric expression result will be available using the \"thread.completed-expression\" key in the thread \ 2460b57cec5SDimitry Andric format." 2470b57cec5SDimitry Andric 2480b57cec5SDimitry Andric R"( 2490b57cec5SDimitry Andric 2500b57cec5SDimitry Andric Examples: 2510b57cec5SDimitry Andric 2520b57cec5SDimitry Andric expr my_struct->a = my_array[3] 2530b57cec5SDimitry Andric expr -f bin -- (index * 8) + 5 2540b57cec5SDimitry Andric expr unsigned int $foo = 5 2550b57cec5SDimitry Andric expr char c[] = \"foo\"; c[0])"); 2560b57cec5SDimitry Andric 2570b57cec5SDimitry Andric CommandArgumentEntry arg; 2580b57cec5SDimitry Andric CommandArgumentData expression_arg; 2590b57cec5SDimitry Andric 2600b57cec5SDimitry Andric // Define the first (and only) variant of this arg. 2610b57cec5SDimitry Andric expression_arg.arg_type = eArgTypeExpression; 2620b57cec5SDimitry Andric expression_arg.arg_repetition = eArgRepeatPlain; 2630b57cec5SDimitry Andric 2640b57cec5SDimitry Andric // There is only one variant this argument could be; put it into the argument 2650b57cec5SDimitry Andric // entry. 2660b57cec5SDimitry Andric arg.push_back(expression_arg); 2670b57cec5SDimitry Andric 2680b57cec5SDimitry Andric // Push the data for the first argument into the m_arguments vector. 2690b57cec5SDimitry Andric m_arguments.push_back(arg); 2700b57cec5SDimitry Andric 2710b57cec5SDimitry Andric // Add the "--format" and "--gdb-format" 2720b57cec5SDimitry Andric m_option_group.Append(&m_format_options, 2730b57cec5SDimitry Andric OptionGroupFormat::OPTION_GROUP_FORMAT | 2740b57cec5SDimitry Andric OptionGroupFormat::OPTION_GROUP_GDB_FMT, 2750b57cec5SDimitry Andric LLDB_OPT_SET_1); 2760b57cec5SDimitry Andric m_option_group.Append(&m_command_options); 2770b57cec5SDimitry Andric m_option_group.Append(&m_varobj_options, LLDB_OPT_SET_ALL, 2780b57cec5SDimitry Andric LLDB_OPT_SET_1 | LLDB_OPT_SET_2); 2790b57cec5SDimitry Andric m_option_group.Append(&m_repl_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_3); 2800b57cec5SDimitry Andric m_option_group.Finalize(); 2810b57cec5SDimitry Andric } 2820b57cec5SDimitry Andric 2830b57cec5SDimitry Andric CommandObjectExpression::~CommandObjectExpression() = default; 2840b57cec5SDimitry Andric 2850b57cec5SDimitry Andric Options *CommandObjectExpression::GetOptions() { return &m_option_group; } 2860b57cec5SDimitry Andric 2879dba64beSDimitry Andric void CommandObjectExpression::HandleCompletion(CompletionRequest &request) { 2880b57cec5SDimitry Andric EvaluateExpressionOptions options; 2890b57cec5SDimitry Andric options.SetCoerceToId(m_varobj_options.use_objc); 2900b57cec5SDimitry Andric options.SetLanguage(m_command_options.language); 2910b57cec5SDimitry Andric options.SetExecutionPolicy(lldb_private::eExecutionPolicyNever); 2920b57cec5SDimitry Andric options.SetAutoApplyFixIts(false); 2930b57cec5SDimitry Andric options.SetGenerateDebugInfo(false); 2940b57cec5SDimitry Andric 2950b57cec5SDimitry Andric // We need a valid execution context with a frame pointer for this 2960b57cec5SDimitry Andric // completion, so if we don't have one we should try to make a valid 2970b57cec5SDimitry Andric // execution context. 2980b57cec5SDimitry Andric if (m_interpreter.GetExecutionContext().GetFramePtr() == nullptr) 2990b57cec5SDimitry Andric m_interpreter.UpdateExecutionContext(nullptr); 3000b57cec5SDimitry Andric 3010b57cec5SDimitry Andric // This didn't work, so let's get out before we start doing things that 3020b57cec5SDimitry Andric // expect a valid frame pointer. 3030b57cec5SDimitry Andric if (m_interpreter.GetExecutionContext().GetFramePtr() == nullptr) 3049dba64beSDimitry Andric return; 3050b57cec5SDimitry Andric 3060b57cec5SDimitry Andric ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 3070b57cec5SDimitry Andric 3080b57cec5SDimitry Andric Target *target = exe_ctx.GetTargetPtr(); 3090b57cec5SDimitry Andric 3100b57cec5SDimitry Andric if (!target) 3119dba64beSDimitry Andric target = &GetDummyTarget(); 3120b57cec5SDimitry Andric 3130b57cec5SDimitry Andric unsigned cursor_pos = request.GetRawCursorPos(); 3145ffd83dbSDimitry Andric // Get the full user input including the suffix. The suffix is necessary 3155ffd83dbSDimitry Andric // as OptionsWithRaw will use it to detect if the cursor is cursor is in the 3165ffd83dbSDimitry Andric // argument part of in the raw input part of the arguments. If we cut of 3175ffd83dbSDimitry Andric // of the suffix then "expr -arg[cursor] --" would interpret the "-arg" as 3185ffd83dbSDimitry Andric // the raw input (as the "--" is hidden in the suffix). 3195ffd83dbSDimitry Andric llvm::StringRef code = request.GetRawLineWithUnusedSuffix(); 3200b57cec5SDimitry Andric 3210b57cec5SDimitry Andric const std::size_t original_code_size = code.size(); 3220b57cec5SDimitry Andric 3230b57cec5SDimitry Andric // Remove the first token which is 'expr' or some alias/abbreviation of that. 3240b57cec5SDimitry Andric code = llvm::getToken(code).second.ltrim(); 3250b57cec5SDimitry Andric OptionsWithRaw args(code); 3260b57cec5SDimitry Andric code = args.GetRawPart(); 3270b57cec5SDimitry Andric 3280b57cec5SDimitry Andric // The position where the expression starts in the command line. 3290b57cec5SDimitry Andric assert(original_code_size >= code.size()); 3300b57cec5SDimitry Andric std::size_t raw_start = original_code_size - code.size(); 3310b57cec5SDimitry Andric 3320b57cec5SDimitry Andric // Check if the cursor is actually in the expression string, and if not, we 3330b57cec5SDimitry Andric // exit. 3340b57cec5SDimitry Andric // FIXME: We should complete the options here. 3350b57cec5SDimitry Andric if (cursor_pos < raw_start) 3369dba64beSDimitry Andric return; 3370b57cec5SDimitry Andric 3380b57cec5SDimitry Andric // Make the cursor_pos again relative to the start of the code string. 3390b57cec5SDimitry Andric assert(cursor_pos >= raw_start); 3400b57cec5SDimitry Andric cursor_pos -= raw_start; 3410b57cec5SDimitry Andric 3420b57cec5SDimitry Andric auto language = exe_ctx.GetFrameRef().GetLanguage(); 3430b57cec5SDimitry Andric 3440b57cec5SDimitry Andric Status error; 3450b57cec5SDimitry Andric lldb::UserExpressionSP expr(target->GetUserExpressionForLanguage( 3460b57cec5SDimitry Andric code, llvm::StringRef(), language, UserExpression::eResultTypeAny, 3470b57cec5SDimitry Andric options, nullptr, error)); 3480b57cec5SDimitry Andric if (error.Fail()) 3499dba64beSDimitry Andric return; 3500b57cec5SDimitry Andric 3510b57cec5SDimitry Andric expr->Complete(exe_ctx, request, cursor_pos); 3520b57cec5SDimitry Andric } 3530b57cec5SDimitry Andric 3540b57cec5SDimitry Andric static lldb_private::Status 3550b57cec5SDimitry Andric CanBeUsedForElementCountPrinting(ValueObject &valobj) { 3560b57cec5SDimitry Andric CompilerType type(valobj.GetCompilerType()); 3570b57cec5SDimitry Andric CompilerType pointee; 3580b57cec5SDimitry Andric if (!type.IsPointerType(&pointee)) 3590b57cec5SDimitry Andric return Status("as it does not refer to a pointer"); 3600b57cec5SDimitry Andric if (pointee.IsVoidType()) 3610b57cec5SDimitry Andric return Status("as it refers to a pointer to void"); 3620b57cec5SDimitry Andric return Status(); 3630b57cec5SDimitry Andric } 3640b57cec5SDimitry Andric 3655ffd83dbSDimitry Andric EvaluateExpressionOptions 3665ffd83dbSDimitry Andric CommandObjectExpression::GetEvalOptions(const Target &target) { 3670b57cec5SDimitry Andric EvaluateExpressionOptions options; 3680b57cec5SDimitry Andric options.SetCoerceToId(m_varobj_options.use_objc); 3690b57cec5SDimitry Andric options.SetUnwindOnError(m_command_options.unwind_on_error); 3700b57cec5SDimitry Andric options.SetIgnoreBreakpoints(m_command_options.ignore_breakpoints); 3715ffd83dbSDimitry Andric options.SetKeepInMemory(true); 3720b57cec5SDimitry Andric options.SetUseDynamic(m_varobj_options.use_dynamic); 3730b57cec5SDimitry Andric options.SetTryAllThreads(m_command_options.try_all_threads); 3740b57cec5SDimitry Andric options.SetDebug(m_command_options.debug); 3750b57cec5SDimitry Andric options.SetLanguage(m_command_options.language); 3760b57cec5SDimitry Andric options.SetExecutionPolicy( 3770b57cec5SDimitry Andric m_command_options.allow_jit 3780b57cec5SDimitry Andric ? EvaluateExpressionOptions::default_execution_policy 3790b57cec5SDimitry Andric : lldb_private::eExecutionPolicyNever); 3800b57cec5SDimitry Andric 3810b57cec5SDimitry Andric bool auto_apply_fixits; 3820b57cec5SDimitry Andric if (m_command_options.auto_apply_fixits == eLazyBoolCalculate) 3835ffd83dbSDimitry Andric auto_apply_fixits = target.GetEnableAutoApplyFixIts(); 3840b57cec5SDimitry Andric else 3850b57cec5SDimitry Andric auto_apply_fixits = m_command_options.auto_apply_fixits == eLazyBoolYes; 3860b57cec5SDimitry Andric 3870b57cec5SDimitry Andric options.SetAutoApplyFixIts(auto_apply_fixits); 3885ffd83dbSDimitry Andric options.SetRetriesWithFixIts(target.GetNumberOfRetriesWithFixits()); 3890b57cec5SDimitry Andric 3900b57cec5SDimitry Andric if (m_command_options.top_level) 3910b57cec5SDimitry Andric options.SetExecutionPolicy(eExecutionPolicyTopLevel); 3920b57cec5SDimitry Andric 3930b57cec5SDimitry Andric // If there is any chance we are going to stop and want to see what went 3940b57cec5SDimitry Andric // wrong with our expression, we should generate debug info 3950b57cec5SDimitry Andric if (!m_command_options.ignore_breakpoints || 3960b57cec5SDimitry Andric !m_command_options.unwind_on_error) 3970b57cec5SDimitry Andric options.SetGenerateDebugInfo(true); 3980b57cec5SDimitry Andric 3990b57cec5SDimitry Andric if (m_command_options.timeout > 0) 4000b57cec5SDimitry Andric options.SetTimeout(std::chrono::microseconds(m_command_options.timeout)); 4010b57cec5SDimitry Andric else 4020b57cec5SDimitry Andric options.SetTimeout(llvm::None); 4035ffd83dbSDimitry Andric return options; 4045ffd83dbSDimitry Andric } 4050b57cec5SDimitry Andric 4065ffd83dbSDimitry Andric bool CommandObjectExpression::EvaluateExpression(llvm::StringRef expr, 4075ffd83dbSDimitry Andric Stream &output_stream, 4085ffd83dbSDimitry Andric Stream &error_stream, 4095ffd83dbSDimitry Andric CommandReturnObject &result) { 4105ffd83dbSDimitry Andric // Don't use m_exe_ctx as this might be called asynchronously after the 4115ffd83dbSDimitry Andric // command object DoExecute has finished when doing multi-line expression 4125ffd83dbSDimitry Andric // that use an input reader... 4135ffd83dbSDimitry Andric ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 4145ffd83dbSDimitry Andric 4155ffd83dbSDimitry Andric Target *target = exe_ctx.GetTargetPtr(); 4165ffd83dbSDimitry Andric 4175ffd83dbSDimitry Andric if (!target) 4185ffd83dbSDimitry Andric target = &GetDummyTarget(); 4195ffd83dbSDimitry Andric 4205ffd83dbSDimitry Andric lldb::ValueObjectSP result_valobj_sp; 4215ffd83dbSDimitry Andric StackFrame *frame = exe_ctx.GetFramePtr(); 4225ffd83dbSDimitry Andric 4235ffd83dbSDimitry Andric const EvaluateExpressionOptions options = GetEvalOptions(*target); 4240b57cec5SDimitry Andric ExpressionResults success = target->EvaluateExpression( 4250b57cec5SDimitry Andric expr, frame, result_valobj_sp, options, &m_fixed_expression); 4260b57cec5SDimitry Andric 4270b57cec5SDimitry Andric // We only tell you about the FixIt if we applied it. The compiler errors 4280b57cec5SDimitry Andric // will suggest the FixIt if it parsed. 4295ffd83dbSDimitry Andric if (!m_fixed_expression.empty() && target->GetEnableNotifyAboutFixIts()) { 4300b57cec5SDimitry Andric if (success == eExpressionCompleted) 4315ffd83dbSDimitry Andric error_stream.Printf(" Fix-it applied, fixed expression was: \n %s\n", 4320b57cec5SDimitry Andric m_fixed_expression.c_str()); 4330b57cec5SDimitry Andric } 4340b57cec5SDimitry Andric 4350b57cec5SDimitry Andric if (result_valobj_sp) { 4360b57cec5SDimitry Andric Format format = m_format_options.GetFormat(); 4370b57cec5SDimitry Andric 4380b57cec5SDimitry Andric if (result_valobj_sp->GetError().Success()) { 4390b57cec5SDimitry Andric if (format != eFormatVoid) { 4400b57cec5SDimitry Andric if (format != eFormatDefault) 4410b57cec5SDimitry Andric result_valobj_sp->SetFormat(format); 4420b57cec5SDimitry Andric 4430b57cec5SDimitry Andric if (m_varobj_options.elem_count > 0) { 4440b57cec5SDimitry Andric Status error(CanBeUsedForElementCountPrinting(*result_valobj_sp)); 4450b57cec5SDimitry Andric if (error.Fail()) { 4465ffd83dbSDimitry Andric result.AppendErrorWithFormat( 4470b57cec5SDimitry Andric "expression cannot be used with --element-count %s\n", 4480b57cec5SDimitry Andric error.AsCString("")); 4495ffd83dbSDimitry Andric result.SetStatus(eReturnStatusFailed); 4500b57cec5SDimitry Andric return false; 4510b57cec5SDimitry Andric } 4520b57cec5SDimitry Andric } 4530b57cec5SDimitry Andric 4540b57cec5SDimitry Andric DumpValueObjectOptions options(m_varobj_options.GetAsDumpOptions( 4550b57cec5SDimitry Andric m_command_options.m_verbosity, format)); 4560b57cec5SDimitry Andric options.SetVariableFormatDisplayLanguage( 4570b57cec5SDimitry Andric result_valobj_sp->GetPreferredDisplayLanguage()); 4580b57cec5SDimitry Andric 4595ffd83dbSDimitry Andric result_valobj_sp->Dump(output_stream, options); 4600b57cec5SDimitry Andric 4615ffd83dbSDimitry Andric result.SetStatus(eReturnStatusSuccessFinishResult); 4620b57cec5SDimitry Andric } 4630b57cec5SDimitry Andric } else { 4640b57cec5SDimitry Andric if (result_valobj_sp->GetError().GetError() == 4650b57cec5SDimitry Andric UserExpression::kNoResult) { 4660b57cec5SDimitry Andric if (format != eFormatVoid && GetDebugger().GetNotifyVoid()) { 4675ffd83dbSDimitry Andric error_stream.PutCString("(void)\n"); 4680b57cec5SDimitry Andric } 4690b57cec5SDimitry Andric 4705ffd83dbSDimitry Andric result.SetStatus(eReturnStatusSuccessFinishResult); 4710b57cec5SDimitry Andric } else { 4720b57cec5SDimitry Andric const char *error_cstr = result_valobj_sp->GetError().AsCString(); 4730b57cec5SDimitry Andric if (error_cstr && error_cstr[0]) { 4740b57cec5SDimitry Andric const size_t error_cstr_len = strlen(error_cstr); 4759dba64beSDimitry Andric const bool ends_with_newline = error_cstr[error_cstr_len - 1] == '\n'; 4760b57cec5SDimitry Andric if (strstr(error_cstr, "error:") != error_cstr) 4775ffd83dbSDimitry Andric error_stream.PutCString("error: "); 4785ffd83dbSDimitry Andric error_stream.Write(error_cstr, error_cstr_len); 4790b57cec5SDimitry Andric if (!ends_with_newline) 4805ffd83dbSDimitry Andric error_stream.EOL(); 4810b57cec5SDimitry Andric } else { 4825ffd83dbSDimitry Andric error_stream.PutCString("error: unknown error\n"); 4830b57cec5SDimitry Andric } 4840b57cec5SDimitry Andric 4855ffd83dbSDimitry Andric result.SetStatus(eReturnStatusFailed); 4860b57cec5SDimitry Andric } 4870b57cec5SDimitry Andric } 4880b57cec5SDimitry Andric } 4890b57cec5SDimitry Andric 4905ffd83dbSDimitry Andric return (success != eExpressionSetupError && 4915ffd83dbSDimitry Andric success != eExpressionParseError); 4920b57cec5SDimitry Andric } 4930b57cec5SDimitry Andric 4940b57cec5SDimitry Andric void CommandObjectExpression::IOHandlerInputComplete(IOHandler &io_handler, 4950b57cec5SDimitry Andric std::string &line) { 4960b57cec5SDimitry Andric io_handler.SetIsDone(true); 4970b57cec5SDimitry Andric // StreamSP output_stream = 4980b57cec5SDimitry Andric // io_handler.GetDebugger().GetAsyncOutputStream(); 4990b57cec5SDimitry Andric // StreamSP error_stream = io_handler.GetDebugger().GetAsyncErrorStream(); 5009dba64beSDimitry Andric StreamFileSP output_sp = io_handler.GetOutputStreamFileSP(); 5019dba64beSDimitry Andric StreamFileSP error_sp = io_handler.GetErrorStreamFileSP(); 5020b57cec5SDimitry Andric 5035ffd83dbSDimitry Andric CommandReturnObject return_obj( 5045ffd83dbSDimitry Andric GetCommandInterpreter().GetDebugger().GetUseColor()); 5055ffd83dbSDimitry Andric EvaluateExpression(line.c_str(), *output_sp, *error_sp, return_obj); 5060b57cec5SDimitry Andric if (output_sp) 5070b57cec5SDimitry Andric output_sp->Flush(); 5080b57cec5SDimitry Andric if (error_sp) 5090b57cec5SDimitry Andric error_sp->Flush(); 5100b57cec5SDimitry Andric } 5110b57cec5SDimitry Andric 5120b57cec5SDimitry Andric bool CommandObjectExpression::IOHandlerIsInputComplete(IOHandler &io_handler, 5130b57cec5SDimitry Andric StringList &lines) { 5140b57cec5SDimitry Andric // An empty lines is used to indicate the end of input 5150b57cec5SDimitry Andric const size_t num_lines = lines.GetSize(); 5160b57cec5SDimitry Andric if (num_lines > 0 && lines[num_lines - 1].empty()) { 5170b57cec5SDimitry Andric // Remove the last empty line from "lines" so it doesn't appear in our 5180b57cec5SDimitry Andric // resulting input and return true to indicate we are done getting lines 5190b57cec5SDimitry Andric lines.PopBack(); 5200b57cec5SDimitry Andric return true; 5210b57cec5SDimitry Andric } 5220b57cec5SDimitry Andric return false; 5230b57cec5SDimitry Andric } 5240b57cec5SDimitry Andric 5250b57cec5SDimitry Andric void CommandObjectExpression::GetMultilineExpression() { 5260b57cec5SDimitry Andric m_expr_lines.clear(); 5270b57cec5SDimitry Andric m_expr_line_count = 0; 5280b57cec5SDimitry Andric 5290b57cec5SDimitry Andric Debugger &debugger = GetCommandInterpreter().GetDebugger(); 5300b57cec5SDimitry Andric bool color_prompt = debugger.GetUseColor(); 5310b57cec5SDimitry Andric const bool multiple_lines = true; // Get multiple lines 5320b57cec5SDimitry Andric IOHandlerSP io_handler_sp( 5330b57cec5SDimitry Andric new IOHandlerEditline(debugger, IOHandler::Type::Expression, 5340b57cec5SDimitry Andric "lldb-expr", // Name of input reader for history 5350b57cec5SDimitry Andric llvm::StringRef(), // No prompt 5360b57cec5SDimitry Andric llvm::StringRef(), // Continuation prompt 5370b57cec5SDimitry Andric multiple_lines, color_prompt, 5380b57cec5SDimitry Andric 1, // Show line numbers starting at 1 5390b57cec5SDimitry Andric *this, nullptr)); 5400b57cec5SDimitry Andric 5419dba64beSDimitry Andric StreamFileSP output_sp = io_handler_sp->GetOutputStreamFileSP(); 5420b57cec5SDimitry Andric if (output_sp) { 5430b57cec5SDimitry Andric output_sp->PutCString( 5440b57cec5SDimitry Andric "Enter expressions, then terminate with an empty line to evaluate:\n"); 5450b57cec5SDimitry Andric output_sp->Flush(); 5460b57cec5SDimitry Andric } 5475ffd83dbSDimitry Andric debugger.RunIOHandlerAsync(io_handler_sp); 5480b57cec5SDimitry Andric } 5490b57cec5SDimitry Andric 5500b57cec5SDimitry Andric static EvaluateExpressionOptions 5510b57cec5SDimitry Andric GetExprOptions(ExecutionContext &ctx, 5520b57cec5SDimitry Andric CommandObjectExpression::CommandOptions command_options) { 5530b57cec5SDimitry Andric command_options.OptionParsingStarting(&ctx); 5540b57cec5SDimitry Andric 5550b57cec5SDimitry Andric // Default certain settings for REPL regardless of the global settings. 5560b57cec5SDimitry Andric command_options.unwind_on_error = false; 5570b57cec5SDimitry Andric command_options.ignore_breakpoints = false; 5580b57cec5SDimitry Andric command_options.debug = false; 5590b57cec5SDimitry Andric 5600b57cec5SDimitry Andric EvaluateExpressionOptions expr_options; 5610b57cec5SDimitry Andric expr_options.SetUnwindOnError(command_options.unwind_on_error); 5620b57cec5SDimitry Andric expr_options.SetIgnoreBreakpoints(command_options.ignore_breakpoints); 5630b57cec5SDimitry Andric expr_options.SetTryAllThreads(command_options.try_all_threads); 5640b57cec5SDimitry Andric 5650b57cec5SDimitry Andric if (command_options.timeout > 0) 5660b57cec5SDimitry Andric expr_options.SetTimeout(std::chrono::microseconds(command_options.timeout)); 5670b57cec5SDimitry Andric else 5680b57cec5SDimitry Andric expr_options.SetTimeout(llvm::None); 5690b57cec5SDimitry Andric 5700b57cec5SDimitry Andric return expr_options; 5710b57cec5SDimitry Andric } 5720b57cec5SDimitry Andric 5730b57cec5SDimitry Andric bool CommandObjectExpression::DoExecute(llvm::StringRef command, 5740b57cec5SDimitry Andric CommandReturnObject &result) { 5750b57cec5SDimitry Andric m_fixed_expression.clear(); 5760b57cec5SDimitry Andric auto exe_ctx = GetCommandInterpreter().GetExecutionContext(); 5770b57cec5SDimitry Andric m_option_group.NotifyOptionParsingStarting(&exe_ctx); 5780b57cec5SDimitry Andric 5790b57cec5SDimitry Andric if (command.empty()) { 5800b57cec5SDimitry Andric GetMultilineExpression(); 5810b57cec5SDimitry Andric return result.Succeeded(); 5820b57cec5SDimitry Andric } 5830b57cec5SDimitry Andric 5840b57cec5SDimitry Andric OptionsWithRaw args(command); 5850b57cec5SDimitry Andric llvm::StringRef expr = args.GetRawPart(); 5860b57cec5SDimitry Andric 5870b57cec5SDimitry Andric if (args.HasArgs()) { 5880b57cec5SDimitry Andric if (!ParseOptionsAndNotify(args.GetArgs(), result, m_option_group, exe_ctx)) 5890b57cec5SDimitry Andric return false; 5900b57cec5SDimitry Andric 5910b57cec5SDimitry Andric if (m_repl_option.GetOptionValue().GetCurrentValue()) { 592480093f4SDimitry Andric Target &target = GetSelectedOrDummyTarget(); 5930b57cec5SDimitry Andric // Drop into REPL 5940b57cec5SDimitry Andric m_expr_lines.clear(); 5950b57cec5SDimitry Andric m_expr_line_count = 0; 5960b57cec5SDimitry Andric 597480093f4SDimitry Andric Debugger &debugger = target.GetDebugger(); 5980b57cec5SDimitry Andric 5990b57cec5SDimitry Andric // Check if the LLDB command interpreter is sitting on top of a REPL 6000b57cec5SDimitry Andric // that launched it... 6010b57cec5SDimitry Andric if (debugger.CheckTopIOHandlerTypes(IOHandler::Type::CommandInterpreter, 6020b57cec5SDimitry Andric IOHandler::Type::REPL)) { 6030b57cec5SDimitry Andric // the LLDB command interpreter is sitting on top of a REPL that 6040b57cec5SDimitry Andric // launched it, so just say the command interpreter is done and 6050b57cec5SDimitry Andric // fall back to the existing REPL 6060b57cec5SDimitry Andric m_interpreter.GetIOHandler(false)->SetIsDone(true); 6070b57cec5SDimitry Andric } else { 6080b57cec5SDimitry Andric // We are launching the REPL on top of the current LLDB command 6090b57cec5SDimitry Andric // interpreter, so just push one 6100b57cec5SDimitry Andric bool initialize = false; 6110b57cec5SDimitry Andric Status repl_error; 612480093f4SDimitry Andric REPLSP repl_sp(target.GetREPL(repl_error, m_command_options.language, 6130b57cec5SDimitry Andric nullptr, false)); 6140b57cec5SDimitry Andric 6150b57cec5SDimitry Andric if (!repl_sp) { 6160b57cec5SDimitry Andric initialize = true; 617480093f4SDimitry Andric repl_sp = target.GetREPL(repl_error, m_command_options.language, 6180b57cec5SDimitry Andric nullptr, true); 6190b57cec5SDimitry Andric if (!repl_error.Success()) { 6200b57cec5SDimitry Andric result.SetError(repl_error); 6210b57cec5SDimitry Andric return result.Succeeded(); 6220b57cec5SDimitry Andric } 6230b57cec5SDimitry Andric } 6240b57cec5SDimitry Andric 6250b57cec5SDimitry Andric if (repl_sp) { 6260b57cec5SDimitry Andric if (initialize) { 6270b57cec5SDimitry Andric repl_sp->SetEvaluateOptions( 6280b57cec5SDimitry Andric GetExprOptions(exe_ctx, m_command_options)); 6290b57cec5SDimitry Andric repl_sp->SetFormatOptions(m_format_options); 6300b57cec5SDimitry Andric repl_sp->SetValueObjectDisplayOptions(m_varobj_options); 6310b57cec5SDimitry Andric } 6320b57cec5SDimitry Andric 6330b57cec5SDimitry Andric IOHandlerSP io_handler_sp(repl_sp->GetIOHandler()); 6340b57cec5SDimitry Andric io_handler_sp->SetIsDone(false); 6355ffd83dbSDimitry Andric debugger.RunIOHandlerAsync(io_handler_sp); 6360b57cec5SDimitry Andric } else { 6370b57cec5SDimitry Andric repl_error.SetErrorStringWithFormat( 6380b57cec5SDimitry Andric "Couldn't create a REPL for %s", 6390b57cec5SDimitry Andric Language::GetNameForLanguageType(m_command_options.language)); 6400b57cec5SDimitry Andric result.SetError(repl_error); 6410b57cec5SDimitry Andric return result.Succeeded(); 6420b57cec5SDimitry Andric } 6430b57cec5SDimitry Andric } 6440b57cec5SDimitry Andric } 6450b57cec5SDimitry Andric // No expression following options 6460b57cec5SDimitry Andric else if (expr.empty()) { 6470b57cec5SDimitry Andric GetMultilineExpression(); 6480b57cec5SDimitry Andric return result.Succeeded(); 6490b57cec5SDimitry Andric } 6500b57cec5SDimitry Andric } 6510b57cec5SDimitry Andric 6529dba64beSDimitry Andric Target &target = GetSelectedOrDummyTarget(); 6535ffd83dbSDimitry Andric if (EvaluateExpression(expr, result.GetOutputStream(), 6545ffd83dbSDimitry Andric result.GetErrorStream(), result)) { 6550b57cec5SDimitry Andric 6569dba64beSDimitry Andric if (!m_fixed_expression.empty() && target.GetEnableNotifyAboutFixIts()) { 6570b57cec5SDimitry Andric CommandHistory &history = m_interpreter.GetCommandHistory(); 6580b57cec5SDimitry Andric // FIXME: Can we figure out what the user actually typed (e.g. some alias 6590b57cec5SDimitry Andric // for expr???) 6600b57cec5SDimitry Andric // If we can it would be nice to show that. 6610b57cec5SDimitry Andric std::string fixed_command("expression "); 6620b57cec5SDimitry Andric if (args.HasArgs()) { 6630b57cec5SDimitry Andric // Add in any options that might have been in the original command: 6645ffd83dbSDimitry Andric fixed_command.append(std::string(args.GetArgStringWithDelimiter())); 6650b57cec5SDimitry Andric fixed_command.append(m_fixed_expression); 6660b57cec5SDimitry Andric } else 6670b57cec5SDimitry Andric fixed_command.append(m_fixed_expression); 6680b57cec5SDimitry Andric history.AppendString(fixed_command); 6690b57cec5SDimitry Andric } 6700b57cec5SDimitry Andric // Increment statistics to record this expression evaluation success. 6719dba64beSDimitry Andric target.IncrementStats(StatisticKind::ExpressionSuccessful); 6720b57cec5SDimitry Andric return true; 6730b57cec5SDimitry Andric } 6740b57cec5SDimitry Andric 6750b57cec5SDimitry Andric // Increment statistics to record this expression evaluation failure. 6769dba64beSDimitry Andric target.IncrementStats(StatisticKind::ExpressionFailure); 6770b57cec5SDimitry Andric result.SetStatus(eReturnStatusFailed); 6780b57cec5SDimitry Andric return false; 6790b57cec5SDimitry Andric } 680