lldb/source/Plugins/SymbolFile/DWARF/AppleDWARFIndex.h

   1 //===-- AppleDWARFIndex.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_SOURCE_PLUGINS_SYMBOLFILE_DWARF_APPLEDWARFINDEX_H
  10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_APPLEDWARFINDEX_H
  11
  12 #include "Plugins/SymbolFile/DWARF/DWARFIndex.h"
  13 #include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
  14
  15 namespace lldb_private::plugin {
  16 namespace dwarf {
  17 class AppleDWARFIndex : public DWARFIndex {
  18 public:
  19   static std::unique_ptr<AppleDWARFIndex>
  20   Create(Module &module, DWARFDataExtractor apple_names,
  21          DWARFDataExtractor apple_namespaces, DWARFDataExtractor apple_types,
  22          DWARFDataExtractor apple_objc, DWARFDataExtractor debug_str);
  23
  24   AppleDWARFIndex(Module &module,
  25                   std::unique_ptr<llvm::AppleAcceleratorTable> apple_names,
  26                   std::unique_ptr<llvm::AppleAcceleratorTable> apple_namespaces,
  27                   std::unique_ptr<llvm::AppleAcceleratorTable> apple_types,
  28                   std::unique_ptr<llvm::AppleAcceleratorTable> apple_objc,
  29                   lldb::DataBufferSP apple_names_storage,
  30                   lldb::DataBufferSP apple_namespaces_storage,
  31                   lldb::DataBufferSP apple_types_storage,
  32                   lldb::DataBufferSP apple_objc_storage)
  33       : DWARFIndex(module), m_apple_names_up(std::move(apple_names)),
  34         m_apple_namespaces_up(std::move(apple_namespaces)),
  35         m_apple_types_up(std::move(apple_types)),
  36         m_apple_objc_up(std::move(apple_objc)),
  37         m_apple_names_storage(apple_names_storage),
  38         m_apple_namespaces_storage(apple_namespaces_storage),
  39         m_apple_types_storage(apple_types_storage),
  40         m_apple_objc_storage(apple_objc_storage) {}
  41
  42   void Preload() override {}
  43
  44   void
  45   GetGlobalVariables(ConstString basename,
  46                      llvm::function_ref<bool(DWARFDIE die)> callback) override;
  47   void
  48   GetGlobalVariables(const RegularExpression &regex,
  49                      llvm::function_ref<bool(DWARFDIE die)> callback) override;
  50   void
  51   GetGlobalVariables(DWARFUnit &cu,
  52                      llvm::function_ref<bool(DWARFDIE die)> callback) override;
  53   void GetObjCMethods(ConstString class_name,
  54                       llvm::function_ref<bool(DWARFDIE die)> callback) override;
  55   void GetCompleteObjCClass(
  56       ConstString class_name, bool must_be_implementation,
  57       llvm::function_ref<bool(DWARFDIE die)> callback) override;
  58   void GetTypes(ConstString name,
  59                 llvm::function_ref<bool(DWARFDIE die)> callback) override;
  60   void GetTypes(const DWARFDeclContext &context,
  61                 llvm::function_ref<bool(DWARFDIE die)> callback) override;
  62   void GetNamespaces(ConstString name,
  63                      llvm::function_ref<bool(DWARFDIE die)> callback) override;
  64   void GetFunctions(const Module::LookupInfo &lookup_info,
  65                     SymbolFileDWARF &dwarf,
  66                     const CompilerDeclContext &parent_decl_ctx,
  67                     llvm::function_ref<bool(DWARFDIE die)> callback) override;
  68   void GetFunctions(const RegularExpression &regex,
  69                     llvm::function_ref<bool(DWARFDIE die)> callback) override;
  70
  71   void Dump(Stream &s) override;
  72
  73 private:
  74   std::unique_ptr<llvm::AppleAcceleratorTable> m_apple_names_up;
  75   std::unique_ptr<llvm::AppleAcceleratorTable> m_apple_namespaces_up;
  76   std::unique_ptr<llvm::AppleAcceleratorTable> m_apple_types_up;
  77   std::unique_ptr<llvm::AppleAcceleratorTable> m_apple_objc_up;
  78   /// The following storage variables hold the data that the apple accelerator
  79   /// tables tables above point to.
  80   /// {
  81   lldb::DataBufferSP m_apple_names_storage;
  82   lldb::DataBufferSP m_apple_namespaces_storage;
  83   lldb::DataBufferSP m_apple_types_storage;
  84   lldb::DataBufferSP m_apple_objc_storage;
  85   /// }
  86
  87   /// Search for entries whose name is `name` in `table`, calling `callback` for
  88   /// each match. If `search_for_tag` is provided, ignore entries whose tag is
  89   /// not `search_for_tag`. If `search_for_qualhash` is provided, ignore entries
  90   /// whose qualified name hash does not match `search_for_qualhash`.
  91   /// If `callback` returns false for an entry, the search is interrupted.
  92   void SearchFor(const llvm::AppleAcceleratorTable &table, llvm::StringRef name,
  93                  llvm::function_ref<bool(DWARFDIE die)> callback,
  94                  std::optional<dw_tag_t> search_for_tag = std::nullopt,
  95                  std::optional<uint32_t> search_for_qualhash = std::nullopt);
  96 };
  97 } // namespace dwarf
  98 } // namespace lldb_private::plugin
  99
 100 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_APPLEDWARFINDEX_H