LLDB mainline
SymbolContext.h
Go to the documentation of this file.
1//===-- SymbolContext.h -----------------------------------------*- C++ -*-===//
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
9#ifndef LLDB_SYMBOL_SYMBOLCONTEXT_H
10#define LLDB_SYMBOL_SYMBOLCONTEXT_H
11
12#include <memory>
13#include <string>
14#include <vector>
15
16#include "lldb/Core/Address.h"
17#include "lldb/Core/Mangled.h"
20#include "lldb/lldb-private.h"
21
22namespace lldb_private {
23
24class SymbolContextScope;
25
26/// \class SymbolContext SymbolContext.h "lldb/Symbol/SymbolContext.h" Defines
27/// a symbol context baton that can be handed other debug core functions.
28///
29/// Many debugger functions require a context when doing lookups. This class
30/// provides a common structure that can be used as the result of a query that
31/// can contain a single result. Examples of such queries include
32/// \li Looking up a load address.
34public:
35 /// Default constructor.
36 ///
37 /// Initialize all pointer members to nullptr and all struct members to
38 /// their default state.
40
41 /// Construct with an object that knows how to reconstruct its symbol
42 /// context.
43 ///
44 /// \param[in] sc_scope
45 /// A symbol context scope object that knows how to reconstruct
46 /// it's context.
47 explicit SymbolContext(SymbolContextScope *sc_scope);
48
49 /// Construct with module, and optional compile unit, function, block, line
50 /// table, line entry and symbol.
51 ///
52 /// Initialize all pointer to the specified values.
53 ///
54 /// \param[in] module_sp
55 /// A Module pointer to the module for this context.
56 ///
57 /// \param[in] comp_unit
58 /// A CompileUnit pointer to the compile unit for this context.
59 ///
60 /// \param[in] function
61 /// A Function pointer to the function for this context.
62 ///
63 /// \param[in] block
64 /// A Block pointer to the deepest block for this context.
65 ///
66 /// \param[in] line_entry
67 /// A LineEntry pointer to the line entry for this context.
68 ///
69 /// \param[in] symbol
70 /// A Symbol pointer to the symbol for this context.
71 explicit SymbolContext(const lldb::TargetSP &target_sp,
72 const lldb::ModuleSP &module_sp,
73 CompileUnit *comp_unit = nullptr,
74 Function *function = nullptr, Block *block = nullptr,
75 LineEntry *line_entry = nullptr,
76 Symbol *symbol = nullptr);
77
78 // This version sets the target to a NULL TargetSP if you don't know it.
79 explicit SymbolContext(const lldb::ModuleSP &module_sp,
80 CompileUnit *comp_unit = nullptr,
81 Function *function = nullptr, Block *block = nullptr,
82 LineEntry *line_entry = nullptr,
83 Symbol *symbol = nullptr);
84
86
87 /// Clear the object's state.
88 ///
89 /// Resets all pointer members to nullptr, and clears any class objects to
90 /// their default state.
91 void Clear(bool clear_target);
92
93 /// Dump a description of this object to a Stream.
94 ///
95 /// Dump a description of the contents of this object to the supplied stream
96 /// \a s.
97 ///
98 /// \param[in] s
99 /// The stream to which to dump the object description.
100 void Dump(Stream *s, Target *target) const;
101
102 /// Dump the stop context in this object to a Stream.
103 ///
104 /// Dump the best description of this object to the stream. The information
105 /// displayed depends on the amount and quality of the information in this
106 /// context. If a module, function, file and line number are available, they
107 /// will be dumped. If only a module and function or symbol name with offset
108 /// is available, that will be output. Else just the address at which the
109 /// target was stopped will be displayed.
110 ///
111 /// \param[in] s
112 /// The stream to which to dump the object description.
113 ///
114 /// \param[in] so_addr
115 /// The resolved section offset address.
116 ///
117 /// \param[in] show_fullpaths
118 /// When printing file paths (with the Module), whether the
119 /// base name of the Module should be printed or the full path.
120 ///
121 /// \param[in] show_module
122 /// Whether the module name should be printed followed by a
123 /// grave accent "`" character.
124 ///
125 /// \param[in] show_inlined_frames
126 /// If a given pc is in inlined function(s), whether the inlined
127 /// functions should be printed on separate lines in addition to
128 /// the concrete function containing the pc.
129 ///
130 /// \param[in] show_function_arguments
131 /// If false, this method will try to elide the function argument
132 /// types when printing the function name. This may be ambiguous
133 /// for languages that have function overloading - but it may
134 /// make the "function name" too long to include all the argument
135 /// types.
136 ///
137 /// \param[in] show_function_name
138 /// Normally this should be true - the function/symbol name should
139 /// be printed. In disassembly formatting, where we want a format
140 /// like "<*+36>", this should be false and "*" will be printed
141 /// instead.
142 ///
143 /// \param[in] show_inline_callsite_line_info
144 /// When processing an inline block, the line info of the callsite
145 /// is dumped if this flag is \b true, otherwise the line info
146 /// of the actual inlined function is dumped.
147 ///
148 /// \return
149 /// \b true if some text was dumped, \b false otherwise.
150 bool DumpStopContext(Stream *s, ExecutionContextScope *exe_scope,
151 const Address &so_addr, bool show_fullpaths,
152 bool show_module, bool show_inlined_frames,
153 bool show_function_arguments,
154 bool show_function_name) const;
155
156 /// Get the address range contained within a symbol context.
157 ///
158 /// Address range priority is as follows:
159 /// - line_entry address range if line_entry is valid and
160 /// eSymbolContextLineEntry is set in \a scope
161 /// - block address range if block is not nullptr and eSymbolContextBlock
162 /// is set in \a scope
163 /// - function address range if function is not nullptr and
164 /// eSymbolContextFunction is set in \a scope
165 /// - symbol address range if symbol is not nullptr and
166 /// eSymbolContextSymbol is set in \a scope
167 ///
168 /// \param[in] scope
169 /// A mask of symbol context bits telling this function which
170 /// address ranges it can use when trying to extract one from
171 /// the valid (non-nullptr) symbol context classes.
172 ///
173 /// \param[in] range_idx
174 /// The address range index to grab. Since many functions and
175 /// blocks are not always contiguous, they may have more than
176 /// one address range.
177 ///
178 /// \param[in] use_inline_block_range
179 /// If \a scope has the eSymbolContextBlock bit set, and there
180 /// is a valid block in the symbol context, return the block
181 /// address range for the containing inline function block, not
182 /// the deepest most block. This allows us to extract information
183 /// for the address range of the inlined function block, not
184 /// the deepest lexical block.
185 ///
186 /// \param[out] range
187 /// An address range object that will be filled in if \b true
188 /// is returned.
189 ///
190 /// \return
191 /// \b True if this symbol context contains items that describe
192 /// an address range, \b false otherwise.
193 bool GetAddressRange(uint32_t scope, uint32_t range_idx,
194 bool use_inline_block_range, AddressRange &range) const;
195
197 Status &error);
198
199 /// Find the best global data symbol visible from this context.
200 ///
201 /// Symbol priority is:
202 /// - extern symbol in the current module if there is one
203 /// - non-extern symbol in the current module if there is one
204 /// - extern symbol in the target
205 /// - non-extern symbol in the target
206 /// It is an error if the highest-priority result is ambiguous.
207 ///
208 /// \param[in] name
209 /// The name of the symbol to search for.
210 ///
211 /// \param[out] error
212 /// An error that will be populated with a message if there was an
213 /// ambiguous result. The error will not be populated if no result
214 /// was found.
215 ///
216 /// \return
217 /// The symbol that was found, or \b nullptr if none was found.
219
221 Target *target) const;
222
224
226
227 /// Find a block that defines the function represented by this symbol
228 /// context.
229 ///
230 /// If this symbol context points to a block that is an inlined function, or
231 /// is contained within an inlined function, the block that defines the
232 /// inlined function is returned.
233 ///
234 /// If this symbol context has no block in it, or the block is not itself an
235 /// inlined function block or contained within one, we return the top level
236 /// function block.
237 ///
238 /// This is a handy function to call when you want to get the block whose
239 /// variable list will include the arguments for the function that is
240 /// represented by this symbol context (whether the function is an inline
241 /// function or not).
242 ///
243 /// \return
244 /// The block object pointer that defines the function that is
245 /// represented by this symbol context object, nullptr otherwise.
247
248 /// Determines the name of the instance variable for the this decl context.
249 ///
250 /// For C++ the name is "this", for Objective-C the name is "self".
251 ///
252 /// \return
253 /// Returns a StringRef for the name of the instance variable.
254 llvm::StringRef GetInstanceVariableName();
255
256 /// Sorts the types in TypeMap according to SymbolContext to TypeList
257 ///
258 void SortTypeList(TypeMap &type_map, TypeList &type_list) const;
259
260 /// Find a name of the innermost function for the symbol context.
261 ///
262 /// For instance, if the symbol context contains an inlined block, it will
263 /// return the inlined function name.
264 ///
265 /// \return
266 /// The name of the function represented by this symbol context.
268 Mangled::NamePreference preference = Mangled::ePreferDemangled) const;
269
270 /// Get the line entry that corresponds to the function.
271 ///
272 /// If the symbol context contains an inlined block, the line entry for the
273 /// start address of the inlined function will be returned, otherwise the
274 /// line entry for the start address of the function will be returned. This
275 /// can be used after doing a Module::FindFunctions(...) or
276 /// ModuleList::FindFunctions(...) call in order to get the correct line
277 /// table information for the symbol context. it will return the inlined
278 /// function name.
280
281 /// Find the block containing the inlined block that contains this block.
282 ///
283 /// For instance, if the symbol context contains an inlined block, it will
284 /// return the inlined function name.
285 ///
286 /// \param[in] curr_frame_pc
287 /// The address within the block of this object.
288 ///
289 /// \param[out] next_frame_sc
290 /// A new symbol context that does what the title says it does.
291 ///
292 /// \param[out] inlined_frame_addr
293 /// This is what you should report as the PC in \a next_frame_sc.
294 ///
295 /// \return
296 /// \b true if this SymbolContext specifies a block contained in an
297 /// inlined block. If this returns \b true, \a next_frame_sc and
298 /// \a inlined_frame_addr will be filled in correctly.
299 bool GetParentOfInlinedScope(const Address &curr_frame_pc,
300 SymbolContext &next_frame_sc,
301 Address &inlined_frame_addr) const;
302
303 // Member variables
304 lldb::TargetSP target_sp; ///< The Target for a given query
305 lldb::ModuleSP module_sp; ///< The Module for a given query
306 CompileUnit *comp_unit = nullptr; ///< The CompileUnit for a given query
307 Function *function = nullptr; ///< The Function for a given query
308 Block *block = nullptr; ///< The Block for a given query
309 LineEntry line_entry; ///< The LineEntry for a given query
310 Symbol *symbol = nullptr; ///< The Symbol for a given query
312 nullptr; ///< The global variable matching the given query
313};
314
316public:
326 };
327
328 // This one produces a specifier that matches everything...
329 SymbolContextSpecifier(const lldb::TargetSP &target_sp);
330
332
333 bool AddSpecification(const char *spec_string, SpecificationType type);
334
336
337 void Clear();
338
339 bool SymbolContextMatches(const SymbolContext &sc);
340
341 bool AddressMatches(lldb::addr_t addr);
342
343 void GetDescription(Stream *s, lldb::DescriptionLevel level) const;
344
345private:
346 lldb::TargetSP m_target_sp;
347 std::string m_module_spec;
348 lldb::ModuleSP m_module_sp;
349 std::unique_ptr<FileSpec> m_file_spec_up;
352 std::string m_function_spec;
353 std::string m_class_name;
354 std::unique_ptr<AddressRange> m_address_range_up;
355 uint32_t m_type; // Or'ed bits from SpecificationType
356};
357
358/// \class SymbolContextList SymbolContext.h "lldb/Symbol/SymbolContext.h"
359/// Defines a list of symbol context objects.
360///
361/// This class provides a common structure that can be used to contain the
362/// result of a query that can contain a multiple results. Examples of such
363/// queries include:
364/// \li Looking up a function by name.
365/// \li Finding all addresses for a specified file and line number.
367public:
368 /// Default constructor.
369 ///
370 /// Initialize with an empty list.
372
373 /// Destructor.
375
376 /// Append a new symbol context to the list.
377 ///
378 /// \param[in] sc
379 /// A symbol context to append to the list.
380 void Append(const SymbolContext &sc);
381
382 void Append(const SymbolContextList &sc_list);
383
384 bool AppendIfUnique(const SymbolContext &sc, bool merge_symbol_into_function);
385
387 bool merge_symbol_into_function);
388
389 /// Clear the object's state.
390 ///
391 /// Clears the symbol context list.
392 void Clear();
393
394 /// Dump a description of this object to a Stream.
395 ///
396 /// Dump a description of the contents of each symbol context in the list to
397 /// the supplied stream \a s.
398 ///
399 /// \param[in] s
400 /// The stream to which to dump the object description.
401 void Dump(Stream *s, Target *target) const;
402
403 /// Get accessor for a symbol context at index \a idx.
404 ///
405 /// Dump a description of the contents of each symbol context in the list to
406 /// the supplied stream \a s.
407 ///
408 /// \param[in] idx
409 /// The zero based index into the symbol context list.
410 ///
411 /// \param[out] sc
412 /// A reference to the symbol context to fill in.
413 ///
414 /// \return
415 /// Returns \b true if \a idx was a valid index into this
416 /// symbol context list and \a sc was filled in, \b false
417 /// otherwise.
418 bool GetContextAtIndex(size_t idx, SymbolContext &sc) const;
419
420 /// Direct reference accessor for a symbol context at index \a idx.
421 ///
422 /// The index \a idx must be a valid index, no error checking will be done
423 /// to ensure that it is valid.
424 ///
425 /// \param[in] idx
426 /// The zero based index into the symbol context list.
427 ///
428 /// \return
429 /// A const reference to the symbol context to fill in.
430 SymbolContext &operator[](size_t idx) { return m_symbol_contexts[idx]; }
431
432 const SymbolContext &operator[](size_t idx) const {
433 return m_symbol_contexts[idx];
434 }
435
436 bool RemoveContextAtIndex(size_t idx);
437
438 /// Get accessor for a symbol context list size.
439 ///
440 /// \return
441 /// Returns the number of symbol context objects in the list.
442 uint32_t GetSize() const;
443
444 bool IsEmpty() const;
445
447
449 Target *target) const;
450
451protected:
452 typedef std::vector<SymbolContext>
453 collection; ///< The collection type for the list.
454 typedef collection::const_iterator const_iterator;
455
456 // Member variables.
457 collection m_symbol_contexts; ///< The list of symbol contexts.
458
459public:
460 const_iterator begin() const { return m_symbol_contexts.begin(); }
461 const_iterator end() const { return m_symbol_contexts.end(); }
462
467 }
468};
469
470bool operator==(const SymbolContext &lhs, const SymbolContext &rhs);
471bool operator!=(const SymbolContext &lhs, const SymbolContext &rhs);
472
473bool operator==(const SymbolContextList &lhs, const SymbolContextList &rhs);
474bool operator!=(const SymbolContextList &lhs, const SymbolContextList &rhs);
475
476} // namespace lldb_private
477
478#endif // LLDB_SYMBOL_SYMBOLCONTEXT_H
static llvm::raw_ostream & error(Stream &strm)
A section + offset based address range class.
Definition: AddressRange.h:25
A section + offset based address class.
Definition: Address.h:59
A class that describes a single lexical block.
Definition: Block.h:41
A class that describes a compilation unit.
Definition: CompileUnit.h:41
A uniqued constant string class.
Definition: ConstString.h:40
"lldb/Target/ExecutionContextScope.h" Inherit from this if your object can reconstruct its execution ...
A class that describes a function.
Definition: Function.h:409
An error handling class.
Definition: Status.h:44
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
Defines a list of symbol context objects.
collection m_symbol_contexts
The list of symbol contexts.
bool GetContextAtIndex(size_t idx, SymbolContext &sc) const
Get accessor for a symbol context at index idx.
uint32_t GetSize() const
Get accessor for a symbol context list size.
SymbolContext & operator[](size_t idx)
Direct reference accessor for a symbol context at index idx.
const_iterator begin() const
void GetDescription(Stream *s, lldb::DescriptionLevel level, Target *target) const
const_iterator end() const
bool AppendIfUnique(const SymbolContext &sc, bool merge_symbol_into_function)
void Dump(Stream *s, Target *target) const
Dump a description of this object to a Stream.
uint32_t NumLineEntriesWithLine(uint32_t line) const
collection::const_iterator const_iterator
void Append(const SymbolContext &sc)
Append a new symbol context to the list.
AdaptedIterable< collection, SymbolContext, vector_adapter > SymbolContextIterable
const SymbolContext & operator[](size_t idx) const
SymbolContextIterable SymbolContexts()
void Clear()
Clear the object's state.
std::vector< SymbolContext > collection
The collection type for the list.
SymbolContextList()
Default constructor.
"lldb/Symbol/SymbolContextScope.h" Inherit from this if your object is part of a symbol context and c...
void GetDescription(Stream *s, lldb::DescriptionLevel level) const
bool AddressMatches(lldb::addr_t addr)
std::unique_ptr< AddressRange > m_address_range_up
std::unique_ptr< FileSpec > m_file_spec_up
bool AddLineSpecification(uint32_t line_no, SpecificationType type)
bool AddSpecification(const char *spec_string, SpecificationType type)
bool SymbolContextMatches(const SymbolContext &sc)
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:33
LineEntry GetFunctionStartLineEntry() const
Get the line entry that corresponds to the function.
const Symbol * FindBestGlobalDataSymbol(ConstString name, Status &error)
Find the best global data symbol visible from this context.
lldb::LanguageType GetLanguage() const
void Dump(Stream *s, Target *target) const
Dump a description of this object to a Stream.
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) const
Dump the stop context in this object to a Stream.
Function * function
The Function for a given query.
Block * GetFunctionBlock()
Find a block that defines the function represented by this symbol context.
llvm::StringRef GetInstanceVariableName()
Determines the name of the instance variable for the this decl context.
bool GetParentOfInlinedScope(const Address &curr_frame_pc, SymbolContext &next_frame_sc, Address &inlined_frame_addr) const
Find the block containing the inlined block that contains this block.
ConstString GetFunctionName(Mangled::NamePreference preference=Mangled::ePreferDemangled) const
Find a name of the innermost function for the symbol context.
void SortTypeList(TypeMap &type_map, TypeList &type_list) const
Sorts the types in TypeMap according to SymbolContext to TypeList.
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.
uint32_t GetResolvedMask() const
void Clear(bool clear_target)
Clear the object's state.
Variable * variable
The global variable matching the given query.
bool GetAddressRange(uint32_t scope, uint32_t range_idx, bool use_inline_block_range, AddressRange &range) const
Get the address range contained within a symbol context.
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.
void GetDescription(Stream *s, lldb::DescriptionLevel level, Target *target) const
SymbolContext(const lldb::TargetSP &target_sp, const lldb::ModuleSP &module_sp, CompileUnit *comp_unit=nullptr, Function *function=nullptr, Block *block=nullptr, LineEntry *line_entry=nullptr, Symbol *symbol=nullptr)
Construct with module, and optional compile unit, function, block, line table, line entry and symbol.
bool GetAddressRangeFromHereToEndLine(uint32_t end_line, AddressRange &range, Status &error)
SymbolContext(const lldb::ModuleSP &module_sp, CompileUnit *comp_unit=nullptr, Function *function=nullptr, Block *block=nullptr, LineEntry *line_entry=nullptr, Symbol *symbol=nullptr)
SymbolContext()
Default constructor.
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
bool operator!=(const Address &lhs, const Address &rhs)
Definition: Address.cpp:1022
bool operator==(const Address &lhs, const Address &rhs)
Definition: Address.cpp:1016
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
LanguageType
Programming language type.
uint64_t addr_t
Definition: lldb-types.h:79
A line table entry class.
Definition: LineEntry.h:20