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                                    exe_ctx,
262                                    0,
263                                    false,
264                                    false,
265                                    m_disassembly);
266         if (m_disassembly.GetSize() == 0)
267             return NULL;
268     }
269     return m_disassembly.GetData();
270 }
271 
272 Block *
273 StackFrame::GetFrameBlock ()
274 {
275     if (m_sc.block == NULL && m_flags.IsClear (eSymbolContextBlock))
276         GetSymbolContext (eSymbolContextBlock);
277 
278     if (m_sc.block)
279     {
280         Block *inline_block = m_sc.block->GetContainingInlinedBlock();
281         if (inline_block)
282         {
283             // Use the block with the inlined function info
284             // as the frame block we want this frame to have only the variables
285             // for the inlined function and its non-inlined block child blocks.
286             return inline_block;
287         }
288         else
289         {
290             // This block is not contained withing any inlined function blocks
291             // with so we want to use the top most function block.
292             return &m_sc.function->GetBlock (false);
293         }
294     }
295     return NULL;
296 }
297 
298 //----------------------------------------------------------------------
299 // Get the symbol context if we already haven't done so by resolving the
300 // PC address as much as possible. This way when we pass around a
301 // StackFrame object, everyone will have as much information as
302 // possible and no one will ever have to look things up manually.
303 //----------------------------------------------------------------------
304 const SymbolContext&
305 StackFrame::GetSymbolContext (uint32_t resolve_scope)
306 {
307     // Copy our internal symbol context into "sc".
308     if ((m_flags.Get() & resolve_scope) != resolve_scope)
309     {
310         // Resolve our PC to section offset if we haven't alreday done so
311         // and if we don't have a module. The resolved address section will
312         // contain the module to which it belongs
313         if (!m_sc.module_sp && m_flags.IsClear(RESOLVED_FRAME_CODE_ADDR))
314             GetFrameCodeAddress();
315 
316         // If this is not frame zero, then we need to subtract 1 from the PC
317         // value when doing address lookups since the PC will be on the
318         // instruction following the function call instruction...
319 
320         Address lookup_addr(GetFrameCodeAddress());
321         if (m_frame_index > 0 && lookup_addr.IsValid())
322         {
323             addr_t offset = lookup_addr.GetOffset();
324             if (offset > 0)
325                 lookup_addr.SetOffset(offset - 1);
326         }
327 
328 
329         uint32_t resolved = 0;
330         if (m_sc.module_sp)
331         {
332             // We have something in our stack frame symbol context, lets check
333             // if we haven't already tried to lookup one of those things. If we
334             // haven't then we will do the query.
335 
336             uint32_t actual_resolve_scope = 0;
337 
338             if (resolve_scope & eSymbolContextCompUnit)
339             {
340                 if (m_flags.IsClear (eSymbolContextCompUnit))
341                 {
342                     if (m_sc.comp_unit)
343                         resolved |= eSymbolContextCompUnit;
344                     else
345                         actual_resolve_scope |= eSymbolContextCompUnit;
346                 }
347             }
348 
349             if (resolve_scope & eSymbolContextFunction)
350             {
351                 if (m_flags.IsClear (eSymbolContextFunction))
352                 {
353                     if (m_sc.function)
354                         resolved |= eSymbolContextFunction;
355                     else
356                         actual_resolve_scope |= eSymbolContextFunction;
357                 }
358             }
359 
360             if (resolve_scope & eSymbolContextBlock)
361             {
362                 if (m_flags.IsClear (eSymbolContextBlock))
363                 {
364                     if (m_sc.block)
365                         resolved |= eSymbolContextBlock;
366                     else
367                         actual_resolve_scope |= eSymbolContextBlock;
368                 }
369             }
370 
371             if (resolve_scope & eSymbolContextSymbol)
372             {
373                 if (m_flags.IsClear (eSymbolContextSymbol))
374                 {
375                     if (m_sc.symbol)
376                         resolved |= eSymbolContextSymbol;
377                     else
378                         actual_resolve_scope |= eSymbolContextSymbol;
379                 }
380             }
381 
382             if (resolve_scope & eSymbolContextLineEntry)
383             {
384                 if (m_flags.IsClear (eSymbolContextLineEntry))
385                 {
386                     if (m_sc.line_entry.IsValid())
387                         resolved |= eSymbolContextLineEntry;
388                     else
389                         actual_resolve_scope |= eSymbolContextLineEntry;
390                 }
391             }
392 
393             if (actual_resolve_scope)
394             {
395                 // We might be resolving less information than what is already
396                 // in our current symbol context so resolve into a temporary
397                 // symbol context "sc" so we don't clear out data we have
398                 // already found in "m_sc"
399                 SymbolContext sc;
400                 // Set flags that indicate what we have tried to resolve
401                 resolved |= m_sc.module_sp->ResolveSymbolContextForAddress (lookup_addr, actual_resolve_scope, sc);
402                 // Only replace what we didn't already have as we may have
403                 // information for an inlined function scope that won't match
404                 // what a standard lookup by address would match
405                 if ((resolved & eSymbolContextCompUnit)  && m_sc.comp_unit == NULL)
406                     m_sc.comp_unit = sc.comp_unit;
407                 if ((resolved & eSymbolContextFunction)  && m_sc.function == NULL)
408                     m_sc.function = sc.function;
409                 if ((resolved & eSymbolContextBlock)     && m_sc.block == NULL)
410                     m_sc.block = sc.block;
411                 if ((resolved & eSymbolContextSymbol)    && m_sc.symbol == NULL)
412                     m_sc.symbol = sc.symbol;
413                 if ((resolved & eSymbolContextLineEntry) && !m_sc.line_entry.IsValid())
414                     m_sc.line_entry = sc.line_entry;
415 
416             }
417         }
418         else
419         {
420             // If we don't have a module, then we can't have the compile unit,
421             // function, block, line entry or symbol, so we can safely call
422             // ResolveSymbolContextForAddress with our symbol context member m_sc.
423             resolved |= m_thread.GetProcess().GetTarget().GetImages().ResolveSymbolContextForAddress (lookup_addr, resolve_scope, m_sc);
424         }
425 
426         // If the target was requested add that:
427         if (m_sc.target_sp.get() == NULL)
428         {
429             m_sc.target_sp = CalculateProcess()->GetTarget().GetSP();
430             if (m_sc.target_sp)
431                 resolved |= eSymbolContextTarget;
432         }
433 
434         // Update our internal flags so we remember what we have tried to locate so
435         // we don't have to keep trying when more calls to this function are made.
436         // We might have dug up more information that was requested (for example
437         // if we were asked to only get the block, we will have gotten the
438         // compile unit, and function) so set any additional bits that we resolved
439         m_flags.Set (resolve_scope | resolved);
440     }
441 
442     // Return the symbol context with everything that was possible to resolve
443     // resolved.
444     return m_sc;
445 }
446 
447 
448 VariableList *
449 StackFrame::GetVariableList (bool get_file_globals)
450 {
451     if (m_flags.IsClear(RESOLVED_VARIABLES))
452     {
453         m_flags.Set(RESOLVED_VARIABLES);
454 
455         Block *frame_block = GetFrameBlock();
456 
457         if (frame_block)
458         {
459             const bool get_child_variables = true;
460             const bool can_create = true;
461             m_variable_list_sp = frame_block->GetVariableList (get_child_variables, can_create);
462         }
463     }
464 
465     if (m_flags.IsClear(RESOLVED_GLOBAL_VARIABLES) &&
466         get_file_globals)
467     {
468         m_flags.Set(RESOLVED_GLOBAL_VARIABLES);
469 
470         if (m_flags.IsClear (eSymbolContextCompUnit))
471             GetSymbolContext (eSymbolContextCompUnit);
472 
473         if (m_sc.comp_unit)
474         {
475             VariableListSP global_variable_list_sp (m_sc.comp_unit->GetVariableList(true));
476             if (m_variable_list_sp)
477                 m_variable_list_sp->AddVariables (global_variable_list_sp.get());
478             else
479                 m_variable_list_sp = global_variable_list_sp;
480         }
481     }
482 
483     return m_variable_list_sp.get();
484 }
485 
486 ValueObjectSP
487 StackFrame::GetValueForVariableExpressionPath (const char *var_expr_cstr, uint32_t options, Error &error)
488 {
489 
490     if (var_expr_cstr && var_expr_cstr[0])
491     {
492         const bool check_ptr_vs_member = (options & eExpressionPathOptionCheckPtrVsMember) != 0;
493         const bool no_fragile_ivar = (options & eExpressionPathOptionsNoFragileObjcIvar) != 0;
494         error.Clear();
495         bool deref = false;
496         bool address_of = false;
497         ValueObjectSP valobj_sp;
498         const bool get_file_globals = true;
499         VariableList *variable_list = GetVariableList (get_file_globals);
500 
501         if (variable_list)
502         {
503             // If first character is a '*', then show pointer contents
504             const char *var_expr = var_expr_cstr;
505             if (var_expr[0] == '*')
506             {
507                 deref = true;
508                 var_expr++; // Skip the '*'
509             }
510             else if (var_expr[0] == '&')
511             {
512                 address_of = true;
513                 var_expr++; // Skip the '&'
514             }
515 
516             std::string var_path (var_expr);
517             size_t separator_idx = var_path.find_first_of(".-[=+~|&^%#@!/?,<>{}");
518             StreamString var_expr_path_strm;
519 
520             ConstString name_const_string;
521             if (separator_idx == std::string::npos)
522                 name_const_string.SetCString (var_path.c_str());
523             else
524                 name_const_string.SetCStringWithLength (var_path.c_str(), separator_idx);
525 
526             VariableSP var_sp (variable_list->FindVariable(name_const_string));
527             if (var_sp)
528             {
529                 valobj_sp = GetValueObjectForFrameVariable (var_sp);
530 
531                 var_path.erase (0, name_const_string.GetLength ());
532                 // We are dumping at least one child
533                 while (separator_idx != std::string::npos)
534                 {
535                     // Calculate the next separator index ahead of time
536                     ValueObjectSP child_valobj_sp;
537                     const char separator_type = var_path[0];
538                     switch (separator_type)
539                     {
540 
541                     case '-':
542                         if (var_path.size() >= 2 && var_path[1] != '>')
543                             return ValueObjectSP();
544 
545                         if (no_fragile_ivar)
546                         {
547                             // Make sure we aren't trying to deref an objective
548                             // C ivar if this is not allowed
549                             const uint32_t pointer_type_flags = ClangASTContext::GetTypeInfo (valobj_sp->GetClangType(), NULL, NULL);
550                             if ((pointer_type_flags & ClangASTContext::eTypeIsObjC) &&
551                                 (pointer_type_flags & ClangASTContext::eTypeIsPointer))
552                             {
553                                 // This was an objective C object pointer and
554                                 // it was requested we skip any fragile ivars
555                                 // so return nothing here
556                                 return ValueObjectSP();
557                             }
558                         }
559                         var_path.erase (0, 1); // Remove the '-'
560                         // Fall through
561                     case '.':
562                         {
563                             const bool expr_is_ptr = var_path[0] == '>';
564 
565                             var_path.erase (0, 1); // Remove the '.' or '>'
566                             separator_idx = var_path.find_first_of(".-[");
567                             ConstString child_name;
568                             if (separator_idx == std::string::npos)
569                                 child_name.SetCString (var_path.c_str());
570                             else
571                                 child_name.SetCStringWithLength(var_path.c_str(), separator_idx);
572 
573                             if (check_ptr_vs_member)
574                             {
575                                 // We either have a pointer type and need to verify
576                                 // valobj_sp is a pointer, or we have a member of a
577                                 // class/union/struct being accessed with the . syntax
578                                 // and need to verify we don't have a pointer.
579                                 const bool actual_is_ptr = valobj_sp->IsPointerType ();
580 
581                                 if (actual_is_ptr != expr_is_ptr)
582                                 {
583                                     // Incorrect use of "." with a pointer, or "->" with
584                                     // a class/union/struct instance or reference.
585                                     valobj_sp->GetExpressionPath (var_expr_path_strm, false);
586                                     if (actual_is_ptr)
587                                         error.SetErrorStringWithFormat ("\"%s\" is a pointer and . was used to attempt to access \"%s\". Did you mean \"%s->%s\"?",
588                                                                         var_expr_path_strm.GetString().c_str(),
589                                                                         child_name.GetCString(),
590                                                                         var_expr_path_strm.GetString().c_str(),
591                                                                         var_path.c_str());
592                                     else
593                                         error.SetErrorStringWithFormat ("\"%s\" is not a pointer and -> was used to attempt to access \"%s\". Did you mean \"%s.%s\"?",
594                                                                         var_expr_path_strm.GetString().c_str(),
595                                                                         child_name.GetCString(),
596                                                                         var_expr_path_strm.GetString().c_str(),
597                                                                         var_path.c_str());
598                                     return ValueObjectSP();
599                                 }
600                             }
601 
602                             child_valobj_sp = valobj_sp->GetChildMemberWithName (child_name, true);
603                             if (!child_valobj_sp)
604                             {
605                                 // No child member with name "child_name"
606                                 valobj_sp->GetExpressionPath (var_expr_path_strm, false);
607                                 if (child_name)
608                                 {
609                                     error.SetErrorStringWithFormat ("\"%s\" is not a member of \"(%s) %s\"",
610                                                                     child_name.GetCString(),
611                                                                     valobj_sp->GetTypeName().AsCString("<invalid type>"),
612                                                                     var_expr_path_strm.GetString().c_str());
613                                 }
614                                 else
615                                 {
616                                     error.SetErrorStringWithFormat ("incomplete expression path after \"%s\" in \"%s\"",
617                                                                     var_expr_path_strm.GetString().c_str(),
618                                                                     var_expr_cstr);
619                                 }
620 
621                                 return ValueObjectSP();
622                             }
623                             // Remove the child name from the path
624                             var_path.erase(0, child_name.GetLength());
625                         }
626                         break;
627 
628                     case '[':
629                         // Array member access, or treating pointer as an array
630                         if (var_path.size() > 2) // Need at least two brackets and a number
631                         {
632                             char *end = NULL;
633                             long child_index = ::strtol (&var_path[1], &end, 0);
634                             if (end && *end == ']')
635                             {
636 
637                                 if (valobj_sp->IsPointerType ())
638                                 {
639                                     child_valobj_sp = valobj_sp->GetSyntheticArrayMemberFromPointer (child_index, true);
640                                     if (!child_valobj_sp)
641                                     {
642                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
643                                         error.SetErrorStringWithFormat ("failed to use pointer as array for index %i for \"(%s) %s\"",
644                                                                         child_index,
645                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
646                                                                         var_expr_path_strm.GetString().c_str());
647                                     }
648                                 }
649                                 else if (ClangASTContext::IsArrayType (valobj_sp->GetClangType(), NULL, NULL))
650                                 {
651                                     child_valobj_sp = valobj_sp->GetChildAtIndex (child_index, true);
652                                     if (!child_valobj_sp)
653                                     {
654                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
655                                         error.SetErrorStringWithFormat ("array index %i is not valid for \"(%s) %s\"",
656                                                                         child_index,
657                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
658                                                                         var_expr_path_strm.GetString().c_str());
659                                     }
660                                 }
661                                 else
662                                 {
663                                     valobj_sp->GetExpressionPath (var_expr_path_strm, false);
664                                     error.SetErrorStringWithFormat ("\"(%s) %s\" is not an array type",
665                                                                     valobj_sp->GetTypeName().AsCString("<invalid type>"),
666                                                                     var_expr_path_strm.GetString().c_str());
667                                 }
668 
669                                 if (!child_valobj_sp)
670                                 {
671                                     // Invalid array index...
672                                     return ValueObjectSP();
673                                 }
674 
675                                 // Erase the array member specification '[%i]' where
676                                 // %i is the array index
677                                 var_path.erase(0, (end - var_path.c_str()) + 1);
678                                 separator_idx = var_path.find_first_of(".-[");
679 
680                                 // Break out early from the switch since we were
681                                 // able to find the child member
682                                 break;
683                             }
684                         }
685                         return ValueObjectSP();
686 
687                     default:
688                         // Failure...
689                         {
690                             valobj_sp->GetExpressionPath (var_expr_path_strm, false);
691                             error.SetErrorStringWithFormat ("unexpected char '%c' encountered after \"%s\" in \"%s\"",
692                                                             separator_type,
693                                                             var_expr_path_strm.GetString().c_str(),
694                                                             var_path.c_str());
695 
696                             return ValueObjectSP();
697                         }
698                     }
699 
700                     if (child_valobj_sp)
701                         valobj_sp = child_valobj_sp;
702 
703                     if (var_path.empty())
704                         break;
705 
706                 }
707                 if (valobj_sp)
708                 {
709                     if (deref)
710                     {
711                         ValueObjectSP deref_valobj_sp (valobj_sp->Dereference(error));
712                         valobj_sp = deref_valobj_sp;
713                     }
714                     else if (address_of)
715                     {
716                         ValueObjectSP address_of_valobj_sp (valobj_sp->AddressOf(error));
717                         valobj_sp = address_of_valobj_sp;
718                     }
719                 }
720                 return valobj_sp;
721             }
722             else
723             {
724                 error.SetErrorStringWithFormat("no variable named '%s' found in this frame", name_const_string.GetCString());
725             }
726         }
727     }
728     else
729     {
730         error.SetErrorStringWithFormat("invalid variable path '%s'", var_expr_cstr);
731     }
732     return ValueObjectSP();
733 }
734 
735 bool
736 StackFrame::GetFrameBaseValue (Scalar &frame_base, Error *error_ptr)
737 {
738     if (m_flags.IsClear(GOT_FRAME_BASE))
739     {
740         if (m_sc.function)
741         {
742             m_frame_base.Clear();
743             m_frame_base_error.Clear();
744 
745             m_flags.Set(GOT_FRAME_BASE);
746             ExecutionContext exe_ctx (&m_thread.GetProcess(), &m_thread, this);
747             Value expr_value;
748             addr_t loclist_base_addr = LLDB_INVALID_ADDRESS;
749             if (m_sc.function->GetFrameBaseExpression().IsLocationList())
750                 loclist_base_addr = m_sc.function->GetAddressRange().GetBaseAddress().GetLoadAddress (&m_thread.GetProcess().GetTarget());
751 
752             if (m_sc.function->GetFrameBaseExpression().Evaluate(&exe_ctx, NULL, NULL, NULL, NULL, loclist_base_addr, NULL, expr_value, &m_frame_base_error) == false)
753             {
754                 // We should really have an error if evaluate returns, but in case
755                 // we don't, lets set the error to something at least.
756                 if (m_frame_base_error.Success())
757                     m_frame_base_error.SetErrorString("Evaluation of the frame base expression failed.");
758             }
759             else
760             {
761                 m_frame_base = expr_value.ResolveValue(&exe_ctx, NULL);
762             }
763         }
764         else
765         {
766             m_frame_base_error.SetErrorString ("No function in symbol context.");
767         }
768     }
769 
770     if (m_frame_base_error.Success())
771         frame_base = m_frame_base;
772 
773     if (error_ptr)
774         *error_ptr = m_frame_base_error;
775     return m_frame_base_error.Success();
776 }
777 
778 RegisterContextSP
779 StackFrame::GetRegisterContext ()
780 {
781     if (!m_reg_context_sp)
782         m_reg_context_sp = m_thread.CreateRegisterContextForFrame (this);
783     return m_reg_context_sp;
784 }
785 
786 bool
787 StackFrame::HasDebugInformation ()
788 {
789     GetSymbolContext (eSymbolContextLineEntry);
790     return m_sc.line_entry.IsValid();
791 }
792 
793 
794 ValueObjectSP
795 StackFrame::GetValueObjectForFrameVariable (const VariableSP &variable_sp)
796 {
797     ValueObjectSP valobj_sp;
798     VariableList *var_list = GetVariableList (true);
799     if (var_list)
800     {
801         // Make sure the variable is a frame variable
802         const uint32_t var_idx = var_list->FindIndexForVariable (variable_sp.get());
803         const uint32_t num_variables = var_list->GetSize();
804         if (var_idx < num_variables)
805         {
806             valobj_sp = m_variable_list_value_objects.GetValueObjectAtIndex (var_idx);
807             if (valobj_sp.get() == NULL)
808             {
809                 if (m_variable_list_value_objects.GetSize() < num_variables)
810                     m_variable_list_value_objects.Resize(num_variables);
811                 valobj_sp.reset (new ValueObjectVariable (variable_sp));
812                 m_variable_list_value_objects.SetValueObjectAtIndex (var_idx, valobj_sp);
813             }
814         }
815     }
816     return valobj_sp;
817 }
818 
819 ValueObjectSP
820 StackFrame::TrackGlobalVariable (const VariableSP &variable_sp)
821 {
822     // Check to make sure we aren't already tracking this variable?
823     ValueObjectSP valobj_sp (GetValueObjectForFrameVariable (variable_sp));
824     if (!valobj_sp)
825     {
826         // We aren't already tracking this global
827         VariableList *var_list = GetVariableList (true);
828         // If this frame has no variables, create a new list
829         if (var_list == NULL)
830             m_variable_list_sp.reset (new VariableList());
831 
832         // Add the global/static variable to this frame
833         m_variable_list_sp->AddVariable (variable_sp);
834 
835         // Now make a value object for it so we can track its changes
836         valobj_sp = GetValueObjectForFrameVariable (variable_sp);
837     }
838     return valobj_sp;
839 }
840 
841 bool
842 StackFrame::IsInlined ()
843 {
844     if (m_sc.block == NULL)
845         GetSymbolContext (eSymbolContextBlock);
846     if (m_sc.block)
847         return m_sc.block->GetContainingInlinedBlock() != NULL;
848     return false;
849 }
850 
851 Target *
852 StackFrame::CalculateTarget ()
853 {
854     return m_thread.CalculateTarget();
855 }
856 
857 Process *
858 StackFrame::CalculateProcess ()
859 {
860     return m_thread.CalculateProcess();
861 }
862 
863 Thread *
864 StackFrame::CalculateThread ()
865 {
866     return &m_thread;
867 }
868 
869 StackFrame *
870 StackFrame::CalculateStackFrame ()
871 {
872     return this;
873 }
874 
875 
876 void
877 StackFrame::CalculateExecutionContext (ExecutionContext &exe_ctx)
878 {
879     m_thread.CalculateExecutionContext (exe_ctx);
880     exe_ctx.frame = this;
881 }
882 
883 void
884 StackFrame::DumpUsingSettingsFormat (Stream *strm)
885 {
886     if (strm == NULL)
887         return;
888 
889     GetSymbolContext(eSymbolContextEverything);
890     ExecutionContext exe_ctx;
891     CalculateExecutionContext(exe_ctx);
892     const char *end = NULL;
893     StreamString s;
894     const char *frame_format = m_thread.GetProcess().GetTarget().GetDebugger().GetFrameFormat();
895     if (frame_format && Debugger::FormatPrompt (frame_format, &m_sc, &exe_ctx, NULL, s, &end))
896     {
897         strm->Write(s.GetData(), s.GetSize());
898     }
899     else
900     {
901         Dump (strm, true, false);
902         strm->EOL();
903     }
904 }
905 
906 void
907 StackFrame::Dump (Stream *strm, bool show_frame_index, bool show_fullpaths)
908 {
909     if (strm == NULL)
910         return;
911 
912     if (show_frame_index)
913         strm->Printf("frame #%u: ", m_frame_index);
914     strm->Printf("0x%0*llx ", m_thread.GetProcess().GetTarget().GetArchitecture().GetAddressByteSize() * 2, GetFrameCodeAddress().GetLoadAddress(&m_thread.GetProcess().GetTarget()));
915     GetSymbolContext(eSymbolContextEverything);
916     const bool show_module = true;
917     const bool show_inline = true;
918     m_sc.DumpStopContext(strm, &m_thread.GetProcess(), GetFrameCodeAddress(), show_fullpaths, show_module, show_inline);
919 }
920 
921 void
922 StackFrame::UpdateCurrentFrameFromPreviousFrame (StackFrame &prev_frame)
923 {
924     assert (GetStackID() == prev_frame.GetStackID());    // TODO: remove this after some testing
925     m_variable_list_sp = prev_frame.m_variable_list_sp;
926     m_variable_list_value_objects.Swap (prev_frame.m_variable_list_value_objects);
927     if (!m_disassembly.GetString().empty())
928         m_disassembly.GetString().swap (m_disassembly.GetString());
929 }
930 
931 
932 void
933 StackFrame::UpdatePreviousFrameFromCurrentFrame (StackFrame &curr_frame)
934 {
935     assert (GetStackID() == curr_frame.GetStackID());        // TODO: remove this after some testing
936     m_id.SetPC (curr_frame.m_id.GetPC());       // Update the Stack ID PC value
937     assert (&m_thread == &curr_frame.m_thread);
938     m_frame_index = curr_frame.m_frame_index;
939     m_concrete_frame_index = curr_frame.m_concrete_frame_index;
940     m_reg_context_sp = curr_frame.m_reg_context_sp;
941     m_frame_code_addr = curr_frame.m_frame_code_addr;
942     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());
943     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());
944     assert (m_sc.comp_unit == NULL || curr_frame.m_sc.comp_unit == NULL || m_sc.comp_unit == curr_frame.m_sc.comp_unit);
945     assert (m_sc.function == NULL || curr_frame.m_sc.function == NULL || m_sc.function == curr_frame.m_sc.function);
946     m_sc = curr_frame.m_sc;
947     m_flags.Clear(GOT_FRAME_BASE | eSymbolContextEverything);
948     m_flags.Set (m_sc.GetResolvedMask());
949     m_frame_base.Clear();
950     m_frame_base_error.Clear();
951 }
952 
953 
954 bool
955 StackFrame::HasCachedData () const
956 {
957     if (m_variable_list_sp.get())
958         return true;
959     if (m_variable_list_value_objects.GetSize() > 0)
960         return true;
961     if (!m_disassembly.GetString().empty())
962         return true;
963     return false;
964 }
965 
966 lldb::StackFrameSP
967 StackFrame::GetSP ()
968 {
969     return m_thread.GetStackFrameSPForStackFramePtr (this);
970 }
971