1 //===-- ThreadPlanCallFunction.cpp ------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 // Other libraries and framework includes
14 #include "lldb/Target/ThreadPlanCallFunction.h"
15 #include "lldb/Breakpoint/Breakpoint.h"
16 #include "lldb/Breakpoint/BreakpointLocation.h"
17 #include "lldb/Core/Address.h"
18 #include "lldb/Core/Log.h"
19 #include "lldb/Core/Module.h"
20 #include "lldb/Core/Stream.h"
21 #include "lldb/Symbol/ObjectFile.h"
22 #include "lldb/Target/ABI.h"
23 #include "lldb/Target/LanguageRuntime.h"
24 #include "lldb/Target/Process.h"
25 #include "lldb/Target/RegisterContext.h"
26 #include "lldb/Target/StopInfo.h"
27 #include "lldb/Target/Target.h"
28 #include "lldb/Target/Thread.h"
29 #include "lldb/Target/ThreadPlanRunToAddress.h"
32 using namespace lldb_private;
34 //----------------------------------------------------------------------
35 // ThreadPlanCallFunction: Plan to call a single function
36 //----------------------------------------------------------------------
37 bool ThreadPlanCallFunction::ConstructorSetup(
38 Thread &thread, ABI *&abi, lldb::addr_t &start_load_addr,
39 lldb::addr_t &function_load_addr) {
40 SetIsMasterPlan(true);
41 SetOkayToDiscard(false);
44 ProcessSP process_sp(thread.GetProcess());
48 abi = process_sp->GetABI().get();
53 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_STEP));
57 m_function_sp = thread.GetRegisterContext()->GetSP() - abi->GetRedZoneSize();
58 // If we can't read memory at the point of the process where we are planning
59 // to put our function, we're
60 // not going to get any further...
62 process_sp->ReadUnsignedIntegerFromMemory(m_function_sp, 4, 0, error);
63 if (!error.Success()) {
64 m_constructor_errors.Printf(
65 "Trying to put the stack in unreadable memory at: 0x%" PRIx64 ".",
68 log->Printf("ThreadPlanCallFunction(%p): %s.", static_cast<void *>(this),
69 m_constructor_errors.GetData());
73 Module *exe_module = GetTarget().GetExecutableModulePointer();
75 if (exe_module == nullptr) {
76 m_constructor_errors.Printf(
77 "Can't execute code without an executable module.");
79 log->Printf("ThreadPlanCallFunction(%p): %s.", static_cast<void *>(this),
80 m_constructor_errors.GetData());
83 ObjectFile *objectFile = exe_module->GetObjectFile();
85 m_constructor_errors.Printf(
86 "Could not find object file for module \"%s\".",
87 exe_module->GetFileSpec().GetFilename().AsCString());
90 log->Printf("ThreadPlanCallFunction(%p): %s.",
91 static_cast<void *>(this), m_constructor_errors.GetData());
95 m_start_addr = objectFile->GetEntryPointAddress();
96 if (!m_start_addr.IsValid()) {
97 m_constructor_errors.Printf(
98 "Could not find entry point address for executable module \"%s\".",
99 exe_module->GetFileSpec().GetFilename().AsCString());
101 log->Printf("ThreadPlanCallFunction(%p): %s.",
102 static_cast<void *>(this), m_constructor_errors.GetData());
107 start_load_addr = m_start_addr.GetLoadAddress(&GetTarget());
109 // Checkpoint the thread state so we can restore it later.
110 if (log && log->GetVerbose())
111 ReportRegisterState("About to checkpoint thread before function call. "
112 "Original register state was:");
114 if (!thread.CheckpointThreadState(m_stored_thread_state)) {
115 m_constructor_errors.Printf("Setting up ThreadPlanCallFunction, failed to "
116 "checkpoint thread state.");
118 log->Printf("ThreadPlanCallFunction(%p): %s.", static_cast<void *>(this),
119 m_constructor_errors.GetData());
122 function_load_addr = m_function_addr.GetLoadAddress(&GetTarget());
127 ThreadPlanCallFunction::ThreadPlanCallFunction(
128 Thread &thread, const Address &function, const CompilerType &return_type,
129 llvm::ArrayRef<addr_t> args, const EvaluateExpressionOptions &options)
130 : ThreadPlan(ThreadPlan::eKindCallFunction, "Call function plan", thread,
131 eVoteNoOpinion, eVoteNoOpinion),
132 m_valid(false), m_stop_other_threads(options.GetStopOthers()),
133 m_unwind_on_error(options.DoesUnwindOnError()),
134 m_ignore_breakpoints(options.DoesIgnoreBreakpoints()),
135 m_debug_execution(options.GetDebug()),
136 m_trap_exceptions(options.GetTrapExceptions()), m_function_addr(function),
137 m_function_sp(0), m_takedown_done(false),
138 m_should_clear_objc_exception_bp(false),
139 m_should_clear_cxx_exception_bp(false),
140 m_stop_address(LLDB_INVALID_ADDRESS), m_return_type(return_type) {
141 lldb::addr_t start_load_addr = LLDB_INVALID_ADDRESS;
142 lldb::addr_t function_load_addr = LLDB_INVALID_ADDRESS;
145 if (!ConstructorSetup(thread, abi, start_load_addr, function_load_addr))
148 if (!abi->PrepareTrivialCall(thread, m_function_sp, function_load_addr,
149 start_load_addr, args))
152 ReportRegisterState("Function call was set up. Register state was:");
157 ThreadPlanCallFunction::ThreadPlanCallFunction(
158 Thread &thread, const Address &function,
159 const EvaluateExpressionOptions &options)
160 : ThreadPlan(ThreadPlan::eKindCallFunction, "Call function plan", thread,
161 eVoteNoOpinion, eVoteNoOpinion),
162 m_valid(false), m_stop_other_threads(options.GetStopOthers()),
163 m_unwind_on_error(options.DoesUnwindOnError()),
164 m_ignore_breakpoints(options.DoesIgnoreBreakpoints()),
165 m_debug_execution(options.GetDebug()),
166 m_trap_exceptions(options.GetTrapExceptions()), m_function_addr(function),
167 m_function_sp(0), m_takedown_done(false),
168 m_should_clear_objc_exception_bp(false),
169 m_should_clear_cxx_exception_bp(false),
170 m_stop_address(LLDB_INVALID_ADDRESS), m_return_type(CompilerType()) {}
172 ThreadPlanCallFunction::~ThreadPlanCallFunction() {
173 DoTakedown(PlanSucceeded());
176 void ThreadPlanCallFunction::ReportRegisterState(const char *message) {
177 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP |
178 LIBLLDB_LOG_VERBOSE));
181 RegisterContext *reg_ctx = m_thread.GetRegisterContext().get();
183 log->PutCString(message);
185 RegisterValue reg_value;
187 for (uint32_t reg_idx = 0, num_registers = reg_ctx->GetRegisterCount();
188 reg_idx < num_registers; ++reg_idx) {
189 const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex(reg_idx);
190 if (reg_ctx->ReadRegister(reg_info, reg_value)) {
191 reg_value.Dump(&strm, reg_info, true, false, eFormatDefault);
195 log->PutString(strm.GetString());
199 void ThreadPlanCallFunction::DoTakedown(bool success) {
200 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_STEP));
203 // Don't call DoTakedown if we were never valid to begin with.
205 log->Printf("ThreadPlanCallFunction(%p): Log called on "
206 "ThreadPlanCallFunction that was never valid.",
207 static_cast<void *>(this));
211 if (!m_takedown_done) {
216 log->Printf("ThreadPlanCallFunction(%p): DoTakedown called for thread "
217 "0x%4.4" PRIx64 ", m_valid: %d complete: %d.\n",
218 static_cast<void *>(this), m_thread.GetID(), m_valid,
220 m_takedown_done = true;
222 m_thread.GetStackFrameAtIndex(0)->GetRegisterContext()->GetPC();
223 m_real_stop_info_sp = GetPrivateStopInfo();
224 if (!m_thread.RestoreRegisterStateFromCheckpoint(m_stored_thread_state)) {
226 log->Printf("ThreadPlanCallFunction(%p): DoTakedown failed to restore "
228 static_cast<void *>(this));
230 SetPlanComplete(success);
232 if (log && log->GetVerbose())
233 ReportRegisterState("Restoring thread state after function call. "
234 "Restored register state:");
237 log->Printf("ThreadPlanCallFunction(%p): DoTakedown called as no-op for "
238 "thread 0x%4.4" PRIx64 ", m_valid: %d complete: %d.\n",
239 static_cast<void *>(this), m_thread.GetID(), m_valid,
244 void ThreadPlanCallFunction::WillPop() { DoTakedown(PlanSucceeded()); }
246 void ThreadPlanCallFunction::GetDescription(Stream *s, DescriptionLevel level) {
247 if (level == eDescriptionLevelBrief) {
248 s->Printf("Function call thread plan");
250 TargetSP target_sp(m_thread.CalculateTarget());
251 s->Printf("Thread plan to call 0x%" PRIx64,
252 m_function_addr.GetLoadAddress(target_sp.get()));
256 bool ThreadPlanCallFunction::ValidatePlan(Stream *error) {
259 if (m_constructor_errors.GetSize() > 0)
260 error->PutCString(m_constructor_errors.GetString());
262 error->PutCString("Unknown error");
270 Vote ThreadPlanCallFunction::ShouldReportStop(Event *event_ptr) {
271 if (m_takedown_done || IsPlanComplete())
274 return ThreadPlan::ShouldReportStop(event_ptr);
277 bool ThreadPlanCallFunction::DoPlanExplainsStop(Event *event_ptr) {
278 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_STEP |
279 LIBLLDB_LOG_PROCESS));
280 m_real_stop_info_sp = GetPrivateStopInfo();
282 // If our subplan knows why we stopped, even if it's done (which would forward
283 // the question to us)
285 if (m_subplan_sp && m_subplan_sp->PlanExplainsStop(event_ptr)) {
290 // Check if the breakpoint is one of ours.
292 StopReason stop_reason;
293 if (!m_real_stop_info_sp)
294 stop_reason = eStopReasonNone;
296 stop_reason = m_real_stop_info_sp->GetStopReason();
299 "ThreadPlanCallFunction::PlanExplainsStop: Got stop reason - %s.",
300 Thread::StopReasonAsCString(stop_reason));
302 if (stop_reason == eStopReasonBreakpoint && BreakpointsExplainStop())
305 // One more quirk here. If this event was from Halt interrupting the target,
306 // then we should not consider
307 // ourselves complete. Return true to acknowledge the stop.
308 if (Process::ProcessEventData::GetInterruptedFromEvent(event_ptr)) {
310 log->Printf("ThreadPlanCallFunction::PlanExplainsStop: The event is an "
311 "Interrupt, returning true.");
314 // We control breakpoints separately from other "stop reasons." So first,
315 // check the case where we stopped for an internal breakpoint, in that case,
317 // If it is not an internal breakpoint, consult m_ignore_breakpoints.
319 if (stop_reason == eStopReasonBreakpoint) {
320 ProcessSP process_sp(m_thread.CalculateProcess());
321 uint64_t break_site_id = m_real_stop_info_sp->GetValue();
322 BreakpointSiteSP bp_site_sp;
324 bp_site_sp = process_sp->GetBreakpointSiteList().FindByID(break_site_id);
326 uint32_t num_owners = bp_site_sp->GetNumberOfOwners();
327 bool is_internal = true;
328 for (uint32_t i = 0; i < num_owners; i++) {
329 Breakpoint &bp = bp_site_sp->GetOwnerAtIndex(i)->GetBreakpoint();
331 log->Printf("ThreadPlanCallFunction::PlanExplainsStop: hit "
332 "breakpoint %d while calling function",
335 if (!bp.IsInternal()) {
342 log->Printf("ThreadPlanCallFunction::PlanExplainsStop hit an "
343 "internal breakpoint, not stopping.");
348 if (m_ignore_breakpoints) {
350 log->Printf("ThreadPlanCallFunction::PlanExplainsStop: we are ignoring "
351 "breakpoints, overriding breakpoint stop info ShouldStop, "
353 m_real_stop_info_sp->OverrideShouldStop(false);
357 log->Printf("ThreadPlanCallFunction::PlanExplainsStop: we are not "
358 "ignoring breakpoints, overriding breakpoint stop info "
359 "ShouldStop, returning true");
360 m_real_stop_info_sp->OverrideShouldStop(true);
363 } else if (!m_unwind_on_error) {
364 // If we don't want to discard this plan, than any stop we don't understand
365 // should be propagated up the stack.
368 // If the subplan is running, any crashes are attributable to us.
369 // If we want to discard the plan, then we say we explain the stop
370 // but if we are going to be discarded, let whoever is above us
372 // But don't discard the plan if the stop would restart itself (for instance
374 // signal that is set not to stop. Check that here first. We just say we
376 // but aren't done and everything will continue on from there.
378 if (m_real_stop_info_sp &&
379 m_real_stop_info_sp->ShouldStopSynchronous(event_ptr)) {
380 SetPlanComplete(false);
381 return m_subplan_sp ? m_unwind_on_error : false;
387 bool ThreadPlanCallFunction::ShouldStop(Event *event_ptr) {
388 // We do some computation in DoPlanExplainsStop that may or may not set the
390 // We need to do that here to make sure our state is correct.
391 DoPlanExplainsStop(event_ptr);
393 if (IsPlanComplete()) {
394 ReportRegisterState("Function completed. Register state was:");
401 bool ThreadPlanCallFunction::StopOthers() { return m_stop_other_threads; }
403 StateType ThreadPlanCallFunction::GetPlanRunState() { return eStateRunning; }
405 void ThreadPlanCallFunction::DidPush() {
406 //#define SINGLE_STEP_EXPRESSIONS
408 // Now set the thread state to "no reason" so we don't run with whatever
409 // signal was outstanding...
410 // Wait till the plan is pushed so we aren't changing the stop info till we're
413 GetThread().SetStopInfoToNothing();
415 #ifndef SINGLE_STEP_EXPRESSIONS
417 new ThreadPlanRunToAddress(m_thread, m_start_addr, m_stop_other_threads));
419 m_thread.QueueThreadPlan(m_subplan_sp, false);
420 m_subplan_sp->SetPrivate(true);
424 bool ThreadPlanCallFunction::WillStop() { return true; }
426 bool ThreadPlanCallFunction::MischiefManaged() {
427 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
429 if (IsPlanComplete()) {
431 log->Printf("ThreadPlanCallFunction(%p): Completed call function plan.",
432 static_cast<void *>(this));
434 ThreadPlan::MischiefManaged();
441 void ThreadPlanCallFunction::SetBreakpoints() {
442 ProcessSP process_sp(m_thread.CalculateProcess());
443 if (m_trap_exceptions && process_sp) {
444 m_cxx_language_runtime =
445 process_sp->GetLanguageRuntime(eLanguageTypeC_plus_plus);
446 m_objc_language_runtime = process_sp->GetLanguageRuntime(eLanguageTypeObjC);
448 if (m_cxx_language_runtime) {
449 m_should_clear_cxx_exception_bp =
450 !m_cxx_language_runtime->ExceptionBreakpointsAreSet();
451 m_cxx_language_runtime->SetExceptionBreakpoints();
453 if (m_objc_language_runtime) {
454 m_should_clear_objc_exception_bp =
455 !m_objc_language_runtime->ExceptionBreakpointsAreSet();
456 m_objc_language_runtime->SetExceptionBreakpoints();
461 void ThreadPlanCallFunction::ClearBreakpoints() {
462 if (m_trap_exceptions) {
463 if (m_cxx_language_runtime && m_should_clear_cxx_exception_bp)
464 m_cxx_language_runtime->ClearExceptionBreakpoints();
465 if (m_objc_language_runtime && m_should_clear_objc_exception_bp)
466 m_objc_language_runtime->ClearExceptionBreakpoints();
470 bool ThreadPlanCallFunction::BreakpointsExplainStop() {
471 StopInfoSP stop_info_sp = GetPrivateStopInfo();
473 if (m_trap_exceptions) {
474 if ((m_cxx_language_runtime &&
475 m_cxx_language_runtime->ExceptionBreakpointsExplainStop(
477 (m_objc_language_runtime &&
478 m_objc_language_runtime->ExceptionBreakpointsExplainStop(
480 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_STEP));
482 log->Printf("ThreadPlanCallFunction::BreakpointsExplainStop - Hit an "
483 "exception breakpoint, setting plan complete.");
485 SetPlanComplete(false);
487 // If the user has set the ObjC language breakpoint, it would normally get
488 // priority over our internal
489 // catcher breakpoint, but in this case we can't let that happen, so force
490 // the ShouldStop here.
491 stop_info_sp->OverrideShouldStop(true);
499 void ThreadPlanCallFunction::SetStopOthers(bool new_value) {
500 m_subplan_sp->SetStopOthers(new_value);
503 bool ThreadPlanCallFunction::RestoreThreadState() {
504 return GetThread().RestoreThreadStateFromCheckpoint(m_stored_thread_state);
507 void ThreadPlanCallFunction::SetReturnValue() {
508 ProcessSP process_sp(m_thread.GetProcess());
509 const ABI *abi = process_sp ? process_sp->GetABI().get() : nullptr;
510 if (abi && m_return_type.IsValid()) {
511 const bool persistent = false;
513 abi->GetReturnValueObject(m_thread, m_return_type, persistent);