1 //===-- ThreadPlanCallFunction.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 
10 #include "lldb/Target/ThreadPlanCallFunction.h"
11 
12 // C Includes
13 // C++ Includes
14 // Other libraries and framework includes
15 #include "llvm/Support/MachO.h"
16 // Project includes
17 #include "lldb/lldb-private-log.h"
18 #include "lldb/Breakpoint/Breakpoint.h"
19 #include "lldb/Breakpoint/BreakpointLocation.h"
20 #include "lldb/Core/Address.h"
21 #include "lldb/Core/Log.h"
22 #include "lldb/Core/Module.h"
23 #include "lldb/Core/Stream.h"
24 #include "lldb/Symbol/ObjectFile.h"
25 #include "lldb/Target/LanguageRuntime.h"
26 #include "lldb/Target/Process.h"
27 #include "lldb/Target/RegisterContext.h"
28 #include "lldb/Target/StopInfo.h"
29 #include "lldb/Target/Target.h"
30 #include "lldb/Target/Thread.h"
31 #include "lldb/Target/ThreadPlanRunToAddress.h"
32 
33 using namespace lldb;
34 using namespace lldb_private;
35 
36 //----------------------------------------------------------------------
37 // ThreadPlanCallFunction: Plan to call a single function
38 //----------------------------------------------------------------------
39 bool
40 ThreadPlanCallFunction::ConstructorSetup (Thread &thread,
41                                           ABI *& abi,
42                                           lldb::addr_t &start_load_addr,
43                                           lldb::addr_t &function_load_addr)
44 {
45     SetIsMasterPlan (true);
46     SetOkayToDiscard (false);
47 
48     ProcessSP process_sp (thread.GetProcess());
49     if (!process_sp)
50         return false;
51 
52     abi = process_sp->GetABI().get();
53 
54     if (!abi)
55         return false;
56 
57     TargetSP target_sp (thread.CalculateTarget());
58 
59     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP));
60 
61     SetBreakpoints();
62 
63     m_function_sp = thread.GetRegisterContext()->GetSP() - abi->GetRedZoneSize();
64     // If we can't read memory at the point of the process where we are planning to put our function, we're
65     // not going to get any further...
66     Error error;
67     process_sp->ReadUnsignedIntegerFromMemory(m_function_sp, 4, 0, error);
68     if (!error.Success())
69     {
70         if (log)
71             log->Printf ("ThreadPlanCallFunction(%p): Trying to put the stack in unreadable memory at: 0x%llx.", this, m_function_sp);
72         return false;
73     }
74 
75     Module *exe_module = target_sp->GetExecutableModulePointer();
76 
77     if (exe_module == NULL)
78     {
79         if (log)
80             log->Printf ("ThreadPlanCallFunction(%p): Can't execute code without an executable module.", this);
81         return false;
82     }
83     else
84     {
85         ObjectFile *objectFile = exe_module->GetObjectFile();
86         if (!objectFile)
87         {
88             if (log)
89                 log->Printf ("ThreadPlanCallFunction(%p): Could not find object file for module \"%s\".",
90                              this, exe_module->GetFileSpec().GetFilename().AsCString());
91             return false;
92         }
93         m_start_addr = objectFile->GetEntryPointAddress();
94         if (!m_start_addr.IsValid())
95         {
96             if (log)
97                 log->Printf ("ThreadPlanCallFunction(%p): Could not find entry point address for executable module \"%s\".",
98                              this, exe_module->GetFileSpec().GetFilename().AsCString());
99             return false;
100         }
101     }
102 
103     start_load_addr = m_start_addr.GetLoadAddress (target_sp.get());
104 
105     // Checkpoint the thread state so we can restore it later.
106     if (log && log->GetVerbose())
107         ReportRegisterState ("About to checkpoint thread before function call.  Original register state was:");
108 
109     if (!thread.CheckpointThreadState (m_stored_thread_state))
110     {
111         if (log)
112             log->Printf ("ThreadPlanCallFunction(%p): Setting up ThreadPlanCallFunction, failed to checkpoint thread state.", this);
113         return false;
114     }
115     // Now set the thread state to "no reason" so we don't run with whatever signal was outstanding...
116     thread.SetStopInfoToNothing();
117 
118     function_load_addr = m_function_addr.GetLoadAddress (target_sp.get());
119 
120     return true;
121 }
122 
123 ThreadPlanCallFunction::ThreadPlanCallFunction (Thread &thread,
124                                                 Address &function,
125                                                 const ClangASTType &return_type,
126                                                 addr_t arg,
127                                                 bool stop_other_threads,
128                                                 bool discard_on_error,
129                                                 addr_t *this_arg,
130                                                 addr_t *cmd_arg) :
131     ThreadPlan (ThreadPlan::eKindCallFunction, "Call function plan", thread, eVoteNoOpinion, eVoteNoOpinion),
132     m_valid (false),
133     m_stop_other_threads (stop_other_threads),
134     m_function_addr (function),
135     m_function_sp (0),
136     m_return_type (return_type),
137     m_takedown_done (false),
138     m_stop_address (LLDB_INVALID_ADDRESS),
139     m_discard_on_error (discard_on_error)
140 {
141     lldb::addr_t start_load_addr;
142     ABI *abi;
143     lldb::addr_t function_load_addr;
144     if (!ConstructorSetup (thread, abi, start_load_addr, function_load_addr))
145         return;
146 
147     if (this_arg && cmd_arg)
148     {
149         if (!abi->PrepareTrivialCall (thread,
150                                       m_function_sp,
151                                       function_load_addr,
152                                       start_load_addr,
153                                       this_arg,
154                                       cmd_arg,
155                                       &arg))
156             return;
157     }
158     else if (this_arg)
159     {
160         if (!abi->PrepareTrivialCall (thread,
161                                       m_function_sp,
162                                       function_load_addr,
163                                       start_load_addr,
164                                       this_arg,
165                                       &arg))
166             return;
167     }
168     else
169     {
170         if (!abi->PrepareTrivialCall (thread,
171                                       m_function_sp,
172                                       function_load_addr,
173                                       start_load_addr,
174                                       &arg))
175             return;
176     }
177 
178     ReportRegisterState ("Function call was set up.  Register state was:");
179 
180     m_valid = true;
181 }
182 
183 
184 ThreadPlanCallFunction::ThreadPlanCallFunction (Thread &thread,
185                                                 Address &function,
186                                                 const ClangASTType &return_type,
187                                                 bool stop_other_threads,
188                                                 bool discard_on_error,
189                                                 addr_t *arg1_ptr,
190                                                 addr_t *arg2_ptr,
191                                                 addr_t *arg3_ptr,
192                                                 addr_t *arg4_ptr,
193                                                 addr_t *arg5_ptr,
194                                                 addr_t *arg6_ptr) :
195     ThreadPlan (ThreadPlan::eKindCallFunction, "Call function plan", thread, eVoteNoOpinion, eVoteNoOpinion),
196     m_valid (false),
197     m_stop_other_threads (stop_other_threads),
198     m_function_addr (function),
199     m_function_sp(0),
200     m_return_type (return_type),
201     m_takedown_done (false),
202     m_stop_address (LLDB_INVALID_ADDRESS)
203 {
204     lldb::addr_t start_load_addr;
205     ABI *abi;
206     lldb::addr_t function_load_addr;
207     if (!ConstructorSetup (thread, abi, start_load_addr, function_load_addr))
208         return;
209 
210     if (!abi->PrepareTrivialCall (thread,
211                                   m_function_sp,
212                                   function_load_addr,
213                                   start_load_addr,
214                                   arg1_ptr,
215                                   arg2_ptr,
216                                   arg3_ptr,
217                                   arg4_ptr,
218                                   arg5_ptr,
219                                   arg6_ptr))
220     {
221             return;
222     }
223 
224     ReportRegisterState ("Function call was set up.  Register state was:");
225 
226     m_valid = true;
227 }
228 
229 ThreadPlanCallFunction::~ThreadPlanCallFunction ()
230 {
231     DoTakedown(true);
232 }
233 
234 void
235 ThreadPlanCallFunction::ReportRegisterState (const char *message)
236 {
237     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_VERBOSE));
238     if (log)
239     {
240         StreamString strm;
241         RegisterContext *reg_ctx = m_thread.GetRegisterContext().get();
242 
243         log->PutCString(message);
244 
245         RegisterValue reg_value;
246 
247         for (uint32_t reg_idx = 0, num_registers = reg_ctx->GetRegisterCount();
248              reg_idx < num_registers;
249              ++reg_idx)
250         {
251             const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex (reg_idx);
252             if (reg_ctx->ReadRegister(reg_info, reg_value))
253             {
254                 reg_value.Dump(&strm, reg_info, true, false, eFormatDefault);
255                 strm.EOL();
256             }
257         }
258         log->PutCString(strm.GetData());
259     }
260 }
261 
262 void
263 ThreadPlanCallFunction::DoTakedown (bool success)
264 {
265     LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP));
266 
267     if (!m_valid)
268     {
269         //Don't call DoTakedown if we were never valid to begin with.
270         if (log)
271             log->Printf ("ThreadPlanCallFunction(%p): Log called on ThreadPlanCallFunction that was never valid.", this);
272         return;
273     }
274 
275     if (!m_takedown_done)
276     {
277         if (success)
278         {
279             ProcessSP process_sp (m_thread.GetProcess());
280             const ABI *abi = process_sp ? process_sp->GetABI().get() : NULL;
281             if (abi && m_return_type.IsValid())
282             {
283                 const bool persistent = false;
284                 m_return_valobj_sp = abi->GetReturnValueObject (m_thread, m_return_type, persistent);
285             }
286         }
287         if (log)
288             log->Printf ("ThreadPlanCallFunction(%p): DoTakedown called for thread 0x%4.4llx, m_valid: %d complete: %d.\n", this, m_thread.GetID(), m_valid, IsPlanComplete());
289         m_takedown_done = true;
290         m_stop_address = m_thread.GetStackFrameAtIndex(0)->GetRegisterContext()->GetPC();
291         m_real_stop_info_sp = GetPrivateStopReason();
292         m_thread.RestoreThreadStateFromCheckpoint(m_stored_thread_state);
293         SetPlanComplete(success);
294         ClearBreakpoints();
295         if (log && log->GetVerbose())
296             ReportRegisterState ("Restoring thread state after function call.  Restored register state:");
297 
298     }
299     else
300     {
301         if (log)
302             log->Printf ("ThreadPlanCallFunction(%p): DoTakedown called as no-op for thread 0x%4.4llx, m_valid: %d complete: %d.\n", this, m_thread.GetID(), m_valid, IsPlanComplete());
303     }
304 }
305 
306 void
307 ThreadPlanCallFunction::WillPop ()
308 {
309     DoTakedown(true);
310 }
311 
312 void
313 ThreadPlanCallFunction::GetDescription (Stream *s, DescriptionLevel level)
314 {
315     if (level == eDescriptionLevelBrief)
316     {
317         s->Printf("Function call thread plan");
318     }
319     else
320     {
321         TargetSP target_sp (m_thread.CalculateTarget());
322         s->Printf("Thread plan to call 0x%llx", m_function_addr.GetLoadAddress(target_sp.get()));
323     }
324 }
325 
326 bool
327 ThreadPlanCallFunction::ValidatePlan (Stream *error)
328 {
329     if (!m_valid)
330         return false;
331 
332     return true;
333 }
334 
335 bool
336 ThreadPlanCallFunction::PlanExplainsStop ()
337 {
338     m_real_stop_info_sp = GetPrivateStopReason();
339 
340     // If our subplan knows why we stopped, even if it's done (which would forward the question to us)
341     // we answer yes.
342     if (m_subplan_sp.get() != NULL && m_subplan_sp->PlanExplainsStop())
343         return true;
344 
345     // Check if the breakpoint is one of ours.
346 
347     StopReason stop_reason;
348     if (!m_real_stop_info_sp)
349         stop_reason = eStopReasonNone;
350     else
351         stop_reason = m_real_stop_info_sp->GetStopReason();
352 
353     if (stop_reason == eStopReasonBreakpoint && BreakpointsExplainStop())
354         return true;
355 
356     // If we don't want to discard this plan, than any stop we don't understand should be propagated up the stack.
357     if (!m_discard_on_error)
358         return false;
359 
360     // Otherwise, check the case where we stopped for an internal breakpoint, in that case, continue on.
361     // If it is not an internal breakpoint, consult OkayToDiscard.
362 
363 
364     if (stop_reason == eStopReasonBreakpoint)
365     {
366         ProcessSP process_sp (m_thread.CalculateProcess());
367         uint64_t break_site_id = m_real_stop_info_sp->GetValue();
368         BreakpointSiteSP bp_site_sp;
369         if (process_sp)
370             bp_site_sp = process_sp->GetBreakpointSiteList().FindByID(break_site_id);
371         if (bp_site_sp)
372         {
373             uint32_t num_owners = bp_site_sp->GetNumberOfOwners();
374             bool is_internal = true;
375             for (uint32_t i = 0; i < num_owners; i++)
376             {
377                 Breakpoint &bp = bp_site_sp->GetOwnerAtIndex(i)->GetBreakpoint();
378 
379                 if (!bp.IsInternal())
380                 {
381                     is_internal = false;
382                     break;
383                 }
384             }
385             if (is_internal)
386                 return false;
387         }
388 
389         if (m_discard_on_error)
390         {
391             DoTakedown(false);
392             return true;
393         }
394         else
395             return false;
396     }
397     else
398     {
399         // If the subplan is running, any crashes are attributable to us.
400         // If we want to discard the plan, then we say we explain the stop
401         // but if we are going to be discarded, let whoever is above us
402         // explain the stop.
403         if (m_subplan_sp)
404         {
405             if (m_discard_on_error)
406             {
407                 DoTakedown(false);
408                 return true;
409             }
410             else
411                 return false;
412         }
413         else
414             return false;
415     }
416 }
417 
418 bool
419 ThreadPlanCallFunction::ShouldStop (Event *event_ptr)
420 {
421     if (IsPlanComplete() || PlanExplainsStop())
422     {
423         ReportRegisterState ("Function completed.  Register state was:");
424 
425         DoTakedown(true);
426 
427         return true;
428     }
429     else
430     {
431         return false;
432     }
433 }
434 
435 bool
436 ThreadPlanCallFunction::StopOthers ()
437 {
438     return m_stop_other_threads;
439 }
440 
441 void
442 ThreadPlanCallFunction::SetStopOthers (bool new_value)
443 {
444     if (m_subplan_sp)
445     {
446         ThreadPlanRunToAddress *address_plan = static_cast<ThreadPlanRunToAddress *>(m_subplan_sp.get());
447         address_plan->SetStopOthers(new_value);
448     }
449     m_stop_other_threads = new_value;
450 }
451 
452 StateType
453 ThreadPlanCallFunction::GetPlanRunState ()
454 {
455     return eStateRunning;
456 }
457 
458 void
459 ThreadPlanCallFunction::DidPush ()
460 {
461 //#define SINGLE_STEP_EXPRESSIONS
462 
463 #ifndef SINGLE_STEP_EXPRESSIONS
464     m_subplan_sp.reset(new ThreadPlanRunToAddress(m_thread, m_start_addr, m_stop_other_threads));
465 
466     m_thread.QueueThreadPlan(m_subplan_sp, false);
467     m_subplan_sp->SetPrivate (true);
468 #endif
469 }
470 
471 bool
472 ThreadPlanCallFunction::WillStop ()
473 {
474     return true;
475 }
476 
477 bool
478 ThreadPlanCallFunction::MischiefManaged ()
479 {
480     if (IsPlanComplete())
481     {
482         LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
483 
484         if (log)
485             log->Printf("ThreadPlanCallFunction(%p): Completed call function plan.", this);
486 
487         ThreadPlan::MischiefManaged ();
488         return true;
489     }
490     else
491     {
492         return false;
493     }
494 }
495 
496 void
497 ThreadPlanCallFunction::SetBreakpoints ()
498 {
499     ProcessSP process_sp (m_thread.CalculateProcess());
500     if (process_sp)
501     {
502         m_cxx_language_runtime = process_sp->GetLanguageRuntime(eLanguageTypeC_plus_plus);
503         m_objc_language_runtime = process_sp->GetLanguageRuntime(eLanguageTypeObjC);
504 
505         if (m_cxx_language_runtime)
506             m_cxx_language_runtime->SetExceptionBreakpoints();
507         if (m_objc_language_runtime)
508             m_objc_language_runtime->SetExceptionBreakpoints();
509     }
510 }
511 
512 void
513 ThreadPlanCallFunction::ClearBreakpoints ()
514 {
515     if (m_cxx_language_runtime)
516         m_cxx_language_runtime->ClearExceptionBreakpoints();
517     if (m_objc_language_runtime)
518         m_objc_language_runtime->ClearExceptionBreakpoints();
519 }
520 
521 bool
522 ThreadPlanCallFunction::BreakpointsExplainStop()
523 {
524     StopInfoSP stop_info_sp = GetPrivateStopReason();
525 
526     if (m_cxx_language_runtime &&
527         m_cxx_language_runtime->ExceptionBreakpointsExplainStop(stop_info_sp))
528         return true;
529 
530     if (m_objc_language_runtime &&
531         m_objc_language_runtime->ExceptionBreakpointsExplainStop(stop_info_sp))
532         return true;
533 
534     return false;
535 }
536