[binutils-gdb] Introduce gdb-hashtab module in gdbsupport

[binutils-gdb] Introduce gdb-hashtab module in gdbsupport

[Tom Tromey]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=0589ca4e7ba9b8d60599706b57be22c007c1f4fa

commit 0589ca4e7ba9b8d60599706b57be22c007c1f4fa
Author: Tom Tromey <tom@tromey.com>
Date:   Tue Dec 21 16:48:38 2021 -0700

    Introduce gdb-hashtab module in gdbsupport
    
    gdb has some extensions and helpers for working with the libiberty
    hash table.  This patch consolidates these and moves them to
    gdbsupport.

Diff:
---
 gdb/compile/compile-internal.h |  1 +
 gdb/completer.h                |  1 +
 gdb/filename-seen-cache.h      |  1 +
 gdb/gdbtypes.h                 |  1 +
 gdb/utils.c                    | 24 --------------------
 gdb/utils.h                    | 26 ----------------------
 gdbsupport/Makefile.am         |  1 +
 gdbsupport/Makefile.in         | 20 +++++++++--------
 gdbsupport/gdb-hashtab.cc      | 44 +++++++++++++++++++++++++++++++++++++
 gdbsupport/gdb-hashtab.h       | 50 ++++++++++++++++++++++++++++++++++++++++++
 10 files changed, 110 insertions(+), 59 deletions(-)

diff --git a/gdb/compile/compile-internal.h b/gdb/compile/compile-internal.h
index 92efd511075..042ddf9c5f9 100644
--- a/gdb/compile/compile-internal.h
+++ b/gdb/compile/compile-internal.h
@@ -18,6 +18,7 @@
 #define COMPILE_COMPILE_INTERNAL_H
 
 #include "gcc-c-interface.h"
+#include "gdbsupport/gdb-hashtab.h"
 
 /* Debugging flag for the "compile" family of commands.  */
 
diff --git a/gdb/completer.h b/gdb/completer.h
index 93125e4c54c..78e5240a95e 100644
--- a/gdb/completer.h
+++ b/gdb/completer.h
@@ -17,6 +17,7 @@
 #if !defined (COMPLETER_H)
 #define COMPLETER_H 1
 
+#include "gdbsupport/gdb-hashtab.h"
 #include "gdbsupport/gdb_vecs.h"
 #include "command.h"
 
diff --git a/gdb/filename-seen-cache.h b/gdb/filename-seen-cache.h
index 09529031973..83a6e8a6258 100644
--- a/gdb/filename-seen-cache.h
+++ b/gdb/filename-seen-cache.h
@@ -22,6 +22,7 @@
 
 #include "defs.h"
 #include "gdbsupport/function-view.h"
+#include "gdbsupport/gdb-hashtab.h"
 
 /* Cache to watch for file names already seen.  */
 
diff --git a/gdb/gdbtypes.h b/gdb/gdbtypes.h
index 467f60975e1..7238873e4db 100644
--- a/gdb/gdbtypes.h
+++ b/gdb/gdbtypes.h
@@ -46,6 +46,7 @@
 
 #include "hashtab.h"
 #include "gdbsupport/array-view.h"
+#include "gdbsupport/gdb-hashtab.h"
 #include "gdbsupport/gdb_optional.h"
 #include "gdbsupport/offset-type.h"
 #include "gdbsupport/enum-flags.h"
diff --git a/gdb/utils.c b/gdb/utils.c
index 0be49a6d4f8..bda3b7b5f0d 100644
--- a/gdb/utils.c
+++ b/gdb/utils.c
@@ -2841,30 +2841,6 @@ gdb_argv_as_array_view_test ()
 
 #endif /* GDB_SELF_TEST */
 
-/* Allocation function for the libiberty hash table which uses an
-   obstack.  The obstack is passed as DATA.  */
-
-void *
-hashtab_obstack_allocate (void *data, size_t size, size_t count)
-{
-  size_t total = size * count;
-  void *ptr = obstack_alloc ((struct obstack *) data, total);
-
-  memset (ptr, 0, total);
-  return ptr;
-}
-
-/* Trivial deallocation function for the libiberty splay tree and hash
-   table - don't deallocate anything.  Rely on later deletion of the
-   obstack.  DATA will be the obstack, although it is not needed
-   here.  */
-
-void
-dummy_obstack_deallocate (void *object, void *data)
-{
-  return;
-}
-
 /* Simple, portable version of dirname that does not modify its
    argument.  */
 
diff --git a/gdb/utils.h b/gdb/utils.h
index 5ac34eb41a9..8e9c2049915 100644
--- a/gdb/utils.h
+++ b/gdb/utils.h
@@ -123,27 +123,6 @@ extern int parse_escape (struct gdbarch *, const char **);
 \f
 /* Cleanup utilities.  */
 
-/* A deleter for a hash table.  */
-struct htab_deleter
-{
-  void operator() (htab *ptr) const
-  {
-    htab_delete (ptr);
-  }
-};
-
-/* A unique_ptr wrapper for htab_t.  */
-typedef std::unique_ptr<htab, htab_deleter> htab_up;
-
-/* A wrapper for 'delete' that can used as a hash table entry deletion
-   function.  */
-template<typename T>
-void
-htab_delete_entry (void *ptr)
-{
-  delete (T *) ptr;
-}
-
 extern void init_page_info (void);
 
 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
@@ -384,11 +363,6 @@ extern void demangler_warning (const char *file, int line,
 \f
 /* Misc. utilities.  */
 
-/* Allocation and deallocation functions for the libiberty hash table
-   which use obstacks.  */
-void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
-void dummy_obstack_deallocate (void *object, void *data);
-
 #ifdef HAVE_WAITPID
 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 #endif
diff --git a/gdbsupport/Makefile.am b/gdbsupport/Makefile.am
index 73d4149f294..9e4334891b5 100644
--- a/gdbsupport/Makefile.am
+++ b/gdbsupport/Makefile.am
@@ -52,6 +52,7 @@ libgdbsupport_a_SOURCES = \
     filestuff.cc \
     format.cc \
     gdb-dlfcn.cc \
+    gdb-hashtab.cc \
     gdb_obstack.cc \
     gdb_tilde_expand.cc \
     gdb_wait.cc \
diff --git a/gdbsupport/Makefile.in b/gdbsupport/Makefile.in
index 88d3dd153d6..59e1dfedd8b 100644
--- a/gdbsupport/Makefile.in
+++ b/gdbsupport/Makefile.in
@@ -151,15 +151,15 @@ am_libgdbsupport_a_OBJECTS = agent.$(OBJEXT) btrace-common.$(OBJEXT) \
 	common-regcache.$(OBJEXT) common-utils.$(OBJEXT) \
 	environ.$(OBJEXT) errors.$(OBJEXT) event-loop.$(OBJEXT) \
 	fileio.$(OBJEXT) filestuff.$(OBJEXT) format.$(OBJEXT) \
-	gdb-dlfcn.$(OBJEXT) gdb_obstack.$(OBJEXT) \
-	gdb_tilde_expand.$(OBJEXT) gdb_wait.$(OBJEXT) \
-	gdb_vecs.$(OBJEXT) job-control.$(OBJEXT) netstuff.$(OBJEXT) \
-	new-op.$(OBJEXT) pathstuff.$(OBJEXT) print-utils.$(OBJEXT) \
-	ptid.$(OBJEXT) rsp-low.$(OBJEXT) run-time-clock.$(OBJEXT) \
-	safe-strerror.$(OBJEXT) scoped_mmap.$(OBJEXT) search.$(OBJEXT) \
-	signals.$(OBJEXT) signals-state-save-restore.$(OBJEXT) \
-	tdesc.$(OBJEXT) thread-pool.$(OBJEXT) xml-utils.$(OBJEXT) \
-	$(am__objects_1)
+	gdb-dlfcn.$(OBJEXT) gdb-hashtab.$(OBJEXT) \
+	gdb_obstack.$(OBJEXT) gdb_tilde_expand.$(OBJEXT) \
+	gdb_wait.$(OBJEXT) gdb_vecs.$(OBJEXT) job-control.$(OBJEXT) \
+	netstuff.$(OBJEXT) new-op.$(OBJEXT) pathstuff.$(OBJEXT) \
+	print-utils.$(OBJEXT) ptid.$(OBJEXT) rsp-low.$(OBJEXT) \
+	run-time-clock.$(OBJEXT) safe-strerror.$(OBJEXT) \
+	scoped_mmap.$(OBJEXT) search.$(OBJEXT) signals.$(OBJEXT) \
+	signals-state-save-restore.$(OBJEXT) tdesc.$(OBJEXT) \
+	thread-pool.$(OBJEXT) xml-utils.$(OBJEXT) $(am__objects_1)
 libgdbsupport_a_OBJECTS = $(am_libgdbsupport_a_OBJECTS)
 AM_V_P = $(am__v_P_@AM_V@)
 am__v_P_ = $(am__v_P_@AM_DEFAULT_V@)
@@ -377,6 +377,7 @@ libgdbsupport_a_SOURCES = \
     filestuff.cc \
     format.cc \
     gdb-dlfcn.cc \
+    gdb-hashtab.cc \
     gdb_obstack.cc \
     gdb_tilde_expand.cc \
     gdb_wait.cc \
@@ -483,6 +484,7 @@ distclean-compile:
 @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/filestuff.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/format.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gdb-dlfcn.Po@am__quote@
+@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gdb-hashtab.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gdb_obstack.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gdb_tilde_expand.Po@am__quote@
 @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gdb_vecs.Po@am__quote@
diff --git a/gdbsupport/gdb-hashtab.cc b/gdbsupport/gdb-hashtab.cc
new file mode 100644
index 00000000000..c42e8fec7b7
--- /dev/null
+++ b/gdbsupport/gdb-hashtab.cc
@@ -0,0 +1,44 @@
+/* Hash table wrappers for gdb.
+   Copyright (C) 2021 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/>.  */
+
+#include "common-defs.h"
+#include "gdb-hashtab.h"
+
+/* Allocation function for the libiberty hash table which uses an
+   obstack.  The obstack is passed as DATA.  */
+
+void *
+hashtab_obstack_allocate (void *data, size_t size, size_t count)
+{
+  size_t total = size * count;
+  void *ptr = obstack_alloc ((struct obstack *) data, total);
+
+  memset (ptr, 0, total);
+  return ptr;
+}
+
+/* Trivial deallocation function for the libiberty splay tree and hash
+   table - don't deallocate anything.  Rely on later deletion of the
+   obstack.  DATA will be the obstack, although it is not needed
+   here.  */
+
+void
+dummy_obstack_deallocate (void *object, void *data)
+{
+  return;
+}
diff --git a/gdbsupport/gdb-hashtab.h b/gdbsupport/gdb-hashtab.h
new file mode 100644
index 00000000000..65c2dc59a79
--- /dev/null
+++ b/gdbsupport/gdb-hashtab.h
@@ -0,0 +1,50 @@
+/* Hash table wrappers for gdb.
+   Copyright (C) 2021 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 GDBSUPPORT_GDB_HASHTAB_H
+#define GDBSUPPORT_GDB_HASHTAB_H
+
+#include "hashtab.h"
+
+/* A deleter for a hash table.  */
+struct htab_deleter
+{
+  void operator() (htab *ptr) const
+  {
+    htab_delete (ptr);
+  }
+};
+
+/* A unique_ptr wrapper for htab_t.  */
+typedef std::unique_ptr<htab, htab_deleter> htab_up;
+
+/* A wrapper for 'delete' that can used as a hash table entry deletion
+   function.  */
+template<typename T>
+void
+htab_delete_entry (void *ptr)
+{
+  delete (T *) ptr;
+}
+
+/* Allocation and deallocation functions for the libiberty hash table
+   which use obstacks.  */
+void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
+void dummy_obstack_deallocate (void *object, void *data);
+
+#endif /* GDBSUPPORT_GDB_HASHTAB_H */