LLDB mainline
StackFrame.cpp
Go to the documentation of this file.
1//===-- StackFrame.cpp ----------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
10#include "lldb/Core/Debugger.h"
13#include "lldb/Core/Mangled.h"
14#include "lldb/Core/Module.h"
15#include "lldb/Core/Value.h"
21#include "lldb/Symbol/Symbol.h"
24#include "lldb/Symbol/Type.h"
26#include "lldb/Target/ABI.h"
28#include "lldb/Target/Process.h"
31#include "lldb/Target/Target.h"
32#include "lldb/Target/Thread.h"
34#include "lldb/Utility/Log.h"
36
38
39#include <memory>
40
41using namespace lldb;
42using namespace lldb_private;
43
44// The first bits in the flags are reserved for the SymbolContext::Scope bits
45// so we know if we have tried to look up information in our internal symbol
46// context (m_sc) already.
47#define RESOLVED_FRAME_CODE_ADDR (uint32_t(eSymbolContextLastItem) << 1)
48#define RESOLVED_FRAME_ID_SYMBOL_SCOPE (RESOLVED_FRAME_CODE_ADDR << 1)
49#define GOT_FRAME_BASE (RESOLVED_FRAME_ID_SYMBOL_SCOPE << 1)
50#define RESOLVED_VARIABLES (GOT_FRAME_BASE << 1)
51#define RESOLVED_GLOBAL_VARIABLES (RESOLVED_VARIABLES << 1)
52
53StackFrame::StackFrame(const ThreadSP &thread_sp, user_id_t frame_idx,
54 user_id_t unwind_frame_index, addr_t cfa,
55 bool cfa_is_valid, addr_t pc, StackFrame::Kind kind,
56 bool behaves_like_zeroth_frame,
57 const SymbolContext *sc_ptr)
58 : m_thread_wp(thread_sp), m_frame_index(frame_idx),
59 m_concrete_frame_index(unwind_frame_index), m_reg_context_sp(),
60 m_id(pc, cfa, nullptr), m_frame_code_addr(pc), m_sc(), m_flags(),
61 m_frame_base(), m_frame_base_error(), m_cfa_is_valid(cfa_is_valid),
62 m_stack_frame_kind(kind),
63 m_behaves_like_zeroth_frame(behaves_like_zeroth_frame),
64 m_variable_list_sp(), m_variable_list_value_objects(),
65 m_recognized_frame_sp(), m_disassembly(), m_mutex() {
66 // If we don't have a CFA value, use the frame index for our StackID so that
67 // recursive functions properly aren't confused with one another on a history
68 // stack.
69 if (IsHistorical() && !m_cfa_is_valid) {
71 }
72
73 if (sc_ptr != nullptr) {
74 m_sc = *sc_ptr;
76 }
77}
78
79StackFrame::StackFrame(const ThreadSP &thread_sp, user_id_t frame_idx,
80 user_id_t unwind_frame_index,
81 const RegisterContextSP &reg_context_sp, addr_t cfa,
82 addr_t pc, bool behaves_like_zeroth_frame,
83 const SymbolContext *sc_ptr)
84 : m_thread_wp(thread_sp), m_frame_index(frame_idx),
85 m_concrete_frame_index(unwind_frame_index),
86 m_reg_context_sp(reg_context_sp), m_id(pc, cfa, nullptr),
87 m_frame_code_addr(pc), m_sc(), m_flags(), m_frame_base(),
88 m_frame_base_error(), m_cfa_is_valid(true),
89 m_stack_frame_kind(StackFrame::Kind::Regular),
90 m_behaves_like_zeroth_frame(behaves_like_zeroth_frame),
91 m_variable_list_sp(), m_variable_list_value_objects(),
92 m_recognized_frame_sp(), m_disassembly(), m_mutex() {
93 if (sc_ptr != nullptr) {
94 m_sc = *sc_ptr;
96 }
97
98 if (reg_context_sp && !m_sc.target_sp) {
99 m_sc.target_sp = reg_context_sp->CalculateTarget();
100 if (m_sc.target_sp)
101 m_flags.Set(eSymbolContextTarget);
102 }
103}
104
105StackFrame::StackFrame(const ThreadSP &thread_sp, user_id_t frame_idx,
106 user_id_t unwind_frame_index,
107 const RegisterContextSP &reg_context_sp, addr_t cfa,
108 const Address &pc_addr, bool behaves_like_zeroth_frame,
109 const SymbolContext *sc_ptr)
110 : m_thread_wp(thread_sp), m_frame_index(frame_idx),
111 m_concrete_frame_index(unwind_frame_index),
112 m_reg_context_sp(reg_context_sp),
113 m_id(pc_addr.GetLoadAddress(thread_sp->CalculateTarget().get()), cfa,
114 nullptr),
115 m_frame_code_addr(pc_addr), m_sc(), m_flags(), m_frame_base(),
116 m_frame_base_error(), m_cfa_is_valid(true),
117 m_stack_frame_kind(StackFrame::Kind::Regular),
118 m_behaves_like_zeroth_frame(behaves_like_zeroth_frame),
119 m_variable_list_sp(), m_variable_list_value_objects(),
120 m_recognized_frame_sp(), m_disassembly(), m_mutex() {
121 if (sc_ptr != nullptr) {
122 m_sc = *sc_ptr;
124 }
125
126 if (!m_sc.target_sp && reg_context_sp) {
127 m_sc.target_sp = reg_context_sp->CalculateTarget();
128 if (m_sc.target_sp)
129 m_flags.Set(eSymbolContextTarget);
130 }
131
132 ModuleSP pc_module_sp(pc_addr.GetModule());
133 if (!m_sc.module_sp || m_sc.module_sp != pc_module_sp) {
134 if (pc_module_sp) {
135 m_sc.module_sp = pc_module_sp;
136 m_flags.Set(eSymbolContextModule);
137 } else {
138 m_sc.module_sp.reset();
139 }
140 }
141}
142
143StackFrame::~StackFrame() = default;
144
146 std::lock_guard<std::recursive_mutex> guard(m_mutex);
147 // Make sure we have resolved the StackID object's symbol context scope if we
148 // already haven't looked it up.
149
152 // We already have a symbol context scope, we just don't have our flag
153 // bit set.
155 } else {
156 // Calculate the frame block and use this for the stack ID symbol context
157 // scope if we have one.
159 if (scope == nullptr) {
160 // We don't have a block, so use the symbol
161 if (m_flags.IsClear(eSymbolContextSymbol))
162 GetSymbolContext(eSymbolContextSymbol);
163
164 // It is ok if m_sc.symbol is nullptr here
165 scope = m_sc.symbol;
166 }
167 // Set the symbol context scope (the accessor will set the
168 // RESOLVED_FRAME_ID_SYMBOL_SCOPE bit in m_flags).
170 }
171 }
172 return m_id;
173}
174
176 ThreadSP thread_sp = GetThread();
177 if (thread_sp)
178 return thread_sp->GetStackFrameList()->GetVisibleStackFrameIndex(
180 else
181 return m_frame_index;
182}
183
185 std::lock_guard<std::recursive_mutex> guard(m_mutex);
187 m_id.SetSymbolContextScope(symbol_scope);
188}
189
191 std::lock_guard<std::recursive_mutex> guard(m_mutex);
195
196 // Resolve the PC into a temporary address because if ResolveLoadAddress
197 // fails to resolve the address, it will clear the address object...
198 ThreadSP thread_sp(GetThread());
199 if (thread_sp) {
200 TargetSP target_sp(thread_sp->CalculateTarget());
201 if (target_sp) {
202 const bool allow_section_end = true;
204 m_frame_code_addr.GetOffset(), target_sp.get(),
205 AddressClass::eCode, allow_section_end)) {
207 if (module_sp) {
208 m_sc.module_sp = module_sp;
209 m_flags.Set(eSymbolContextModule);
210 }
211 }
212 }
213 }
214 }
215 return m_frame_code_addr;
216}
217
218// This can't be rewritten into a call to
219// RegisterContext::GetPCForSymbolication because this
220// StackFrame may have been constructed with a special pc,
221// e.g. tail-call artificial frames.
223 Address lookup_addr(GetFrameCodeAddress());
224 if (!lookup_addr.IsValid())
225 return lookup_addr;
227 return lookup_addr;
228
229 addr_t offset = lookup_addr.GetOffset();
230 if (offset > 0) {
231 lookup_addr.SetOffset(offset - 1);
232 } else {
233 // lookup_addr is the start of a section. We need do the math on the
234 // actual load address and re-compute the section. We're working with
235 // a 'noreturn' function at the end of a section.
236 TargetSP target_sp = CalculateTarget();
237 if (target_sp) {
238 addr_t addr_minus_one = lookup_addr.GetOpcodeLoadAddress(
239 target_sp.get(), AddressClass::eCode) -
240 1;
241 lookup_addr.SetOpcodeLoadAddress(addr_minus_one, target_sp.get());
242 }
243 }
244 return lookup_addr;
245}
246
248 std::lock_guard<std::recursive_mutex> guard(m_mutex);
249 // We can't change the pc value of a history stack frame - it is immutable.
250 if (IsHistorical())
251 return false;
253 m_sc.Clear(false);
254 m_flags.Reset(0);
255 ThreadSP thread_sp(GetThread());
256 if (thread_sp)
257 thread_sp->ClearStackFrames();
258 return true;
259}
260
262 std::lock_guard<std::recursive_mutex> guard(m_mutex);
263 if (!m_disassembly.Empty())
264 return m_disassembly.GetData();
265
266 ExecutionContext exe_ctx(shared_from_this());
267 if (Target *target = exe_ctx.GetTargetPtr()) {
268 Disassembler::Disassemble(target->GetDebugger(), target->GetArchitecture(),
269 *this, m_disassembly);
270 }
271
272 return m_disassembly.Empty() ? nullptr : m_disassembly.GetData();
273}
274
276 if (m_sc.block == nullptr && m_flags.IsClear(eSymbolContextBlock))
277 GetSymbolContext(eSymbolContextBlock);
278
279 if (m_sc.block) {
280 Block *inline_block = m_sc.block->GetContainingInlinedBlock();
281 if (inline_block) {
282 // Use the block with the inlined function info as the frame block we
283 // want this frame to have only the variables for the inlined function
284 // and its non-inlined block child blocks.
285 return inline_block;
286 } else {
287 // This block is not contained within any inlined function blocks with so
288 // we want to use the top most function block.
289 return &m_sc.function->GetBlock(false);
290 }
291 }
292 return nullptr;
293}
294
295// Get the symbol context if we already haven't done so by resolving the
296// PC address as much as possible. This way when we pass around a
297// StackFrame object, everyone will have as much information as possible and no
298// one will ever have to look things up manually.
299const SymbolContext &
300StackFrame::GetSymbolContext(SymbolContextItem resolve_scope) {
301 std::lock_guard<std::recursive_mutex> guard(m_mutex);
302 // Copy our internal symbol context into "sc".
303 if ((m_flags.Get() & resolve_scope) != resolve_scope) {
304 uint32_t resolved = 0;
305
306 // If the target was requested add that:
307 if (!m_sc.target_sp) {
309 if (m_sc.target_sp)
310 resolved |= eSymbolContextTarget;
311 }
312
313 // Resolve our PC to section offset if we haven't already done so and if we
314 // don't have a module. The resolved address section will contain the
315 // module to which it belongs
318
319 // If this is not frame zero, then we need to subtract 1 from the PC value
320 // when doing address lookups since the PC will be on the instruction
321 // following the function call instruction...
323
324 if (m_sc.module_sp) {
325 // We have something in our stack frame symbol context, lets check if we
326 // haven't already tried to lookup one of those things. If we haven't
327 // then we will do the query.
328
329 SymbolContextItem actual_resolve_scope = SymbolContextItem(0);
330
331 if (resolve_scope & eSymbolContextCompUnit) {
332 if (m_flags.IsClear(eSymbolContextCompUnit)) {
333 if (m_sc.comp_unit)
334 resolved |= eSymbolContextCompUnit;
335 else
336 actual_resolve_scope |= eSymbolContextCompUnit;
337 }
338 }
339
340 if (resolve_scope & eSymbolContextFunction) {
341 if (m_flags.IsClear(eSymbolContextFunction)) {
342 if (m_sc.function)
343 resolved |= eSymbolContextFunction;
344 else
345 actual_resolve_scope |= eSymbolContextFunction;
346 }
347 }
348
349 if (resolve_scope & eSymbolContextBlock) {
350 if (m_flags.IsClear(eSymbolContextBlock)) {
351 if (m_sc.block)
352 resolved |= eSymbolContextBlock;
353 else
354 actual_resolve_scope |= eSymbolContextBlock;
355 }
356 }
357
358 if (resolve_scope & eSymbolContextSymbol) {
359 if (m_flags.IsClear(eSymbolContextSymbol)) {
360 if (m_sc.symbol)
361 resolved |= eSymbolContextSymbol;
362 else
363 actual_resolve_scope |= eSymbolContextSymbol;
364 }
365 }
366
367 if (resolve_scope & eSymbolContextLineEntry) {
368 if (m_flags.IsClear(eSymbolContextLineEntry)) {
369 if (m_sc.line_entry.IsValid())
370 resolved |= eSymbolContextLineEntry;
371 else
372 actual_resolve_scope |= eSymbolContextLineEntry;
373 }
374 }
375
376 if (actual_resolve_scope) {
377 // We might be resolving less information than what is already in our
378 // current symbol context so resolve into a temporary symbol context
379 // "sc" so we don't clear out data we have already found in "m_sc"
380 SymbolContext sc;
381 // Set flags that indicate what we have tried to resolve
382 resolved |= m_sc.module_sp->ResolveSymbolContextForAddress(
383 lookup_addr, actual_resolve_scope, sc);
384 // Only replace what we didn't already have as we may have information
385 // for an inlined function scope that won't match what a standard
386 // lookup by address would match
387 if ((resolved & eSymbolContextCompUnit) && m_sc.comp_unit == nullptr)
389 if ((resolved & eSymbolContextFunction) && m_sc.function == nullptr)
391 if ((resolved & eSymbolContextBlock) && m_sc.block == nullptr)
392 m_sc.block = sc.block;
393 if ((resolved & eSymbolContextSymbol) && m_sc.symbol == nullptr)
394 m_sc.symbol = sc.symbol;
395 if ((resolved & eSymbolContextLineEntry) &&
399 }
400 }
401 } else {
402 // If we don't have a module, then we can't have the compile unit,
403 // function, block, line entry or symbol, so we can safely call
404 // ResolveSymbolContextForAddress with our symbol context member m_sc.
405 if (m_sc.target_sp) {
406 resolved |= m_sc.target_sp->GetImages().ResolveSymbolContextForAddress(
407 lookup_addr, resolve_scope, m_sc);
408 }
409 }
410
411 // Update our internal flags so we remember what we have tried to locate so
412 // we don't have to keep trying when more calls to this function are made.
413 // We might have dug up more information that was requested (for example if
414 // we were asked to only get the block, we will have gotten the compile
415 // unit, and function) so set any additional bits that we resolved
416 m_flags.Set(resolve_scope | resolved);
417 }
418
419 // Return the symbol context with everything that was possible to resolve
420 // resolved.
421 return m_sc;
422}
423
425 Status *error_ptr) {
426 std::lock_guard<std::recursive_mutex> guard(m_mutex);
429 m_variable_list_sp = std::make_shared<VariableList>();
430
431 Block *frame_block = GetFrameBlock();
432
433 if (frame_block) {
434 const bool get_child_variables = true;
435 const bool can_create = true;
436 const bool stop_if_child_block_is_inlined_function = true;
437 frame_block->AppendBlockVariables(can_create, get_child_variables,
438 stop_if_child_block_is_inlined_function,
439 [](Variable *v) { return true; },
440 m_variable_list_sp.get());
441 }
442 }
443
444 if (m_flags.IsClear(RESOLVED_GLOBAL_VARIABLES) && get_file_globals) {
446
447 if (m_flags.IsClear(eSymbolContextCompUnit))
448 GetSymbolContext(eSymbolContextCompUnit);
449
450 if (m_sc.comp_unit) {
451 VariableListSP global_variable_list_sp(
454 m_variable_list_sp->AddVariables(global_variable_list_sp.get());
455 else
456 m_variable_list_sp = global_variable_list_sp;
457 }
458 }
459
460 if (error_ptr && m_variable_list_sp->GetSize() == 0) {
461 // Check with the symbol file to check if there is an error for why we
462 // don't have variables that the user might need to know about.
463 GetSymbolContext(eSymbolContextEverything);
464 if (m_sc.module_sp) {
465 SymbolFile *sym_file = m_sc.module_sp->GetSymbolFile();
466 if (sym_file)
467 *error_ptr = sym_file->GetFrameVariableError(*this);
468 }
469 }
470
471 return m_variable_list_sp.get();
472}
473
476 bool must_have_valid_location) {
477 std::lock_guard<std::recursive_mutex> guard(m_mutex);
478 // We can't fetch variable information for a history stack frame.
479 if (IsHistorical())
480 return VariableListSP();
481
482 VariableListSP var_list_sp(new VariableList);
483 GetSymbolContext(eSymbolContextCompUnit | eSymbolContextBlock);
484
485 if (m_sc.block) {
486 const bool can_create = true;
487 const bool get_parent_variables = true;
488 const bool stop_if_block_is_inlined_function = true;
490 can_create, get_parent_variables, stop_if_block_is_inlined_function,
491 [this, must_have_valid_location](Variable *v) {
492 return v->IsInScope(this) && (!must_have_valid_location ||
493 v->LocationIsValidForFrame(this));
494 },
495 var_list_sp.get());
496 }
497
498 if (m_sc.comp_unit && get_file_globals) {
499 VariableListSP global_variable_list_sp(
501 if (global_variable_list_sp)
502 var_list_sp->AddVariables(global_variable_list_sp.get());
503 }
504
505 return var_list_sp;
506}
507
509 llvm::StringRef var_expr, DynamicValueType use_dynamic, uint32_t options,
510 VariableSP &var_sp, Status &error) {
511 llvm::StringRef original_var_expr = var_expr;
512 // We can't fetch variable information for a history stack frame.
513 if (IsHistorical())
514 return ValueObjectSP();
515
516 if (var_expr.empty()) {
517 error.SetErrorStringWithFormat("invalid variable path '%s'",
518 var_expr.str().c_str());
519 return ValueObjectSP();
520 }
521
522 const bool check_ptr_vs_member =
524 const bool no_fragile_ivar =
526 const bool no_synth_child =
528 // const bool no_synth_array = (options &
529 // eExpressionPathOptionsNoSyntheticArrayRange) != 0;
530 error.Clear();
531 bool deref = false;
532 bool address_of = false;
533 ValueObjectSP valobj_sp;
534 const bool get_file_globals = true;
535 // When looking up a variable for an expression, we need only consider the
536 // variables that are in scope.
537 VariableListSP var_list_sp(GetInScopeVariableList(get_file_globals));
538 VariableList *variable_list = var_list_sp.get();
539
540 if (!variable_list)
541 return ValueObjectSP();
542
543 // If first character is a '*', then show pointer contents
544 std::string var_expr_storage;
545 if (var_expr[0] == '*') {
546 deref = true;
547 var_expr = var_expr.drop_front(); // Skip the '*'
548 } else if (var_expr[0] == '&') {
549 address_of = true;
550 var_expr = var_expr.drop_front(); // Skip the '&'
551 }
552
553 size_t separator_idx = var_expr.find_first_of(".-[=+~|&^%#@!/?,<>{}");
554 StreamString var_expr_path_strm;
555
556 ConstString name_const_string(var_expr.substr(0, separator_idx));
557
558 var_sp = variable_list->FindVariable(name_const_string, false);
559
560 bool synthetically_added_instance_object = false;
561
562 if (var_sp) {
563 var_expr = var_expr.drop_front(name_const_string.GetLength());
564 }
565
566 if (!var_sp && (options & eExpressionPathOptionsAllowDirectIVarAccess)) {
567 // Check for direct ivars access which helps us with implicit access to
568 // ivars using "this" or "self".
569 GetSymbolContext(eSymbolContextFunction | eSymbolContextBlock);
570 llvm::StringRef instance_var_name = m_sc.GetInstanceVariableName();
571 if (!instance_var_name.empty()) {
572 var_sp = variable_list->FindVariable(ConstString(instance_var_name));
573 if (var_sp) {
574 separator_idx = 0;
575 if (Type *var_type = var_sp->GetType())
576 if (auto compiler_type = var_type->GetForwardCompilerType())
577 if (!compiler_type.IsPointerType())
578 var_expr_storage = ".";
579
580 if (var_expr_storage.empty())
581 var_expr_storage = "->";
582 var_expr_storage += var_expr;
583 var_expr = var_expr_storage;
584 synthetically_added_instance_object = true;
585 }
586 }
587 }
588
589 if (!var_sp && (options & eExpressionPathOptionsInspectAnonymousUnions)) {
590 // Check if any anonymous unions are there which contain a variable with
591 // the name we need
592 for (const VariableSP &variable_sp : *variable_list) {
593 if (!variable_sp)
594 continue;
595 if (!variable_sp->GetName().IsEmpty())
596 continue;
597
598 Type *var_type = variable_sp->GetType();
599 if (!var_type)
600 continue;
601
602 if (!var_type->GetForwardCompilerType().IsAnonymousType())
603 continue;
604 valobj_sp = GetValueObjectForFrameVariable(variable_sp, use_dynamic);
605 if (!valobj_sp)
606 return valobj_sp;
607 valobj_sp = valobj_sp->GetChildMemberWithName(name_const_string);
608 if (valobj_sp)
609 break;
610 }
611 }
612
613 if (var_sp && !valobj_sp) {
614 valobj_sp = GetValueObjectForFrameVariable(var_sp, use_dynamic);
615 if (!valobj_sp)
616 return valobj_sp;
617 }
618 if (!valobj_sp) {
619 error.SetErrorStringWithFormat("no variable named '%s' found in this frame",
620 name_const_string.GetCString());
621 return ValueObjectSP();
622 }
623
624 // We are dumping at least one child
625 while (!var_expr.empty()) {
626 // Calculate the next separator index ahead of time
627 ValueObjectSP child_valobj_sp;
628 const char separator_type = var_expr[0];
629 bool expr_is_ptr = false;
630 switch (separator_type) {
631 case '-':
632 expr_is_ptr = true;
633 if (var_expr.size() >= 2 && var_expr[1] != '>')
634 return ValueObjectSP();
635
636 if (no_fragile_ivar) {
637 // Make sure we aren't trying to deref an objective
638 // C ivar if this is not allowed
639 const uint32_t pointer_type_flags =
640 valobj_sp->GetCompilerType().GetTypeInfo(nullptr);
641 if ((pointer_type_flags & eTypeIsObjC) &&
642 (pointer_type_flags & eTypeIsPointer)) {
643 // This was an objective C object pointer and it was requested we
644 // skip any fragile ivars so return nothing here
645 return ValueObjectSP();
646 }
647 }
648
649 // If we have a non pointer type with a sythetic value then lets check if
650 // we have an sythetic dereference specified.
651 if (!valobj_sp->IsPointerType() && valobj_sp->HasSyntheticValue()) {
652 Status deref_error;
653 if (valobj_sp->GetCompilerType().IsReferenceType()) {
654 valobj_sp = valobj_sp->GetSyntheticValue()->Dereference(deref_error);
655 if (!valobj_sp || deref_error.Fail()) {
656 error.SetErrorStringWithFormatv(
657 "Failed to dereference reference type: %s", deref_error);
658 return ValueObjectSP();
659 }
660 }
661
662 valobj_sp = valobj_sp->Dereference(deref_error);
663 if (!valobj_sp || deref_error.Fail()) {
664 error.SetErrorStringWithFormatv(
665 "Failed to dereference sythetic value: {0}", deref_error);
666 return ValueObjectSP();
667 }
668 // Some synthetic plug-ins fail to set the error in Dereference
669 if (!valobj_sp) {
670 error.SetErrorString("Failed to dereference sythetic value");
671 return ValueObjectSP();
672 }
673 expr_is_ptr = false;
674 }
675
676 var_expr = var_expr.drop_front(); // Remove the '-'
677 [[fallthrough]];
678 case '.': {
679 var_expr = var_expr.drop_front(); // Remove the '.' or '>'
680 separator_idx = var_expr.find_first_of(".-[");
681 ConstString child_name(var_expr.substr(0, var_expr.find_first_of(".-[")));
682
683 if (check_ptr_vs_member) {
684 // We either have a pointer type and need to verify valobj_sp is a
685 // pointer, or we have a member of a class/union/struct being accessed
686 // with the . syntax and need to verify we don't have a pointer.
687 const bool actual_is_ptr = valobj_sp->IsPointerType();
688
689 if (actual_is_ptr != expr_is_ptr) {
690 // Incorrect use of "." with a pointer, or "->" with a
691 // class/union/struct instance or reference.
692 valobj_sp->GetExpressionPath(var_expr_path_strm);
693 if (actual_is_ptr)
694 error.SetErrorStringWithFormat(
695 "\"%s\" is a pointer and . was used to attempt to access "
696 "\"%s\". Did you mean \"%s->%s\"?",
697 var_expr_path_strm.GetData(), child_name.GetCString(),
698 var_expr_path_strm.GetData(), var_expr.str().c_str());
699 else
700 error.SetErrorStringWithFormat(
701 "\"%s\" is not a pointer and -> was used to attempt to "
702 "access \"%s\". Did you mean \"%s.%s\"?",
703 var_expr_path_strm.GetData(), child_name.GetCString(),
704 var_expr_path_strm.GetData(), var_expr.str().c_str());
705 return ValueObjectSP();
706 }
707 }
708 child_valobj_sp = valobj_sp->GetChildMemberWithName(child_name);
709 if (!child_valobj_sp) {
710 if (!no_synth_child) {
711 child_valobj_sp = valobj_sp->GetSyntheticValue();
712 if (child_valobj_sp)
713 child_valobj_sp =
714 child_valobj_sp->GetChildMemberWithName(child_name);
715 }
716
717 if (no_synth_child || !child_valobj_sp) {
718 // No child member with name "child_name"
719 if (synthetically_added_instance_object) {
720 // We added a "this->" or "self->" to the beginning of the
721 // expression and this is the first pointer ivar access, so just
722 // return the normal error
723 error.SetErrorStringWithFormat(
724 "no variable or instance variable named '%s' found in "
725 "this frame",
726 name_const_string.GetCString());
727 } else {
728 valobj_sp->GetExpressionPath(var_expr_path_strm);
729 if (child_name) {
730 error.SetErrorStringWithFormat(
731 "\"%s\" is not a member of \"(%s) %s\"",
732 child_name.GetCString(),
733 valobj_sp->GetTypeName().AsCString("<invalid type>"),
734 var_expr_path_strm.GetData());
735 } else {
736 error.SetErrorStringWithFormat(
737 "incomplete expression path after \"%s\" in \"%s\"",
738 var_expr_path_strm.GetData(),
739 original_var_expr.str().c_str());
740 }
741 }
742 return ValueObjectSP();
743 }
744 }
745 synthetically_added_instance_object = false;
746 // Remove the child name from the path
747 var_expr = var_expr.drop_front(child_name.GetLength());
748 if (use_dynamic != eNoDynamicValues) {
749 ValueObjectSP dynamic_value_sp(
750 child_valobj_sp->GetDynamicValue(use_dynamic));
751 if (dynamic_value_sp)
752 child_valobj_sp = dynamic_value_sp;
753 }
754 } break;
755
756 case '[': {
757 // Array member access, or treating pointer as an array Need at least two
758 // brackets and a number
759 if (var_expr.size() <= 2) {
760 error.SetErrorStringWithFormat(
761 "invalid square bracket encountered after \"%s\" in \"%s\"",
762 var_expr_path_strm.GetData(), var_expr.str().c_str());
763 return ValueObjectSP();
764 }
765
766 // Drop the open brace.
767 var_expr = var_expr.drop_front();
768 long child_index = 0;
769
770 // If there's no closing brace, this is an invalid expression.
771 size_t end_pos = var_expr.find_first_of(']');
772 if (end_pos == llvm::StringRef::npos) {
773 error.SetErrorStringWithFormat(
774 "missing closing square bracket in expression \"%s\"",
775 var_expr_path_strm.GetData());
776 return ValueObjectSP();
777 }
778 llvm::StringRef index_expr = var_expr.take_front(end_pos);
779 llvm::StringRef original_index_expr = index_expr;
780 // Drop all of "[index_expr]"
781 var_expr = var_expr.drop_front(end_pos + 1);
782
783 if (index_expr.consumeInteger(0, child_index)) {
784 // If there was no integer anywhere in the index expression, this is
785 // erroneous expression.
786 error.SetErrorStringWithFormat("invalid index expression \"%s\"",
787 index_expr.str().c_str());
788 return ValueObjectSP();
789 }
790
791 if (index_expr.empty()) {
792 // The entire index expression was a single integer.
793
794 if (valobj_sp->GetCompilerType().IsPointerToScalarType() && deref) {
795 // what we have is *ptr[low]. the most similar C++ syntax is to deref
796 // ptr and extract bit low out of it. reading array item low would be
797 // done by saying ptr[low], without a deref * sign
798 Status deref_error;
799 ValueObjectSP temp(valobj_sp->Dereference(deref_error));
800 if (!temp || deref_error.Fail()) {
801 valobj_sp->GetExpressionPath(var_expr_path_strm);
802 error.SetErrorStringWithFormat(
803 "could not dereference \"(%s) %s\"",
804 valobj_sp->GetTypeName().AsCString("<invalid type>"),
805 var_expr_path_strm.GetData());
806 return ValueObjectSP();
807 }
808 valobj_sp = temp;
809 deref = false;
810 } else if (valobj_sp->GetCompilerType().IsArrayOfScalarType() &&
811 deref) {
812 // what we have is *arr[low]. the most similar C++ syntax is to get
813 // arr[0] (an operation that is equivalent to deref-ing arr) and
814 // extract bit low out of it. reading array item low would be done by
815 // saying arr[low], without a deref * sign
816 ValueObjectSP temp(valobj_sp->GetChildAtIndex(0));
817 if (!temp) {
818 valobj_sp->GetExpressionPath(var_expr_path_strm);
819 error.SetErrorStringWithFormat(
820 "could not get item 0 for \"(%s) %s\"",
821 valobj_sp->GetTypeName().AsCString("<invalid type>"),
822 var_expr_path_strm.GetData());
823 return ValueObjectSP();
824 }
825 valobj_sp = temp;
826 deref = false;
827 }
828
829 bool is_incomplete_array = false;
830 if (valobj_sp->IsPointerType()) {
831 bool is_objc_pointer = true;
832
833 if (valobj_sp->GetCompilerType().GetMinimumLanguage() !=
835 is_objc_pointer = false;
836 else if (!valobj_sp->GetCompilerType().IsPointerType())
837 is_objc_pointer = false;
838
839 if (no_synth_child && is_objc_pointer) {
840 error.SetErrorStringWithFormat(
841 "\"(%s) %s\" is an Objective-C pointer, and cannot be "
842 "subscripted",
843 valobj_sp->GetTypeName().AsCString("<invalid type>"),
844 var_expr_path_strm.GetData());
845
846 return ValueObjectSP();
847 } else if (is_objc_pointer) {
848 // dereferencing ObjC variables is not valid.. so let's try and
849 // recur to synthetic children
850 ValueObjectSP synthetic = valobj_sp->GetSyntheticValue();
851 if (!synthetic /* no synthetic */
852 || synthetic == valobj_sp) /* synthetic is the same as
853 the original object */
854 {
855 valobj_sp->GetExpressionPath(var_expr_path_strm);
856 error.SetErrorStringWithFormat(
857 "\"(%s) %s\" is not an array type",
858 valobj_sp->GetTypeName().AsCString("<invalid type>"),
859 var_expr_path_strm.GetData());
860 } else if (static_cast<uint32_t>(child_index) >=
861 synthetic
862 ->GetNumChildrenIgnoringErrors() /* synthetic does
863 not have that
864 many values */) {
865 valobj_sp->GetExpressionPath(var_expr_path_strm);
866 error.SetErrorStringWithFormat(
867 "array index %ld is not valid for \"(%s) %s\"", child_index,
868 valobj_sp->GetTypeName().AsCString("<invalid type>"),
869 var_expr_path_strm.GetData());
870 } else {
871 child_valobj_sp = synthetic->GetChildAtIndex(child_index);
872 if (!child_valobj_sp) {
873 valobj_sp->GetExpressionPath(var_expr_path_strm);
874 error.SetErrorStringWithFormat(
875 "array index %ld is not valid for \"(%s) %s\"", child_index,
876 valobj_sp->GetTypeName().AsCString("<invalid type>"),
877 var_expr_path_strm.GetData());
878 }
879 }
880 } else {
881 child_valobj_sp =
882 valobj_sp->GetSyntheticArrayMember(child_index, true);
883 if (!child_valobj_sp) {
884 valobj_sp->GetExpressionPath(var_expr_path_strm);
885 error.SetErrorStringWithFormat(
886 "failed to use pointer as array for index %ld for "
887 "\"(%s) %s\"",
888 child_index,
889 valobj_sp->GetTypeName().AsCString("<invalid type>"),
890 var_expr_path_strm.GetData());
891 }
892 }
893 } else if (valobj_sp->GetCompilerType().IsArrayType(
894 nullptr, nullptr, &is_incomplete_array)) {
895 // Pass false to dynamic_value here so we can tell the difference
896 // between no dynamic value and no member of this type...
897 child_valobj_sp = valobj_sp->GetChildAtIndex(child_index);
898 if (!child_valobj_sp && (is_incomplete_array || !no_synth_child))
899 child_valobj_sp =
900 valobj_sp->GetSyntheticArrayMember(child_index, true);
901
902 if (!child_valobj_sp) {
903 valobj_sp->GetExpressionPath(var_expr_path_strm);
904 error.SetErrorStringWithFormat(
905 "array index %ld is not valid for \"(%s) %s\"", child_index,
906 valobj_sp->GetTypeName().AsCString("<invalid type>"),
907 var_expr_path_strm.GetData());
908 }
909 } else if (valobj_sp->GetCompilerType().IsScalarType()) {
910 // this is a bitfield asking to display just one bit
911 child_valobj_sp = valobj_sp->GetSyntheticBitFieldChild(
912 child_index, child_index, true);
913 if (!child_valobj_sp) {
914 valobj_sp->GetExpressionPath(var_expr_path_strm);
915 error.SetErrorStringWithFormat(
916 "bitfield range %ld-%ld is not valid for \"(%s) %s\"",
917 child_index, child_index,
918 valobj_sp->GetTypeName().AsCString("<invalid type>"),
919 var_expr_path_strm.GetData());
920 }
921 } else {
922 ValueObjectSP synthetic = valobj_sp->GetSyntheticValue();
923 if (no_synth_child /* synthetic is forbidden */ ||
924 !synthetic /* no synthetic */
925 || synthetic == valobj_sp) /* synthetic is the same as the
926 original object */
927 {
928 valobj_sp->GetExpressionPath(var_expr_path_strm);
929 error.SetErrorStringWithFormat(
930 "\"(%s) %s\" is not an array type",
931 valobj_sp->GetTypeName().AsCString("<invalid type>"),
932 var_expr_path_strm.GetData());
933 } else if (static_cast<uint32_t>(child_index) >=
934 synthetic->GetNumChildrenIgnoringErrors() /* synthetic
935 does not have that many values */) {
936 valobj_sp->GetExpressionPath(var_expr_path_strm);
937 error.SetErrorStringWithFormat(
938 "array index %ld is not valid for \"(%s) %s\"", child_index,
939 valobj_sp->GetTypeName().AsCString("<invalid type>"),
940 var_expr_path_strm.GetData());
941 } else {
942 child_valobj_sp = synthetic->GetChildAtIndex(child_index);
943 if (!child_valobj_sp) {
944 valobj_sp->GetExpressionPath(var_expr_path_strm);
945 error.SetErrorStringWithFormat(
946 "array index %ld is not valid for \"(%s) %s\"", child_index,
947 valobj_sp->GetTypeName().AsCString("<invalid type>"),
948 var_expr_path_strm.GetData());
949 }
950 }
951 }
952
953 if (!child_valobj_sp) {
954 // Invalid array index...
955 return ValueObjectSP();
956 }
957
958 if (use_dynamic != eNoDynamicValues) {
959 ValueObjectSP dynamic_value_sp(
960 child_valobj_sp->GetDynamicValue(use_dynamic));
961 if (dynamic_value_sp)
962 child_valobj_sp = dynamic_value_sp;
963 }
964 // Break out early from the switch since we were able to find the child
965 // member
966 break;
967 }
968
969 // this is most probably a BitField, let's take a look
970 if (index_expr.front() != '-') {
971 error.SetErrorStringWithFormat("invalid range expression \"'%s'\"",
972 original_index_expr.str().c_str());
973 return ValueObjectSP();
974 }
975
976 index_expr = index_expr.drop_front();
977 long final_index = 0;
978 if (index_expr.getAsInteger(0, final_index)) {
979 error.SetErrorStringWithFormat("invalid range expression \"'%s'\"",
980 original_index_expr.str().c_str());
981 return ValueObjectSP();
982 }
983
984 // if the format given is [high-low], swap range
985 if (child_index > final_index) {
986 long temp = child_index;
987 child_index = final_index;
988 final_index = temp;
989 }
990
991 if (valobj_sp->GetCompilerType().IsPointerToScalarType() && deref) {
992 // what we have is *ptr[low-high]. the most similar C++ syntax is to
993 // deref ptr and extract bits low thru high out of it. reading array
994 // items low thru high would be done by saying ptr[low-high], without a
995 // deref * sign
996 Status deref_error;
997 ValueObjectSP temp(valobj_sp->Dereference(deref_error));
998 if (!temp || deref_error.Fail()) {
999 valobj_sp->GetExpressionPath(var_expr_path_strm);
1000 error.SetErrorStringWithFormat(
1001 "could not dereference \"(%s) %s\"",
1002 valobj_sp->GetTypeName().AsCString("<invalid type>"),
1003 var_expr_path_strm.GetData());
1004 return ValueObjectSP();
1005 }
1006 valobj_sp = temp;
1007 deref = false;
1008 } else if (valobj_sp->GetCompilerType().IsArrayOfScalarType() && deref) {
1009 // what we have is *arr[low-high]. the most similar C++ syntax is to
1010 // get arr[0] (an operation that is equivalent to deref-ing arr) and
1011 // extract bits low thru high out of it. reading array items low thru
1012 // high would be done by saying arr[low-high], without a deref * sign
1013 ValueObjectSP temp(valobj_sp->GetChildAtIndex(0));
1014 if (!temp) {
1015 valobj_sp->GetExpressionPath(var_expr_path_strm);
1016 error.SetErrorStringWithFormat(
1017 "could not get item 0 for \"(%s) %s\"",
1018 valobj_sp->GetTypeName().AsCString("<invalid type>"),
1019 var_expr_path_strm.GetData());
1020 return ValueObjectSP();
1021 }
1022 valobj_sp = temp;
1023 deref = false;
1024 }
1025
1026 child_valobj_sp =
1027 valobj_sp->GetSyntheticBitFieldChild(child_index, final_index, true);
1028 if (!child_valobj_sp) {
1029 valobj_sp->GetExpressionPath(var_expr_path_strm);
1030 error.SetErrorStringWithFormat(
1031 "bitfield range %ld-%ld is not valid for \"(%s) %s\"", child_index,
1032 final_index, valobj_sp->GetTypeName().AsCString("<invalid type>"),
1033 var_expr_path_strm.GetData());
1034 }
1035
1036 if (!child_valobj_sp) {
1037 // Invalid bitfield range...
1038 return ValueObjectSP();
1039 }
1040
1041 if (use_dynamic != eNoDynamicValues) {
1042 ValueObjectSP dynamic_value_sp(
1043 child_valobj_sp->GetDynamicValue(use_dynamic));
1044 if (dynamic_value_sp)
1045 child_valobj_sp = dynamic_value_sp;
1046 }
1047 // Break out early from the switch since we were able to find the child
1048 // member
1049 break;
1050 }
1051 default:
1052 // Failure...
1053 {
1054 valobj_sp->GetExpressionPath(var_expr_path_strm);
1055 error.SetErrorStringWithFormat(
1056 "unexpected char '%c' encountered after \"%s\" in \"%s\"",
1057 separator_type, var_expr_path_strm.GetData(),
1058 var_expr.str().c_str());
1059
1060 return ValueObjectSP();
1061 }
1062 }
1063
1064 if (child_valobj_sp)
1065 valobj_sp = child_valobj_sp;
1066 }
1067 if (valobj_sp) {
1068 if (deref) {
1069 ValueObjectSP deref_valobj_sp(valobj_sp->Dereference(error));
1070 valobj_sp = deref_valobj_sp;
1071 } else if (address_of) {
1072 ValueObjectSP address_of_valobj_sp(valobj_sp->AddressOf(error));
1073 valobj_sp = address_of_valobj_sp;
1074 }
1075 }
1076 return valobj_sp;
1077}
1078
1079bool StackFrame::GetFrameBaseValue(Scalar &frame_base, Status *error_ptr) {
1080 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1081 if (!m_cfa_is_valid) {
1083 "No frame base available for this historical stack frame.");
1084 return false;
1085 }
1086
1088 if (m_sc.function) {
1091
1093 ExecutionContext exe_ctx(shared_from_this());
1094 addr_t loclist_base_addr = LLDB_INVALID_ADDRESS;
1096 loclist_base_addr =
1098 exe_ctx.GetTargetPtr());
1099
1100 llvm::Expected<Value> expr_value =
1102 &exe_ctx, nullptr, loclist_base_addr, nullptr, nullptr);
1103 if (!expr_value)
1104 m_frame_base_error = expr_value.takeError();
1105 else
1106 m_frame_base = expr_value->ResolveValue(&exe_ctx);
1107 } else {
1108 m_frame_base_error.SetErrorString("No function in symbol context.");
1109 }
1110 }
1111
1113 frame_base = m_frame_base;
1114
1115 if (error_ptr)
1116 *error_ptr = m_frame_base_error;
1117 return m_frame_base_error.Success();
1118}
1119
1121 if (!m_sc.function) {
1122 if (error_ptr) {
1123 error_ptr->SetErrorString("No function in symbol context.");
1124 }
1125 return nullptr;
1126 }
1127
1129}
1130
1132 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1133 if (!m_reg_context_sp) {
1134 ThreadSP thread_sp(GetThread());
1135 if (thread_sp)
1136 m_reg_context_sp = thread_sp->CreateRegisterContextForFrame(this);
1137 }
1138 return m_reg_context_sp;
1139}
1140
1142 GetSymbolContext(eSymbolContextLineEntry);
1143 return m_sc.line_entry.IsValid();
1144}
1145
1148 DynamicValueType use_dynamic) {
1149 ValueObjectSP valobj_sp;
1150 { // Scope for stack frame mutex. We need to drop this mutex before we figure
1151 // out the dynamic value. That will require converting the StackID in the
1152 // VO back to a StackFrame, which will in turn require locking the
1153 // StackFrameList. If we still hold the StackFrame mutex, we could suffer
1154 // lock inversion against the pattern of getting the StackFrameList and
1155 // then the stack frame, which is fairly common.
1156 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1157 if (IsHistorical()) {
1158 return valobj_sp;
1159 }
1160 VariableList *var_list = GetVariableList(true, nullptr);
1161 if (var_list) {
1162 // Make sure the variable is a frame variable
1163 const uint32_t var_idx = var_list->FindIndexForVariable(variable_sp.get());
1164 const uint32_t num_variables = var_list->GetSize();
1165 if (var_idx < num_variables) {
1167 if (!valobj_sp) {
1168 if (m_variable_list_value_objects.GetSize() < num_variables)
1170 valobj_sp = ValueObjectVariable::Create(this, variable_sp);
1172 valobj_sp);
1173 }
1174 }
1175 }
1176 } // End of StackFrame mutex scope.
1177 if (use_dynamic != eNoDynamicValues && valobj_sp) {
1178 ValueObjectSP dynamic_sp = valobj_sp->GetDynamicValue(use_dynamic);
1179 if (dynamic_sp)
1180 return dynamic_sp;
1181 }
1182 return valobj_sp;
1183}
1184
1186 if (m_sc.block == nullptr)
1187 GetSymbolContext(eSymbolContextBlock);
1188 if (m_sc.block)
1189 return m_sc.block->GetContainingInlinedBlock() != nullptr;
1190 return false;
1191}
1192
1195}
1196
1199}
1200
1202 CompileUnit *cu = GetSymbolContext(eSymbolContextCompUnit).comp_unit;
1203 if (cu)
1204 return cu->GetLanguage();
1205 return {};
1206}
1207
1209 SourceLanguage lang_type = GetLanguage();
1210
1211 if (lang_type == eLanguageTypeUnknown) {
1212 SymbolContext sc =
1213 GetSymbolContext(eSymbolContextFunction | eSymbolContextSymbol);
1214 if (sc.function)
1215 lang_type = LanguageType(sc.function->GetMangled().GuessLanguage());
1216 else if (sc.symbol)
1217 lang_type = SourceLanguage(sc.symbol->GetMangled().GuessLanguage());
1218 }
1219
1220 return lang_type;
1221}
1222
1223namespace {
1224std::pair<const Instruction::Operand *, int64_t>
1225GetBaseExplainingValue(const Instruction::Operand &operand,
1226 RegisterContext &register_context, lldb::addr_t value) {
1227 switch (operand.m_type) {
1232 // These are not currently interesting
1233 return std::make_pair(nullptr, 0);
1235 const Instruction::Operand *immediate_child = nullptr;
1236 const Instruction::Operand *variable_child = nullptr;
1237 if (operand.m_children[0].m_type == Instruction::Operand::Type::Immediate) {
1238 immediate_child = &operand.m_children[0];
1239 variable_child = &operand.m_children[1];
1240 } else if (operand.m_children[1].m_type ==
1242 immediate_child = &operand.m_children[1];
1243 variable_child = &operand.m_children[0];
1244 }
1245 if (!immediate_child) {
1246 return std::make_pair(nullptr, 0);
1247 }
1248 lldb::addr_t adjusted_value = value;
1249 if (immediate_child->m_negative) {
1250 adjusted_value += immediate_child->m_immediate;
1251 } else {
1252 adjusted_value -= immediate_child->m_immediate;
1253 }
1254 std::pair<const Instruction::Operand *, int64_t> base_and_offset =
1255 GetBaseExplainingValue(*variable_child, register_context,
1256 adjusted_value);
1257 if (!base_and_offset.first) {
1258 return std::make_pair(nullptr, 0);
1259 }
1260 if (immediate_child->m_negative) {
1261 base_and_offset.second -= immediate_child->m_immediate;
1262 } else {
1263 base_and_offset.second += immediate_child->m_immediate;
1264 }
1265 return base_and_offset;
1266 }
1268 const RegisterInfo *info =
1269 register_context.GetRegisterInfoByName(operand.m_register.AsCString());
1270 if (!info) {
1271 return std::make_pair(nullptr, 0);
1272 }
1273 RegisterValue reg_value;
1274 if (!register_context.ReadRegister(info, reg_value)) {
1275 return std::make_pair(nullptr, 0);
1276 }
1277 if (reg_value.GetAsUInt64() == value) {
1278 return std::make_pair(&operand, 0);
1279 } else {
1280 return std::make_pair(nullptr, 0);
1281 }
1282 }
1283 }
1284 return std::make_pair(nullptr, 0);
1285}
1286
1287std::pair<const Instruction::Operand *, int64_t>
1288GetBaseExplainingDereference(const Instruction::Operand &operand,
1289 RegisterContext &register_context,
1290 lldb::addr_t addr) {
1292 return GetBaseExplainingValue(operand.m_children[0], register_context,
1293 addr);
1294 }
1295 return std::make_pair(nullptr, 0);
1296}
1297} // namespace
1298
1300 TargetSP target_sp = CalculateTarget();
1301
1302 const ArchSpec &target_arch = target_sp->GetArchitecture();
1303
1304 AddressRange pc_range;
1305 pc_range.GetBaseAddress() = GetFrameCodeAddress();
1306 pc_range.SetByteSize(target_arch.GetMaximumOpcodeByteSize());
1307
1308 const char *plugin_name = nullptr;
1309 const char *flavor = nullptr;
1310 const bool force_live_memory = true;
1311
1312 DisassemblerSP disassembler_sp =
1313 Disassembler::DisassembleRange(target_arch, plugin_name, flavor,
1314 *target_sp, pc_range, force_live_memory);
1315
1316 if (!disassembler_sp || !disassembler_sp->GetInstructionList().GetSize()) {
1317 return ValueObjectSP();
1318 }
1319
1320 InstructionSP instruction_sp =
1321 disassembler_sp->GetInstructionList().GetInstructionAtIndex(0);
1322
1323 llvm::SmallVector<Instruction::Operand, 3> operands;
1324
1325 if (!instruction_sp->ParseOperands(operands)) {
1326 return ValueObjectSP();
1327 }
1328
1329 RegisterContextSP register_context_sp = GetRegisterContext();
1330
1331 if (!register_context_sp) {
1332 return ValueObjectSP();
1333 }
1334
1335 for (const Instruction::Operand &operand : operands) {
1336 std::pair<const Instruction::Operand *, int64_t> base_and_offset =
1337 GetBaseExplainingDereference(operand, *register_context_sp, addr);
1338
1339 if (!base_and_offset.first) {
1340 continue;
1341 }
1342
1343 switch (base_and_offset.first->m_type) {
1346 if (target_sp->ResolveLoadAddress(base_and_offset.first->m_immediate +
1347 base_and_offset.second,
1348 addr)) {
1349 auto c_type_system_or_err =
1350 target_sp->GetScratchTypeSystemForLanguage(eLanguageTypeC);
1351 if (auto err = c_type_system_or_err.takeError()) {
1352 LLDB_LOG_ERROR(GetLog(LLDBLog::Thread), std::move(err),
1353 "Unable to guess value for given address: {0}");
1354 return ValueObjectSP();
1355 } else {
1356 auto ts = *c_type_system_or_err;
1357 if (!ts)
1358 return {};
1359 CompilerType void_ptr_type =
1361 .GetPointerType();
1362 return ValueObjectMemory::Create(this, "", addr, void_ptr_type);
1363 }
1364 } else {
1365 return ValueObjectSP();
1366 }
1367 break;
1368 }
1370 return GuessValueForRegisterAndOffset(base_and_offset.first->m_register,
1371 base_and_offset.second);
1372 }
1373 default:
1374 return ValueObjectSP();
1375 }
1376 }
1377
1378 return ValueObjectSP();
1379}
1380
1381namespace {
1382ValueObjectSP GetValueForOffset(StackFrame &frame, ValueObjectSP &parent,
1383 int64_t offset) {
1384 if (offset < 0 || uint64_t(offset) >= parent->GetByteSize()) {
1385 return ValueObjectSP();
1386 }
1387
1388 if (parent->IsPointerOrReferenceType()) {
1389 return parent;
1390 }
1391
1392 for (int ci = 0, ce = parent->GetNumChildrenIgnoringErrors(); ci != ce;
1393 ++ci) {
1394 ValueObjectSP child_sp = parent->GetChildAtIndex(ci);
1395
1396 if (!child_sp) {
1397 return ValueObjectSP();
1398 }
1399
1400 int64_t child_offset = child_sp->GetByteOffset();
1401 int64_t child_size = child_sp->GetByteSize().value_or(0);
1402
1403 if (offset >= child_offset && offset < (child_offset + child_size)) {
1404 return GetValueForOffset(frame, child_sp, offset - child_offset);
1405 }
1406 }
1407
1408 if (offset == 0) {
1409 return parent;
1410 } else {
1411 return ValueObjectSP();
1412 }
1413}
1414
1415ValueObjectSP GetValueForDereferincingOffset(StackFrame &frame,
1416 ValueObjectSP &base,
1417 int64_t offset) {
1418 // base is a pointer to something
1419 // offset is the thing to add to the pointer We return the most sensible
1420 // ValueObject for the result of *(base+offset)
1421
1422 if (!base->IsPointerOrReferenceType()) {
1423 return ValueObjectSP();
1424 }
1425
1426 Status error;
1427 ValueObjectSP pointee = base->Dereference(error);
1428
1429 if (!pointee) {
1430 return ValueObjectSP();
1431 }
1432
1433 if (offset >= 0 && uint64_t(offset) >= pointee->GetByteSize()) {
1434 int64_t index = offset / pointee->GetByteSize().value_or(1);
1435 offset = offset % pointee->GetByteSize().value_or(1);
1436 const bool can_create = true;
1437 pointee = base->GetSyntheticArrayMember(index, can_create);
1438 }
1439
1440 if (!pointee || error.Fail()) {
1441 return ValueObjectSP();
1442 }
1443
1444 return GetValueForOffset(frame, pointee, offset);
1445}
1446
1447/// Attempt to reconstruct the ValueObject for the address contained in a
1448/// given register plus an offset.
1449///
1450/// \param [in] frame
1451/// The current stack frame.
1452///
1453/// \param [in] reg
1454/// The register.
1455///
1456/// \param [in] offset
1457/// The offset from the register.
1458///
1459/// \param [in] disassembler
1460/// A disassembler containing instructions valid up to the current PC.
1461///
1462/// \param [in] variables
1463/// The variable list from the current frame,
1464///
1465/// \param [in] pc
1466/// The program counter for the instruction considered the 'user'.
1467///
1468/// \return
1469/// A string describing the base for the ExpressionPath. This could be a
1470/// variable, a register value, an argument, or a function return value.
1471/// The ValueObject if found. If valid, it has a valid ExpressionPath.
1472lldb::ValueObjectSP DoGuessValueAt(StackFrame &frame, ConstString reg,
1473 int64_t offset, Disassembler &disassembler,
1474 VariableList &variables, const Address &pc) {
1475 // Example of operation for Intel:
1476 //
1477 // +14: movq -0x8(%rbp), %rdi
1478 // +18: movq 0x8(%rdi), %rdi
1479 // +22: addl 0x4(%rdi), %eax
1480 //
1481 // f, a pointer to a struct, is known to be at -0x8(%rbp).
1482 //
1483 // DoGuessValueAt(frame, rdi, 4, dis, vars, 0x22) finds the instruction at
1484 // +18 that assigns to rdi, and calls itself recursively for that dereference
1485 // DoGuessValueAt(frame, rdi, 8, dis, vars, 0x18) finds the instruction at
1486 // +14 that assigns to rdi, and calls itself recursively for that
1487 // dereference
1488 // DoGuessValueAt(frame, rbp, -8, dis, vars, 0x14) finds "f" in the
1489 // variable list.
1490 // Returns a ValueObject for f. (That's what was stored at rbp-8 at +14)
1491 // Returns a ValueObject for *(f+8) or f->b (That's what was stored at rdi+8
1492 // at +18)
1493 // Returns a ValueObject for *(f->b+4) or f->b->a (That's what was stored at
1494 // rdi+4 at +22)
1495
1496 // First, check the variable list to see if anything is at the specified
1497 // location.
1498
1499 using namespace OperandMatchers;
1500
1501 const RegisterInfo *reg_info =
1502 frame.GetRegisterContext()->GetRegisterInfoByName(reg.AsCString());
1503 if (!reg_info) {
1504 return ValueObjectSP();
1505 }
1506
1512 : Instruction::Operand::BuildDereference(
1513 Instruction::Operand::BuildRegister(reg));
1514
1515 for (VariableSP var_sp : variables) {
1516 if (var_sp->LocationExpressionList().MatchesOperand(frame, op))
1518 }
1519
1520 const uint32_t current_inst =
1522 if (current_inst == UINT32_MAX) {
1523 return ValueObjectSP();
1524 }
1525
1526 for (uint32_t ii = current_inst - 1; ii != (uint32_t)-1; --ii) {
1527 // This is not an exact algorithm, and it sacrifices accuracy for
1528 // generality. Recognizing "mov" and "ld" instructions –– and which
1529 // are their source and destination operands -- is something the
1530 // disassembler should do for us.
1531 InstructionSP instruction_sp =
1532 disassembler.GetInstructionList().GetInstructionAtIndex(ii);
1533
1534 if (instruction_sp->IsCall()) {
1535 ABISP abi_sp = frame.CalculateProcess()->GetABI();
1536 if (!abi_sp) {
1537 continue;
1538 }
1539
1540 const char *return_register_name;
1541 if (!abi_sp->GetPointerReturnRegister(return_register_name)) {
1542 continue;
1543 }
1544
1545 const RegisterInfo *return_register_info =
1546 frame.GetRegisterContext()->GetRegisterInfoByName(
1547 return_register_name);
1548 if (!return_register_info) {
1549 continue;
1550 }
1551
1552 int64_t offset = 0;
1553
1555 MatchRegOp(*return_register_info))(op) &&
1556 !MatchUnaryOp(
1559 MatchRegOp(*return_register_info),
1560 FetchImmOp(offset)))(op)) {
1561 continue;
1562 }
1563
1564 llvm::SmallVector<Instruction::Operand, 1> operands;
1565 if (!instruction_sp->ParseOperands(operands) || operands.size() != 1) {
1566 continue;
1567 }
1568
1569 switch (operands[0].m_type) {
1570 default:
1571 break;
1573 SymbolContext sc;
1574 Address load_address;
1575 if (!frame.CalculateTarget()->ResolveLoadAddress(
1576 operands[0].m_immediate, load_address)) {
1577 break;
1578 }
1579 frame.CalculateTarget()->GetImages().ResolveSymbolContextForAddress(
1580 load_address, eSymbolContextFunction, sc);
1581 if (!sc.function) {
1582 break;
1583 }
1584 CompilerType function_type = sc.function->GetCompilerType();
1585 if (!function_type.IsFunctionType()) {
1586 break;
1587 }
1588 CompilerType return_type = function_type.GetFunctionReturnType();
1589 RegisterValue return_value;
1590 if (!frame.GetRegisterContext()->ReadRegister(return_register_info,
1591 return_value)) {
1592 break;
1593 }
1594 std::string name_str(
1595 sc.function->GetName().AsCString("<unknown function>"));
1596 name_str.append("()");
1597 Address return_value_address(return_value.GetAsUInt64());
1598 ValueObjectSP return_value_sp = ValueObjectMemory::Create(
1599 &frame, name_str, return_value_address, return_type);
1600 return GetValueForDereferincingOffset(frame, return_value_sp, offset);
1601 }
1602 }
1603
1604 continue;
1605 }
1606
1607 llvm::SmallVector<Instruction::Operand, 2> operands;
1608 if (!instruction_sp->ParseOperands(operands) || operands.size() != 2) {
1609 continue;
1610 }
1611
1612 Instruction::Operand *origin_operand = nullptr;
1613 auto clobbered_reg_matcher = [reg_info](const Instruction::Operand &op) {
1614 return MatchRegOp(*reg_info)(op) && op.m_clobbered;
1615 };
1616
1617 if (clobbered_reg_matcher(operands[0])) {
1618 origin_operand = &operands[1];
1619 }
1620 else if (clobbered_reg_matcher(operands[1])) {
1621 origin_operand = &operands[0];
1622 }
1623 else {
1624 continue;
1625 }
1626
1627 // We have an origin operand. Can we track its value down?
1628 ValueObjectSP source_path;
1629 ConstString origin_register;
1630 int64_t origin_offset = 0;
1631
1632 if (FetchRegOp(origin_register)(*origin_operand)) {
1633 source_path = DoGuessValueAt(frame, origin_register, 0, disassembler,
1634 variables, instruction_sp->GetAddress());
1635 } else if (MatchUnaryOp(
1637 FetchRegOp(origin_register))(*origin_operand) ||
1641 FetchRegOp(origin_register),
1642 FetchImmOp(origin_offset)))(*origin_operand)) {
1643 source_path =
1644 DoGuessValueAt(frame, origin_register, origin_offset, disassembler,
1645 variables, instruction_sp->GetAddress());
1646 if (!source_path) {
1647 continue;
1648 }
1649 source_path =
1650 GetValueForDereferincingOffset(frame, source_path, offset);
1651 }
1652
1653 if (source_path) {
1654 return source_path;
1655 }
1656 }
1657
1658 return ValueObjectSP();
1659}
1660}
1661
1663 int64_t offset) {
1664 TargetSP target_sp = CalculateTarget();
1665
1666 const ArchSpec &target_arch = target_sp->GetArchitecture();
1667
1668 Block *frame_block = GetFrameBlock();
1669
1670 if (!frame_block) {
1671 return ValueObjectSP();
1672 }
1673
1674 Function *function = frame_block->CalculateSymbolContextFunction();
1675 if (!function) {
1676 return ValueObjectSP();
1677 }
1678
1679 AddressRange pc_range = function->GetAddressRange();
1680
1681 if (GetFrameCodeAddress().GetFileAddress() <
1682 pc_range.GetBaseAddress().GetFileAddress() ||
1683 GetFrameCodeAddress().GetFileAddress() -
1684 pc_range.GetBaseAddress().GetFileAddress() >=
1685 pc_range.GetByteSize()) {
1686 return ValueObjectSP();
1687 }
1688
1689 const char *plugin_name = nullptr;
1690 const char *flavor = nullptr;
1691 const bool force_live_memory = true;
1692 DisassemblerSP disassembler_sp =
1693 Disassembler::DisassembleRange(target_arch, plugin_name, flavor,
1694 *target_sp, pc_range, force_live_memory);
1695
1696 if (!disassembler_sp || !disassembler_sp->GetInstructionList().GetSize()) {
1697 return ValueObjectSP();
1698 }
1699
1700 const bool get_file_globals = false;
1701 VariableList *variables = GetVariableList(get_file_globals, nullptr);
1702
1703 if (!variables) {
1704 return ValueObjectSP();
1705 }
1706
1707 return DoGuessValueAt(*this, reg, offset, *disassembler_sp, *variables,
1709}
1710
1712 ValueObjectSP value_sp;
1713
1714 if (!name)
1715 return value_sp;
1716
1717 TargetSP target_sp = CalculateTarget();
1718 ProcessSP process_sp = CalculateProcess();
1719
1720 if (!target_sp && !process_sp)
1721 return value_sp;
1722
1723 VariableList variable_list;
1724 VariableSP var_sp;
1725 SymbolContext sc(GetSymbolContext(eSymbolContextBlock));
1726
1727 if (sc.block) {
1728 const bool can_create = true;
1729 const bool get_parent_variables = true;
1730 const bool stop_if_block_is_inlined_function = true;
1731
1732 if (sc.block->AppendVariables(
1733 can_create, get_parent_variables, stop_if_block_is_inlined_function,
1734 [this](Variable *v) { return v->IsInScope(this); },
1735 &variable_list)) {
1736 var_sp = variable_list.FindVariable(name);
1737 }
1738
1739 if (var_sp)
1741 }
1742
1743 return value_sp;
1744}
1745
1747 TargetSP target_sp;
1748 ThreadSP thread_sp(GetThread());
1749 if (thread_sp) {
1750 ProcessSP process_sp(thread_sp->CalculateProcess());
1751 if (process_sp)
1752 target_sp = process_sp->CalculateTarget();
1753 }
1754 return target_sp;
1755}
1756
1758 ProcessSP process_sp;
1759 ThreadSP thread_sp(GetThread());
1760 if (thread_sp)
1761 process_sp = thread_sp->CalculateProcess();
1762 return process_sp;
1763}
1764
1766
1767StackFrameSP StackFrame::CalculateStackFrame() { return shared_from_this(); }
1768
1770 exe_ctx.SetContext(shared_from_this());
1771}
1772
1774 const FormatEntity::Entry *format,
1775 llvm::StringRef frame_marker) {
1776 GetSymbolContext(eSymbolContextEverything);
1777 ExecutionContext exe_ctx(shared_from_this());
1778 StreamString s;
1779 s.PutCString(frame_marker);
1780
1781 if (format && FormatEntity::Format(*format, s, &m_sc, &exe_ctx, nullptr,
1782 nullptr, false, false)) {
1783 strm.PutCString(s.GetString());
1784 return true;
1785 }
1786 return false;
1787}
1788
1789void StackFrame::DumpUsingSettingsFormat(Stream *strm, bool show_unique,
1790 const char *frame_marker) {
1791 if (strm == nullptr)
1792 return;
1793
1794 ExecutionContext exe_ctx(shared_from_this());
1795
1796 const FormatEntity::Entry *frame_format = nullptr;
1797 Target *target = exe_ctx.GetTargetPtr();
1798 if (target) {
1799 if (show_unique) {
1800 frame_format = target->GetDebugger().GetFrameFormatUnique();
1801 } else {
1802 frame_format = target->GetDebugger().GetFrameFormat();
1803 }
1804 }
1805 if (!DumpUsingFormat(*strm, frame_format, frame_marker)) {
1806 Dump(strm, true, false);
1807 strm->EOL();
1808 }
1809}
1810
1811void StackFrame::Dump(Stream *strm, bool show_frame_index,
1812 bool show_fullpaths) {
1813 if (strm == nullptr)
1814 return;
1815
1816 if (show_frame_index)
1817 strm->Printf("frame #%u: ", m_frame_index);
1818 ExecutionContext exe_ctx(shared_from_this());
1819 Target *target = exe_ctx.GetTargetPtr();
1820 strm->Printf("0x%0*" PRIx64 " ",
1821 target ? (target->GetArchitecture().GetAddressByteSize() * 2)
1822 : 16,
1823 GetFrameCodeAddress().GetLoadAddress(target));
1824 GetSymbolContext(eSymbolContextEverything);
1825 const bool show_module = true;
1826 const bool show_inline = true;
1827 const bool show_function_arguments = true;
1828 const bool show_function_name = true;
1830 GetFrameCodeAddress(), show_fullpaths, show_module,
1831 show_inline, show_function_arguments,
1832 show_function_name);
1833}
1834
1836 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1837 assert(GetStackID() ==
1838 prev_frame.GetStackID()); // TODO: remove this after some testing
1841 if (!m_disassembly.GetString().empty()) {
1844 }
1845}
1846
1848 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1849 assert(GetStackID() ==
1850 curr_frame.GetStackID()); // TODO: remove this after some testing
1851 m_id.SetPC(curr_frame.m_id.GetPC()); // Update the Stack ID PC value
1852 assert(GetThread() == curr_frame.GetThread());
1853 m_frame_index = curr_frame.m_frame_index;
1858 assert(!m_sc.target_sp || !curr_frame.m_sc.target_sp ||
1859 m_sc.target_sp.get() == curr_frame.m_sc.target_sp.get());
1860 assert(!m_sc.module_sp || !curr_frame.m_sc.module_sp ||
1861 m_sc.module_sp.get() == curr_frame.m_sc.module_sp.get());
1862 assert(m_sc.comp_unit == nullptr || curr_frame.m_sc.comp_unit == nullptr ||
1863 m_sc.comp_unit == curr_frame.m_sc.comp_unit);
1864 assert(m_sc.function == nullptr || curr_frame.m_sc.function == nullptr ||
1865 m_sc.function == curr_frame.m_sc.function);
1866 m_sc = curr_frame.m_sc;
1867 m_flags.Clear(GOT_FRAME_BASE | eSymbolContextEverything);
1871}
1872
1875 return true;
1877 return true;
1878 if (!m_disassembly.GetString().empty())
1879 return true;
1880 return false;
1881}
1882
1883bool StackFrame::GetStatus(Stream &strm, bool show_frame_info, bool show_source,
1884 bool show_unique, const char *frame_marker) {
1885 if (show_frame_info) {
1886 strm.Indent();
1887 DumpUsingSettingsFormat(&strm, show_unique, frame_marker);
1888 }
1889
1890 if (show_source) {
1891 ExecutionContext exe_ctx(shared_from_this());
1892 bool have_source = false, have_debuginfo = false;
1893 Debugger::StopDisassemblyType disasm_display =
1895 Target *target = exe_ctx.GetTargetPtr();
1896 if (target) {
1897 Debugger &debugger = target->GetDebugger();
1898 const uint32_t source_lines_before =
1899 debugger.GetStopSourceLineCount(true);
1900 const uint32_t source_lines_after =
1901 debugger.GetStopSourceLineCount(false);
1902 disasm_display = debugger.GetStopDisassemblyDisplay();
1903
1904 GetSymbolContext(eSymbolContextCompUnit | eSymbolContextLineEntry);
1906 have_debuginfo = true;
1907 if (source_lines_before > 0 || source_lines_after > 0) {
1908 uint32_t start_line = m_sc.line_entry.line;
1909 if (!start_line && m_sc.function) {
1910 FileSpec source_file;
1911 m_sc.function->GetStartLineSourceInfo(source_file, start_line);
1912 }
1913
1914 size_t num_lines =
1917 source_lines_before, source_lines_after, "->", &strm);
1918 if (num_lines != 0)
1919 have_source = true;
1920 // TODO: Give here a one time warning if source file is missing.
1921 if (!m_sc.line_entry.line) {
1922 ConstString fn_name = m_sc.GetFunctionName();
1923
1924 if (!fn_name.IsEmpty())
1925 strm.Printf(
1926 "Note: this address is compiler-generated code in function "
1927 "%s that has no source code associated with it.",
1928 fn_name.AsCString());
1929 else
1930 strm.Printf("Note: this address is compiler-generated code that "
1931 "has no source code associated with it.");
1932 strm.EOL();
1933 }
1934 }
1935 }
1936 switch (disasm_display) {
1938 break;
1939
1941 if (have_debuginfo)
1942 break;
1943 [[fallthrough]];
1944
1946 if (have_source)
1947 break;
1948 [[fallthrough]];
1949
1951 if (target) {
1952 const uint32_t disasm_lines = debugger.GetDisassemblyLineCount();
1953 if (disasm_lines > 0) {
1954 const ArchSpec &target_arch = target->GetArchitecture();
1955 const char *plugin_name = nullptr;
1956 const char *flavor = nullptr;
1957 const bool mixed_source_and_assembly = false;
1959 target->GetDebugger(), target_arch, plugin_name, flavor,
1960 exe_ctx, GetFrameCodeAddress(),
1961 {Disassembler::Limit::Instructions, disasm_lines},
1962 mixed_source_and_assembly, 0,
1964 }
1965 }
1966 break;
1967 }
1968 }
1969 }
1970 return true;
1971}
1972
1974 if (!m_recognized_frame_sp) {
1976 ->GetProcess()
1977 ->GetTarget()
1978 .GetFrameRecognizerManager()
1979 .RecognizeFrame(CalculateStackFrame());
1980 }
1981 return m_recognized_frame_sp;
1982}
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOG_ERROR(log, error,...)
Definition: Log.h:382
#define GOT_FRAME_BASE
Definition: StackFrame.cpp:49
#define RESOLVED_GLOBAL_VARIABLES
Definition: StackFrame.cpp:51
#define RESOLVED_FRAME_ID_SYMBOL_SCOPE
Definition: StackFrame.cpp:48
#define RESOLVED_FRAME_CODE_ADDR
Definition: StackFrame.cpp:47
#define RESOLVED_VARIABLES
Definition: StackFrame.cpp:50
A section + offset based address range class.
Definition: AddressRange.h:25
Address & GetBaseAddress()
Get accessor for the base address of the range.
Definition: AddressRange.h:211
void SetByteSize(lldb::addr_t byte_size)
Set accessor for the byte size of this range.
Definition: AddressRange.h:239
lldb::addr_t GetByteSize() const
Get accessor for the byte size of this range.
Definition: AddressRange.h:223
A section + offset based address class.
Definition: Address.h:62
lldb::addr_t GetLoadAddress(Target *target) const
Get the load address.
Definition: Address.cpp:313
lldb::addr_t GetOpcodeLoadAddress(Target *target, AddressClass addr_class=AddressClass::eInvalid) const
Get the load address as an opcode load address.
Definition: Address.cpp:370
bool SetOpcodeLoadAddress(lldb::addr_t load_addr, Target *target, AddressClass addr_class=AddressClass::eInvalid, bool allow_section_end=false)
Definition: Address.cpp:381
void SetRawAddress(lldb::addr_t addr)
Definition: Address.h:454
lldb::ModuleSP GetModule() const
Get accessor for the module for this address.
Definition: Address.cpp:285
lldb::addr_t GetFileAddress() const
Get the file address.
Definition: Address.cpp:293
lldb::addr_t GetOffset() const
Get the section relative offset value.
Definition: Address.h:329
bool IsValid() const
Check if the object state is valid.
Definition: Address.h:355
bool IsSectionOffset() const
Check if an address is section offset.
Definition: Address.h:342
bool SetOffset(lldb::addr_t offset)
Set accessor for the offset.
Definition: Address.h:448
An architecture specification class.
Definition: ArchSpec.h:31
uint32_t GetAddressByteSize() const
Returns the size in bytes of an address of the current architecture.
Definition: ArchSpec.cpp:691
uint32_t GetMaximumOpcodeByteSize() const
Definition: ArchSpec.cpp:934
A class that describes a single lexical block.
Definition: Block.h:41
Block * GetContainingInlinedBlock()
Get the inlined block that contains this block.
Definition: Block.cpp:208
Function * CalculateSymbolContextFunction() override
Definition: Block.cpp:154
uint32_t AppendVariables(bool can_create, bool get_parent_variables, bool stop_if_block_is_inlined_function, const std::function< bool(Variable *)> &filter, VariableList *variable_list)
Appends the variables from this block, and optionally from all parent blocks, to variable_list.
Definition: Block.cpp:459
uint32_t AppendBlockVariables(bool can_create, bool get_child_block_variables, bool stop_if_child_block_is_inlined_function, const std::function< bool(Variable *)> &filter, VariableList *variable_list)
Get the variable list for this block and optionally all child blocks if get_child_variables is true.
Definition: Block.cpp:429
A class that describes a compilation unit.
Definition: CompileUnit.h:41
lldb::VariableListSP GetVariableList(bool can_create)
Get the variable list for a compile unit.
lldb::LanguageType GetLanguage()
Generic representation of a type in a programming language.
Definition: CompilerType.h:36
CompilerType GetBasicTypeFromAST(lldb::BasicType basic_type) const
Create related types using the current type's AST.
CompilerType GetPointerType() const
Return a new CompilerType that is a pointer to this type.
CompilerType GetFunctionReturnType() const
A uniqued constant string class.
Definition: ConstString.h:40
const char * AsCString(const char *value_if_empty=nullptr) const
Get the string value as a C string.
Definition: ConstString.h:188
bool IsEmpty() const
Test for empty string.
Definition: ConstString.h:304
size_t GetLength() const
Get the length in bytes of string value.
const char * GetCString() const
Get the string value as a C string.
Definition: ConstString.h:216
"lldb/Expression/DWARFExpressionList.h" Encapsulates a range map from file address range to a single ...
llvm::Expected< Value > Evaluate(ExecutionContext *exe_ctx, RegisterContext *reg_ctx, lldb::addr_t func_load_addr, const Value *initial_value_ptr, const Value *object_address_ptr) const
A class to manage flag bits.
Definition: Debugger.h:80
uint64_t GetDisassemblyLineCount() const
Definition: Debugger.cpp:540
StopDisassemblyType GetStopDisassemblyDisplay() const
Definition: Debugger.cpp:533
uint64_t GetStopSourceLineCount(bool before) const
Definition: Debugger.cpp:526
const FormatEntity::Entry * GetFrameFormat() const
Definition: Debugger.cpp:284
const FormatEntity::Entry * GetFrameFormatUnique() const
Definition: Debugger.cpp:289
InstructionList & GetInstructionList()
static lldb::DisassemblerSP DisassembleRange(const ArchSpec &arch, const char *plugin_name, const char *flavor, Target &target, const AddressRange &disasm_range, bool force_live_memory=false)
static bool Disassemble(Debugger &debugger, const ArchSpec &arch, const char *plugin_name, const char *flavor, const ExecutionContext &exe_ctx, const Address &start, Limit limit, bool mixed_source_and_assembly, uint32_t num_mixed_context_lines, uint32_t options, Stream &strm)
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
ExecutionContextScope * GetBestExecutionContextScope() const
void SetContext(const lldb::TargetSP &target_sp, bool get_process)
Target * GetTargetPtr() const
Returns a pointer to the target object.
A file utility class.
Definition: FileSpec.h:56
bool IsClear(ValueType bit) const
Test a single flag bit to see if it is clear (zero).
Definition: Flags.h:111
ValueType Get() const
Get accessor for all flags.
Definition: Flags.h:40
ValueType Clear(ValueType mask=~static_cast< ValueType >(0))
Clear one or more flags.
Definition: Flags.h:61
void Reset(ValueType flags)
Set accessor for all flags.
Definition: Flags.h:52
ValueType Set(ValueType mask)
Set one or more flags by logical OR'ing mask with the current flags.
Definition: Flags.h:73
A class that describes a function.
Definition: Function.h:399
const AddressRange & GetAddressRange()
Definition: Function.h:447
CompilerType GetCompilerType()
Definition: Function.cpp:560
DWARFExpressionList & GetFrameBaseExpression()
Get accessor for the frame base location.
Definition: Function.h:514
ConstString GetName() const
Definition: Function.cpp:693
const Mangled & GetMangled() const
Definition: Function.h:528
void GetStartLineSourceInfo(FileSpec &source_file, uint32_t &line_no)
Find the file and line number of the source location of the start of the function.
Definition: Function.cpp:270
Block & GetBlock(bool can_create)
Get accessor for the block list.
Definition: Function.cpp:371
uint32_t GetIndexOfInstructionAtAddress(const Address &addr)
lldb::InstructionSP GetInstructionAtIndex(size_t idx) const
lldb::LanguageType GuessLanguage() const
Try to guess the language from the mangling.
Definition: Mangled.cpp:391
const RegisterInfo * GetRegisterInfoByName(llvm::StringRef reg_name, uint32_t start_idx=0)
virtual bool ReadRegister(const RegisterInfo *reg_info, RegisterValue &reg_value)=0
uint64_t GetAsUInt64(uint64_t fail_value=UINT64_MAX, bool *success_ptr=nullptr) const
size_t DisplaySourceLinesWithLineNumbers(const FileSpec &file, uint32_t line, uint32_t column, uint32_t context_before, uint32_t context_after, const char *current_line_cstr, Stream *s, const SymbolContextList *bp_locs=nullptr)
This base class provides an interface to stack frames.
Definition: StackFrame.h:43
void SetSymbolContextScope(SymbolContextScope *symbol_scope)
Definition: StackFrame.cpp:184
lldb::VariableListSP m_variable_list_sp
Definition: StackFrame.h:543
void UpdatePreviousFrameFromCurrentFrame(StackFrame &curr_frame)
lldb::ThreadSP GetThread() const
Definition: StackFrame.h:127
@ eExpressionPathOptionsInspectAnonymousUnions
Definition: StackFrame.h:51
@ eExpressionPathOptionsAllowDirectIVarAccess
Definition: StackFrame.h:50
@ eExpressionPathOptionsNoSyntheticChildren
Definition: StackFrame.h:48
VariableList * GetVariableList(bool get_file_globals, Status *error_ptr)
Retrieve the list of variables that are in scope at this StackFrame's pc.
Definition: StackFrame.cpp:424
DWARFExpressionList * GetFrameBaseExpression(Status *error_ptr)
Get the DWARFExpressionList corresponding to the Canonical Frame Address.
void UpdateCurrentFrameFromPreviousFrame(StackFrame &prev_frame)
ValueObjectList m_variable_list_value_objects
Definition: StackFrame.h:544
void DumpUsingSettingsFormat(Stream *strm, bool show_unique=false, const char *frame_marker=nullptr)
Print a description for this frame using the frame-format formatter settings.
bool IsInlined()
Query whether this frame is a concrete frame on the call stack, or if it is an inlined frame derived ...
lldb::ValueObjectSP GetValueForVariableExpressionPath(llvm::StringRef var_expr, lldb::DynamicValueType use_dynamic, uint32_t options, lldb::VariableSP &var_sp, Status &error)
Create a ValueObject for a variable name / pathname, possibly including simple dereference/child sele...
Definition: StackFrame.cpp:508
SourceLanguage GuessLanguage()
Similar to GetLanguage(), but is allowed to take a potentially incorrect guess if exact information i...
lldb::RegisterContextSP GetRegisterContext()
Get the RegisterContext for this frame, if possible.
lldb::RegisterContextSP m_reg_context_sp
Definition: StackFrame.h:525
lldb::ValueObjectSP GuessValueForRegisterAndOffset(ConstString reg, int64_t offset)
Attempt to reconstruct the ValueObject for the address contained in a given register plus an offset.
lldb::VariableListSP GetInScopeVariableList(bool get_file_globals, bool must_have_valid_location=false)
Retrieve the list of variables that are in scope at this StackFrame's pc.
Definition: StackFrame.cpp:475
lldb::RecognizedStackFrameSP m_recognized_frame_sp
Definition: StackFrame.h:547
Address GetFrameCodeAddressForSymbolication()
Get the current code Address suitable for symbolication, may not be the same as GetFrameCodeAddress()...
Definition: StackFrame.cpp:222
@ History
A historical stack frame – possibly without CFA or registers or local variables.
@ Artificial
An artificial stack frame (e.g.
uint32_t m_concrete_frame_index
Definition: StackFrame.h:524
lldb::ValueObjectSP GuessValueForAddress(lldb::addr_t addr)
Attempt to econstruct the ValueObject for a given raw address touched by the current instruction.
bool ChangePC(lldb::addr_t pc)
Change the pc value for a given thread.
Definition: StackFrame.cpp:247
lldb::ThreadSP CalculateThread() override
SourceLanguage GetLanguage()
Query this frame to determine what the default language should be when parsing expressions given the ...
lldb::ValueObjectSP GetValueObjectForFrameVariable(const lldb::VariableSP &variable_sp, lldb::DynamicValueType use_dynamic)
Create a ValueObject for a given Variable in this StackFrame.
StreamString m_disassembly
Definition: StackFrame.h:548
lldb::StackFrameSP CalculateStackFrame() override
const SymbolContext & GetSymbolContext(lldb::SymbolContextItem resolve_scope)
Provide a SymbolContext for this StackFrame's current pc value.
Definition: StackFrame.cpp:300
bool IsHistorical() const
Query whether this frame is part of a historical backtrace.
const char * Disassemble()
Return the disassembly for the instructions of this StackFrame's function as a single C string.
Definition: StackFrame.cpp:261
bool IsArtificial() const
Query whether this frame is artificial (e.g a synthesized result of inferring missing tail call frame...
void CalculateExecutionContext(ExecutionContext &exe_ctx) override
Reconstruct the object's execution context into sc.
void Dump(Stream *strm, bool show_frame_index, bool show_fullpaths)
Print a description for this frame using a default format.
uint32_t GetFrameIndex() const
Query this frame to find what frame it is in this Thread's StackFrameList.
Definition: StackFrame.cpp:175
bool HasDebugInformation()
Determine whether this StackFrame has debug information available or not.
bool GetStatus(Stream &strm, bool show_frame_info, bool show_source, bool show_unique=false, const char *frame_marker=nullptr)
Print a description of this stack frame and/or the source context/assembly for this stack frame.
Block * GetFrameBlock()
Get the current lexical scope block for this StackFrame, if possible.
Definition: StackFrame.cpp:275
bool GetFrameBaseValue(Scalar &value, Status *error_ptr)
Return the Canonical Frame Address (DWARF term) for this frame.
bool DumpUsingFormat(Stream &strm, const lldb_private::FormatEntity::Entry *format, llvm::StringRef frame_marker={})
Print a description of this frame using the provided frame format.
lldb::ProcessSP CalculateProcess() override
lldb::RecognizedStackFrameSP GetRecognizedFrame()
std::recursive_mutex m_mutex
Definition: StackFrame.h:549
StackFrame(const lldb::ThreadSP &thread_sp, lldb::user_id_t frame_idx, lldb::user_id_t concrete_frame_idx, lldb::addr_t cfa, bool cfa_is_valid, lldb::addr_t pc, Kind frame_kind, bool behaves_like_zeroth_frame, const SymbolContext *sc_ptr)
Construct a StackFrame object without supplying a RegisterContextSP.
Definition: StackFrame.cpp:53
lldb::ValueObjectSP FindVariable(ConstString name)
Attempt to reconstruct the ValueObject for a variable with a given name from within the current Stack...
const Address & GetFrameCodeAddress()
Get an Address for the current pc value in this StackFrame.
Definition: StackFrame.cpp:190
lldb::TargetSP CalculateTarget() override
void SetPC(lldb::addr_t pc)
Definition: StackID.h:66
SymbolContextScope * GetSymbolContextScope() const
Definition: StackID.h:35
lldb::addr_t GetPC() const
Definition: StackID.h:31
void SetSymbolContextScope(SymbolContextScope *symbol_scope)
Definition: StackID.h:37
void SetCFA(lldb::addr_t cfa)
Definition: StackID.h:68
An error handling class.
Definition: Status.h:44
void Clear()
Clear the object state.
Definition: Status.cpp:166
bool Fail() const
Test for error condition.
Definition: Status.cpp:180
void SetErrorString(llvm::StringRef err_str)
Set the current error string to err_str.
Definition: Status.cpp:232
bool Success() const
Test for success condition.
Definition: Status.cpp:278
const char * GetData() const
Definition: StreamString.h:43
llvm::StringRef GetString() const
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition: Stream.cpp:157
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:134
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:65
size_t EOL()
Output and End of Line character to the stream.
Definition: Stream.cpp:155
"lldb/Symbol/SymbolContextScope.h" Inherit from this if your object is part of a symbol context and c...
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:34
Function * function
The Function for a given query.
llvm::StringRef GetInstanceVariableName()
Determines the name of the instance variable for the this decl context.
ConstString GetFunctionName(Mangled::NamePreference preference=Mangled::ePreferDemangled) const
Find a name of the innermost function for the symbol context.
Block * block
The Block for a given query.
lldb::ModuleSP module_sp
The Module for a given query.
CompileUnit * comp_unit
The CompileUnit for a given query.
bool DumpStopContext(Stream *s, ExecutionContextScope *exe_scope, const Address &so_addr, bool show_fullpaths, bool show_module, bool show_inlined_frames, bool show_function_arguments, bool show_function_name, bool show_function_display_name=false, std::optional< Stream::HighlightSettings > settings=std::nullopt) const
Dump the stop context in this object to a Stream.
uint32_t GetResolvedMask() const
void Clear(bool clear_target)
Clear the object's state.
Symbol * symbol
The Symbol for a given query.
lldb::TargetSP target_sp
The Target for a given query.
LineEntry line_entry
The LineEntry for a given query.
Provides public interface for all SymbolFiles.
Definition: SymbolFile.h:50
Status GetFrameVariableError(StackFrame &frame)
Get an error that describes why variables might be missing for a given symbol context.
Definition: SymbolFile.h:271
Mangled & GetMangled()
Definition: Symbol.h:146
SourceManager & GetSourceManager()
Definition: Target.cpp:2816
Debugger & GetDebugger()
Definition: Target.h:1064
const ArchSpec & GetArchitecture() const
Definition: Target.h:1023
CompilerType GetForwardCompilerType()
Definition: Type.cpp:771
void SetValueObjectAtIndex(size_t idx, const lldb::ValueObjectSP &valobj_sp)
lldb::ValueObjectSP GetValueObjectAtIndex(size_t idx)
void Swap(ValueObjectList &value_object_list)
static lldb::ValueObjectSP Create(ExecutionContextScope *exe_scope, llvm::StringRef name, const Address &address, lldb::TypeSP &type_sp)
static lldb::ValueObjectSP Create(ExecutionContextScope *exe_scope, const lldb::VariableSP &var_sp)
lldb::VariableSP FindVariable(ConstString name, bool include_static_members=true)
uint32_t FindIndexForVariable(Variable *variable)
bool IsInScope(StackFrame *frame)
Definition: Variable.cpp:275
bool LocationIsValidForFrame(StackFrame *frame)
Definition: Variable.cpp:216
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
#define UINT32_MAX
Definition: lldb-defines.h:19
bool Format(const Entry &entry, Stream &s, const SymbolContext *sc, const ExecutionContext *exe_ctx, const Address *addr, ValueObject *valobj, bool function_changed, bool initial_function)
std::function< bool(const Instruction::Operand &)> MatchRegOp(const RegisterInfo &info)
std::function< bool(const Instruction::Operand &)> FetchRegOp(ConstString &reg)
std::function< bool(const Instruction::Operand &)> FetchImmOp(int64_t &imm)
std::function< bool(const Instruction::Operand &)> MatchOpType(Instruction::Operand::Type type)
std::function< bool(const Instruction::Operand &)> MatchBinaryOp(std::function< bool(const Instruction::Operand &)> base, std::function< bool(const Instruction::Operand &)> left, std::function< bool(const Instruction::Operand &)> right)
std::function< bool(const Instruction::Operand &)> MatchUnaryOp(std::function< bool(const Instruction::Operand &)> base, std::function< bool(const Instruction::Operand &)> child)
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:331
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::ABI > ABISP
Definition: lldb-forward.h:312
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
Definition: lldb-forward.h:415
std::shared_ptr< lldb_private::RecognizedStackFrame > RecognizedStackFrameSP
Definition: lldb-forward.h:398
std::shared_ptr< lldb_private::Thread > ThreadSP
Definition: lldb-forward.h:441
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:475
LanguageType
Programming language type.
@ eLanguageTypeUnknown
Unknown or invalid language value.
@ eLanguageTypeC
Non-standardized C, such as K&R.
@ eLanguageTypeObjC
Objective-C.
std::shared_ptr< lldb_private::Instruction > InstructionSP
Definition: lldb-forward.h:353
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:384
std::shared_ptr< lldb_private::Disassembler > DisassemblerSP
Definition: lldb-forward.h:336
std::shared_ptr< lldb_private::VariableList > VariableListSP
Definition: lldb-forward.h:478
std::shared_ptr< lldb_private::Variable > VariableSP
Definition: lldb-forward.h:477
uint64_t user_id_t
Definition: lldb-types.h:82
uint64_t addr_t
Definition: lldb-types.h:80
std::shared_ptr< lldb_private::Target > TargetSP
Definition: lldb-forward.h:439
@ eNoDynamicValues
std::shared_ptr< lldb_private::RegisterContext > RegisterContextSP
Definition: lldb-forward.h:389
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:368
enum lldb_private::Instruction::Operand::Type m_type
static Operand BuildImmediate(lldb::addr_t imm, bool neg)
static Operand BuildDereference(const Operand &ref)
std::vector< Operand > m_children
Definition: Disassembler.h:209
static Operand BuildSum(const Operand &lhs, const Operand &rhs)
static Operand BuildRegister(ConstString &r)
uint16_t column
The column number of the source line, or zero if there is no column information.
Definition: LineEntry.h:151
bool IsValid() const
Check if a line entry object is valid.
Definition: LineEntry.cpp:35
uint32_t line
The source line number, or LLDB_INVALID_LINE_NUMBER if there is no line number information.
Definition: LineEntry.h:147
const FileSpec & GetFile() const
Helper to access the file.
Definition: LineEntry.h:134
void ApplyFileMappings(lldb::TargetSP target_sp)
Apply file mappings from target.source-map to the LineEntry's file.
Definition: LineEntry.cpp:243
Every register is described in detail including its name, alternate name (optional),...
A type-erased pair of llvm::dwarf::SourceLanguageName and version.