1 //===-- StackFrame.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/StackFrame.h"
11 
12 // C Includes
13 // C++ Includes
14 // Other libraries and framework includes
15 // Project includes
16 #include "lldb/Core/Module.h"
17 #include "lldb/Core/Debugger.h"
18 #include "lldb/Core/Disassembler.h"
19 #include "lldb/Core/Value.h"
20 #include "lldb/Core/ValueObjectVariable.h"
21 #include "lldb/Core/ValueObjectConstResult.h"
22 #include "lldb/Symbol/Function.h"
23 #include "lldb/Symbol/VariableList.h"
24 #include "lldb/Target/ExecutionContext.h"
25 #include "lldb/Target/Process.h"
26 #include "lldb/Target/RegisterContext.h"
27 #include "lldb/Target/Target.h"
28 #include "lldb/Target/Thread.h"
29 
30 using namespace lldb;
31 using namespace lldb_private;
32 
33 // The first bits in the flags are reserved for the SymbolContext::Scope bits
34 // so we know if we have tried to look up information in our internal symbol
35 // context (m_sc) already.
36 #define RESOLVED_FRAME_CODE_ADDR        (uint32_t(eSymbolContextEverything + 1))
37 #define RESOLVED_FRAME_ID_SYMBOL_SCOPE  (RESOLVED_FRAME_CODE_ADDR << 1)
38 #define GOT_FRAME_BASE                  (RESOLVED_FRAME_ID_SYMBOL_SCOPE << 1)
39 #define RESOLVED_VARIABLES              (GOT_FRAME_BASE << 1)
40 #define RESOLVED_GLOBAL_VARIABLES       (RESOLVED_VARIABLES << 1)
41 
42 StackFrame::StackFrame
43 (
44     lldb::user_id_t frame_idx,
45     lldb::user_id_t unwind_frame_index,
46     Thread &thread,
47     lldb::addr_t cfa,
48     lldb::addr_t pc,
49     const SymbolContext *sc_ptr
50 ) :
51     m_thread (thread),
52     m_frame_index (frame_idx),
53     m_concrete_frame_index (unwind_frame_index),
54     m_reg_context_sp (),
55     m_id (pc, cfa, NULL),
56     m_frame_code_addr (NULL, pc),
57     m_sc (),
58     m_flags (),
59     m_frame_base (),
60     m_frame_base_error (),
61     m_variable_list_sp (),
62     m_variable_list_value_objects (),
63     m_disassembly ()
64 {
65     if (sc_ptr != NULL)
66     {
67         m_sc = *sc_ptr;
68         m_flags.Set(m_sc.GetResolvedMask ());
69     }
70 }
71 
72 StackFrame::StackFrame
73 (
74     lldb::user_id_t frame_idx,
75     lldb::user_id_t unwind_frame_index,
76     Thread &thread,
77     const RegisterContextSP &reg_context_sp,
78     lldb::addr_t cfa,
79     lldb::addr_t pc,
80     const SymbolContext *sc_ptr
81 ) :
82     m_thread (thread),
83     m_frame_index (frame_idx),
84     m_concrete_frame_index (unwind_frame_index),
85     m_reg_context_sp (reg_context_sp),
86     m_id (pc, cfa, NULL),
87     m_frame_code_addr (NULL, pc),
88     m_sc (),
89     m_flags (),
90     m_frame_base (),
91     m_frame_base_error (),
92     m_variable_list_sp (),
93     m_variable_list_value_objects (),
94     m_disassembly ()
95 {
96     if (sc_ptr != NULL)
97     {
98         m_sc = *sc_ptr;
99         m_flags.Set(m_sc.GetResolvedMask ());
100     }
101 
102     if (reg_context_sp && !m_sc.target_sp)
103     {
104         m_sc.target_sp = reg_context_sp->GetThread().GetProcess().GetTarget().GetSP();
105         m_flags.Set (eSymbolContextTarget);
106     }
107 }
108 
109 StackFrame::StackFrame
110 (
111     lldb::user_id_t frame_idx,
112     lldb::user_id_t unwind_frame_index,
113     Thread &thread,
114     const RegisterContextSP &reg_context_sp,
115     lldb::addr_t cfa,
116     const Address& pc_addr,
117     const SymbolContext *sc_ptr
118 ) :
119     m_thread (thread),
120     m_frame_index (frame_idx),
121     m_concrete_frame_index (unwind_frame_index),
122     m_reg_context_sp (reg_context_sp),
123     m_id (pc_addr.GetLoadAddress (&thread.GetProcess().GetTarget()), cfa, NULL),
124     m_frame_code_addr (pc_addr),
125     m_sc (),
126     m_flags (),
127     m_frame_base (),
128     m_frame_base_error (),
129     m_variable_list_sp (),
130     m_variable_list_value_objects (),
131     m_disassembly ()
132 {
133     if (sc_ptr != NULL)
134     {
135         m_sc = *sc_ptr;
136         m_flags.Set(m_sc.GetResolvedMask ());
137     }
138 
139     if (m_sc.target_sp.get() == NULL && reg_context_sp)
140     {
141         m_sc.target_sp = reg_context_sp->GetThread().GetProcess().GetTarget().GetSP();
142         m_flags.Set (eSymbolContextTarget);
143     }
144 
145     Module *pc_module = pc_addr.GetModule();
146     if (m_sc.module_sp.get() == NULL || m_sc.module_sp.get() != pc_module)
147     {
148         if (pc_module)
149         {
150             m_sc.module_sp = pc_module->GetSP();
151             m_flags.Set (eSymbolContextModule);
152         }
153         else
154         {
155             m_sc.module_sp.reset();
156         }
157 
158     }
159 }
160 
161 
162 //----------------------------------------------------------------------
163 // Destructor
164 //----------------------------------------------------------------------
165 StackFrame::~StackFrame()
166 {
167 }
168 
169 StackID&
170 StackFrame::GetStackID()
171 {
172     // Make sure we have resolved the StackID object's symbol context scope if
173     // we already haven't looked it up.
174 
175     if (m_flags.IsClear (RESOLVED_FRAME_ID_SYMBOL_SCOPE))
176     {
177         if (m_id.GetSymbolContextScope ())
178         {
179             // We already have a symbol context scope, we just don't have our
180             // flag bit set.
181             m_flags.Set (RESOLVED_FRAME_ID_SYMBOL_SCOPE);
182         }
183         else
184         {
185             // Calculate the frame block and use this for the stack ID symbol
186             // context scope if we have one.
187             SymbolContextScope *scope = GetFrameBlock ();
188             if (scope == NULL)
189             {
190                 // We don't have a block, so use the symbol
191                 if (m_flags.IsClear (eSymbolContextSymbol))
192                     GetSymbolContext (eSymbolContextSymbol);
193 
194                 // It is ok if m_sc.symbol is NULL here
195                 scope = m_sc.symbol;
196             }
197             // Set the symbol context scope (the accessor will set the
198             // RESOLVED_FRAME_ID_SYMBOL_SCOPE bit in m_flags).
199             SetSymbolContextScope (scope);
200         }
201     }
202     return m_id;
203 }
204 
205 void
206 StackFrame::SetSymbolContextScope (SymbolContextScope *symbol_scope)
207 {
208     m_flags.Set (RESOLVED_FRAME_ID_SYMBOL_SCOPE);
209     m_id.SetSymbolContextScope (symbol_scope);
210 }
211 
212 Address&
213 StackFrame::GetFrameCodeAddress()
214 {
215     if (m_flags.IsClear(RESOLVED_FRAME_CODE_ADDR) && !m_frame_code_addr.IsSectionOffset())
216     {
217         m_flags.Set (RESOLVED_FRAME_CODE_ADDR);
218 
219         // Resolve the PC into a temporary address because if ResolveLoadAddress
220         // fails to resolve the address, it will clear the address object...
221         Address resolved_pc;
222         if (m_thread.GetProcess().GetTarget().GetSectionLoadList().ResolveLoadAddress(m_frame_code_addr.GetOffset(), resolved_pc))
223         {
224             m_frame_code_addr = resolved_pc;
225             const Section *section = m_frame_code_addr.GetSection();
226             if (section)
227             {
228                 Module *module = section->GetModule();
229                 if (module)
230                 {
231                     m_sc.module_sp = module->GetSP();
232                     if (m_sc.module_sp)
233                         m_flags.Set(eSymbolContextModule);
234                 }
235             }
236         }
237     }
238     return m_frame_code_addr;
239 }
240 
241 void
242 StackFrame::ChangePC (addr_t pc)
243 {
244     m_frame_code_addr.SetOffset(pc);
245     m_frame_code_addr.SetSection(NULL);
246     m_sc.Clear();
247     m_flags.Reset(0);
248     m_thread.ClearStackFrames ();
249 }
250 
251 const char *
252 StackFrame::Disassemble ()
253 {
254     if (m_disassembly.GetSize() == 0)
255     {
256         ExecutionContext exe_ctx;
257         CalculateExecutionContext(exe_ctx);
258         Target &target = m_thread.GetProcess().GetTarget();
259         Disassembler::Disassemble (target.GetDebugger(),
260                                    target.GetArchitecture(),
261                                    NULL,
262                                    exe_ctx,
263                                    0,
264                                    0,
265                                    false,
266                                    false,
267                                    m_disassembly);
268         if (m_disassembly.GetSize() == 0)
269             return NULL;
270     }
271     return m_disassembly.GetData();
272 }
273 
274 Block *
275 StackFrame::GetFrameBlock ()
276 {
277     if (m_sc.block == NULL && m_flags.IsClear (eSymbolContextBlock))
278         GetSymbolContext (eSymbolContextBlock);
279 
280     if (m_sc.block)
281     {
282         Block *inline_block = m_sc.block->GetContainingInlinedBlock();
283         if (inline_block)
284         {
285             // Use the block with the inlined function info
286             // as the frame block we want this frame to have only the variables
287             // for the inlined function and its non-inlined block child blocks.
288             return inline_block;
289         }
290         else
291         {
292             // This block is not contained withing any inlined function blocks
293             // with so we want to use the top most function block.
294             return &m_sc.function->GetBlock (false);
295         }
296     }
297     return NULL;
298 }
299 
300 //----------------------------------------------------------------------
301 // Get the symbol context if we already haven't done so by resolving the
302 // PC address as much as possible. This way when we pass around a
303 // StackFrame object, everyone will have as much information as
304 // possible and no one will ever have to look things up manually.
305 //----------------------------------------------------------------------
306 const SymbolContext&
307 StackFrame::GetSymbolContext (uint32_t resolve_scope)
308 {
309     // Copy our internal symbol context into "sc".
310     if ((m_flags.Get() & resolve_scope) != resolve_scope)
311     {
312         // Resolve our PC to section offset if we haven't alreday done so
313         // and if we don't have a module. The resolved address section will
314         // contain the module to which it belongs
315         if (!m_sc.module_sp && m_flags.IsClear(RESOLVED_FRAME_CODE_ADDR))
316             GetFrameCodeAddress();
317 
318         // If this is not frame zero, then we need to subtract 1 from the PC
319         // value when doing address lookups since the PC will be on the
320         // instruction following the function call instruction...
321 
322         Address lookup_addr(GetFrameCodeAddress());
323         if (m_frame_index > 0 && lookup_addr.IsValid())
324         {
325             addr_t offset = lookup_addr.GetOffset();
326             if (offset > 0)
327                 lookup_addr.SetOffset(offset - 1);
328         }
329 
330 
331         uint32_t resolved = 0;
332         if (m_sc.module_sp)
333         {
334             // We have something in our stack frame symbol context, lets check
335             // if we haven't already tried to lookup one of those things. If we
336             // haven't then we will do the query.
337 
338             uint32_t actual_resolve_scope = 0;
339 
340             if (resolve_scope & eSymbolContextCompUnit)
341             {
342                 if (m_flags.IsClear (eSymbolContextCompUnit))
343                 {
344                     if (m_sc.comp_unit)
345                         resolved |= eSymbolContextCompUnit;
346                     else
347                         actual_resolve_scope |= eSymbolContextCompUnit;
348                 }
349             }
350 
351             if (resolve_scope & eSymbolContextFunction)
352             {
353                 if (m_flags.IsClear (eSymbolContextFunction))
354                 {
355                     if (m_sc.function)
356                         resolved |= eSymbolContextFunction;
357                     else
358                         actual_resolve_scope |= eSymbolContextFunction;
359                 }
360             }
361 
362             if (resolve_scope & eSymbolContextBlock)
363             {
364                 if (m_flags.IsClear (eSymbolContextBlock))
365                 {
366                     if (m_sc.block)
367                         resolved |= eSymbolContextBlock;
368                     else
369                         actual_resolve_scope |= eSymbolContextBlock;
370                 }
371             }
372 
373             if (resolve_scope & eSymbolContextSymbol)
374             {
375                 if (m_flags.IsClear (eSymbolContextSymbol))
376                 {
377                     if (m_sc.symbol)
378                         resolved |= eSymbolContextSymbol;
379                     else
380                         actual_resolve_scope |= eSymbolContextSymbol;
381                 }
382             }
383 
384             if (resolve_scope & eSymbolContextLineEntry)
385             {
386                 if (m_flags.IsClear (eSymbolContextLineEntry))
387                 {
388                     if (m_sc.line_entry.IsValid())
389                         resolved |= eSymbolContextLineEntry;
390                     else
391                         actual_resolve_scope |= eSymbolContextLineEntry;
392                 }
393             }
394 
395             if (actual_resolve_scope)
396             {
397                 // We might be resolving less information than what is already
398                 // in our current symbol context so resolve into a temporary
399                 // symbol context "sc" so we don't clear out data we have
400                 // already found in "m_sc"
401                 SymbolContext sc;
402                 // Set flags that indicate what we have tried to resolve
403                 resolved |= m_sc.module_sp->ResolveSymbolContextForAddress (lookup_addr, actual_resolve_scope, sc);
404                 // Only replace what we didn't already have as we may have
405                 // information for an inlined function scope that won't match
406                 // what a standard lookup by address would match
407                 if ((resolved & eSymbolContextCompUnit)  && m_sc.comp_unit == NULL)
408                     m_sc.comp_unit = sc.comp_unit;
409                 if ((resolved & eSymbolContextFunction)  && m_sc.function == NULL)
410                     m_sc.function = sc.function;
411                 if ((resolved & eSymbolContextBlock)     && m_sc.block == NULL)
412                     m_sc.block = sc.block;
413                 if ((resolved & eSymbolContextSymbol)    && m_sc.symbol == NULL)
414                     m_sc.symbol = sc.symbol;
415                 if ((resolved & eSymbolContextLineEntry) && !m_sc.line_entry.IsValid())
416                     m_sc.line_entry = sc.line_entry;
417 
418             }
419         }
420         else
421         {
422             // If we don't have a module, then we can't have the compile unit,
423             // function, block, line entry or symbol, so we can safely call
424             // ResolveSymbolContextForAddress with our symbol context member m_sc.
425             resolved |= m_thread.GetProcess().GetTarget().GetImages().ResolveSymbolContextForAddress (lookup_addr, resolve_scope, m_sc);
426         }
427 
428         // If the target was requested add that:
429         if (m_sc.target_sp.get() == NULL)
430         {
431             m_sc.target_sp = CalculateProcess()->GetTarget().GetSP();
432             if (m_sc.target_sp)
433                 resolved |= eSymbolContextTarget;
434         }
435 
436         // Update our internal flags so we remember what we have tried to locate so
437         // we don't have to keep trying when more calls to this function are made.
438         // We might have dug up more information that was requested (for example
439         // if we were asked to only get the block, we will have gotten the
440         // compile unit, and function) so set any additional bits that we resolved
441         m_flags.Set (resolve_scope | resolved);
442     }
443 
444     // Return the symbol context with everything that was possible to resolve
445     // resolved.
446     return m_sc;
447 }
448 
449 
450 VariableList *
451 StackFrame::GetVariableList (bool get_file_globals)
452 {
453     if (m_flags.IsClear(RESOLVED_VARIABLES))
454     {
455         m_flags.Set(RESOLVED_VARIABLES);
456 
457         Block *frame_block = GetFrameBlock();
458 
459         if (frame_block)
460         {
461             const bool get_child_variables = true;
462             const bool can_create = true;
463             m_variable_list_sp = frame_block->GetVariableList (get_child_variables, can_create);
464         }
465     }
466 
467     if (m_flags.IsClear(RESOLVED_GLOBAL_VARIABLES) &&
468         get_file_globals)
469     {
470         m_flags.Set(RESOLVED_GLOBAL_VARIABLES);
471 
472         if (m_flags.IsClear (eSymbolContextCompUnit))
473             GetSymbolContext (eSymbolContextCompUnit);
474 
475         if (m_sc.comp_unit)
476         {
477             VariableListSP global_variable_list_sp (m_sc.comp_unit->GetVariableList(true));
478             if (m_variable_list_sp)
479                 m_variable_list_sp->AddVariables (global_variable_list_sp.get());
480             else
481                 m_variable_list_sp = global_variable_list_sp;
482         }
483     }
484 
485     return m_variable_list_sp.get();
486 }
487 
488 ValueObjectSP
489 StackFrame::GetValueForVariableExpressionPath (const char *var_expr_cstr, uint32_t options, Error &error)
490 {
491 
492     if (var_expr_cstr && var_expr_cstr[0])
493     {
494         const bool check_ptr_vs_member = (options & eExpressionPathOptionCheckPtrVsMember) != 0;
495         const bool no_fragile_ivar = (options & eExpressionPathOptionsNoFragileObjcIvar) != 0;
496         error.Clear();
497         bool deref = false;
498         bool address_of = false;
499         ValueObjectSP valobj_sp;
500         const bool get_file_globals = true;
501         VariableList *variable_list = GetVariableList (get_file_globals);
502 
503         if (variable_list)
504         {
505             // If first character is a '*', then show pointer contents
506             const char *var_expr = var_expr_cstr;
507             if (var_expr[0] == '*')
508             {
509                 deref = true;
510                 var_expr++; // Skip the '*'
511             }
512             else if (var_expr[0] == '&')
513             {
514                 address_of = true;
515                 var_expr++; // Skip the '&'
516             }
517 
518             std::string var_path (var_expr);
519             size_t separator_idx = var_path.find_first_of(".-[=+~|&^%#@!/?,<>{}");
520             StreamString var_expr_path_strm;
521 
522             ConstString name_const_string;
523             if (separator_idx == std::string::npos)
524                 name_const_string.SetCString (var_path.c_str());
525             else
526                 name_const_string.SetCStringWithLength (var_path.c_str(), separator_idx);
527 
528             VariableSP var_sp (variable_list->FindVariable(name_const_string));
529             if (var_sp)
530             {
531                 valobj_sp = GetValueObjectForFrameVariable (var_sp);
532 
533                 var_path.erase (0, name_const_string.GetLength ());
534                 // We are dumping at least one child
535                 while (separator_idx != std::string::npos)
536                 {
537                     // Calculate the next separator index ahead of time
538                     ValueObjectSP child_valobj_sp;
539                     const char separator_type = var_path[0];
540                     switch (separator_type)
541                     {
542 
543                     case '-':
544                         if (var_path.size() >= 2 && var_path[1] != '>')
545                             return ValueObjectSP();
546 
547                         if (no_fragile_ivar)
548                         {
549                             // Make sure we aren't trying to deref an objective
550                             // C ivar if this is not allowed
551                             const uint32_t pointer_type_flags = ClangASTContext::GetTypeInfo (valobj_sp->GetClangType(), NULL, NULL);
552                             if ((pointer_type_flags & ClangASTContext::eTypeIsObjC) &&
553                                 (pointer_type_flags & ClangASTContext::eTypeIsPointer))
554                             {
555                                 // This was an objective C object pointer and
556                                 // it was requested we skip any fragile ivars
557                                 // so return nothing here
558                                 return ValueObjectSP();
559                             }
560                         }
561                         var_path.erase (0, 1); // Remove the '-'
562                         // Fall through
563                     case '.':
564                         {
565                             const bool expr_is_ptr = var_path[0] == '>';
566 
567                             var_path.erase (0, 1); // Remove the '.' or '>'
568                             separator_idx = var_path.find_first_of(".-[");
569                             ConstString child_name;
570                             if (separator_idx == std::string::npos)
571                                 child_name.SetCString (var_path.c_str());
572                             else
573                                 child_name.SetCStringWithLength(var_path.c_str(), separator_idx);
574 
575                             if (check_ptr_vs_member)
576                             {
577                                 // We either have a pointer type and need to verify
578                                 // valobj_sp is a pointer, or we have a member of a
579                                 // class/union/struct being accessed with the . syntax
580                                 // and need to verify we don't have a pointer.
581                                 const bool actual_is_ptr = valobj_sp->IsPointerType ();
582 
583                                 if (actual_is_ptr != expr_is_ptr)
584                                 {
585                                     // Incorrect use of "." with a pointer, or "->" with
586                                     // a class/union/struct instance or reference.
587                                     valobj_sp->GetExpressionPath (var_expr_path_strm, false);
588                                     if (actual_is_ptr)
589                                         error.SetErrorStringWithFormat ("\"%s\" is a pointer and . was used to attempt to access \"%s\". Did you mean \"%s->%s\"?",
590                                                                         var_expr_path_strm.GetString().c_str(),
591                                                                         child_name.GetCString(),
592                                                                         var_expr_path_strm.GetString().c_str(),
593                                                                         var_path.c_str());
594                                     else
595                                         error.SetErrorStringWithFormat ("\"%s\" is not a pointer and -> was used to attempt to access \"%s\". Did you mean \"%s.%s\"?",
596                                                                         var_expr_path_strm.GetString().c_str(),
597                                                                         child_name.GetCString(),
598                                                                         var_expr_path_strm.GetString().c_str(),
599                                                                         var_path.c_str());
600                                     return ValueObjectSP();
601                                 }
602                             }
603 
604                             child_valobj_sp = valobj_sp->GetChildMemberWithName (child_name, true);
605                             if (!child_valobj_sp)
606                             {
607                                 // No child member with name "child_name"
608                                 valobj_sp->GetExpressionPath (var_expr_path_strm, false);
609                                 if (child_name)
610                                 {
611                                     error.SetErrorStringWithFormat ("\"%s\" is not a member of \"(%s) %s\"",
612                                                                     child_name.GetCString(),
613                                                                     valobj_sp->GetTypeName().AsCString("<invalid type>"),
614                                                                     var_expr_path_strm.GetString().c_str());
615                                 }
616                                 else
617                                 {
618                                     error.SetErrorStringWithFormat ("incomplete expression path after \"%s\" in \"%s\"",
619                                                                     var_expr_path_strm.GetString().c_str(),
620                                                                     var_expr_cstr);
621                                 }
622 
623                                 return ValueObjectSP();
624                             }
625                             // Remove the child name from the path
626                             var_path.erase(0, child_name.GetLength());
627                         }
628                         break;
629 
630                     case '[':
631                         // Array member access, or treating pointer as an array
632                         if (var_path.size() > 2) // Need at least two brackets and a number
633                         {
634                             char *end = NULL;
635                             long child_index = ::strtol (&var_path[1], &end, 0);
636                             if (end && *end == ']')
637                             {
638 
639                                 if (valobj_sp->IsPointerType ())
640                                 {
641                                     child_valobj_sp = valobj_sp->GetSyntheticArrayMemberFromPointer (child_index, true);
642                                     if (!child_valobj_sp)
643                                     {
644                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
645                                         error.SetErrorStringWithFormat ("failed to use pointer as array for index %i for \"(%s) %s\"",
646                                                                         child_index,
647                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
648                                                                         var_expr_path_strm.GetString().c_str());
649                                     }
650                                 }
651                                 else if (ClangASTContext::IsArrayType (valobj_sp->GetClangType(), NULL, NULL))
652                                 {
653                                     child_valobj_sp = valobj_sp->GetChildAtIndex (child_index, true);
654                                     if (!child_valobj_sp)
655                                     {
656                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
657                                         error.SetErrorStringWithFormat ("array index %i is not valid for \"(%s) %s\"",
658                                                                         child_index,
659                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
660                                                                         var_expr_path_strm.GetString().c_str());
661                                     }
662                                 }
663                                 else
664                                 {
665                                     valobj_sp->GetExpressionPath (var_expr_path_strm, false);
666                                     error.SetErrorStringWithFormat ("\"(%s) %s\" is not an array type",
667                                                                     valobj_sp->GetTypeName().AsCString("<invalid type>"),
668                                                                     var_expr_path_strm.GetString().c_str());
669                                 }
670 
671                                 if (!child_valobj_sp)
672                                 {
673                                     // Invalid array index...
674                                     return ValueObjectSP();
675                                 }
676 
677                                 // Erase the array member specification '[%i]' where
678                                 // %i is the array index
679                                 var_path.erase(0, (end - var_path.c_str()) + 1);
680                                 separator_idx = var_path.find_first_of(".-[");
681 
682                                 // Break out early from the switch since we were
683                                 // able to find the child member
684                                 break;
685                             }
686                         }
687                         return ValueObjectSP();
688 
689                     default:
690                         // Failure...
691                         {
692                             valobj_sp->GetExpressionPath (var_expr_path_strm, false);
693                             error.SetErrorStringWithFormat ("unexpected char '%c' encountered after \"%s\" in \"%s\"",
694                                                             separator_type,
695                                                             var_expr_path_strm.GetString().c_str(),
696                                                             var_path.c_str());
697 
698                             return ValueObjectSP();
699                         }
700                     }
701 
702                     if (child_valobj_sp)
703                         valobj_sp = child_valobj_sp;
704 
705                     if (var_path.empty())
706                         break;
707 
708                 }
709                 if (valobj_sp)
710                 {
711                     if (deref)
712                     {
713                         ValueObjectSP deref_valobj_sp (valobj_sp->Dereference(error));
714                         valobj_sp = deref_valobj_sp;
715                     }
716                     else if (address_of)
717                     {
718                         ValueObjectSP address_of_valobj_sp (valobj_sp->AddressOf(error));
719                         valobj_sp = address_of_valobj_sp;
720                     }
721                 }
722                 return valobj_sp;
723             }
724             else
725             {
726                 error.SetErrorStringWithFormat("no variable named '%s' found in this frame", name_const_string.GetCString());
727             }
728         }
729     }
730     else
731     {
732         error.SetErrorStringWithFormat("invalid variable path '%s'", var_expr_cstr);
733     }
734     return ValueObjectSP();
735 }
736 
737 bool
738 StackFrame::GetFrameBaseValue (Scalar &frame_base, Error *error_ptr)
739 {
740     if (m_flags.IsClear(GOT_FRAME_BASE))
741     {
742         if (m_sc.function)
743         {
744             m_frame_base.Clear();
745             m_frame_base_error.Clear();
746 
747             m_flags.Set(GOT_FRAME_BASE);
748             ExecutionContext exe_ctx (&m_thread.GetProcess(), &m_thread, this);
749             Value expr_value;
750             addr_t loclist_base_addr = LLDB_INVALID_ADDRESS;
751             if (m_sc.function->GetFrameBaseExpression().IsLocationList())
752                 loclist_base_addr = m_sc.function->GetAddressRange().GetBaseAddress().GetLoadAddress (&m_thread.GetProcess().GetTarget());
753 
754             if (m_sc.function->GetFrameBaseExpression().Evaluate(&exe_ctx, NULL, NULL, NULL, NULL, loclist_base_addr, NULL, expr_value, &m_frame_base_error) == false)
755             {
756                 // We should really have an error if evaluate returns, but in case
757                 // we don't, lets set the error to something at least.
758                 if (m_frame_base_error.Success())
759                     m_frame_base_error.SetErrorString("Evaluation of the frame base expression failed.");
760             }
761             else
762             {
763                 m_frame_base = expr_value.ResolveValue(&exe_ctx, NULL);
764             }
765         }
766         else
767         {
768             m_frame_base_error.SetErrorString ("No function in symbol context.");
769         }
770     }
771 
772     if (m_frame_base_error.Success())
773         frame_base = m_frame_base;
774 
775     if (error_ptr)
776         *error_ptr = m_frame_base_error;
777     return m_frame_base_error.Success();
778 }
779 
780 RegisterContextSP
781 StackFrame::GetRegisterContext ()
782 {
783     if (!m_reg_context_sp)
784         m_reg_context_sp = m_thread.CreateRegisterContextForFrame (this);
785     return m_reg_context_sp;
786 }
787 
788 bool
789 StackFrame::HasDebugInformation ()
790 {
791     GetSymbolContext (eSymbolContextLineEntry);
792     return m_sc.line_entry.IsValid();
793 }
794 
795 
796 ValueObjectSP
797 StackFrame::GetValueObjectForFrameVariable (const VariableSP &variable_sp)
798 {
799     ValueObjectSP valobj_sp;
800     VariableList *var_list = GetVariableList (true);
801     if (var_list)
802     {
803         // Make sure the variable is a frame variable
804         const uint32_t var_idx = var_list->FindIndexForVariable (variable_sp.get());
805         const uint32_t num_variables = var_list->GetSize();
806         if (var_idx < num_variables)
807         {
808             valobj_sp = m_variable_list_value_objects.GetValueObjectAtIndex (var_idx);
809             if (valobj_sp.get() == NULL)
810             {
811                 if (m_variable_list_value_objects.GetSize() < num_variables)
812                     m_variable_list_value_objects.Resize(num_variables);
813                 valobj_sp.reset (new ValueObjectVariable (this, variable_sp));
814                 m_variable_list_value_objects.SetValueObjectAtIndex (var_idx, valobj_sp);
815             }
816         }
817     }
818     return valobj_sp;
819 }
820 
821 ValueObjectSP
822 StackFrame::TrackGlobalVariable (const VariableSP &variable_sp)
823 {
824     // Check to make sure we aren't already tracking this variable?
825     ValueObjectSP valobj_sp (GetValueObjectForFrameVariable (variable_sp));
826     if (!valobj_sp)
827     {
828         // We aren't already tracking this global
829         VariableList *var_list = GetVariableList (true);
830         // If this frame has no variables, create a new list
831         if (var_list == NULL)
832             m_variable_list_sp.reset (new VariableList());
833 
834         // Add the global/static variable to this frame
835         m_variable_list_sp->AddVariable (variable_sp);
836 
837         // Now make a value object for it so we can track its changes
838         valobj_sp = GetValueObjectForFrameVariable (variable_sp);
839     }
840     return valobj_sp;
841 }
842 
843 bool
844 StackFrame::IsInlined ()
845 {
846     if (m_sc.block == NULL)
847         GetSymbolContext (eSymbolContextBlock);
848     if (m_sc.block)
849         return m_sc.block->GetContainingInlinedBlock() != NULL;
850     return false;
851 }
852 
853 Target *
854 StackFrame::CalculateTarget ()
855 {
856     return m_thread.CalculateTarget();
857 }
858 
859 Process *
860 StackFrame::CalculateProcess ()
861 {
862     return m_thread.CalculateProcess();
863 }
864 
865 Thread *
866 StackFrame::CalculateThread ()
867 {
868     return &m_thread;
869 }
870 
871 StackFrame *
872 StackFrame::CalculateStackFrame ()
873 {
874     return this;
875 }
876 
877 
878 void
879 StackFrame::CalculateExecutionContext (ExecutionContext &exe_ctx)
880 {
881     m_thread.CalculateExecutionContext (exe_ctx);
882     exe_ctx.frame = this;
883 }
884 
885 void
886 StackFrame::DumpUsingSettingsFormat (Stream *strm)
887 {
888     if (strm == NULL)
889         return;
890 
891     GetSymbolContext(eSymbolContextEverything);
892     ExecutionContext exe_ctx;
893     CalculateExecutionContext(exe_ctx);
894     const char *end = NULL;
895     StreamString s;
896     const char *frame_format = m_thread.GetProcess().GetTarget().GetDebugger().GetFrameFormat();
897     if (frame_format && Debugger::FormatPrompt (frame_format, &m_sc, &exe_ctx, NULL, s, &end))
898     {
899         strm->Write(s.GetData(), s.GetSize());
900     }
901     else
902     {
903         Dump (strm, true, false);
904         strm->EOL();
905     }
906 }
907 
908 void
909 StackFrame::Dump (Stream *strm, bool show_frame_index, bool show_fullpaths)
910 {
911     if (strm == NULL)
912         return;
913 
914     if (show_frame_index)
915         strm->Printf("frame #%u: ", m_frame_index);
916     strm->Printf("0x%0*llx ", m_thread.GetProcess().GetTarget().GetArchitecture().GetAddressByteSize() * 2, GetFrameCodeAddress().GetLoadAddress(&m_thread.GetProcess().GetTarget()));
917     GetSymbolContext(eSymbolContextEverything);
918     const bool show_module = true;
919     const bool show_inline = true;
920     m_sc.DumpStopContext(strm, &m_thread.GetProcess(), GetFrameCodeAddress(), show_fullpaths, show_module, show_inline);
921 }
922 
923 void
924 StackFrame::UpdateCurrentFrameFromPreviousFrame (StackFrame &prev_frame)
925 {
926     assert (GetStackID() == prev_frame.GetStackID());    // TODO: remove this after some testing
927     m_variable_list_sp = prev_frame.m_variable_list_sp;
928     m_variable_list_value_objects.Swap (prev_frame.m_variable_list_value_objects);
929     if (!m_disassembly.GetString().empty())
930         m_disassembly.GetString().swap (m_disassembly.GetString());
931 }
932 
933 
934 void
935 StackFrame::UpdatePreviousFrameFromCurrentFrame (StackFrame &curr_frame)
936 {
937     assert (GetStackID() == curr_frame.GetStackID());        // TODO: remove this after some testing
938     m_id.SetPC (curr_frame.m_id.GetPC());       // Update the Stack ID PC value
939     assert (&m_thread == &curr_frame.m_thread);
940     m_frame_index = curr_frame.m_frame_index;
941     m_concrete_frame_index = curr_frame.m_concrete_frame_index;
942     m_reg_context_sp = curr_frame.m_reg_context_sp;
943     m_frame_code_addr = curr_frame.m_frame_code_addr;
944     assert (m_sc.target_sp.get() == NULL || curr_frame.m_sc.target_sp.get() == NULL || m_sc.target_sp.get() == curr_frame.m_sc.target_sp.get());
945     assert (m_sc.module_sp.get() == NULL || curr_frame.m_sc.module_sp.get() == NULL || m_sc.module_sp.get() == curr_frame.m_sc.module_sp.get());
946     assert (m_sc.comp_unit == NULL || curr_frame.m_sc.comp_unit == NULL || m_sc.comp_unit == curr_frame.m_sc.comp_unit);
947     assert (m_sc.function == NULL || curr_frame.m_sc.function == NULL || m_sc.function == curr_frame.m_sc.function);
948     m_sc = curr_frame.m_sc;
949     m_flags.Clear(GOT_FRAME_BASE | eSymbolContextEverything);
950     m_flags.Set (m_sc.GetResolvedMask());
951     m_frame_base.Clear();
952     m_frame_base_error.Clear();
953 }
954 
955 
956 bool
957 StackFrame::HasCachedData () const
958 {
959     if (m_variable_list_sp.get())
960         return true;
961     if (m_variable_list_value_objects.GetSize() > 0)
962         return true;
963     if (!m_disassembly.GetString().empty())
964         return true;
965     return false;
966 }
967 
968 lldb::StackFrameSP
969 StackFrame::GetSP ()
970 {
971     return m_thread.GetStackFrameSPForStackFramePtr (this);
972 }
973