d482fe2add
Pavel Labath wrote in D73206: The internal representation of DebugNames and Apple indexes is fixed by the relevant (pseudo-)standards, so we can't really change it. The question is how to efficiently (and cleanly) convert from the internal representation to some common thing. The conversion from AppleIndex to DIERef is trivial (which is not surprising as it was the first and the overall design was optimized for that). With debug_names, the situation gets more tricky. The internal representation of debug_names uses CU-relative DIE offsets, but DIERef wants an absolute offset. That means the index has to do more work to produce the common representation. And it needs to do that for all results, even though a lot of the index users are really interested only in a single entry. With the switch to user_id_t, _all_ indexes would have to do some extra work to encode it, only for their users to have to immediately decode it back. Having a iterator/callback based api would allow us to minimize the impact of that, as it would only need to happen for the entries that are really used. And /I think/ we could make it interface returns DWARFDies directly, and each index converts to that using the most direct approach available. Jan Kratochvil: It also makes all the callers shorter as they no longer need to fetch DWARFDIE from DIERef (and handling if not found by ReportInvalidDIERef) but the callers are already served DWARFDIE which they need. In some cases the DWARFDIE had to be fetched both by callee (DWARFIndex implementation) and caller. Differential Revision: https://reviews.llvm.org/D77970
101 lines
3.8 KiB
C++
101 lines
3.8 KiB
C++
//===-- DWARFIndex.h -------------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFINDEX_H
|
|
#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFINDEX_H
|
|
|
|
#include "Plugins/SymbolFile/DWARF/DIERef.h"
|
|
#include "Plugins/SymbolFile/DWARF/DWARFDIE.h"
|
|
#include "Plugins/SymbolFile/DWARF/DWARFFormValue.h"
|
|
|
|
class DWARFDeclContext;
|
|
class DWARFDIE;
|
|
|
|
namespace lldb_private {
|
|
class DWARFIndex {
|
|
public:
|
|
DWARFIndex(Module &module) : m_module(module) {}
|
|
virtual ~DWARFIndex();
|
|
|
|
virtual void Preload() = 0;
|
|
|
|
/// Finds global variables with the given base name. Any additional filtering
|
|
/// (e.g., to only retrieve variables from a given context) should be done by
|
|
/// the consumer.
|
|
virtual void
|
|
GetGlobalVariables(ConstString basename,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
|
|
virtual void
|
|
GetGlobalVariables(const RegularExpression ®ex,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void
|
|
GetGlobalVariables(const DWARFUnit &cu,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void
|
|
GetObjCMethods(ConstString class_name,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void
|
|
GetCompleteObjCClass(ConstString class_name, bool must_be_implementation,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void GetTypes(ConstString name,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void GetTypes(const DWARFDeclContext &context,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void
|
|
GetNamespaces(ConstString name,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void
|
|
GetFunctions(ConstString name, SymbolFileDWARF &dwarf,
|
|
const CompilerDeclContext &parent_decl_ctx,
|
|
uint32_t name_type_mask,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
virtual void
|
|
GetFunctions(const RegularExpression ®ex,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback) = 0;
|
|
|
|
virtual void Dump(Stream &s) = 0;
|
|
|
|
protected:
|
|
Module &m_module;
|
|
|
|
/// Helper function implementing common logic for processing function dies. If
|
|
/// the function given by "ref" matches search criteria given by
|
|
/// "parent_decl_ctx" and "name_type_mask", it is inserted into the "dies"
|
|
/// vector.
|
|
bool ProcessFunctionDIE(llvm::StringRef name, DIERef ref,
|
|
SymbolFileDWARF &dwarf,
|
|
const CompilerDeclContext &parent_decl_ctx,
|
|
uint32_t name_type_mask,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback);
|
|
|
|
class DIERefCallbackImpl {
|
|
public:
|
|
DIERefCallbackImpl(const DWARFIndex &index,
|
|
llvm::function_ref<bool(DWARFDIE die)> callback,
|
|
llvm::StringRef name);
|
|
bool operator()(DIERef ref) const;
|
|
|
|
private:
|
|
const DWARFIndex &m_index;
|
|
SymbolFileDWARF &m_dwarf;
|
|
const llvm::function_ref<bool(DWARFDIE die)> m_callback;
|
|
const llvm::StringRef m_name;
|
|
};
|
|
DIERefCallbackImpl
|
|
DIERefCallback(llvm::function_ref<bool(DWARFDIE die)> callback,
|
|
llvm::StringRef name = {}) const {
|
|
return DIERefCallbackImpl(*this, callback, name);
|
|
}
|
|
|
|
void ReportInvalidDIERef(DIERef ref, llvm::StringRef name) const;
|
|
};
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFINDEX_H
|