binutils-gdb/gdb/dwarf2/abbrev-cache.h
Tom Tromey 3c8184c43d Add comments to dwarf2/abbrev-cache.h
This patch started when I noticed that the unordered_set include
wasn't needed in abbrev-cache.h.  (That was probably leftover from
some earlier implementation of the class.)  Then, I noticed that the
class itself was under-commented.  This patch fixes both issues.
2022-04-16 13:58:34 -06:00

67 lines
2.0 KiB
C++

/* DWARF abbrev table cache
Copyright (C) 2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef GDB_DWARF2_ABBREV_CACHE_H
#define GDB_DWARF2_ABBREV_CACHE_H
#include "dwarf2/abbrev.h"
#include "gdbtypes.h"
/* An abbrev cache holds abbrev tables for easier reuse. */
class abbrev_cache
{
public:
abbrev_cache ();
DISABLE_COPY_AND_ASSIGN (abbrev_cache);
/* Find an abbrev table coming from the abbrev section SECTION at
offset OFFSET. Return the table, or nullptr if it has not yet
been registered. */
abbrev_table *find (struct dwarf2_section_info *section, sect_offset offset)
{
search_key key = { section, offset };
return (abbrev_table *) htab_find_with_hash (m_tables.get (), &key,
to_underlying (offset));
}
/* Add TABLE to this cache. Ownership of TABLE is transferred to
the cache. Note that a table at a given section+offset may only
be registered once -- a violation of this will cause an assert.
To avoid this, call the 'find' method first, to see if the table
has already been read. */
void add (abbrev_table_up table);
private:
static hashval_t hash_table (const void *item);
static int eq_table (const void *lhs, const void *rhs);
struct search_key
{
struct dwarf2_section_info *section;
sect_offset offset;
};
/* Hash table of abbrev tables. */
htab_up m_tables;
};
#endif /* GDB_DWARF2_ABBREV_CACHE_H */