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 const 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 
222         if (m_frame_code_addr.SetOpcodeLoadAddress (m_frame_code_addr.GetOffset(), &m_thread.GetProcess().GetTarget()))
223         {
224             const Section *section = m_frame_code_addr.GetSection();
225             if (section)
226             {
227                 Module *module = section->GetModule();
228                 if (module)
229                 {
230                     m_sc.module_sp = module->GetSP();
231                     if (m_sc.module_sp)
232                         m_flags.Set(eSymbolContextModule);
233                 }
234             }
235         }
236     }
237     return m_frame_code_addr;
238 }
239 
240 void
241 StackFrame::ChangePC (addr_t pc)
242 {
243     m_frame_code_addr.SetOffset(pc);
244     m_frame_code_addr.SetSection(NULL);
245     m_sc.Clear();
246     m_flags.Reset(0);
247     m_thread.ClearStackFrames ();
248 }
249 
250 const char *
251 StackFrame::Disassemble ()
252 {
253     if (m_disassembly.GetSize() == 0)
254     {
255         ExecutionContext exe_ctx;
256         CalculateExecutionContext(exe_ctx);
257         Target &target = m_thread.GetProcess().GetTarget();
258         Disassembler::Disassemble (target.GetDebugger(),
259                                    target.GetArchitecture(),
260                                    NULL,
261                                    exe_ctx,
262                                    0,
263                                    0,
264                                    0,
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             const bool stop_if_child_block_is_inlined_function = true;
462             m_variable_list_sp.reset(new VariableList());
463             frame_block->AppendBlockVariables(can_create, get_child_variables, stop_if_child_block_is_inlined_function, m_variable_list_sp.get());
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 VariableListSP
489 StackFrame::GetInScopeVariableList (bool get_file_globals)
490 {
491     VariableListSP var_list_sp(new VariableList);
492     GetSymbolContext (eSymbolContextCompUnit | eSymbolContextBlock);
493 
494     if (m_sc.block)
495     {
496         const bool can_create = true;
497         const bool get_parent_variables = true;
498         const bool stop_if_block_is_inlined_function = true;
499         m_sc.block->AppendVariables (can_create,
500                                      get_parent_variables,
501                                      stop_if_block_is_inlined_function,
502                                      var_list_sp.get());
503     }
504 
505     if (m_sc.comp_unit)
506     {
507         VariableListSP global_variable_list_sp (m_sc.comp_unit->GetVariableList(true));
508         if (global_variable_list_sp)
509             var_list_sp->AddVariables (global_variable_list_sp.get());
510     }
511 
512     return var_list_sp;
513 }
514 
515 
516 ValueObjectSP
517 StackFrame::GetValueForVariableExpressionPath (const char *var_expr_cstr,
518                                                lldb::DynamicValueType use_dynamic,
519                                                uint32_t options,
520                                                lldb::VariableSP &var_sp,
521                                                Error &error)
522 {
523 
524     if (var_expr_cstr && var_expr_cstr[0])
525     {
526         const bool check_ptr_vs_member = (options & eExpressionPathOptionCheckPtrVsMember) != 0;
527         const bool no_fragile_ivar = (options & eExpressionPathOptionsNoFragileObjcIvar) != 0;
528         error.Clear();
529         bool deref = false;
530         bool address_of = false;
531         ValueObjectSP valobj_sp;
532         const bool get_file_globals = true;
533         // When looking up a variable for an expression, we need only consider the
534         // variables that are in scope.
535         VariableListSP var_list_sp (GetInScopeVariableList (get_file_globals));
536         VariableList *variable_list = var_list_sp.get();
537 
538         if (variable_list)
539         {
540             // If first character is a '*', then show pointer contents
541             const char *var_expr = var_expr_cstr;
542             if (var_expr[0] == '*')
543             {
544                 deref = true;
545                 var_expr++; // Skip the '*'
546             }
547             else if (var_expr[0] == '&')
548             {
549                 address_of = true;
550                 var_expr++; // Skip the '&'
551             }
552 
553             std::string var_path (var_expr);
554             size_t separator_idx = var_path.find_first_of(".-[=+~|&^%#@!/?,<>{}");
555             StreamString var_expr_path_strm;
556 
557             ConstString name_const_string;
558             if (separator_idx == std::string::npos)
559                 name_const_string.SetCString (var_path.c_str());
560             else
561                 name_const_string.SetCStringWithLength (var_path.c_str(), separator_idx);
562 
563             var_sp = variable_list->FindVariable(name_const_string);
564             if (var_sp)
565             {
566                 valobj_sp = GetValueObjectForFrameVariable (var_sp, use_dynamic);
567                 if (!valobj_sp)
568                     return valobj_sp;
569 
570                 var_path.erase (0, name_const_string.GetLength ());
571                 // We are dumping at least one child
572                 while (separator_idx != std::string::npos)
573                 {
574                     // Calculate the next separator index ahead of time
575                     ValueObjectSP child_valobj_sp;
576                     const char separator_type = var_path[0];
577                     switch (separator_type)
578                     {
579 
580                     case '-':
581                         if (var_path.size() >= 2 && var_path[1] != '>')
582                             return ValueObjectSP();
583 
584                         if (no_fragile_ivar)
585                         {
586                             // Make sure we aren't trying to deref an objective
587                             // C ivar if this is not allowed
588                             const uint32_t pointer_type_flags = ClangASTContext::GetTypeInfo (valobj_sp->GetClangType(), NULL, NULL);
589                             if ((pointer_type_flags & ClangASTContext::eTypeIsObjC) &&
590                                 (pointer_type_flags & ClangASTContext::eTypeIsPointer))
591                             {
592                                 // This was an objective C object pointer and
593                                 // it was requested we skip any fragile ivars
594                                 // so return nothing here
595                                 return ValueObjectSP();
596                             }
597                         }
598                         var_path.erase (0, 1); // Remove the '-'
599                         // Fall through
600                     case '.':
601                         {
602                             const bool expr_is_ptr = var_path[0] == '>';
603 
604                             var_path.erase (0, 1); // Remove the '.' or '>'
605                             separator_idx = var_path.find_first_of(".-[");
606                             ConstString child_name;
607                             if (separator_idx == std::string::npos)
608                                 child_name.SetCString (var_path.c_str());
609                             else
610                                 child_name.SetCStringWithLength(var_path.c_str(), separator_idx);
611 
612                             if (check_ptr_vs_member)
613                             {
614                                 // We either have a pointer type and need to verify
615                                 // valobj_sp is a pointer, or we have a member of a
616                                 // class/union/struct being accessed with the . syntax
617                                 // and need to verify we don't have a pointer.
618                                 const bool actual_is_ptr = valobj_sp->IsPointerType ();
619 
620                                 if (actual_is_ptr != expr_is_ptr)
621                                 {
622                                     // Incorrect use of "." with a pointer, or "->" with
623                                     // a class/union/struct instance or reference.
624                                     valobj_sp->GetExpressionPath (var_expr_path_strm, false);
625                                     if (actual_is_ptr)
626                                         error.SetErrorStringWithFormat ("\"%s\" is a pointer and . was used to attempt to access \"%s\". Did you mean \"%s->%s\"?",
627                                                                         var_expr_path_strm.GetString().c_str(),
628                                                                         child_name.GetCString(),
629                                                                         var_expr_path_strm.GetString().c_str(),
630                                                                         var_path.c_str());
631                                     else
632                                         error.SetErrorStringWithFormat ("\"%s\" is not a pointer and -> was used to attempt to access \"%s\". Did you mean \"%s.%s\"?",
633                                                                         var_expr_path_strm.GetString().c_str(),
634                                                                         child_name.GetCString(),
635                                                                         var_expr_path_strm.GetString().c_str(),
636                                                                         var_path.c_str());
637                                     return ValueObjectSP();
638                                 }
639                             }
640                             child_valobj_sp = valobj_sp->GetChildMemberWithName (child_name, true);
641                             if (!child_valobj_sp)
642                             {
643                                 // No child member with name "child_name"
644                                 valobj_sp->GetExpressionPath (var_expr_path_strm, false);
645                                 if (child_name)
646                                 {
647                                     error.SetErrorStringWithFormat ("\"%s\" is not a member of \"(%s) %s\"",
648                                                                     child_name.GetCString(),
649                                                                     valobj_sp->GetTypeName().AsCString("<invalid type>"),
650                                                                     var_expr_path_strm.GetString().c_str());
651                                 }
652                                 else
653                                 {
654                                     error.SetErrorStringWithFormat ("incomplete expression path after \"%s\" in \"%s\"",
655                                                                     var_expr_path_strm.GetString().c_str(),
656                                                                     var_expr_cstr);
657                                 }
658 
659                                 return ValueObjectSP();
660                             }
661                             // Remove the child name from the path
662                             var_path.erase(0, child_name.GetLength());
663                             if (use_dynamic != lldb::eNoDynamicValues)
664                             {
665                                 ValueObjectSP dynamic_value_sp(child_valobj_sp->GetDynamicValue(use_dynamic));
666                                 if (dynamic_value_sp)
667                                     child_valobj_sp = dynamic_value_sp;
668                             }
669                         }
670                         break;
671 
672                     case '[':
673                         // Array member access, or treating pointer as an array
674                         if (var_path.size() > 2) // Need at least two brackets and a number
675                         {
676                             char *end = NULL;
677                             long child_index = ::strtol (&var_path[1], &end, 0);
678                             if (end && *end == ']'
679                                 && *(end-1) != '[') // this code forces an error in the case of arr[]. as bitfield[] is not a good syntax we're good to go
680                             {
681                                 if (ClangASTContext::IsPointerToScalarType(valobj_sp->GetClangType()) && deref)
682                                 {
683                                     // what we have is *ptr[low]. the most similar C++ syntax is to deref ptr
684                                     // and extract bit low out of it. reading array item low
685                                     // would be done by saying ptr[low], without a deref * sign
686                                     Error error;
687                                     ValueObjectSP temp(valobj_sp->Dereference(error));
688                                     if (error.Fail())
689                                     {
690                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
691                                         error.SetErrorStringWithFormat ("could not dereference \"(%s) %s\"",
692                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
693                                                                         var_expr_path_strm.GetString().c_str());
694                                         return ValueObjectSP();
695                                     }
696                                     valobj_sp = temp;
697                                     deref = false;
698                                 }
699                                 else if (ClangASTContext::IsArrayOfScalarType(valobj_sp->GetClangType()) && deref)
700                                 {
701                                     // what we have is *arr[low]. the most similar C++ syntax is to get arr[0]
702                                     // (an operation that is equivalent to deref-ing arr)
703                                     // and extract bit low out of it. reading array item low
704                                     // would be done by saying arr[low], without a deref * sign
705                                     Error error;
706                                     ValueObjectSP temp(valobj_sp->GetChildAtIndex (0, true));
707                                     if (error.Fail())
708                                     {
709                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
710                                         error.SetErrorStringWithFormat ("could not get item 0 for \"(%s) %s\"",
711                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
712                                                                         var_expr_path_strm.GetString().c_str());
713                                         return ValueObjectSP();
714                                     }
715                                     valobj_sp = temp;
716                                     deref = false;
717                                 }
718 
719                                 if (valobj_sp->IsPointerType ())
720                                 {
721                                     child_valobj_sp = valobj_sp->GetSyntheticArrayMemberFromPointer (child_index, true);
722                                     if (!child_valobj_sp)
723                                     {
724                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
725                                         error.SetErrorStringWithFormat ("failed to use pointer as array for index %i for \"(%s) %s\"",
726                                                                         child_index,
727                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
728                                                                         var_expr_path_strm.GetString().c_str());
729                                     }
730                                 }
731                                 else if (ClangASTContext::IsArrayType (valobj_sp->GetClangType(), NULL, NULL))
732                                 {
733                                     // Pass false to dynamic_value here so we can tell the difference between
734                                     // no dynamic value and no member of this type...
735                                     child_valobj_sp = valobj_sp->GetChildAtIndex (child_index, true);
736                                     if (!child_valobj_sp)
737                                     {
738                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
739                                         error.SetErrorStringWithFormat ("array index %i is not valid for \"(%s) %s\"",
740                                                                         child_index,
741                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
742                                                                         var_expr_path_strm.GetString().c_str());
743                                     }
744                                 }
745                                 else if (ClangASTContext::IsScalarType(valobj_sp->GetClangType()))
746                                 {
747                                     // this is a bitfield asking to display just one bit
748                                     child_valobj_sp = valobj_sp->GetSyntheticBitFieldChild(child_index, child_index, true);
749                                     if (!child_valobj_sp)
750                                     {
751                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
752                                         error.SetErrorStringWithFormat ("bitfield range %i-%i is not valid for \"(%s) %s\"",
753                                                                         child_index, child_index,
754                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
755                                                                         var_expr_path_strm.GetString().c_str());
756                                     }
757                                 }
758                                 else
759                                 {
760                                     valobj_sp->GetExpressionPath (var_expr_path_strm, false);
761                                     error.SetErrorStringWithFormat ("\"(%s) %s\" is not an array type",
762                                                                     valobj_sp->GetTypeName().AsCString("<invalid type>"),
763                                                                     var_expr_path_strm.GetString().c_str());
764                                 }
765 
766                                 if (!child_valobj_sp)
767                                 {
768                                     // Invalid array index...
769                                     return ValueObjectSP();
770                                 }
771 
772                                 // Erase the array member specification '[%i]' where
773                                 // %i is the array index
774                                 var_path.erase(0, (end - var_path.c_str()) + 1);
775                                 separator_idx = var_path.find_first_of(".-[");
776                                 if (use_dynamic != lldb::eNoDynamicValues)
777                                 {
778                                     ValueObjectSP dynamic_value_sp(child_valobj_sp->GetDynamicValue(use_dynamic));
779                                     if (dynamic_value_sp)
780                                         child_valobj_sp = dynamic_value_sp;
781                                 }
782                                 // Break out early from the switch since we were
783                                 // able to find the child member
784                                 break;
785                             }
786                             else if (end && *end == '-')
787                             {
788                                 // this is most probably a BitField, let's take a look
789                                 char *real_end = NULL;
790                                 long final_index = ::strtol (end+1, &real_end, 0);
791                                 if (real_end && *real_end == ']')
792                                 {
793                                     // if the format given is [high-low], swap range
794                                     if (child_index > final_index)
795                                     {
796                                         long temp = child_index;
797                                         child_index = final_index;
798                                         final_index = temp;
799                                     }
800 
801                                     if (ClangASTContext::IsPointerToScalarType(valobj_sp->GetClangType()) && deref)
802                                     {
803                                         // what we have is *ptr[low-high]. the most similar C++ syntax is to deref ptr
804                                         // and extract bits low thru high out of it. reading array items low thru high
805                                         // would be done by saying ptr[low-high], without a deref * sign
806                                         Error error;
807                                         ValueObjectSP temp(valobj_sp->Dereference(error));
808                                         if (error.Fail())
809                                         {
810                                             valobj_sp->GetExpressionPath (var_expr_path_strm, false);
811                                             error.SetErrorStringWithFormat ("could not dereference \"(%s) %s\"",
812                                                                             valobj_sp->GetTypeName().AsCString("<invalid type>"),
813                                                                             var_expr_path_strm.GetString().c_str());
814                                             return ValueObjectSP();
815                                         }
816                                         valobj_sp = temp;
817                                         deref = false;
818                                     }
819                                     else if (ClangASTContext::IsArrayOfScalarType(valobj_sp->GetClangType()) && deref)
820                                     {
821                                         // what we have is *arr[low-high]. the most similar C++ syntax is to get arr[0]
822                                         // (an operation that is equivalent to deref-ing arr)
823                                         // and extract bits low thru high out of it. reading array items low thru high
824                                         // would be done by saying arr[low-high], without a deref * sign
825                                         Error error;
826                                         ValueObjectSP temp(valobj_sp->GetChildAtIndex (0, true));
827                                         if (error.Fail())
828                                         {
829                                             valobj_sp->GetExpressionPath (var_expr_path_strm, false);
830                                             error.SetErrorStringWithFormat ("could not get item 0 for \"(%s) %s\"",
831                                                                             valobj_sp->GetTypeName().AsCString("<invalid type>"),
832                                                                             var_expr_path_strm.GetString().c_str());
833                                             return ValueObjectSP();
834                                         }
835                                         valobj_sp = temp;
836                                         deref = false;
837                                     }
838 
839                                     child_valobj_sp = valobj_sp->GetSyntheticBitFieldChild(child_index, final_index, true);
840                                     if (!child_valobj_sp)
841                                     {
842                                         valobj_sp->GetExpressionPath (var_expr_path_strm, false);
843                                         error.SetErrorStringWithFormat ("bitfield range %i-%i is not valid for \"(%s) %s\"",
844                                                                         child_index, final_index,
845                                                                         valobj_sp->GetTypeName().AsCString("<invalid type>"),
846                                                                         var_expr_path_strm.GetString().c_str());
847                                     }
848                                 }
849 
850                                 if (!child_valobj_sp)
851                                 {
852                                     // Invalid bitfield range...
853                                     return ValueObjectSP();
854                                 }
855 
856                                 // Erase the bitfield member specification '[%i-%i]' where
857                                 // %i is the index
858                                 var_path.erase(0, (real_end - var_path.c_str()) + 1);
859                                 separator_idx = var_path.find_first_of(".-[");
860                                 if (use_dynamic != lldb::eNoDynamicValues)
861                                 {
862                                     ValueObjectSP dynamic_value_sp(child_valobj_sp->GetDynamicValue(use_dynamic));
863                                     if (dynamic_value_sp)
864                                         child_valobj_sp = dynamic_value_sp;
865                                 }
866                                 // Break out early from the switch since we were
867                                 // able to find the child member
868                                 break;
869 
870                             }
871                         }
872                         else
873                         {
874                             error.SetErrorStringWithFormat("invalid square bracket encountered after \"%s\" in \"%s\"",
875                                                            var_expr_path_strm.GetString().c_str(),
876                                                            var_path.c_str());
877                         }
878                         return ValueObjectSP();
879 
880                     default:
881                         // Failure...
882                         {
883                             valobj_sp->GetExpressionPath (var_expr_path_strm, false);
884                             error.SetErrorStringWithFormat ("unexpected char '%c' encountered after \"%s\" in \"%s\"",
885                                                             separator_type,
886                                                             var_expr_path_strm.GetString().c_str(),
887                                                             var_path.c_str());
888 
889                             return ValueObjectSP();
890                         }
891                     }
892 
893                     if (child_valobj_sp)
894                         valobj_sp = child_valobj_sp;
895 
896                     if (var_path.empty())
897                         break;
898 
899                 }
900                 if (valobj_sp)
901                 {
902                     if (deref)
903                     {
904                         ValueObjectSP deref_valobj_sp (valobj_sp->Dereference(error));
905                         valobj_sp = deref_valobj_sp;
906                     }
907                     else if (address_of)
908                     {
909                         ValueObjectSP address_of_valobj_sp (valobj_sp->AddressOf(error));
910                         valobj_sp = address_of_valobj_sp;
911                     }
912                 }
913                 return valobj_sp;
914             }
915             else
916             {
917                 error.SetErrorStringWithFormat("no variable named '%s' found in this frame",
918                                                name_const_string.GetCString());
919             }
920         }
921     }
922     else
923     {
924         error.SetErrorStringWithFormat("invalid variable path '%s'", var_expr_cstr);
925     }
926     return ValueObjectSP();
927 }
928 
929 bool
930 StackFrame::GetFrameBaseValue (Scalar &frame_base, Error *error_ptr)
931 {
932     if (m_flags.IsClear(GOT_FRAME_BASE))
933     {
934         if (m_sc.function)
935         {
936             m_frame_base.Clear();
937             m_frame_base_error.Clear();
938 
939             m_flags.Set(GOT_FRAME_BASE);
940             ExecutionContext exe_ctx (&m_thread.GetProcess(), &m_thread, this);
941             Value expr_value;
942             addr_t loclist_base_addr = LLDB_INVALID_ADDRESS;
943             if (m_sc.function->GetFrameBaseExpression().IsLocationList())
944                 loclist_base_addr = m_sc.function->GetAddressRange().GetBaseAddress().GetLoadAddress (&m_thread.GetProcess().GetTarget());
945 
946             if (m_sc.function->GetFrameBaseExpression().Evaluate(&exe_ctx, NULL, NULL, NULL, NULL, loclist_base_addr, NULL, expr_value, &m_frame_base_error) == false)
947             {
948                 // We should really have an error if evaluate returns, but in case
949                 // we don't, lets set the error to something at least.
950                 if (m_frame_base_error.Success())
951                     m_frame_base_error.SetErrorString("Evaluation of the frame base expression failed.");
952             }
953             else
954             {
955                 m_frame_base = expr_value.ResolveValue(&exe_ctx, NULL);
956             }
957         }
958         else
959         {
960             m_frame_base_error.SetErrorString ("No function in symbol context.");
961         }
962     }
963 
964     if (m_frame_base_error.Success())
965         frame_base = m_frame_base;
966 
967     if (error_ptr)
968         *error_ptr = m_frame_base_error;
969     return m_frame_base_error.Success();
970 }
971 
972 RegisterContextSP
973 StackFrame::GetRegisterContext ()
974 {
975     if (!m_reg_context_sp)
976         m_reg_context_sp = m_thread.CreateRegisterContextForFrame (this);
977     return m_reg_context_sp;
978 }
979 
980 bool
981 StackFrame::HasDebugInformation ()
982 {
983     GetSymbolContext (eSymbolContextLineEntry);
984     return m_sc.line_entry.IsValid();
985 }
986 
987 
988 ValueObjectSP
989 StackFrame::GetValueObjectForFrameVariable (const VariableSP &variable_sp, lldb::DynamicValueType use_dynamic)
990 {
991     ValueObjectSP valobj_sp;
992     VariableList *var_list = GetVariableList (true);
993     if (var_list)
994     {
995         // Make sure the variable is a frame variable
996         const uint32_t var_idx = var_list->FindIndexForVariable (variable_sp.get());
997         const uint32_t num_variables = var_list->GetSize();
998         if (var_idx < num_variables)
999         {
1000             valobj_sp = m_variable_list_value_objects.GetValueObjectAtIndex (var_idx);
1001             if (valobj_sp.get() == NULL)
1002             {
1003                 if (m_variable_list_value_objects.GetSize() < num_variables)
1004                     m_variable_list_value_objects.Resize(num_variables);
1005                 valobj_sp = ValueObjectVariable::Create (this, variable_sp);
1006                 m_variable_list_value_objects.SetValueObjectAtIndex (var_idx, valobj_sp);
1007             }
1008         }
1009     }
1010     if (use_dynamic != lldb::eNoDynamicValues && valobj_sp)
1011     {
1012         ValueObjectSP dynamic_sp = valobj_sp->GetDynamicValue (use_dynamic);
1013         if (dynamic_sp)
1014             return dynamic_sp;
1015     }
1016     return valobj_sp;
1017 }
1018 
1019 ValueObjectSP
1020 StackFrame::TrackGlobalVariable (const VariableSP &variable_sp, lldb::DynamicValueType use_dynamic)
1021 {
1022     // Check to make sure we aren't already tracking this variable?
1023     ValueObjectSP valobj_sp (GetValueObjectForFrameVariable (variable_sp, use_dynamic));
1024     if (!valobj_sp)
1025     {
1026         // We aren't already tracking this global
1027         VariableList *var_list = GetVariableList (true);
1028         // If this frame has no variables, create a new list
1029         if (var_list == NULL)
1030             m_variable_list_sp.reset (new VariableList());
1031 
1032         // Add the global/static variable to this frame
1033         m_variable_list_sp->AddVariable (variable_sp);
1034 
1035         // Now make a value object for it so we can track its changes
1036         valobj_sp = GetValueObjectForFrameVariable (variable_sp, use_dynamic);
1037     }
1038     return valobj_sp;
1039 }
1040 
1041 bool
1042 StackFrame::IsInlined ()
1043 {
1044     if (m_sc.block == NULL)
1045         GetSymbolContext (eSymbolContextBlock);
1046     if (m_sc.block)
1047         return m_sc.block->GetContainingInlinedBlock() != NULL;
1048     return false;
1049 }
1050 
1051 Target *
1052 StackFrame::CalculateTarget ()
1053 {
1054     return m_thread.CalculateTarget();
1055 }
1056 
1057 Process *
1058 StackFrame::CalculateProcess ()
1059 {
1060     return m_thread.CalculateProcess();
1061 }
1062 
1063 Thread *
1064 StackFrame::CalculateThread ()
1065 {
1066     return &m_thread;
1067 }
1068 
1069 StackFrame *
1070 StackFrame::CalculateStackFrame ()
1071 {
1072     return this;
1073 }
1074 
1075 
1076 void
1077 StackFrame::CalculateExecutionContext (ExecutionContext &exe_ctx)
1078 {
1079     m_thread.CalculateExecutionContext (exe_ctx);
1080     exe_ctx.frame = this;
1081 }
1082 
1083 void
1084 StackFrame::DumpUsingSettingsFormat (Stream *strm)
1085 {
1086     if (strm == NULL)
1087         return;
1088 
1089     GetSymbolContext(eSymbolContextEverything);
1090     ExecutionContext exe_ctx;
1091     CalculateExecutionContext(exe_ctx);
1092     const char *end = NULL;
1093     StreamString s;
1094     const char *frame_format = m_thread.GetProcess().GetTarget().GetDebugger().GetFrameFormat();
1095     if (frame_format && Debugger::FormatPrompt (frame_format, &m_sc, &exe_ctx, NULL, s, &end))
1096     {
1097         strm->Write(s.GetData(), s.GetSize());
1098     }
1099     else
1100     {
1101         Dump (strm, true, false);
1102         strm->EOL();
1103     }
1104 }
1105 
1106 void
1107 StackFrame::Dump (Stream *strm, bool show_frame_index, bool show_fullpaths)
1108 {
1109     if (strm == NULL)
1110         return;
1111 
1112     if (show_frame_index)
1113         strm->Printf("frame #%u: ", m_frame_index);
1114     strm->Printf("0x%0*llx ", m_thread.GetProcess().GetTarget().GetArchitecture().GetAddressByteSize() * 2, GetFrameCodeAddress().GetLoadAddress(&m_thread.GetProcess().GetTarget()));
1115     GetSymbolContext(eSymbolContextEverything);
1116     const bool show_module = true;
1117     const bool show_inline = true;
1118     m_sc.DumpStopContext(strm, &m_thread.GetProcess(), GetFrameCodeAddress(), show_fullpaths, show_module, show_inline);
1119 }
1120 
1121 void
1122 StackFrame::UpdateCurrentFrameFromPreviousFrame (StackFrame &prev_frame)
1123 {
1124     assert (GetStackID() == prev_frame.GetStackID());    // TODO: remove this after some testing
1125     m_variable_list_sp = prev_frame.m_variable_list_sp;
1126     m_variable_list_value_objects.Swap (prev_frame.m_variable_list_value_objects);
1127     if (!m_disassembly.GetString().empty())
1128         m_disassembly.GetString().swap (m_disassembly.GetString());
1129 }
1130 
1131 
1132 void
1133 StackFrame::UpdatePreviousFrameFromCurrentFrame (StackFrame &curr_frame)
1134 {
1135     assert (GetStackID() == curr_frame.GetStackID());        // TODO: remove this after some testing
1136     m_id.SetPC (curr_frame.m_id.GetPC());       // Update the Stack ID PC value
1137     assert (&m_thread == &curr_frame.m_thread);
1138     m_frame_index = curr_frame.m_frame_index;
1139     m_concrete_frame_index = curr_frame.m_concrete_frame_index;
1140     m_reg_context_sp = curr_frame.m_reg_context_sp;
1141     m_frame_code_addr = curr_frame.m_frame_code_addr;
1142     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());
1143     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());
1144     assert (m_sc.comp_unit == NULL || curr_frame.m_sc.comp_unit == NULL || m_sc.comp_unit == curr_frame.m_sc.comp_unit);
1145     assert (m_sc.function == NULL || curr_frame.m_sc.function == NULL || m_sc.function == curr_frame.m_sc.function);
1146     m_sc = curr_frame.m_sc;
1147     m_flags.Clear(GOT_FRAME_BASE | eSymbolContextEverything);
1148     m_flags.Set (m_sc.GetResolvedMask());
1149     m_frame_base.Clear();
1150     m_frame_base_error.Clear();
1151 }
1152 
1153 
1154 bool
1155 StackFrame::HasCachedData () const
1156 {
1157     if (m_variable_list_sp.get())
1158         return true;
1159     if (m_variable_list_value_objects.GetSize() > 0)
1160         return true;
1161     if (!m_disassembly.GetString().empty())
1162         return true;
1163     return false;
1164 }
1165 
1166 lldb::StackFrameSP
1167 StackFrame::GetSP ()
1168 {
1169     return m_thread.GetStackFrameSPForStackFramePtr (this);
1170 }
1171 
1172 
1173 
1174 bool
1175 StackFrame::GetStatus (Stream& strm,
1176                        bool show_frame_info,
1177                        bool show_source,
1178                        uint32_t source_lines_before,
1179                        uint32_t source_lines_after)
1180 {
1181     if (show_frame_info)
1182     {
1183         strm.Indent();
1184         DumpUsingSettingsFormat (&strm);
1185     }
1186 
1187     if (show_source)
1188     {
1189         GetSymbolContext(eSymbolContextCompUnit | eSymbolContextLineEntry);
1190 
1191         if (m_sc.comp_unit && m_sc.line_entry.IsValid())
1192         {
1193             Target &target = GetThread().GetProcess().GetTarget();
1194             target.GetDebugger().GetSourceManager().DisplaySourceLinesWithLineNumbers (
1195                 &target,
1196                 m_sc.line_entry.file,
1197                 m_sc.line_entry.line,
1198                 3,
1199                 3,
1200                 "->",
1201                 &strm);
1202 
1203         }
1204     }
1205     return true;
1206 }
1207 
1208