1dda28197Spatrick //===-- ThreadPlanCallUserExpression.cpp ----------------------------------===//
2061da546Spatrick //
3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information.
5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6061da546Spatrick //
7061da546Spatrick //===----------------------------------------------------------------------===//
8061da546Spatrick
9061da546Spatrick #include "lldb/Target/ThreadPlanCallUserExpression.h"
10061da546Spatrick
11061da546Spatrick #include "lldb/Breakpoint/Breakpoint.h"
12061da546Spatrick #include "lldb/Breakpoint/BreakpointLocation.h"
13061da546Spatrick #include "lldb/Core/Address.h"
14061da546Spatrick #include "lldb/Expression/DiagnosticManager.h"
15061da546Spatrick #include "lldb/Expression/DynamicCheckerFunctions.h"
16061da546Spatrick #include "lldb/Expression/UserExpression.h"
17061da546Spatrick #include "lldb/Host/HostInfo.h"
18061da546Spatrick #include "lldb/Target/LanguageRuntime.h"
19061da546Spatrick #include "lldb/Target/Process.h"
20061da546Spatrick #include "lldb/Target/RegisterContext.h"
21061da546Spatrick #include "lldb/Target/StopInfo.h"
22061da546Spatrick #include "lldb/Target/Target.h"
23061da546Spatrick #include "lldb/Target/Thread.h"
24061da546Spatrick #include "lldb/Target/ThreadPlanRunToAddress.h"
25*f6aab3d8Srobert #include "lldb/Utility/LLDBLog.h"
26061da546Spatrick #include "lldb/Utility/Log.h"
27061da546Spatrick #include "lldb/Utility/Stream.h"
28061da546Spatrick
29061da546Spatrick using namespace lldb;
30061da546Spatrick using namespace lldb_private;
31061da546Spatrick
32061da546Spatrick // ThreadPlanCallUserExpression: Plan to call a single function
33061da546Spatrick
ThreadPlanCallUserExpression(Thread & thread,Address & function,llvm::ArrayRef<lldb::addr_t> args,const EvaluateExpressionOptions & options,lldb::UserExpressionSP & user_expression_sp)34061da546Spatrick ThreadPlanCallUserExpression::ThreadPlanCallUserExpression(
35061da546Spatrick Thread &thread, Address &function, llvm::ArrayRef<lldb::addr_t> args,
36061da546Spatrick const EvaluateExpressionOptions &options,
37061da546Spatrick lldb::UserExpressionSP &user_expression_sp)
38061da546Spatrick : ThreadPlanCallFunction(thread, function, CompilerType(), args, options),
39061da546Spatrick m_user_expression_sp(user_expression_sp) {
40061da546Spatrick // User expressions are generally "User generated" so we should set them up
41061da546Spatrick // to stop when done.
42*f6aab3d8Srobert SetIsControllingPlan(true);
43061da546Spatrick SetOkayToDiscard(false);
44061da546Spatrick }
45061da546Spatrick
46be691f3bSpatrick ThreadPlanCallUserExpression::~ThreadPlanCallUserExpression() = default;
47061da546Spatrick
GetDescription(Stream * s,lldb::DescriptionLevel level)48061da546Spatrick void ThreadPlanCallUserExpression::GetDescription(
49061da546Spatrick Stream *s, lldb::DescriptionLevel level) {
50061da546Spatrick if (level == eDescriptionLevelBrief)
51061da546Spatrick s->Printf("User Expression thread plan");
52061da546Spatrick else
53061da546Spatrick ThreadPlanCallFunction::GetDescription(s, level);
54061da546Spatrick }
55061da546Spatrick
DidPush()56061da546Spatrick void ThreadPlanCallUserExpression::DidPush() {
57061da546Spatrick ThreadPlanCallFunction::DidPush();
58061da546Spatrick if (m_user_expression_sp)
59061da546Spatrick m_user_expression_sp->WillStartExecuting();
60061da546Spatrick }
61061da546Spatrick
DidPop()62*f6aab3d8Srobert void ThreadPlanCallUserExpression::DidPop() {
63*f6aab3d8Srobert ThreadPlanCallFunction::DidPop();
64061da546Spatrick if (m_user_expression_sp)
65061da546Spatrick m_user_expression_sp.reset();
66061da546Spatrick }
67061da546Spatrick
MischiefManaged()68061da546Spatrick bool ThreadPlanCallUserExpression::MischiefManaged() {
69*f6aab3d8Srobert Log *log = GetLog(LLDBLog::Step);
70061da546Spatrick
71061da546Spatrick if (IsPlanComplete()) {
72061da546Spatrick LLDB_LOGF(log, "ThreadPlanCallFunction(%p): Completed call function plan.",
73061da546Spatrick static_cast<void *>(this));
74061da546Spatrick
75061da546Spatrick if (m_manage_materialization && PlanSucceeded() && m_user_expression_sp) {
76061da546Spatrick lldb::addr_t function_stack_top;
77061da546Spatrick lldb::addr_t function_stack_bottom;
78061da546Spatrick lldb::addr_t function_stack_pointer = GetFunctionStackPointer();
79061da546Spatrick
80061da546Spatrick function_stack_bottom = function_stack_pointer - HostInfo::GetPageSize();
81061da546Spatrick function_stack_top = function_stack_pointer;
82061da546Spatrick
83061da546Spatrick DiagnosticManager diagnostics;
84061da546Spatrick
85061da546Spatrick ExecutionContext exe_ctx(GetThread());
86061da546Spatrick
87061da546Spatrick m_user_expression_sp->FinalizeJITExecution(
88061da546Spatrick diagnostics, exe_ctx, m_result_var_sp, function_stack_bottom,
89061da546Spatrick function_stack_top);
90061da546Spatrick }
91061da546Spatrick
92061da546Spatrick ThreadPlan::MischiefManaged();
93061da546Spatrick return true;
94061da546Spatrick } else {
95061da546Spatrick return false;
96061da546Spatrick }
97061da546Spatrick }
98061da546Spatrick
GetRealStopInfo()99061da546Spatrick StopInfoSP ThreadPlanCallUserExpression::GetRealStopInfo() {
100061da546Spatrick StopInfoSP stop_info_sp = ThreadPlanCallFunction::GetRealStopInfo();
101061da546Spatrick
102061da546Spatrick if (stop_info_sp) {
103061da546Spatrick lldb::addr_t addr = GetStopAddress();
104dda28197Spatrick DynamicCheckerFunctions *checkers = m_process.GetDynamicCheckers();
105061da546Spatrick StreamString s;
106061da546Spatrick
107061da546Spatrick if (checkers && checkers->DoCheckersExplainStop(addr, s))
108061da546Spatrick stop_info_sp->SetDescription(s.GetData());
109061da546Spatrick }
110061da546Spatrick
111061da546Spatrick return stop_info_sp;
112061da546Spatrick }
113061da546Spatrick
DoTakedown(bool success)114061da546Spatrick void ThreadPlanCallUserExpression::DoTakedown(bool success) {
115061da546Spatrick ThreadPlanCallFunction::DoTakedown(success);
116061da546Spatrick m_user_expression_sp->DidFinishExecuting();
117061da546Spatrick }
118