//===-- DWARFDebugInfoEntry.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 SymbolFileDWARF_DWARFDebugInfoEntry_h_
#define SymbolFileDWARF_DWARFDebugInfoEntry_h_

#include "SymbolFileDWARF.h"
#include "llvm/ADT/SmallVector.h"

#include "DWARFAbbreviationDeclaration.h"
#include "DWARFDebugAbbrev.h"
#include "DWARFDebugRanges.h"
#include <map>
#include <set>
#include <vector>

typedef std::map<const DWARFDebugInfoEntry *, dw_addr_t> DIEToAddressMap;
typedef DIEToAddressMap::iterator DIEToAddressMapIter;
typedef DIEToAddressMap::const_iterator DIEToAddressMapConstIter;

typedef std::map<dw_addr_t, const DWARFDebugInfoEntry *> AddressToDIEMap;
typedef AddressToDIEMap::iterator AddressToDIEMapIter;
typedef AddressToDIEMap::const_iterator AddressToDIEMapConstIter;

typedef std::map<dw_offset_t, dw_offset_t> DIEToDIEMap;
typedef DIEToDIEMap::iterator DIEToDIEMapIter;
typedef DIEToDIEMap::const_iterator DIEToDIEMapConstIter;

typedef std::map<uint32_t, const DWARFDebugInfoEntry *> UInt32ToDIEMap;
typedef UInt32ToDIEMap::iterator UInt32ToDIEMapIter;
typedef UInt32ToDIEMap::const_iterator UInt32ToDIEMapConstIter;

typedef std::multimap<uint32_t, const DWARFDebugInfoEntry *> UInt32ToDIEMMap;
typedef UInt32ToDIEMMap::iterator UInt32ToDIEMMapIter;
typedef UInt32ToDIEMMap::const_iterator UInt32ToDIEMMapConstIter;

class DWARFDeclContext;

#define DIE_SIBLING_IDX_BITSIZE 31

class DWARFDebugInfoEntry {
public:
  typedef std::vector<DWARFDebugInfoEntry> collection;
  typedef collection::iterator iterator;
  typedef collection::const_iterator const_iterator;

  typedef std::vector<dw_offset_t> offset_collection;
  typedef offset_collection::iterator offset_collection_iterator;
  typedef offset_collection::const_iterator offset_collection_const_iterator;

  DWARFDebugInfoEntry()
      : m_offset(DW_INVALID_OFFSET), m_parent_idx(0), m_sibling_idx(0),
        m_has_children(false), m_abbr_idx(0), m_tag(0) {}

  explicit operator bool() const { return m_offset != DW_INVALID_OFFSET; }
  bool operator==(const DWARFDebugInfoEntry &rhs) const;
  bool operator!=(const DWARFDebugInfoEntry &rhs) const;

  void BuildAddressRangeTable(SymbolFileDWARF *dwarf2Data,
                              const DWARFUnit *cu,
                              DWARFDebugAranges *debug_aranges) const;

  void BuildFunctionAddressRangeTable(SymbolFileDWARF *dwarf2Data,
                                      const DWARFUnit *cu,
                                      DWARFDebugAranges *debug_aranges) const;

  bool FastExtract(const lldb_private::DWARFDataExtractor &debug_info_data,
                   const DWARFUnit *cu,
                   const DWARFFormValue::FixedFormSizes &fixed_form_sizes,
                   lldb::offset_t *offset_ptr);

  bool Extract(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
               lldb::offset_t *offset_ptr);

  bool LookupAddress(const dw_addr_t address, SymbolFileDWARF *dwarf2Data,
                     const DWARFUnit *cu,
                     DWARFDebugInfoEntry **function_die,
                     DWARFDebugInfoEntry **block_die);

  size_t GetAttributes(const DWARFUnit *cu,
                       DWARFFormValue::FixedFormSizes fixed_form_sizes,
                       DWARFAttributes &attrs,
                       uint32_t curr_depth = 0)
      const; // "curr_depth" for internal use only, don't set this yourself!!!

  dw_offset_t
  GetAttributeValue(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
                    const dw_attr_t attr, DWARFFormValue &formValue,
                    dw_offset_t *end_attr_offset_ptr = nullptr,
                    bool check_specification_or_abstract_origin = false) const;

  const char *GetAttributeValueAsString(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
      const dw_attr_t attr, const char *fail_value,
      bool check_specification_or_abstract_origin = false) const;

  uint64_t GetAttributeValueAsUnsigned(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
      const dw_attr_t attr, uint64_t fail_value,
      bool check_specification_or_abstract_origin = false) const;

  uint64_t GetAttributeValueAsReference(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
      const dw_attr_t attr, uint64_t fail_value,
      bool check_specification_or_abstract_origin = false) const;

  int64_t GetAttributeValueAsSigned(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
      const dw_attr_t attr, int64_t fail_value,
      bool check_specification_or_abstract_origin = false) const;

  uint64_t GetAttributeValueAsAddress(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
      const dw_attr_t attr, uint64_t fail_value,
      bool check_specification_or_abstract_origin = false) const;

  dw_addr_t
  GetAttributeHighPC(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
                     dw_addr_t lo_pc, uint64_t fail_value,
                     bool check_specification_or_abstract_origin = false) const;

  bool GetAttributeAddressRange(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu, dw_addr_t &lo_pc,
      dw_addr_t &hi_pc, uint64_t fail_value,
      bool check_specification_or_abstract_origin = false) const;

  size_t GetAttributeAddressRanges(
      SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
      DWARFRangeList &ranges, bool check_hi_lo_pc,
      bool check_specification_or_abstract_origin = false) const;

  const char *GetName(SymbolFileDWARF *dwarf2Data,
                      const DWARFUnit *cu) const;

  const char *GetMangledName(SymbolFileDWARF *dwarf2Data,
                             const DWARFUnit *cu,
                             bool substitute_name_allowed = true) const;

  const char *GetPubname(SymbolFileDWARF *dwarf2Data,
                         const DWARFUnit *cu) const;

  static bool GetName(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
                      const dw_offset_t die_offset, lldb_private::Stream &s);

  static bool AppendTypeName(SymbolFileDWARF *dwarf2Data,
                             const DWARFUnit *cu,
                             const dw_offset_t die_offset,
                             lldb_private::Stream &s);

  const char *GetQualifiedName(SymbolFileDWARF *dwarf2Data,
                               DWARFUnit *cu,
                               std::string &storage) const;

  const char *GetQualifiedName(SymbolFileDWARF *dwarf2Data,
                               DWARFUnit *cu,
                               const DWARFAttributes &attributes,
                               std::string &storage) const;

  static bool OffsetLessThan(const DWARFDebugInfoEntry &a,
                             const DWARFDebugInfoEntry &b);

  void Dump(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
            lldb_private::Stream &s, uint32_t recurse_depth) const;

  void DumpAncestry(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
                    const DWARFDebugInfoEntry *oldest, lldb_private::Stream &s,
                    uint32_t recurse_depth) const;

  static void
  DumpAttribute(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
                const lldb_private::DWARFDataExtractor &debug_info_data,
                lldb::offset_t *offset_ptr, lldb_private::Stream &s,
                dw_attr_t attr, DWARFFormValue &form_value);
  // This one dumps the comp unit name, objfile name and die offset for this die
  // so the stream S.
  void DumpLocation(SymbolFileDWARF *dwarf2Data, DWARFUnit *cu,
                    lldb_private::Stream &s) const;

  bool
  GetDIENamesAndRanges(SymbolFileDWARF *dwarf2Data, const DWARFUnit *cu,
                       const char *&name, const char *&mangled,
                       DWARFRangeList &rangeList, int &decl_file,
                       int &decl_line, int &decl_column, int &call_file,
                       int &call_line, int &call_column,
                       lldb_private::DWARFExpression *frame_base = NULL) const;

  const DWARFAbbreviationDeclaration *
  GetAbbreviationDeclarationPtr(SymbolFileDWARF *dwarf2Data,
                                const DWARFUnit *cu,
                                lldb::offset_t &offset) const;

  dw_tag_t Tag() const { return m_tag; }

  bool IsNULL() const { return m_abbr_idx == 0; }

  dw_offset_t GetOffset() const { return m_offset; }

  bool HasChildren() const { return m_has_children; }

  void SetHasChildren(bool b) { m_has_children = b; }

  // We know we are kept in a vector of contiguous entries, so we know
  // our parent will be some index behind "this".
  DWARFDebugInfoEntry *GetParent() {
    return m_parent_idx > 0 ? this - m_parent_idx : NULL;
  }
  const DWARFDebugInfoEntry *GetParent() const {
    return m_parent_idx > 0 ? this - m_parent_idx : NULL;
  }
  // We know we are kept in a vector of contiguous entries, so we know
  // our sibling will be some index after "this".
  DWARFDebugInfoEntry *GetSibling() {
    return m_sibling_idx > 0 ? this + m_sibling_idx : NULL;
  }
  const DWARFDebugInfoEntry *GetSibling() const {
    return m_sibling_idx > 0 ? this + m_sibling_idx : NULL;
  }
  // We know we are kept in a vector of contiguous entries, so we know
  // we don't need to store our child pointer, if we have a child it will
  // be the next entry in the list...
  DWARFDebugInfoEntry *GetFirstChild() {
    return HasChildren() ? this + 1 : NULL;
  }
  const DWARFDebugInfoEntry *GetFirstChild() const {
    return HasChildren() ? this + 1 : NULL;
  }

  void GetDeclContextDIEs(DWARFUnit *cu,
                          DWARFDIECollection &decl_context_dies) const;

  void GetDWARFDeclContext(SymbolFileDWARF *dwarf2Data, DWARFUnit *cu,
                           DWARFDeclContext &dwarf_decl_ctx) const;

  bool MatchesDWARFDeclContext(SymbolFileDWARF *dwarf2Data,
                               DWARFUnit *cu,
                               const DWARFDeclContext &dwarf_decl_ctx) const;

  DWARFDIE GetParentDeclContextDIE(SymbolFileDWARF *dwarf2Data,
                                   DWARFUnit *cu) const;
  DWARFDIE GetParentDeclContextDIE(SymbolFileDWARF *dwarf2Data,
                                   DWARFUnit *cu,
                                   const DWARFAttributes &attributes) const;

  void SetParent(DWARFDebugInfoEntry *parent) {
    if (parent) {
      // We know we are kept in a vector of contiguous entries, so we know
      // our parent will be some index behind "this".
      m_parent_idx = this - parent;
    } else
      m_parent_idx = 0;
  }
  void SetSibling(DWARFDebugInfoEntry *sibling) {
    if (sibling) {
      // We know we are kept in a vector of contiguous entries, so we know
      // our sibling will be some index after "this".
      m_sibling_idx = sibling - this;
      sibling->SetParent(GetParent());
    } else
      m_sibling_idx = 0;
  }

  void SetSiblingIndex(uint32_t idx) { m_sibling_idx = idx; }

  void SetParentIndex(uint32_t idx) { m_parent_idx = idx; }

  static void
  DumpDIECollection(lldb_private::Stream &strm,
                    DWARFDebugInfoEntry::collection &die_collection);

protected:
  dw_offset_t
      m_offset; // Offset within the .debug_info of the start of this entry
  uint32_t m_parent_idx; // How many to subtract from "this" to get the parent.
                         // If zero this die has no parent
  uint32_t m_sibling_idx : 31, // How many to add to "this" to get the sibling.
      // If it is zero, then the DIE doesn't have children, or the
      // DWARF claimed it had children but the DIE only contained
      // a single NULL terminating child.
      m_has_children : 1;
  uint16_t m_abbr_idx;
  uint16_t m_tag; // A copy of the DW_TAG value so we don't have to go through
                  // the compile unit abbrev table
};

#endif // SymbolFileDWARF_DWARFDebugInfoEntry_h_
