annotate lldb/source/Target/ThreadPlanStepInRange.cpp @ 207:2e18cbf3894f

LLVM12
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Tue, 08 Jun 2021 06:07:14 +0900
parents 0572611fdcc8
children c4bab56944e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===-- ThreadPlanStepInRange.cpp -----------------------------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #include "lldb/Target/ThreadPlanStepInRange.h"
anatofuz
parents:
diff changeset
10 #include "lldb/Core/Architecture.h"
anatofuz
parents:
diff changeset
11 #include "lldb/Core/Module.h"
anatofuz
parents:
diff changeset
12 #include "lldb/Symbol/Function.h"
anatofuz
parents:
diff changeset
13 #include "lldb/Symbol/Symbol.h"
anatofuz
parents:
diff changeset
14 #include "lldb/Target/Process.h"
anatofuz
parents:
diff changeset
15 #include "lldb/Target/RegisterContext.h"
anatofuz
parents:
diff changeset
16 #include "lldb/Target/SectionLoadList.h"
anatofuz
parents:
diff changeset
17 #include "lldb/Target/Target.h"
anatofuz
parents:
diff changeset
18 #include "lldb/Target/Thread.h"
anatofuz
parents:
diff changeset
19 #include "lldb/Target/ThreadPlanStepOut.h"
anatofuz
parents:
diff changeset
20 #include "lldb/Target/ThreadPlanStepThrough.h"
anatofuz
parents:
diff changeset
21 #include "lldb/Utility/Log.h"
anatofuz
parents:
diff changeset
22 #include "lldb/Utility/RegularExpression.h"
anatofuz
parents:
diff changeset
23 #include "lldb/Utility/Stream.h"
anatofuz
parents:
diff changeset
24
anatofuz
parents:
diff changeset
25 using namespace lldb;
anatofuz
parents:
diff changeset
26 using namespace lldb_private;
anatofuz
parents:
diff changeset
27
anatofuz
parents:
diff changeset
28 uint32_t ThreadPlanStepInRange::s_default_flag_values =
anatofuz
parents:
diff changeset
29 ThreadPlanShouldStopHere::eStepInAvoidNoDebug;
anatofuz
parents:
diff changeset
30
anatofuz
parents:
diff changeset
31 // ThreadPlanStepInRange: Step through a stack range, either stepping over or
anatofuz
parents:
diff changeset
32 // into based on the value of \a type.
anatofuz
parents:
diff changeset
33
anatofuz
parents:
diff changeset
34 ThreadPlanStepInRange::ThreadPlanStepInRange(
anatofuz
parents:
diff changeset
35 Thread &thread, const AddressRange &range,
anatofuz
parents:
diff changeset
36 const SymbolContext &addr_context, const char *step_into_target,
anatofuz
parents:
diff changeset
37 lldb::RunMode stop_others, LazyBool step_in_avoids_code_without_debug_info,
anatofuz
parents:
diff changeset
38 LazyBool step_out_avoids_code_without_debug_info)
anatofuz
parents:
diff changeset
39 : ThreadPlanStepRange(ThreadPlan::eKindStepInRange,
anatofuz
parents:
diff changeset
40 "Step Range stepping in", thread, range, addr_context,
anatofuz
parents:
diff changeset
41 stop_others),
anatofuz
parents:
diff changeset
42 ThreadPlanShouldStopHere(this), m_step_past_prologue(true),
anatofuz
parents:
diff changeset
43 m_virtual_step(false), m_step_into_target(step_into_target) {
anatofuz
parents:
diff changeset
44 SetCallbacks();
anatofuz
parents:
diff changeset
45 SetFlagsToDefault();
anatofuz
parents:
diff changeset
46 SetupAvoidNoDebug(step_in_avoids_code_without_debug_info,
anatofuz
parents:
diff changeset
47 step_out_avoids_code_without_debug_info);
anatofuz
parents:
diff changeset
48 }
anatofuz
parents:
diff changeset
49
anatofuz
parents:
diff changeset
50 ThreadPlanStepInRange::~ThreadPlanStepInRange() = default;
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 void ThreadPlanStepInRange::SetupAvoidNoDebug(
anatofuz
parents:
diff changeset
53 LazyBool step_in_avoids_code_without_debug_info,
anatofuz
parents:
diff changeset
54 LazyBool step_out_avoids_code_without_debug_info) {
anatofuz
parents:
diff changeset
55 bool avoid_nodebug = true;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
56 Thread &thread = GetThread();
150
anatofuz
parents:
diff changeset
57 switch (step_in_avoids_code_without_debug_info) {
anatofuz
parents:
diff changeset
58 case eLazyBoolYes:
anatofuz
parents:
diff changeset
59 avoid_nodebug = true;
anatofuz
parents:
diff changeset
60 break;
anatofuz
parents:
diff changeset
61 case eLazyBoolNo:
anatofuz
parents:
diff changeset
62 avoid_nodebug = false;
anatofuz
parents:
diff changeset
63 break;
anatofuz
parents:
diff changeset
64 case eLazyBoolCalculate:
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
65 avoid_nodebug = thread.GetStepInAvoidsNoDebug();
150
anatofuz
parents:
diff changeset
66 break;
anatofuz
parents:
diff changeset
67 }
anatofuz
parents:
diff changeset
68 if (avoid_nodebug)
anatofuz
parents:
diff changeset
69 GetFlags().Set(ThreadPlanShouldStopHere::eStepInAvoidNoDebug);
anatofuz
parents:
diff changeset
70 else
anatofuz
parents:
diff changeset
71 GetFlags().Clear(ThreadPlanShouldStopHere::eStepInAvoidNoDebug);
anatofuz
parents:
diff changeset
72
anatofuz
parents:
diff changeset
73 switch (step_out_avoids_code_without_debug_info) {
anatofuz
parents:
diff changeset
74 case eLazyBoolYes:
anatofuz
parents:
diff changeset
75 avoid_nodebug = true;
anatofuz
parents:
diff changeset
76 break;
anatofuz
parents:
diff changeset
77 case eLazyBoolNo:
anatofuz
parents:
diff changeset
78 avoid_nodebug = false;
anatofuz
parents:
diff changeset
79 break;
anatofuz
parents:
diff changeset
80 case eLazyBoolCalculate:
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
81 avoid_nodebug = thread.GetStepOutAvoidsNoDebug();
150
anatofuz
parents:
diff changeset
82 break;
anatofuz
parents:
diff changeset
83 }
anatofuz
parents:
diff changeset
84 if (avoid_nodebug)
anatofuz
parents:
diff changeset
85 GetFlags().Set(ThreadPlanShouldStopHere::eStepOutAvoidNoDebug);
anatofuz
parents:
diff changeset
86 else
anatofuz
parents:
diff changeset
87 GetFlags().Clear(ThreadPlanShouldStopHere::eStepOutAvoidNoDebug);
anatofuz
parents:
diff changeset
88 }
anatofuz
parents:
diff changeset
89
anatofuz
parents:
diff changeset
90 void ThreadPlanStepInRange::GetDescription(Stream *s,
anatofuz
parents:
diff changeset
91 lldb::DescriptionLevel level) {
anatofuz
parents:
diff changeset
92
anatofuz
parents:
diff changeset
93 auto PrintFailureIfAny = [&]() {
anatofuz
parents:
diff changeset
94 if (m_status.Success())
anatofuz
parents:
diff changeset
95 return;
anatofuz
parents:
diff changeset
96 s->Printf(" failed (%s)", m_status.AsCString());
anatofuz
parents:
diff changeset
97 };
anatofuz
parents:
diff changeset
98
anatofuz
parents:
diff changeset
99 if (level == lldb::eDescriptionLevelBrief) {
anatofuz
parents:
diff changeset
100 s->Printf("step in");
anatofuz
parents:
diff changeset
101 PrintFailureIfAny();
anatofuz
parents:
diff changeset
102 return;
anatofuz
parents:
diff changeset
103 }
anatofuz
parents:
diff changeset
104
anatofuz
parents:
diff changeset
105 s->Printf("Stepping in");
anatofuz
parents:
diff changeset
106 bool printed_line_info = false;
anatofuz
parents:
diff changeset
107 if (m_addr_context.line_entry.IsValid()) {
anatofuz
parents:
diff changeset
108 s->Printf(" through line ");
anatofuz
parents:
diff changeset
109 m_addr_context.line_entry.DumpStopContext(s, false);
anatofuz
parents:
diff changeset
110 printed_line_info = true;
anatofuz
parents:
diff changeset
111 }
anatofuz
parents:
diff changeset
112
anatofuz
parents:
diff changeset
113 const char *step_into_target = m_step_into_target.AsCString();
anatofuz
parents:
diff changeset
114 if (step_into_target && step_into_target[0] != '\0')
anatofuz
parents:
diff changeset
115 s->Printf(" targeting %s", m_step_into_target.AsCString());
anatofuz
parents:
diff changeset
116
anatofuz
parents:
diff changeset
117 if (!printed_line_info || level == eDescriptionLevelVerbose) {
anatofuz
parents:
diff changeset
118 s->Printf(" using ranges:");
anatofuz
parents:
diff changeset
119 DumpRanges(s);
anatofuz
parents:
diff changeset
120 }
anatofuz
parents:
diff changeset
121
anatofuz
parents:
diff changeset
122 PrintFailureIfAny();
anatofuz
parents:
diff changeset
123
anatofuz
parents:
diff changeset
124 s->PutChar('.');
anatofuz
parents:
diff changeset
125 }
anatofuz
parents:
diff changeset
126
anatofuz
parents:
diff changeset
127 bool ThreadPlanStepInRange::ShouldStop(Event *event_ptr) {
anatofuz
parents:
diff changeset
128 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
anatofuz
parents:
diff changeset
129
anatofuz
parents:
diff changeset
130 if (log) {
anatofuz
parents:
diff changeset
131 StreamString s;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
132 DumpAddress(s.AsRawOstream(), GetThread().GetRegisterContext()->GetPC(),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
133 GetTarget().GetArchitecture().GetAddressByteSize());
150
anatofuz
parents:
diff changeset
134 LLDB_LOGF(log, "ThreadPlanStepInRange reached %s.", s.GetData());
anatofuz
parents:
diff changeset
135 }
anatofuz
parents:
diff changeset
136
anatofuz
parents:
diff changeset
137 if (IsPlanComplete())
anatofuz
parents:
diff changeset
138 return true;
anatofuz
parents:
diff changeset
139
anatofuz
parents:
diff changeset
140 m_no_more_plans = false;
anatofuz
parents:
diff changeset
141 if (m_sub_plan_sp && m_sub_plan_sp->IsPlanComplete()) {
anatofuz
parents:
diff changeset
142 if (!m_sub_plan_sp->PlanSucceeded()) {
anatofuz
parents:
diff changeset
143 SetPlanComplete();
anatofuz
parents:
diff changeset
144 m_no_more_plans = true;
anatofuz
parents:
diff changeset
145 return true;
anatofuz
parents:
diff changeset
146 } else
anatofuz
parents:
diff changeset
147 m_sub_plan_sp.reset();
anatofuz
parents:
diff changeset
148 }
anatofuz
parents:
diff changeset
149
anatofuz
parents:
diff changeset
150 if (m_virtual_step) {
anatofuz
parents:
diff changeset
151 // If we've just completed a virtual step, all we need to do is check for a
anatofuz
parents:
diff changeset
152 // ShouldStopHere plan, and otherwise we're done.
anatofuz
parents:
diff changeset
153 // FIXME - This can be both a step in and a step out. Probably should
anatofuz
parents:
diff changeset
154 // record which in the m_virtual_step.
anatofuz
parents:
diff changeset
155 m_sub_plan_sp =
anatofuz
parents:
diff changeset
156 CheckShouldStopHereAndQueueStepOut(eFrameCompareYounger, m_status);
anatofuz
parents:
diff changeset
157 } else {
anatofuz
parents:
diff changeset
158 // Stepping through should be done running other threads in general, since
anatofuz
parents:
diff changeset
159 // we're setting a breakpoint and continuing. So only stop others if we
anatofuz
parents:
diff changeset
160 // are explicitly told to do so.
anatofuz
parents:
diff changeset
161
anatofuz
parents:
diff changeset
162 bool stop_others = (m_stop_others == lldb::eOnlyThisThread);
anatofuz
parents:
diff changeset
163
anatofuz
parents:
diff changeset
164 FrameComparison frame_order = CompareCurrentFrameToStartFrame();
anatofuz
parents:
diff changeset
165
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
166 Thread &thread = GetThread();
150
anatofuz
parents:
diff changeset
167 if (frame_order == eFrameCompareOlder ||
anatofuz
parents:
diff changeset
168 frame_order == eFrameCompareSameParent) {
anatofuz
parents:
diff changeset
169 // If we're in an older frame then we should stop.
anatofuz
parents:
diff changeset
170 //
anatofuz
parents:
diff changeset
171 // A caveat to this is if we think the frame is older but we're actually
anatofuz
parents:
diff changeset
172 // in a trampoline.
anatofuz
parents:
diff changeset
173 // I'm going to make the assumption that you wouldn't RETURN to a
anatofuz
parents:
diff changeset
174 // trampoline. So if we are in a trampoline we think the frame is older
anatofuz
parents:
diff changeset
175 // because the trampoline confused the backtracer.
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
176 m_sub_plan_sp = thread.QueueThreadPlanForStepThrough(
150
anatofuz
parents:
diff changeset
177 m_stack_id, false, stop_others, m_status);
anatofuz
parents:
diff changeset
178 if (!m_sub_plan_sp) {
anatofuz
parents:
diff changeset
179 // Otherwise check the ShouldStopHere for step out:
anatofuz
parents:
diff changeset
180 m_sub_plan_sp =
anatofuz
parents:
diff changeset
181 CheckShouldStopHereAndQueueStepOut(frame_order, m_status);
anatofuz
parents:
diff changeset
182 if (log) {
anatofuz
parents:
diff changeset
183 if (m_sub_plan_sp)
anatofuz
parents:
diff changeset
184 LLDB_LOGF(log,
anatofuz
parents:
diff changeset
185 "ShouldStopHere found plan to step out of this frame.");
anatofuz
parents:
diff changeset
186 else
anatofuz
parents:
diff changeset
187 LLDB_LOGF(log, "ShouldStopHere no plan to step out of this frame.");
anatofuz
parents:
diff changeset
188 }
anatofuz
parents:
diff changeset
189 } else if (log) {
anatofuz
parents:
diff changeset
190 LLDB_LOGF(
anatofuz
parents:
diff changeset
191 log, "Thought I stepped out, but in fact arrived at a trampoline.");
anatofuz
parents:
diff changeset
192 }
anatofuz
parents:
diff changeset
193 } else if (frame_order == eFrameCompareEqual && InSymbol()) {
anatofuz
parents:
diff changeset
194 // If we are not in a place we should step through, we're done. One
anatofuz
parents:
diff changeset
195 // tricky bit here is that some stubs don't push a frame, so we have to
anatofuz
parents:
diff changeset
196 // check both the case of a frame that is younger, or the same as this
anatofuz
parents:
diff changeset
197 // frame. However, if the frame is the same, and we are still in the
anatofuz
parents:
diff changeset
198 // symbol we started in, the we don't need to do this. This first check
anatofuz
parents:
diff changeset
199 // isn't strictly necessary, but it is more efficient.
anatofuz
parents:
diff changeset
200
anatofuz
parents:
diff changeset
201 // If we're still in the range, keep going, either by running to the next
anatofuz
parents:
diff changeset
202 // branch breakpoint, or by stepping.
anatofuz
parents:
diff changeset
203 if (InRange()) {
anatofuz
parents:
diff changeset
204 SetNextBranchBreakpoint();
anatofuz
parents:
diff changeset
205 return false;
anatofuz
parents:
diff changeset
206 }
anatofuz
parents:
diff changeset
207
anatofuz
parents:
diff changeset
208 SetPlanComplete();
anatofuz
parents:
diff changeset
209 m_no_more_plans = true;
anatofuz
parents:
diff changeset
210 return true;
anatofuz
parents:
diff changeset
211 }
anatofuz
parents:
diff changeset
212
anatofuz
parents:
diff changeset
213 // If we get to this point, we're not going to use a previously set "next
anatofuz
parents:
diff changeset
214 // branch" breakpoint, so delete it:
anatofuz
parents:
diff changeset
215 ClearNextBranchBreakpoint();
anatofuz
parents:
diff changeset
216
anatofuz
parents:
diff changeset
217 // We may have set the plan up above in the FrameIsOlder section:
anatofuz
parents:
diff changeset
218
anatofuz
parents:
diff changeset
219 if (!m_sub_plan_sp)
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
220 m_sub_plan_sp = thread.QueueThreadPlanForStepThrough(
150
anatofuz
parents:
diff changeset
221 m_stack_id, false, stop_others, m_status);
anatofuz
parents:
diff changeset
222
anatofuz
parents:
diff changeset
223 if (log) {
anatofuz
parents:
diff changeset
224 if (m_sub_plan_sp)
anatofuz
parents:
diff changeset
225 LLDB_LOGF(log, "Found a step through plan: %s",
anatofuz
parents:
diff changeset
226 m_sub_plan_sp->GetName());
anatofuz
parents:
diff changeset
227 else
anatofuz
parents:
diff changeset
228 LLDB_LOGF(log, "No step through plan found.");
anatofuz
parents:
diff changeset
229 }
anatofuz
parents:
diff changeset
230
anatofuz
parents:
diff changeset
231 // If not, give the "should_stop" callback a chance to push a plan to get
anatofuz
parents:
diff changeset
232 // us out of here. But only do that if we actually have stepped in.
anatofuz
parents:
diff changeset
233 if (!m_sub_plan_sp && frame_order == eFrameCompareYounger)
anatofuz
parents:
diff changeset
234 m_sub_plan_sp = CheckShouldStopHereAndQueueStepOut(frame_order, m_status);
anatofuz
parents:
diff changeset
235
anatofuz
parents:
diff changeset
236 // If we've stepped in and we are going to stop here, check to see if we
anatofuz
parents:
diff changeset
237 // were asked to run past the prologue, and if so do that.
anatofuz
parents:
diff changeset
238
anatofuz
parents:
diff changeset
239 if (!m_sub_plan_sp && frame_order == eFrameCompareYounger &&
anatofuz
parents:
diff changeset
240 m_step_past_prologue) {
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
241 lldb::StackFrameSP curr_frame = thread.GetStackFrameAtIndex(0);
150
anatofuz
parents:
diff changeset
242 if (curr_frame) {
anatofuz
parents:
diff changeset
243 size_t bytes_to_skip = 0;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
244 lldb::addr_t curr_addr = thread.GetRegisterContext()->GetPC();
150
anatofuz
parents:
diff changeset
245 Address func_start_address;
anatofuz
parents:
diff changeset
246
anatofuz
parents:
diff changeset
247 SymbolContext sc = curr_frame->GetSymbolContext(eSymbolContextFunction |
anatofuz
parents:
diff changeset
248 eSymbolContextSymbol);
anatofuz
parents:
diff changeset
249
anatofuz
parents:
diff changeset
250 if (sc.function) {
anatofuz
parents:
diff changeset
251 func_start_address = sc.function->GetAddressRange().GetBaseAddress();
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
252 if (curr_addr == func_start_address.GetLoadAddress(&GetTarget()))
150
anatofuz
parents:
diff changeset
253 bytes_to_skip = sc.function->GetPrologueByteSize();
anatofuz
parents:
diff changeset
254 } else if (sc.symbol) {
anatofuz
parents:
diff changeset
255 func_start_address = sc.symbol->GetAddress();
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
256 if (curr_addr == func_start_address.GetLoadAddress(&GetTarget()))
150
anatofuz
parents:
diff changeset
257 bytes_to_skip = sc.symbol->GetPrologueByteSize();
anatofuz
parents:
diff changeset
258 }
anatofuz
parents:
diff changeset
259
anatofuz
parents:
diff changeset
260 if (bytes_to_skip == 0 && sc.symbol) {
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
261 const Architecture *arch = GetTarget().GetArchitecturePlugin();
150
anatofuz
parents:
diff changeset
262 if (arch) {
anatofuz
parents:
diff changeset
263 Address curr_sec_addr;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
264 GetTarget().GetSectionLoadList().ResolveLoadAddress(curr_addr,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
265 curr_sec_addr);
150
anatofuz
parents:
diff changeset
266 bytes_to_skip = arch->GetBytesToSkip(*sc.symbol, curr_sec_addr);
anatofuz
parents:
diff changeset
267 }
anatofuz
parents:
diff changeset
268 }
anatofuz
parents:
diff changeset
269
anatofuz
parents:
diff changeset
270 if (bytes_to_skip != 0) {
anatofuz
parents:
diff changeset
271 func_start_address.Slide(bytes_to_skip);
anatofuz
parents:
diff changeset
272 log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP);
anatofuz
parents:
diff changeset
273 LLDB_LOGF(log, "Pushing past prologue ");
anatofuz
parents:
diff changeset
274
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
275 m_sub_plan_sp = thread.QueueThreadPlanForRunToAddress(
150
anatofuz
parents:
diff changeset
276 false, func_start_address, true, m_status);
anatofuz
parents:
diff changeset
277 }
anatofuz
parents:
diff changeset
278 }
anatofuz
parents:
diff changeset
279 }
anatofuz
parents:
diff changeset
280 }
anatofuz
parents:
diff changeset
281
anatofuz
parents:
diff changeset
282 if (!m_sub_plan_sp) {
anatofuz
parents:
diff changeset
283 m_no_more_plans = true;
anatofuz
parents:
diff changeset
284 SetPlanComplete();
anatofuz
parents:
diff changeset
285 return true;
anatofuz
parents:
diff changeset
286 } else {
anatofuz
parents:
diff changeset
287 m_no_more_plans = false;
anatofuz
parents:
diff changeset
288 m_sub_plan_sp->SetPrivate(true);
anatofuz
parents:
diff changeset
289 return false;
anatofuz
parents:
diff changeset
290 }
anatofuz
parents:
diff changeset
291 }
anatofuz
parents:
diff changeset
292
anatofuz
parents:
diff changeset
293 void ThreadPlanStepInRange::SetAvoidRegexp(const char *name) {
anatofuz
parents:
diff changeset
294 if (m_avoid_regexp_up)
207
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
295 *m_avoid_regexp_up = RegularExpression(name);
150
anatofuz
parents:
diff changeset
296 else
207
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 173
diff changeset
297 m_avoid_regexp_up = std::make_unique<RegularExpression>(name);
150
anatofuz
parents:
diff changeset
298 }
anatofuz
parents:
diff changeset
299
anatofuz
parents:
diff changeset
300 void ThreadPlanStepInRange::SetDefaultFlagValue(uint32_t new_value) {
anatofuz
parents:
diff changeset
301 // TODO: Should we test this for sanity?
anatofuz
parents:
diff changeset
302 ThreadPlanStepInRange::s_default_flag_values = new_value;
anatofuz
parents:
diff changeset
303 }
anatofuz
parents:
diff changeset
304
anatofuz
parents:
diff changeset
305 bool ThreadPlanStepInRange::FrameMatchesAvoidCriteria() {
anatofuz
parents:
diff changeset
306 StackFrame *frame = GetThread().GetStackFrameAtIndex(0).get();
anatofuz
parents:
diff changeset
307
anatofuz
parents:
diff changeset
308 // Check the library list first, as that's cheapest:
anatofuz
parents:
diff changeset
309 bool libraries_say_avoid = false;
anatofuz
parents:
diff changeset
310
anatofuz
parents:
diff changeset
311 FileSpecList libraries_to_avoid(GetThread().GetLibrariesToAvoid());
anatofuz
parents:
diff changeset
312 size_t num_libraries = libraries_to_avoid.GetSize();
anatofuz
parents:
diff changeset
313 if (num_libraries > 0) {
anatofuz
parents:
diff changeset
314 SymbolContext sc(frame->GetSymbolContext(eSymbolContextModule));
anatofuz
parents:
diff changeset
315 FileSpec frame_library(sc.module_sp->GetFileSpec());
anatofuz
parents:
diff changeset
316
anatofuz
parents:
diff changeset
317 if (frame_library) {
anatofuz
parents:
diff changeset
318 for (size_t i = 0; i < num_libraries; i++) {
anatofuz
parents:
diff changeset
319 const FileSpec &file_spec(libraries_to_avoid.GetFileSpecAtIndex(i));
anatofuz
parents:
diff changeset
320 if (FileSpec::Match(file_spec, frame_library)) {
anatofuz
parents:
diff changeset
321 libraries_say_avoid = true;
anatofuz
parents:
diff changeset
322 break;
anatofuz
parents:
diff changeset
323 }
anatofuz
parents:
diff changeset
324 }
anatofuz
parents:
diff changeset
325 }
anatofuz
parents:
diff changeset
326 }
anatofuz
parents:
diff changeset
327 if (libraries_say_avoid)
anatofuz
parents:
diff changeset
328 return true;
anatofuz
parents:
diff changeset
329
anatofuz
parents:
diff changeset
330 const RegularExpression *avoid_regexp_to_use = m_avoid_regexp_up.get();
anatofuz
parents:
diff changeset
331 if (avoid_regexp_to_use == nullptr)
anatofuz
parents:
diff changeset
332 avoid_regexp_to_use = GetThread().GetSymbolsToAvoidRegexp();
anatofuz
parents:
diff changeset
333
anatofuz
parents:
diff changeset
334 if (avoid_regexp_to_use != nullptr) {
anatofuz
parents:
diff changeset
335 SymbolContext sc = frame->GetSymbolContext(
anatofuz
parents:
diff changeset
336 eSymbolContextFunction | eSymbolContextBlock | eSymbolContextSymbol);
anatofuz
parents:
diff changeset
337 if (sc.symbol != nullptr) {
anatofuz
parents:
diff changeset
338 const char *frame_function_name =
anatofuz
parents:
diff changeset
339 sc.GetFunctionName(Mangled::ePreferDemangledWithoutArguments)
anatofuz
parents:
diff changeset
340 .GetCString();
anatofuz
parents:
diff changeset
341 if (frame_function_name) {
anatofuz
parents:
diff changeset
342 llvm::SmallVector<llvm::StringRef, 2> matches;
anatofuz
parents:
diff changeset
343 bool return_value =
anatofuz
parents:
diff changeset
344 avoid_regexp_to_use->Execute(frame_function_name, &matches);
anatofuz
parents:
diff changeset
345 if (return_value && matches.size() > 1) {
anatofuz
parents:
diff changeset
346 std::string match = matches[1].str();
anatofuz
parents:
diff changeset
347 LLDB_LOGF(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP),
anatofuz
parents:
diff changeset
348 "Stepping out of function \"%s\" because it matches "
anatofuz
parents:
diff changeset
349 "the avoid regexp \"%s\" - match substring: \"%s\".",
anatofuz
parents:
diff changeset
350 frame_function_name,
anatofuz
parents:
diff changeset
351 avoid_regexp_to_use->GetText().str().c_str(),
anatofuz
parents:
diff changeset
352 match.c_str());
anatofuz
parents:
diff changeset
353 }
anatofuz
parents:
diff changeset
354 return return_value;
anatofuz
parents:
diff changeset
355 }
anatofuz
parents:
diff changeset
356 }
anatofuz
parents:
diff changeset
357 }
anatofuz
parents:
diff changeset
358 return false;
anatofuz
parents:
diff changeset
359 }
anatofuz
parents:
diff changeset
360
anatofuz
parents:
diff changeset
361 bool ThreadPlanStepInRange::DefaultShouldStopHereCallback(
anatofuz
parents:
diff changeset
362 ThreadPlan *current_plan, Flags &flags, FrameComparison operation,
anatofuz
parents:
diff changeset
363 Status &status, void *baton) {
anatofuz
parents:
diff changeset
364 bool should_stop_here = true;
anatofuz
parents:
diff changeset
365 StackFrame *frame = current_plan->GetThread().GetStackFrameAtIndex(0).get();
anatofuz
parents:
diff changeset
366 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
anatofuz
parents:
diff changeset
367
anatofuz
parents:
diff changeset
368 // First see if the ThreadPlanShouldStopHere default implementation thinks we
anatofuz
parents:
diff changeset
369 // should get out of here:
anatofuz
parents:
diff changeset
370 should_stop_here = ThreadPlanShouldStopHere::DefaultShouldStopHereCallback(
anatofuz
parents:
diff changeset
371 current_plan, flags, operation, status, baton);
anatofuz
parents:
diff changeset
372 if (!should_stop_here)
anatofuz
parents:
diff changeset
373 return false;
anatofuz
parents:
diff changeset
374
anatofuz
parents:
diff changeset
375 if (should_stop_here && current_plan->GetKind() == eKindStepInRange &&
anatofuz
parents:
diff changeset
376 operation == eFrameCompareYounger) {
anatofuz
parents:
diff changeset
377 ThreadPlanStepInRange *step_in_range_plan =
anatofuz
parents:
diff changeset
378 static_cast<ThreadPlanStepInRange *>(current_plan);
anatofuz
parents:
diff changeset
379 if (step_in_range_plan->m_step_into_target) {
anatofuz
parents:
diff changeset
380 SymbolContext sc = frame->GetSymbolContext(
anatofuz
parents:
diff changeset
381 eSymbolContextFunction | eSymbolContextBlock | eSymbolContextSymbol);
anatofuz
parents:
diff changeset
382 if (sc.symbol != nullptr) {
anatofuz
parents:
diff changeset
383 // First try an exact match, since that's cheap with ConstStrings.
anatofuz
parents:
diff changeset
384 // Then do a strstr compare.
anatofuz
parents:
diff changeset
385 if (step_in_range_plan->m_step_into_target == sc.GetFunctionName()) {
anatofuz
parents:
diff changeset
386 should_stop_here = true;
anatofuz
parents:
diff changeset
387 } else {
anatofuz
parents:
diff changeset
388 const char *target_name =
anatofuz
parents:
diff changeset
389 step_in_range_plan->m_step_into_target.AsCString();
anatofuz
parents:
diff changeset
390 const char *function_name = sc.GetFunctionName().AsCString();
anatofuz
parents:
diff changeset
391
anatofuz
parents:
diff changeset
392 if (function_name == nullptr)
anatofuz
parents:
diff changeset
393 should_stop_here = false;
anatofuz
parents:
diff changeset
394 else if (strstr(function_name, target_name) == nullptr)
anatofuz
parents:
diff changeset
395 should_stop_here = false;
anatofuz
parents:
diff changeset
396 }
anatofuz
parents:
diff changeset
397 if (log && !should_stop_here)
anatofuz
parents:
diff changeset
398 LLDB_LOGF(log,
anatofuz
parents:
diff changeset
399 "Stepping out of frame %s which did not match step into "
anatofuz
parents:
diff changeset
400 "target %s.",
anatofuz
parents:
diff changeset
401 sc.GetFunctionName().AsCString(),
anatofuz
parents:
diff changeset
402 step_in_range_plan->m_step_into_target.AsCString());
anatofuz
parents:
diff changeset
403 }
anatofuz
parents:
diff changeset
404 }
anatofuz
parents:
diff changeset
405
anatofuz
parents:
diff changeset
406 if (should_stop_here) {
anatofuz
parents:
diff changeset
407 ThreadPlanStepInRange *step_in_range_plan =
anatofuz
parents:
diff changeset
408 static_cast<ThreadPlanStepInRange *>(current_plan);
anatofuz
parents:
diff changeset
409 // Don't log the should_step_out here, it's easier to do it in
anatofuz
parents:
diff changeset
410 // FrameMatchesAvoidCriteria.
anatofuz
parents:
diff changeset
411 should_stop_here = !step_in_range_plan->FrameMatchesAvoidCriteria();
anatofuz
parents:
diff changeset
412 }
anatofuz
parents:
diff changeset
413 }
anatofuz
parents:
diff changeset
414
anatofuz
parents:
diff changeset
415 return should_stop_here;
anatofuz
parents:
diff changeset
416 }
anatofuz
parents:
diff changeset
417
anatofuz
parents:
diff changeset
418 bool ThreadPlanStepInRange::DoPlanExplainsStop(Event *event_ptr) {
anatofuz
parents:
diff changeset
419 // We always explain a stop. Either we've just done a single step, in which
anatofuz
parents:
diff changeset
420 // case we'll do our ordinary processing, or we stopped for some reason that
anatofuz
parents:
diff changeset
421 // isn't handled by our sub-plans, in which case we want to just stop right
anatofuz
parents:
diff changeset
422 // away. In general, we don't want to mark the plan as complete for
anatofuz
parents:
diff changeset
423 // unexplained stops. For instance, if you step in to some code with no debug
anatofuz
parents:
diff changeset
424 // info, so you step out and in the course of that hit a breakpoint, then you
anatofuz
parents:
diff changeset
425 // want to stop & show the user the breakpoint, but not unship the step in
anatofuz
parents:
diff changeset
426 // plan, since you still may want to complete that plan when you continue.
anatofuz
parents:
diff changeset
427 // This is particularly true when doing "step in to target function."
anatofuz
parents:
diff changeset
428 // stepping.
anatofuz
parents:
diff changeset
429 //
anatofuz
parents:
diff changeset
430 // The only variation is that if we are doing "step by running to next
anatofuz
parents:
diff changeset
431 // branch" in which case if we hit our branch breakpoint we don't set the
anatofuz
parents:
diff changeset
432 // plan to complete.
anatofuz
parents:
diff changeset
433
anatofuz
parents:
diff changeset
434 bool return_value = false;
anatofuz
parents:
diff changeset
435
anatofuz
parents:
diff changeset
436 if (m_virtual_step) {
anatofuz
parents:
diff changeset
437 return_value = true;
anatofuz
parents:
diff changeset
438 } else {
anatofuz
parents:
diff changeset
439 StopInfoSP stop_info_sp = GetPrivateStopInfo();
anatofuz
parents:
diff changeset
440 if (stop_info_sp) {
anatofuz
parents:
diff changeset
441 StopReason reason = stop_info_sp->GetStopReason();
anatofuz
parents:
diff changeset
442
anatofuz
parents:
diff changeset
443 if (reason == eStopReasonBreakpoint) {
anatofuz
parents:
diff changeset
444 if (NextRangeBreakpointExplainsStop(stop_info_sp)) {
anatofuz
parents:
diff changeset
445 return_value = true;
anatofuz
parents:
diff changeset
446 }
anatofuz
parents:
diff changeset
447 } else if (IsUsuallyUnexplainedStopReason(reason)) {
anatofuz
parents:
diff changeset
448 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
anatofuz
parents:
diff changeset
449 if (log)
anatofuz
parents:
diff changeset
450 log->PutCString("ThreadPlanStepInRange got asked if it explains the "
anatofuz
parents:
diff changeset
451 "stop for some reason other than step.");
anatofuz
parents:
diff changeset
452 return_value = false;
anatofuz
parents:
diff changeset
453 } else {
anatofuz
parents:
diff changeset
454 return_value = true;
anatofuz
parents:
diff changeset
455 }
anatofuz
parents:
diff changeset
456 } else
anatofuz
parents:
diff changeset
457 return_value = true;
anatofuz
parents:
diff changeset
458 }
anatofuz
parents:
diff changeset
459
anatofuz
parents:
diff changeset
460 return return_value;
anatofuz
parents:
diff changeset
461 }
anatofuz
parents:
diff changeset
462
anatofuz
parents:
diff changeset
463 bool ThreadPlanStepInRange::DoWillResume(lldb::StateType resume_state,
anatofuz
parents:
diff changeset
464 bool current_plan) {
anatofuz
parents:
diff changeset
465 m_virtual_step = false;
anatofuz
parents:
diff changeset
466 if (resume_state == eStateStepping && current_plan) {
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
467 Thread &thread = GetThread();
150
anatofuz
parents:
diff changeset
468 // See if we are about to step over a virtual inlined call.
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
469 bool step_without_resume = thread.DecrementCurrentInlinedDepth();
150
anatofuz
parents:
diff changeset
470 if (step_without_resume) {
anatofuz
parents:
diff changeset
471 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
anatofuz
parents:
diff changeset
472 LLDB_LOGF(log,
anatofuz
parents:
diff changeset
473 "ThreadPlanStepInRange::DoWillResume: returning false, "
anatofuz
parents:
diff changeset
474 "inline_depth: %d",
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
475 thread.GetCurrentInlinedDepth());
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
476 SetStopInfo(StopInfo::CreateStopReasonToTrace(thread));
150
anatofuz
parents:
diff changeset
477
anatofuz
parents:
diff changeset
478 // FIXME: Maybe it would be better to create a InlineStep stop reason, but
anatofuz
parents:
diff changeset
479 // then
anatofuz
parents:
diff changeset
480 // the whole rest of the world would have to handle that stop reason.
anatofuz
parents:
diff changeset
481 m_virtual_step = true;
anatofuz
parents:
diff changeset
482 }
anatofuz
parents:
diff changeset
483 return !step_without_resume;
anatofuz
parents:
diff changeset
484 }
anatofuz
parents:
diff changeset
485 return true;
anatofuz
parents:
diff changeset
486 }
anatofuz
parents:
diff changeset
487
anatofuz
parents:
diff changeset
488 bool ThreadPlanStepInRange::IsVirtualStep() { return m_virtual_step; }