xref: /illumos-gate/usr/src/lib/libdwarf/common/dwarf_dnames.h (revision 4d9fdb46)

/*
  Copyright (C) 2017-2017 David Anderson. All Rights Reserved.

  This program is free software; you can redistribute it and/or modify it
  under the terms of version 2.1 of the GNU Lesser General Public License
  as published by the Free Software Foundation.

  This program is distributed in the hope that it would be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  Further, this software is distributed without any warranty that it is
  free of the rightful claim of any third person regarding infringement
  or the like.  Any license provided herein, whether implied or
  otherwise, applies only to this software file.  Patent licenses, if
  any, provided herein do not apply to combinations of this program with
  other software, or any other product whatsoever.

  You should have received a copy of the GNU Lesser General Public
  License along with this program; if not, write the Free Software
  Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston MA 02110-1301,
  USA.

*/

/*  Only 5 abbrev DW_IDX defined, we
    allow three user defined (arbitrarily) */
#define ABB_PAIRS_MAX 8

struct abbrev_pair_s {
    unsigned ap_index;
    unsigned ap_form;
};

struct Dwarf_D_Abbrev_s {
    struct Dwarf_D_Abbrev_s * da_next;
    unsigned da_abbrev_code;
    unsigned da_tag;
    unsigned da_pairs_count;
    struct abbrev_pair_s da_pairs[ABB_PAIRS_MAX];
};


#define DWARF_DNAMES_VERSION5 5

struct Dwarf_Dnames_index_header_s {
    Dwarf_Debug    din_dbg;
    struct Dwarf_Dnames_index_header_s *din_next;

    /*  The .debug_names section offset of 1st byte
        of a header record. */
    Dwarf_Unsigned din_section_offset;

    /* For offset and pointer sanity calculations. */
    Dwarf_Small  * din_indextable_data;
    Dwarf_Unsigned din_indextable_length;
    unsigned       din_offset_size;

    Dwarf_Unsigned din_version;
    Dwarf_Unsigned din_comp_unit_count;
    Dwarf_Unsigned din_local_type_unit_count;
    Dwarf_Unsigned din_foreign_type_unit_count;
    Dwarf_Unsigned din_bucket_count;
    Dwarf_Unsigned din_name_count;
    Dwarf_Unsigned din_abbrev_table_size; /* bytes */
    Dwarf_Unsigned din_entry_pool_size;   /* bytes */

    Dwarf_Unsigned din_augmentation_string_size;

    /*  Since we cannot assume the string is NUL
        terminated we allocate a sufficient
        string space and NUL terminate the string.
        The DWARF5 standard does not specify
        it as null-terminated.  We copy it into
        calloc area so not 'const'  */
    char *   din_augmentation_string;

    Dwarf_Small *  din_cu_list;
    Dwarf_Small *  din_local_tu_list;
    Dwarf_Small *  din_foreign_tu_list;
    Dwarf_Small *  din_buckets;
    Dwarf_Small *  din_hash_table;
    Dwarf_Small *  din_string_offsets;
    Dwarf_Small *  din_entry_offsets;
    Dwarf_Small *  din_abbreviations;
    Dwarf_Small *  din_entry_pool;

    unsigned       din_abbrev_list_count;
    /* An array of size din_abbrev_list_count. */
    struct Dwarf_D_Abbrev_s * din_abbrev_list;

};


struct Dwarf_Dnames_Head_s {
    Dwarf_Debug               dn_dbg;
    Dwarf_Small             * dn_section_data;
    Dwarf_Small             * dn_section_end;
    Dwarf_Unsigned            dn_section_size;
    unsigned                  dn_inhdr_count;

    /*  Becomes an array of these structs, dn_inhdr_count
        of them. */
    struct Dwarf_Dnames_index_header_s * dn_inhdr_first;
};

void _dwarf_debugnames_destructor(void *m);