|
150
|
1 //===-- UserExpression.cpp ------------------------------------------------===//
|
|
|
2 //
|
|
|
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
|
4 // See https://llvm.org/LICENSE.txt for license information.
|
|
|
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
6 //
|
|
|
7 //===----------------------------------------------------------------------===//
|
|
|
8
|
|
|
9 #include "lldb/Host/Config.h"
|
|
|
10
|
|
|
11 #include <stdio.h>
|
|
|
12 #if HAVE_SYS_TYPES_H
|
|
|
13 #include <sys/types.h>
|
|
|
14 #endif
|
|
|
15
|
|
|
16 #include <cstdlib>
|
|
|
17 #include <map>
|
|
|
18 #include <string>
|
|
|
19
|
|
|
20 #include "lldb/Core/Module.h"
|
|
|
21 #include "lldb/Core/StreamFile.h"
|
|
|
22 #include "lldb/Core/ValueObjectConstResult.h"
|
|
|
23 #include "lldb/Expression/DiagnosticManager.h"
|
|
|
24 #include "lldb/Expression/ExpressionVariable.h"
|
|
|
25 #include "lldb/Expression/IRExecutionUnit.h"
|
|
|
26 #include "lldb/Expression/IRInterpreter.h"
|
|
|
27 #include "lldb/Expression/Materializer.h"
|
|
|
28 #include "lldb/Expression/UserExpression.h"
|
|
|
29 #include "lldb/Host/HostInfo.h"
|
|
|
30 #include "lldb/Symbol/Block.h"
|
|
|
31 #include "lldb/Symbol/Function.h"
|
|
|
32 #include "lldb/Symbol/ObjectFile.h"
|
|
|
33 #include "lldb/Symbol/SymbolVendor.h"
|
|
|
34 #include "lldb/Symbol/Type.h"
|
|
|
35 #include "lldb/Symbol/TypeSystem.h"
|
|
|
36 #include "lldb/Symbol/VariableList.h"
|
|
|
37 #include "lldb/Target/ExecutionContext.h"
|
|
|
38 #include "lldb/Target/Process.h"
|
|
|
39 #include "lldb/Target/StackFrame.h"
|
|
|
40 #include "lldb/Target/Target.h"
|
|
|
41 #include "lldb/Target/ThreadPlan.h"
|
|
|
42 #include "lldb/Target/ThreadPlanCallUserExpression.h"
|
|
|
43 #include "lldb/Utility/ConstString.h"
|
|
|
44 #include "lldb/Utility/Log.h"
|
|
|
45 #include "lldb/Utility/StreamString.h"
|
|
|
46
|
|
|
47 using namespace lldb_private;
|
|
|
48
|
|
|
49 char UserExpression::ID;
|
|
|
50
|
|
|
51 UserExpression::UserExpression(ExecutionContextScope &exe_scope,
|
|
|
52 llvm::StringRef expr, llvm::StringRef prefix,
|
|
|
53 lldb::LanguageType language,
|
|
|
54 ResultType desired_type,
|
|
|
55 const EvaluateExpressionOptions &options)
|
|
|
56 : Expression(exe_scope), m_expr_text(std::string(expr)),
|
|
|
57 m_expr_prefix(std::string(prefix)), m_language(language),
|
|
|
58 m_desired_type(desired_type), m_options(options) {}
|
|
|
59
|
|
|
60 UserExpression::~UserExpression() {}
|
|
|
61
|
|
|
62 void UserExpression::InstallContext(ExecutionContext &exe_ctx) {
|
|
|
63 m_jit_process_wp = exe_ctx.GetProcessSP();
|
|
|
64
|
|
|
65 lldb::StackFrameSP frame_sp = exe_ctx.GetFrameSP();
|
|
|
66
|
|
|
67 if (frame_sp)
|
|
|
68 m_address = frame_sp->GetFrameCodeAddress();
|
|
|
69 }
|
|
|
70
|
|
|
71 bool UserExpression::LockAndCheckContext(ExecutionContext &exe_ctx,
|
|
|
72 lldb::TargetSP &target_sp,
|
|
|
73 lldb::ProcessSP &process_sp,
|
|
|
74 lldb::StackFrameSP &frame_sp) {
|
|
|
75 lldb::ProcessSP expected_process_sp = m_jit_process_wp.lock();
|
|
|
76 process_sp = exe_ctx.GetProcessSP();
|
|
|
77
|
|
|
78 if (process_sp != expected_process_sp)
|
|
|
79 return false;
|
|
|
80
|
|
|
81 process_sp = exe_ctx.GetProcessSP();
|
|
|
82 target_sp = exe_ctx.GetTargetSP();
|
|
|
83 frame_sp = exe_ctx.GetFrameSP();
|
|
|
84
|
|
|
85 if (m_address.IsValid()) {
|
|
|
86 if (!frame_sp)
|
|
|
87 return false;
|
|
|
88 return (Address::CompareLoadAddress(m_address,
|
|
|
89 frame_sp->GetFrameCodeAddress(),
|
|
|
90 target_sp.get()) == 0);
|
|
|
91 }
|
|
|
92
|
|
|
93 return true;
|
|
|
94 }
|
|
|
95
|
|
|
96 bool UserExpression::MatchesContext(ExecutionContext &exe_ctx) {
|
|
|
97 lldb::TargetSP target_sp;
|
|
|
98 lldb::ProcessSP process_sp;
|
|
|
99 lldb::StackFrameSP frame_sp;
|
|
|
100
|
|
|
101 return LockAndCheckContext(exe_ctx, target_sp, process_sp, frame_sp);
|
|
|
102 }
|
|
|
103
|
|
|
104 lldb::addr_t UserExpression::GetObjectPointer(lldb::StackFrameSP frame_sp,
|
|
|
105 ConstString &object_name,
|
|
|
106 Status &err) {
|
|
|
107 err.Clear();
|
|
|
108
|
|
|
109 if (!frame_sp) {
|
|
|
110 err.SetErrorStringWithFormat(
|
|
|
111 "Couldn't load '%s' because the context is incomplete",
|
|
|
112 object_name.AsCString());
|
|
|
113 return LLDB_INVALID_ADDRESS;
|
|
|
114 }
|
|
|
115
|
|
|
116 lldb::VariableSP var_sp;
|
|
|
117 lldb::ValueObjectSP valobj_sp;
|
|
|
118
|
|
|
119 valobj_sp = frame_sp->GetValueForVariableExpressionPath(
|
|
|
120 object_name.GetStringRef(), lldb::eNoDynamicValues,
|
|
|
121 StackFrame::eExpressionPathOptionCheckPtrVsMember |
|
|
|
122 StackFrame::eExpressionPathOptionsNoFragileObjcIvar |
|
|
|
123 StackFrame::eExpressionPathOptionsNoSyntheticChildren |
|
|
|
124 StackFrame::eExpressionPathOptionsNoSyntheticArrayRange,
|
|
|
125 var_sp, err);
|
|
|
126
|
|
|
127 if (!err.Success() || !valobj_sp.get())
|
|
|
128 return LLDB_INVALID_ADDRESS;
|
|
|
129
|
|
|
130 lldb::addr_t ret = valobj_sp->GetValueAsUnsigned(LLDB_INVALID_ADDRESS);
|
|
|
131
|
|
|
132 if (ret == LLDB_INVALID_ADDRESS) {
|
|
|
133 err.SetErrorStringWithFormat(
|
|
|
134 "Couldn't load '%s' because its value couldn't be evaluated",
|
|
|
135 object_name.AsCString());
|
|
|
136 return LLDB_INVALID_ADDRESS;
|
|
|
137 }
|
|
|
138
|
|
|
139 return ret;
|
|
|
140 }
|
|
|
141
|
|
|
142 lldb::ExpressionResults
|
|
|
143 UserExpression::Evaluate(ExecutionContext &exe_ctx,
|
|
|
144 const EvaluateExpressionOptions &options,
|
|
|
145 llvm::StringRef expr, llvm::StringRef prefix,
|
|
|
146 lldb::ValueObjectSP &result_valobj_sp, Status &error,
|
|
|
147 std::string *fixed_expression, ValueObject *ctx_obj) {
|
|
|
148 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EXPRESSIONS |
|
|
|
149 LIBLLDB_LOG_STEP));
|
|
|
150
|
|
|
151 if (ctx_obj) {
|
|
|
152 static unsigned const ctx_type_mask =
|
|
|
153 lldb::TypeFlags::eTypeIsClass | lldb::TypeFlags::eTypeIsStructUnion;
|
|
|
154 if (!(ctx_obj->GetTypeInfo() & ctx_type_mask)) {
|
|
|
155 LLDB_LOG(log, "== [UserExpression::Evaluate] Passed a context object of "
|
|
|
156 "an invalid type, can't run expressions.");
|
|
|
157 error.SetErrorString("a context object of an invalid type passed");
|
|
|
158 return lldb::eExpressionSetupError;
|
|
|
159 }
|
|
|
160 }
|
|
|
161
|
|
|
162 lldb_private::ExecutionPolicy execution_policy = options.GetExecutionPolicy();
|
|
|
163 lldb::LanguageType language = options.GetLanguage();
|
|
|
164 const ResultType desired_type = options.DoesCoerceToId()
|
|
|
165 ? UserExpression::eResultTypeId
|
|
|
166 : UserExpression::eResultTypeAny;
|
|
|
167 lldb::ExpressionResults execution_results = lldb::eExpressionSetupError;
|
|
|
168
|
|
|
169 Target *target = exe_ctx.GetTargetPtr();
|
|
|
170 if (!target) {
|
|
|
171 LLDB_LOGF(log, "== [UserExpression::Evaluate] Passed a NULL target, can't "
|
|
|
172 "run expressions.");
|
|
|
173 error.SetErrorString("expression passed a null target");
|
|
|
174 return lldb::eExpressionSetupError;
|
|
|
175 }
|
|
|
176
|
|
|
177 Process *process = exe_ctx.GetProcessPtr();
|
|
|
178
|
|
|
179 if (process == nullptr || process->GetState() != lldb::eStateStopped) {
|
|
|
180 if (execution_policy == eExecutionPolicyAlways) {
|
|
|
181 LLDB_LOGF(log,
|
|
|
182 "== [UserExpression::Evaluate] Expression may not run, but "
|
|
|
183 "is not constant ==");
|
|
|
184
|
|
|
185 error.SetErrorString("expression needed to run but couldn't");
|
|
|
186
|
|
|
187 return execution_results;
|
|
|
188 }
|
|
|
189 }
|
|
|
190
|
|
|
191 if (process == nullptr || !process->CanJIT())
|
|
|
192 execution_policy = eExecutionPolicyNever;
|
|
|
193
|
|
|
194 // We need to set the expression execution thread here, turns out parse can
|
|
|
195 // call functions in the process of looking up symbols, which will escape the
|
|
|
196 // context set by exe_ctx passed to Execute.
|
|
|
197 lldb::ThreadSP thread_sp = exe_ctx.GetThreadSP();
|
|
|
198 ThreadList::ExpressionExecutionThreadPusher execution_thread_pusher(
|
|
|
199 thread_sp);
|
|
|
200
|
|
|
201 llvm::StringRef full_prefix;
|
|
|
202 llvm::StringRef option_prefix(options.GetPrefix());
|
|
|
203 std::string full_prefix_storage;
|
|
|
204 if (!prefix.empty() && !option_prefix.empty()) {
|
|
|
205 full_prefix_storage = std::string(prefix);
|
|
|
206 full_prefix_storage.append(std::string(option_prefix));
|
|
|
207 full_prefix = full_prefix_storage;
|
|
|
208 } else if (!prefix.empty())
|
|
|
209 full_prefix = prefix;
|
|
|
210 else
|
|
|
211 full_prefix = option_prefix;
|
|
|
212
|
|
|
213 // If the language was not specified in the expression command, set it to the
|
|
|
214 // language in the target's properties if specified, else default to the
|
|
|
215 // langage for the frame.
|
|
|
216 if (language == lldb::eLanguageTypeUnknown) {
|
|
|
217 if (target->GetLanguage() != lldb::eLanguageTypeUnknown)
|
|
|
218 language = target->GetLanguage();
|
|
|
219 else if (StackFrame *frame = exe_ctx.GetFramePtr())
|
|
|
220 language = frame->GetLanguage();
|
|
|
221 }
|
|
|
222
|
|
|
223 lldb::UserExpressionSP user_expression_sp(
|
|
|
224 target->GetUserExpressionForLanguage(expr, full_prefix, language,
|
|
|
225 desired_type, options, ctx_obj,
|
|
|
226 error));
|
|
|
227 if (error.Fail()) {
|
|
|
228 if (log)
|
|
|
229 LLDB_LOGF(log, "== [UserExpression::Evaluate] Getting expression: %s ==",
|
|
|
230 error.AsCString());
|
|
|
231 return lldb::eExpressionSetupError;
|
|
|
232 }
|
|
|
233
|
|
|
234 if (log)
|
|
|
235 LLDB_LOGF(log, "== [UserExpression::Evaluate] Parsing expression %s ==",
|
|
|
236 expr.str().c_str());
|
|
|
237
|
|
|
238 const bool keep_expression_in_memory = true;
|
|
|
239 const bool generate_debug_info = options.GetGenerateDebugInfo();
|
|
|
240
|
|
|
241 if (options.InvokeCancelCallback(lldb::eExpressionEvaluationParse)) {
|
|
|
242 error.SetErrorString("expression interrupted by callback before parse");
|
|
|
243 result_valobj_sp = ValueObjectConstResult::Create(
|
|
|
244 exe_ctx.GetBestExecutionContextScope(), error);
|
|
|
245 return lldb::eExpressionInterrupted;
|
|
|
246 }
|
|
|
247
|
|
|
248 DiagnosticManager diagnostic_manager;
|
|
|
249
|
|
|
250 bool parse_success =
|
|
|
251 user_expression_sp->Parse(diagnostic_manager, exe_ctx, execution_policy,
|
|
|
252 keep_expression_in_memory, generate_debug_info);
|
|
|
253
|
|
|
254 // Calculate the fixed expression always, since we need it for errors.
|
|
|
255 std::string tmp_fixed_expression;
|
|
|
256 if (fixed_expression == nullptr)
|
|
|
257 fixed_expression = &tmp_fixed_expression;
|
|
|
258
|
|
|
259 const char *fixed_text = user_expression_sp->GetFixedText();
|
|
|
260 if (fixed_text != nullptr)
|
|
|
261 fixed_expression->append(fixed_text);
|
|
|
262
|
|
|
263 // If there is a fixed expression, try to parse it:
|
|
|
264 if (!parse_success) {
|
|
|
265 execution_results = lldb::eExpressionParseError;
|
|
|
266 if (fixed_expression && !fixed_expression->empty() &&
|
|
|
267 options.GetAutoApplyFixIts()) {
|
|
|
268 lldb::UserExpressionSP fixed_expression_sp(
|
|
|
269 target->GetUserExpressionForLanguage(fixed_expression->c_str(),
|
|
|
270 full_prefix, language,
|
|
|
271 desired_type, options, ctx_obj,
|
|
|
272 error));
|
|
|
273 DiagnosticManager fixed_diagnostic_manager;
|
|
|
274 parse_success = fixed_expression_sp->Parse(
|
|
|
275 fixed_diagnostic_manager, exe_ctx, execution_policy,
|
|
|
276 keep_expression_in_memory, generate_debug_info);
|
|
|
277 if (parse_success) {
|
|
|
278 diagnostic_manager.Clear();
|
|
|
279 user_expression_sp = fixed_expression_sp;
|
|
|
280 } else {
|
|
|
281 // If the fixed expression failed to parse, don't tell the user about,
|
|
|
282 // that won't help.
|
|
|
283 fixed_expression->clear();
|
|
|
284 }
|
|
|
285 }
|
|
|
286
|
|
|
287 if (!parse_success) {
|
|
|
288 if (!fixed_expression->empty() && target->GetEnableNotifyAboutFixIts()) {
|
|
|
289 error.SetExpressionErrorWithFormat(
|
|
|
290 execution_results,
|
|
|
291 "expression failed to parse, fixed expression suggested:\n %s",
|
|
|
292 fixed_expression->c_str());
|
|
|
293 } else {
|
|
|
294 if (!diagnostic_manager.Diagnostics().size())
|
|
|
295 error.SetExpressionError(execution_results,
|
|
|
296 "expression failed to parse, unknown error");
|
|
|
297 else
|
|
|
298 error.SetExpressionError(execution_results,
|
|
|
299 diagnostic_manager.GetString().c_str());
|
|
|
300 }
|
|
|
301 }
|
|
|
302 }
|
|
|
303
|
|
|
304 if (parse_success) {
|
|
|
305 lldb::ExpressionVariableSP expr_result;
|
|
|
306
|
|
|
307 if (execution_policy == eExecutionPolicyNever &&
|
|
|
308 !user_expression_sp->CanInterpret()) {
|
|
|
309 if (log)
|
|
|
310 LLDB_LOGF(log,
|
|
|
311 "== [UserExpression::Evaluate] Expression may not run, but "
|
|
|
312 "is not constant ==");
|
|
|
313
|
|
|
314 if (!diagnostic_manager.Diagnostics().size())
|
|
|
315 error.SetExpressionError(lldb::eExpressionSetupError,
|
|
|
316 "expression needed to run but couldn't");
|
|
|
317 } else if (execution_policy == eExecutionPolicyTopLevel) {
|
|
|
318 error.SetError(UserExpression::kNoResult, lldb::eErrorTypeGeneric);
|
|
|
319 return lldb::eExpressionCompleted;
|
|
|
320 } else {
|
|
|
321 if (options.InvokeCancelCallback(lldb::eExpressionEvaluationExecution)) {
|
|
|
322 error.SetExpressionError(
|
|
|
323 lldb::eExpressionInterrupted,
|
|
|
324 "expression interrupted by callback before execution");
|
|
|
325 result_valobj_sp = ValueObjectConstResult::Create(
|
|
|
326 exe_ctx.GetBestExecutionContextScope(), error);
|
|
|
327 return lldb::eExpressionInterrupted;
|
|
|
328 }
|
|
|
329
|
|
|
330 diagnostic_manager.Clear();
|
|
|
331
|
|
|
332 if (log)
|
|
|
333 LLDB_LOGF(log, "== [UserExpression::Evaluate] Executing expression ==");
|
|
|
334
|
|
|
335 execution_results =
|
|
|
336 user_expression_sp->Execute(diagnostic_manager, exe_ctx, options,
|
|
|
337 user_expression_sp, expr_result);
|
|
|
338
|
|
|
339 if (execution_results != lldb::eExpressionCompleted) {
|
|
|
340 if (log)
|
|
|
341 LLDB_LOGF(log, "== [UserExpression::Evaluate] Execution completed "
|
|
|
342 "abnormally ==");
|
|
|
343
|
|
|
344 if (!diagnostic_manager.Diagnostics().size())
|
|
|
345 error.SetExpressionError(
|
|
|
346 execution_results, "expression failed to execute, unknown error");
|
|
|
347 else
|
|
|
348 error.SetExpressionError(execution_results,
|
|
|
349 diagnostic_manager.GetString().c_str());
|
|
|
350 } else {
|
|
|
351 if (expr_result) {
|
|
|
352 result_valobj_sp = expr_result->GetValueObject();
|
|
|
353
|
|
|
354 if (log)
|
|
|
355 LLDB_LOGF(log,
|
|
|
356 "== [UserExpression::Evaluate] Execution completed "
|
|
|
357 "normally with result %s ==",
|
|
|
358 result_valobj_sp->GetValueAsCString());
|
|
|
359 } else {
|
|
|
360 if (log)
|
|
|
361 LLDB_LOGF(log, "== [UserExpression::Evaluate] Execution completed "
|
|
|
362 "normally with no result ==");
|
|
|
363
|
|
|
364 error.SetError(UserExpression::kNoResult, lldb::eErrorTypeGeneric);
|
|
|
365 }
|
|
|
366 }
|
|
|
367 }
|
|
|
368 }
|
|
|
369
|
|
|
370 if (options.InvokeCancelCallback(lldb::eExpressionEvaluationComplete)) {
|
|
|
371 error.SetExpressionError(
|
|
|
372 lldb::eExpressionInterrupted,
|
|
|
373 "expression interrupted by callback after complete");
|
|
|
374 return lldb::eExpressionInterrupted;
|
|
|
375 }
|
|
|
376
|
|
|
377 if (result_valobj_sp.get() == nullptr) {
|
|
|
378 result_valobj_sp = ValueObjectConstResult::Create(
|
|
|
379 exe_ctx.GetBestExecutionContextScope(), error);
|
|
|
380 }
|
|
|
381
|
|
|
382 return execution_results;
|
|
|
383 }
|
|
|
384
|
|
|
385 lldb::ExpressionResults
|
|
|
386 UserExpression::Execute(DiagnosticManager &diagnostic_manager,
|
|
|
387 ExecutionContext &exe_ctx,
|
|
|
388 const EvaluateExpressionOptions &options,
|
|
|
389 lldb::UserExpressionSP &shared_ptr_to_me,
|
|
|
390 lldb::ExpressionVariableSP &result_var) {
|
|
|
391 lldb::ExpressionResults expr_result = DoExecute(
|
|
|
392 diagnostic_manager, exe_ctx, options, shared_ptr_to_me, result_var);
|
|
|
393 Target *target = exe_ctx.GetTargetPtr();
|
|
|
394 if (options.GetResultIsInternal() && result_var && target) {
|
|
|
395 if (auto *persistent_state =
|
|
|
396 target->GetPersistentExpressionStateForLanguage(m_language))
|
|
|
397 persistent_state->RemovePersistentVariable(result_var);
|
|
|
398 }
|
|
|
399 return expr_result;
|
|
|
400 }
|
