blob: ac440ef0af50dbca3fb3a6d91a4fee1158a26d3f [file] [log] [blame]
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001//===-- CommandObjectExpression.cpp -----------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Chris Lattner30fdc8d2010-06-08 16:52:24 +000010// C Includes
11// C++ Includes
12// Other libraries and framework includes
Eugene Zelenkoc8ecc2a2016-02-19 19:33:46 +000013#include "llvm/ADT/STLExtras.h"
14#include "llvm/ADT/StringRef.h"
15
Chris Lattner30fdc8d2010-06-08 16:52:24 +000016// Project includes
Eugene Zelenkoc8ecc2a2016-02-19 19:33:46 +000017#include "CommandObjectExpression.h"
Kate Stoneb9c1b512016-09-06 20:57:50 +000018#include "Plugins/ExpressionParser/Clang/ClangExpressionVariable.h"
19#include "lldb/Core/Debugger.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000020#include "lldb/Core/Value.h"
Jim Ingham6c68fb42010-09-30 00:54:27 +000021#include "lldb/Core/ValueObjectVariable.h"
Enrico Granata4d93b8c2013-09-30 19:11:51 +000022#include "lldb/DataFormatters/ValueObjectPrinter.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000023#include "lldb/Expression/DWARFExpression.h"
Sean Callananf2bd5c32015-10-20 00:55:21 +000024#include "lldb/Expression/REPL.h"
Kate Stoneb9c1b512016-09-06 20:57:50 +000025#include "lldb/Expression/UserExpression.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000026#include "lldb/Host/Host.h"
Zachary Turner3eb2b442017-03-22 23:33:16 +000027#include "lldb/Host/OptionParser.h"
Greg Clayton66111032010-06-23 01:19:29 +000028#include "lldb/Interpreter/CommandInterpreter.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000029#include "lldb/Interpreter/CommandReturnObject.h"
Pavel Labath47cbf4a2018-04-10 09:03:59 +000030#include "lldb/Interpreter/OptionArgParser.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000031#include "lldb/Symbol/ObjectFile.h"
32#include "lldb/Symbol/Variable.h"
Kate Stoneb9c1b512016-09-06 20:57:50 +000033#include "lldb/Target/Language.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000034#include "lldb/Target/Process.h"
Jason Molendab57e4a12013-11-04 09:33:30 +000035#include "lldb/Target/StackFrame.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000036#include "lldb/Target/Target.h"
Greg Clayton7260f622011-04-18 08:33:37 +000037#include "lldb/Target/Thread.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000038
39using namespace lldb;
40using namespace lldb_private;
41
Kate Stoneb9c1b512016-09-06 20:57:50 +000042CommandObjectExpression::CommandOptions::CommandOptions() : OptionGroup() {}
Chris Lattner30fdc8d2010-06-08 16:52:24 +000043
Eugene Zelenkoc8ecc2a2016-02-19 19:33:46 +000044CommandObjectExpression::CommandOptions::~CommandOptions() = default;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000045
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000046static constexpr OptionEnumValueElement g_description_verbosity_type[] = {
Kate Stoneb9c1b512016-09-06 20:57:50 +000047 {eLanguageRuntimeDescriptionDisplayVerbosityCompact, "compact",
48 "Only show the description string"},
49 {eLanguageRuntimeDescriptionDisplayVerbosityFull, "full",
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000050 "Show the full output, including persistent variable's name and type"} };
Enrico Granata4d93b8c2013-09-30 19:11:51 +000051
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000052static constexpr OptionEnumValues DescriptionVerbosityTypes() {
53 return OptionEnumValues(g_description_verbosity_type);
54}
55
56static constexpr OptionDefinition g_expression_options[] = {
Kate Stoneb9c1b512016-09-06 20:57:50 +000057 // clang-format off
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000058 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "all-threads", 'a', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeBoolean, "Should we run all threads if the execution doesn't complete on one thread."},
59 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "ignore-breakpoints", 'i', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeBoolean, "Ignore breakpoint hits while running expressions"},
60 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "timeout", 't', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeUnsignedInteger, "Timeout value (in microseconds) for running the expression."},
61 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "unwind-on-error", 'u', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeBoolean, "Clean up program state if the expression causes a crash, or raises a signal. "
Kate Stoneac9c3a62016-08-26 23:28:47 +000062 "Note, unlike gdb hitting a breakpoint is controlled by another option (-i)."},
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000063 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "debug", 'g', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "When specified, debug the JIT code by setting a breakpoint on the first instruction "
Kate Stoneac9c3a62016-08-26 23:28:47 +000064 "and forcing breakpoints to not be ignored (-i0) and no unwinding to happen on error (-u0)."},
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000065 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "language", 'l', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeLanguage, "Specifies the Language to use when parsing the expression. If not set the target.language "
Kate Stoneac9c3a62016-08-26 23:28:47 +000066 "setting is used." },
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000067 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "apply-fixits", 'X', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeLanguage, "If true, simple fix-it hints will be automatically applied to the expression." },
68 {LLDB_OPT_SET_1, false, "description-verbosity", 'v', OptionParser::eOptionalArgument, nullptr, DescriptionVerbosityTypes(), 0, eArgTypeDescriptionVerbosity, "How verbose should the output of this expression be, if the object description is asked for."},
69 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "top-level", 'p', OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, "Interpret the expression as a complete translation unit, without injecting it into the local "
Sean Callanan0354a682016-10-11 16:57:21 +000070 "context. Allows declaration of persistent, top-level entities without a $ prefix."},
Tatyana Krasnukha8fe53c492018-09-26 18:50:19 +000071 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "allow-jit", 'j', OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeBoolean, "Controls whether the expression can fall back to being JITted if it's not supported by "
Kate Stoneac9c3a62016-08-26 23:28:47 +000072 "the interpreter (defaults to true)."}
Kate Stoneb9c1b512016-09-06 20:57:50 +000073 // clang-format on
Greg Clayton1deb7962011-10-25 06:44:01 +000074};
75
Zachary Turner97206d52017-05-12 04:51:55 +000076Status CommandObjectExpression::CommandOptions::SetOptionValue(
Zachary Turner8cef4b02016-09-23 17:48:13 +000077 uint32_t option_idx, llvm::StringRef option_arg,
Kate Stoneb9c1b512016-09-06 20:57:50 +000078 ExecutionContext *execution_context) {
Zachary Turner97206d52017-05-12 04:51:55 +000079 Status error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000080
Zachary Turner1f0f5b52016-09-22 20:22:55 +000081 const int short_option = GetDefinitions()[option_idx].short_option;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000082
Kate Stoneb9c1b512016-09-06 20:57:50 +000083 switch (short_option) {
84 case 'l':
85 language = Language::GetLanguageTypeFromString(option_arg);
86 if (language == eLanguageTypeUnknown)
87 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +000088 "unknown language type: '%s' for expression",
89 option_arg.str().c_str());
Kate Stoneb9c1b512016-09-06 20:57:50 +000090 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000091
Kate Stoneb9c1b512016-09-06 20:57:50 +000092 case 'a': {
93 bool success;
94 bool result;
Pavel Labath47cbf4a2018-04-10 09:03:59 +000095 result = OptionArgParser::ToBoolean(option_arg, true, &success);
Kate Stoneb9c1b512016-09-06 20:57:50 +000096 if (!success)
97 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +000098 "invalid all-threads value setting: \"%s\"",
99 option_arg.str().c_str());
Jim Ingham184e9812013-01-15 02:47:48 +0000100 else
Kate Stoneb9c1b512016-09-06 20:57:50 +0000101 try_all_threads = result;
102 } break;
103
104 case 'i': {
105 bool success;
Pavel Labath47cbf4a2018-04-10 09:03:59 +0000106 bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000107 if (success)
108 ignore_breakpoints = tmp_value;
109 else
110 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +0000111 "could not convert \"%s\" to a boolean value.",
112 option_arg.str().c_str());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000113 break;
114 }
115
116 case 'j': {
117 bool success;
Pavel Labath47cbf4a2018-04-10 09:03:59 +0000118 bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000119 if (success)
120 allow_jit = tmp_value;
121 else
122 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +0000123 "could not convert \"%s\" to a boolean value.",
124 option_arg.str().c_str());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000125 break;
126 }
127
Zachary Turner8cef4b02016-09-23 17:48:13 +0000128 case 't':
129 if (option_arg.getAsInteger(0, timeout)) {
130 timeout = 0;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000131 error.SetErrorStringWithFormat("invalid timeout setting \"%s\"",
Zachary Turner8cef4b02016-09-23 17:48:13 +0000132 option_arg.str().c_str());
133 }
134 break;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000135
136 case 'u': {
137 bool success;
Pavel Labath47cbf4a2018-04-10 09:03:59 +0000138 bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000139 if (success)
140 unwind_on_error = tmp_value;
141 else
142 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +0000143 "could not convert \"%s\" to a boolean value.",
144 option_arg.str().c_str());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000145 break;
146 }
147
148 case 'v':
Enrico Granata543a26e2016-09-26 21:36:17 +0000149 if (option_arg.empty()) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000150 m_verbosity = eLanguageRuntimeDescriptionDisplayVerbosityFull;
151 break;
Jim Ingham184e9812013-01-15 02:47:48 +0000152 }
Pavel Labath47cbf4a2018-04-10 09:03:59 +0000153 m_verbosity = (LanguageRuntimeDescriptionDisplayVerbosity)
154 OptionArgParser::ToOptionEnum(
Zachary Turner1f0f5b52016-09-22 20:22:55 +0000155 option_arg, GetDefinitions()[option_idx].enum_values, 0, error);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000156 if (!error.Success())
157 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +0000158 "unrecognized value for description-verbosity '%s'",
159 option_arg.str().c_str());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000160 break;
161
162 case 'g':
163 debug = true;
164 unwind_on_error = false;
165 ignore_breakpoints = false;
166 break;
167
168 case 'p':
169 top_level = true;
170 break;
171
172 case 'X': {
173 bool success;
Pavel Labath47cbf4a2018-04-10 09:03:59 +0000174 bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000175 if (success)
176 auto_apply_fixits = tmp_value ? eLazyBoolYes : eLazyBoolNo;
177 else
178 error.SetErrorStringWithFormat(
Zachary Turner8cef4b02016-09-23 17:48:13 +0000179 "could not convert \"%s\" to a boolean value.",
180 option_arg.str().c_str());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000181 break;
182 }
183
184 default:
185 error.SetErrorStringWithFormat("invalid short option character '%c'",
186 short_option);
187 break;
188 }
189
190 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000191}
192
Kate Stoneb9c1b512016-09-06 20:57:50 +0000193void CommandObjectExpression::CommandOptions::OptionParsingStarting(
194 ExecutionContext *execution_context) {
195 auto process_sp =
196 execution_context ? execution_context->GetProcessSP() : ProcessSP();
197 if (process_sp) {
198 ignore_breakpoints = process_sp->GetIgnoreBreakpointsInExpressions();
199 unwind_on_error = process_sp->GetUnwindOnErrorInExpressions();
200 } else {
201 ignore_breakpoints = true;
202 unwind_on_error = true;
203 }
204
205 show_summary = true;
206 try_all_threads = true;
207 timeout = 0;
208 debug = false;
209 language = eLanguageTypeUnknown;
210 m_verbosity = eLanguageRuntimeDescriptionDisplayVerbosityCompact;
211 auto_apply_fixits = eLazyBoolCalculate;
212 top_level = false;
213 allow_jit = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000214}
215
Zachary Turner1f0f5b52016-09-22 20:22:55 +0000216llvm::ArrayRef<OptionDefinition>
Kate Stoneb9c1b512016-09-06 20:57:50 +0000217CommandObjectExpression::CommandOptions::GetDefinitions() {
Zachary Turner70602432016-09-22 21:06:13 +0000218 return llvm::makeArrayRef(g_expression_options);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000219}
220
221CommandObjectExpression::CommandObjectExpression(
222 CommandInterpreter &interpreter)
Kate Stone7428a182016-07-14 22:03:10 +0000223 : CommandObjectRaw(
Kate Stoneb9c1b512016-09-06 20:57:50 +0000224 interpreter, "expression", "Evaluate an expression on the current "
225 "thread. Displays any returned value "
226 "with LLDB's default formatting.",
Zachary Turnera4496982016-10-05 21:14:38 +0000227 "", eCommandProcessMustBePaused | eCommandTryTargetAPILock),
Kate Stone7428a182016-07-14 22:03:10 +0000228 IOHandlerDelegate(IOHandlerDelegate::Completion::Expression),
Kate Stoneb9c1b512016-09-06 20:57:50 +0000229 m_option_group(), m_format_options(eFormatDefault),
230 m_repl_option(LLDB_OPT_SET_1, false, "repl", 'r', "Drop into REPL", false,
231 true),
232 m_command_options(), m_expr_line_count(0), m_expr_lines() {
233 SetHelpLong(
234 R"(
Jim Inghamd0309912017-07-19 23:25:42 +0000235Single and multi-line expressions:
236
237)"
238 " The expression provided on the command line must be a complete expression \
239with no newlines. To evaluate a multi-line expression, \
240hit a return after an empty expression, and lldb will enter the multi-line expression editor. \
241Hit return on an empty line to end the multi-line expression."
242
243 R"(
244
Kate Stoneea671fb2015-07-14 05:48:36 +0000245Timeouts:
246
Kate Stoneb9c1b512016-09-06 20:57:50 +0000247)"
248 " If the expression can be evaluated statically (without running code) then it will be. \
Kate Stoneea671fb2015-07-14 05:48:36 +0000249Otherwise, by default the expression will run on the current thread with a short timeout: \
250currently .25 seconds. If it doesn't return in that time, the evaluation will be interrupted \
251and resumed with all threads running. You can use the -a option to disable retrying on all \
Kate Stoneb9c1b512016-09-06 20:57:50 +0000252threads. You can use the -t option to set a shorter timeout."
253 R"(
Kate Stoneea671fb2015-07-14 05:48:36 +0000254
255User defined variables:
256
Kate Stoneb9c1b512016-09-06 20:57:50 +0000257)"
258 " You can define your own variables for convenience or to be used in subsequent expressions. \
Kate Stoneea671fb2015-07-14 05:48:36 +0000259You define them the same way you would define variables in C. If the first character of \
260your user defined variable is a $, then the variable's value will be available in future \
Kate Stoneb9c1b512016-09-06 20:57:50 +0000261expressions, otherwise it will just be available in the current expression."
262 R"(
Kate Stoneea671fb2015-07-14 05:48:36 +0000263
264Continuing evaluation after a breakpoint:
265
Kate Stoneb9c1b512016-09-06 20:57:50 +0000266)"
267 " If the \"-i false\" option is used, and execution is interrupted by a breakpoint hit, once \
Kate Stoneea671fb2015-07-14 05:48:36 +0000268you are done with your investigation, you can either remove the expression execution frames \
269from the stack with \"thread return -x\" or if you are still interested in the expression result \
270you can issue the \"continue\" command and the expression evaluation will complete and the \
271expression result will be available using the \"thread.completed-expression\" key in the thread \
Kate Stoneb9c1b512016-09-06 20:57:50 +0000272format."
Jim Inghamd0309912017-07-19 23:25:42 +0000273
Kate Stoneb9c1b512016-09-06 20:57:50 +0000274 R"(
Kate Stoneea671fb2015-07-14 05:48:36 +0000275
276Examples:
277
278 expr my_struct->a = my_array[3]
279 expr -f bin -- (index * 8) + 5
280 expr unsigned int $foo = 5
Kate Stoneb9c1b512016-09-06 20:57:50 +0000281 expr char c[] = \"foo\"; c[0])");
Caroline Tice405fe672010-10-04 22:28:36 +0000282
Kate Stoneb9c1b512016-09-06 20:57:50 +0000283 CommandArgumentEntry arg;
284 CommandArgumentData expression_arg;
Caroline Tice405fe672010-10-04 22:28:36 +0000285
Kate Stoneb9c1b512016-09-06 20:57:50 +0000286 // Define the first (and only) variant of this arg.
287 expression_arg.arg_type = eArgTypeExpression;
288 expression_arg.arg_repetition = eArgRepeatPlain;
Caroline Tice405fe672010-10-04 22:28:36 +0000289
Kate Stoneb9c1b512016-09-06 20:57:50 +0000290 // There is only one variant this argument could be; put it into the argument
291 // entry.
292 arg.push_back(expression_arg);
Caroline Tice405fe672010-10-04 22:28:36 +0000293
Kate Stoneb9c1b512016-09-06 20:57:50 +0000294 // Push the data for the first argument into the m_arguments vector.
295 m_arguments.push_back(arg);
296
297 // Add the "--format" and "--gdb-format"
298 m_option_group.Append(&m_format_options,
299 OptionGroupFormat::OPTION_GROUP_FORMAT |
300 OptionGroupFormat::OPTION_GROUP_GDB_FMT,
301 LLDB_OPT_SET_1);
302 m_option_group.Append(&m_command_options);
303 m_option_group.Append(&m_varobj_options, LLDB_OPT_SET_ALL,
304 LLDB_OPT_SET_1 | LLDB_OPT_SET_2);
305 m_option_group.Append(&m_repl_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_3);
306 m_option_group.Finalize();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000307}
308
Eugene Zelenkoc8ecc2a2016-02-19 19:33:46 +0000309CommandObjectExpression::~CommandObjectExpression() = default;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000310
Kate Stoneb9c1b512016-09-06 20:57:50 +0000311Options *CommandObjectExpression::GetOptions() { return &m_option_group; }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000312
Raphael Isemann74829732018-08-30 17:29:37 +0000313int CommandObjectExpression::HandleCompletion(CompletionRequest &request) {
314 EvaluateExpressionOptions options;
315 options.SetCoerceToId(m_varobj_options.use_objc);
316 options.SetLanguage(m_command_options.language);
317 options.SetExecutionPolicy(lldb_private::eExecutionPolicyNever);
318 options.SetAutoApplyFixIts(false);
319 options.SetGenerateDebugInfo(false);
320
321 // We need a valid execution context with a frame pointer for this
322 // completion, so if we don't have one we should try to make a valid
323 // execution context.
324 if (m_interpreter.GetExecutionContext().GetFramePtr() == nullptr)
325 m_interpreter.UpdateExecutionContext(nullptr);
326
327 // This didn't work, so let's get out before we start doing things that
328 // expect a valid frame pointer.
329 if (m_interpreter.GetExecutionContext().GetFramePtr() == nullptr)
330 return 0;
331
332 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext());
333
334 Target *target = exe_ctx.GetTargetPtr();
335
336 if (!target)
337 target = GetDummyTarget();
338
339 if (!target)
340 return 0;
341
342 unsigned cursor_pos = request.GetRawCursorPos();
343 llvm::StringRef code = request.GetRawLine();
344
345 const std::size_t original_code_size = code.size();
346
347 // Remove the first token which is 'expr' or some alias/abbreviation of that.
348 code = llvm::getToken(code).second.ltrim();
349 OptionsWithRaw args(code);
350 code = args.GetRawPart();
351
352 // The position where the expression starts in the command line.
353 assert(original_code_size >= code.size());
354 std::size_t raw_start = original_code_size - code.size();
355
356 // Check if the cursor is actually in the expression string, and if not, we
357 // exit.
358 // FIXME: We should complete the options here.
359 if (cursor_pos < raw_start)
360 return 0;
361
362 // Make the cursor_pos again relative to the start of the code string.
363 assert(cursor_pos >= raw_start);
364 cursor_pos -= raw_start;
365
366 auto language = exe_ctx.GetFrameRef().GetLanguage();
367
368 Status error;
369 lldb::UserExpressionSP expr(target->GetUserExpressionForLanguage(
370 code, llvm::StringRef(), language, UserExpression::eResultTypeAny,
371 options, error));
372 if (error.Fail())
373 return 0;
374
Raphael Isemannc11a7802018-08-30 21:26:32 +0000375 expr->Complete(exe_ctx, request, cursor_pos);
Raphael Isemann74829732018-08-30 17:29:37 +0000376 return request.GetNumberOfMatches();
377}
378
Zachary Turner97206d52017-05-12 04:51:55 +0000379static lldb_private::Status
Kate Stoneb9c1b512016-09-06 20:57:50 +0000380CanBeUsedForElementCountPrinting(ValueObject &valobj) {
381 CompilerType type(valobj.GetCompilerType());
382 CompilerType pointee;
383 if (!type.IsPointerType(&pointee))
Zachary Turner97206d52017-05-12 04:51:55 +0000384 return Status("as it does not refer to a pointer");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000385 if (pointee.IsVoidType())
Zachary Turner97206d52017-05-12 04:51:55 +0000386 return Status("as it refers to a pointer to void");
387 return Status();
Enrico Granata520a4222016-04-25 00:52:47 +0000388}
389
Raphael Isemann4d51a902018-07-12 22:28:52 +0000390bool CommandObjectExpression::EvaluateExpression(llvm::StringRef expr,
Kate Stoneb9c1b512016-09-06 20:57:50 +0000391 Stream *output_stream,
392 Stream *error_stream,
393 CommandReturnObject *result) {
Adrian Prantl05097242018-04-30 16:49:04 +0000394 // Don't use m_exe_ctx as this might be called asynchronously after the
395 // command object DoExecute has finished when doing multi-line expression
396 // that use an input reader...
Kate Stoneb9c1b512016-09-06 20:57:50 +0000397 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext());
Greg Claytonba7b8e22013-01-26 23:54:29 +0000398
Kate Stoneb9c1b512016-09-06 20:57:50 +0000399 Target *target = exe_ctx.GetTargetPtr();
Enrico Granatab576bba2013-01-09 20:12:53 +0000400
Kate Stoneb9c1b512016-09-06 20:57:50 +0000401 if (!target)
402 target = GetDummyTarget();
Dawn Perchik15663c52015-07-25 00:19:39 +0000403
Kate Stoneb9c1b512016-09-06 20:57:50 +0000404 if (target) {
405 lldb::ValueObjectSP result_valobj_sp;
406 bool keep_in_memory = true;
407 StackFrame *frame = exe_ctx.GetFramePtr();
Arnaud A. de Grandmaison62e5f4d2014-03-22 20:23:26 +0000408
Kate Stoneb9c1b512016-09-06 20:57:50 +0000409 EvaluateExpressionOptions options;
410 options.SetCoerceToId(m_varobj_options.use_objc);
411 options.SetUnwindOnError(m_command_options.unwind_on_error);
412 options.SetIgnoreBreakpoints(m_command_options.ignore_breakpoints);
413 options.SetKeepInMemory(keep_in_memory);
414 options.SetUseDynamic(m_varobj_options.use_dynamic);
415 options.SetTryAllThreads(m_command_options.try_all_threads);
416 options.SetDebug(m_command_options.debug);
417 options.SetLanguage(m_command_options.language);
418 options.SetExecutionPolicy(
419 m_command_options.allow_jit
420 ? EvaluateExpressionOptions::default_execution_policy
421 : lldb_private::eExecutionPolicyNever);
Sean Callanan4b388c92013-07-30 19:54:09 +0000422
Kate Stoneb9c1b512016-09-06 20:57:50 +0000423 bool auto_apply_fixits;
424 if (m_command_options.auto_apply_fixits == eLazyBoolCalculate)
425 auto_apply_fixits = target->GetEnableAutoApplyFixIts();
Greg Clayton8b2fe6d2010-12-14 02:59:59 +0000426 else
Kate Stoneb9c1b512016-09-06 20:57:50 +0000427 auto_apply_fixits =
428 m_command_options.auto_apply_fixits == eLazyBoolYes ? true : false;
429
430 options.SetAutoApplyFixIts(auto_apply_fixits);
431
432 if (m_command_options.top_level)
433 options.SetExecutionPolicy(eExecutionPolicyTopLevel);
434
Adrian Prantl05097242018-04-30 16:49:04 +0000435 // If there is any chance we are going to stop and want to see what went
436 // wrong with our expression, we should generate debug info
Kate Stoneb9c1b512016-09-06 20:57:50 +0000437 if (!m_command_options.ignore_breakpoints ||
438 !m_command_options.unwind_on_error)
439 options.SetGenerateDebugInfo(true);
440
441 if (m_command_options.timeout > 0)
Pavel Labath43d35412016-12-06 11:24:51 +0000442 options.SetTimeout(std::chrono::microseconds(m_command_options.timeout));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000443 else
Pavel Labath43d35412016-12-06 11:24:51 +0000444 options.SetTimeout(llvm::None);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000445
446 ExpressionResults success = target->EvaluateExpression(
447 expr, frame, result_valobj_sp, options, &m_fixed_expression);
448
449 // We only tell you about the FixIt if we applied it. The compiler errors
450 // will suggest the FixIt if it parsed.
451 if (error_stream && !m_fixed_expression.empty() &&
452 target->GetEnableNotifyAboutFixIts()) {
453 if (success == eExpressionCompleted)
454 error_stream->Printf(
455 " Fix-it applied, fixed expression was: \n %s\n",
456 m_fixed_expression.c_str());
Sean Callananebf77072010-07-23 00:16:21 +0000457 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000458
459 if (result_valobj_sp) {
460 Format format = m_format_options.GetFormat();
461
462 if (result_valobj_sp->GetError().Success()) {
463 if (format != eFormatVoid) {
464 if (format != eFormatDefault)
465 result_valobj_sp->SetFormat(format);
466
467 if (m_varobj_options.elem_count > 0) {
Zachary Turner97206d52017-05-12 04:51:55 +0000468 Status error(CanBeUsedForElementCountPrinting(*result_valobj_sp));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000469 if (error.Fail()) {
470 result->AppendErrorWithFormat(
471 "expression cannot be used with --element-count %s\n",
472 error.AsCString(""));
473 result->SetStatus(eReturnStatusFailed);
474 return false;
475 }
476 }
477
478 DumpValueObjectOptions options(m_varobj_options.GetAsDumpOptions(
479 m_command_options.m_verbosity, format));
480 options.SetVariableFormatDisplayLanguage(
481 result_valobj_sp->GetPreferredDisplayLanguage());
482
483 result_valobj_sp->Dump(*output_stream, options);
484
485 if (result)
486 result->SetStatus(eReturnStatusSuccessFinishResult);
487 }
488 } else {
489 if (result_valobj_sp->GetError().GetError() ==
Krasimir Georgieva35912d2018-10-18 03:10:43 +0000490 UserExpression::kNoResult) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000491 if (format != eFormatVoid &&
492 m_interpreter.GetDebugger().GetNotifyVoid()) {
493 error_stream->PutCString("(void)\n");
494 }
495
496 if (result)
497 result->SetStatus(eReturnStatusSuccessFinishResult);
498 } else {
499 const char *error_cstr = result_valobj_sp->GetError().AsCString();
500 if (error_cstr && error_cstr[0]) {
501 const size_t error_cstr_len = strlen(error_cstr);
502 const bool ends_with_newline =
503 error_cstr[error_cstr_len - 1] == '\n';
504 if (strstr(error_cstr, "error:") != error_cstr)
505 error_stream->PutCString("error: ");
506 error_stream->Write(error_cstr, error_cstr_len);
507 if (!ends_with_newline)
508 error_stream->EOL();
509 } else {
510 error_stream->PutCString("error: unknown error\n");
511 }
512
513 if (result)
514 result->SetStatus(eReturnStatusFailed);
515 }
516 }
517 }
518 } else {
519 error_stream->Printf("error: invalid execution context for expression\n");
520 return false;
521 }
522
523 return true;
524}
525
526void CommandObjectExpression::IOHandlerInputComplete(IOHandler &io_handler,
527 std::string &line) {
528 io_handler.SetIsDone(true);
529 // StreamSP output_stream =
530 // io_handler.GetDebugger().GetAsyncOutputStream();
531 // StreamSP error_stream = io_handler.GetDebugger().GetAsyncErrorStream();
532 StreamFileSP output_sp(io_handler.GetOutputStreamFile());
533 StreamFileSP error_sp(io_handler.GetErrorStreamFile());
534
535 EvaluateExpression(line.c_str(), output_sp.get(), error_sp.get());
536 if (output_sp)
537 output_sp->Flush();
538 if (error_sp)
539 error_sp->Flush();
540}
541
542bool CommandObjectExpression::IOHandlerIsInputComplete(IOHandler &io_handler,
543 StringList &lines) {
544 // An empty lines is used to indicate the end of input
545 const size_t num_lines = lines.GetSize();
546 if (num_lines > 0 && lines[num_lines - 1].empty()) {
Adrian Prantl05097242018-04-30 16:49:04 +0000547 // Remove the last empty line from "lines" so it doesn't appear in our
548 // resulting input and return true to indicate we are done getting lines
Kate Stoneb9c1b512016-09-06 20:57:50 +0000549 lines.PopBack();
Sean Callananebf77072010-07-23 00:16:21 +0000550 return true;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000551 }
552 return false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000553}
554
Kate Stoneb9c1b512016-09-06 20:57:50 +0000555void CommandObjectExpression::GetMultilineExpression() {
556 m_expr_lines.clear();
557 m_expr_line_count = 0;
Greg Clayton44d93782014-01-27 23:43:24 +0000558
Kate Stoneb9c1b512016-09-06 20:57:50 +0000559 Debugger &debugger = GetCommandInterpreter().GetDebugger();
560 bool color_prompt = debugger.GetUseColor();
561 const bool multiple_lines = true; // Get multiple lines
562 IOHandlerSP io_handler_sp(
563 new IOHandlerEditline(debugger, IOHandler::Type::Expression,
564 "lldb-expr", // Name of input reader for history
Zachary Turner514d8cd2016-09-23 18:06:53 +0000565 llvm::StringRef(), // No prompt
566 llvm::StringRef(), // Continuation prompt
Kate Stoneb9c1b512016-09-06 20:57:50 +0000567 multiple_lines, color_prompt,
568 1, // Show line numbers starting at 1
569 *this));
570
571 StreamFileSP output_sp(io_handler_sp->GetOutputStreamFile());
572 if (output_sp) {
573 output_sp->PutCString(
574 "Enter expressions, then terminate with an empty line to evaluate:\n");
575 output_sp->Flush();
576 }
577 debugger.PushIOHandler(io_handler_sp);
Greg Clayton44d93782014-01-27 23:43:24 +0000578}
579
Raphael Isemann4d51a902018-07-12 22:28:52 +0000580bool CommandObjectExpression::DoExecute(llvm::StringRef command,
Kate Stoneb9c1b512016-09-06 20:57:50 +0000581 CommandReturnObject &result) {
582 m_fixed_expression.clear();
583 auto exe_ctx = GetCommandInterpreter().GetExecutionContext();
584 m_option_group.NotifyOptionParsingStarting(&exe_ctx);
Greg Clayton44d93782014-01-27 23:43:24 +0000585
Raphael Isemann4d51a902018-07-12 22:28:52 +0000586 if (command.empty()) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000587 GetMultilineExpression();
588 return result.Succeeded();
589 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000590
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000591 OptionsWithRaw args(command);
Raphael Isemann4d51a902018-07-12 22:28:52 +0000592 llvm::StringRef expr = args.GetRawPart();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000593
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000594 if (args.HasArgs()) {
595 if (!ParseOptionsAndNotify(args.GetArgs(), result, m_option_group, exe_ctx))
596 return false;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000597
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000598 if (m_repl_option.GetOptionValue().GetCurrentValue()) {
599 Target *target = m_interpreter.GetExecutionContext().GetTargetPtr();
600 if (target) {
601 // Drop into REPL
602 m_expr_lines.clear();
603 m_expr_line_count = 0;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000604
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000605 Debugger &debugger = target->GetDebugger();
Johnny Chenfcd43b72010-08-13 00:42:30 +0000606
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000607 // Check if the LLDB command interpreter is sitting on top of a REPL
608 // that launched it...
609 if (debugger.CheckTopIOHandlerTypes(IOHandler::Type::CommandInterpreter,
610 IOHandler::Type::REPL)) {
611 // the LLDB command interpreter is sitting on top of a REPL that
612 // launched it, so just say the command interpreter is done and
613 // fall back to the existing REPL
614 m_interpreter.GetIOHandler(false)->SetIsDone(true);
615 } else {
616 // We are launching the REPL on top of the current LLDB command
617 // interpreter, so just push one
618 bool initialize = false;
619 Status repl_error;
620 REPLSP repl_sp(target->GetREPL(repl_error, m_command_options.language,
621 nullptr, false));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000622
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000623 if (!repl_sp) {
624 initialize = true;
625 repl_sp = target->GetREPL(repl_error, m_command_options.language,
626 nullptr, true);
627 if (!repl_error.Success()) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000628 result.SetError(repl_error);
629 return result.Succeeded();
630 }
631 }
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000632
633 if (repl_sp) {
634 if (initialize) {
635 repl_sp->SetCommandOptions(m_command_options);
636 repl_sp->SetFormatOptions(m_format_options);
637 repl_sp->SetValueObjectDisplayOptions(m_varobj_options);
638 }
639
640 IOHandlerSP io_handler_sp(repl_sp->GetIOHandler());
641
642 io_handler_sp->SetIsDone(false);
643
644 debugger.PushIOHandler(io_handler_sp);
645 } else {
646 repl_error.SetErrorStringWithFormat(
647 "Couldn't create a REPL for %s",
648 Language::GetNameForLanguageType(m_command_options.language));
649 result.SetError(repl_error);
650 return result.Succeeded();
651 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000652 }
653 }
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000654 }
655 // No expression following options
Raphael Isemann4d51a902018-07-12 22:28:52 +0000656 else if (expr.empty()) {
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000657 GetMultilineExpression();
658 return result.Succeeded();
Kate Stoneb9c1b512016-09-06 20:57:50 +0000659 }
660 }
661
Davide Italiano0df817a2018-04-13 18:37:14 +0000662 Target *target = GetSelectedOrDummyTarget();
Kate Stoneb9c1b512016-09-06 20:57:50 +0000663 if (EvaluateExpression(expr, &(result.GetOutputStream()),
664 &(result.GetErrorStream()), &result)) {
Jim Ingham981da8d2016-10-17 23:59:41 +0000665
Kate Stoneb9c1b512016-09-06 20:57:50 +0000666 if (!m_fixed_expression.empty() && target->GetEnableNotifyAboutFixIts()) {
667 CommandHistory &history = m_interpreter.GetCommandHistory();
668 // FIXME: Can we figure out what the user actually typed (e.g. some alias
669 // for expr???)
670 // If we can it would be nice to show that.
671 std::string fixed_command("expression ");
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000672 if (args.HasArgs()) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000673 // Add in any options that might have been in the original command:
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000674 fixed_command.append(args.GetArgStringWithDelimiter());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000675 fixed_command.append(m_fixed_expression);
Raphael Isemann3a0e1272018-07-10 20:17:38 +0000676 } else
677 fixed_command.append(m_fixed_expression);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000678 history.AppendString(fixed_command);
679 }
Adrian Prantl05097242018-04-30 16:49:04 +0000680 // Increment statistics to record this expression evaluation success.
Davide Italiano24fff242018-04-13 18:02:39 +0000681 target->IncrementStats(StatisticKind::ExpressionSuccessful);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000682 return true;
683 }
684
Adrian Prantl05097242018-04-30 16:49:04 +0000685 // Increment statistics to record this expression evaluation failure.
Davide Italiano24fff242018-04-13 18:02:39 +0000686 target->IncrementStats(StatisticKind::ExpressionFailure);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000687 result.SetStatus(eReturnStatusFailed);
688 return false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000689}