Brings hash table IDs feature from develop/1.12 (#768)

* Brings updated tid test from develop

* Adds empty H5Iint.c and H5Idbg.c files

* H5I renaming to match 1.12/develop

* Splits off H5I debug code to H5Idbg.c

* Splits internal H5I.c functionality to H5Iint.c

* Header cleanup

* More renaming cleanup to match develop/1.12

* Adds "save last ID" optimization

* Adds uthash.h

* Adds hash table IDs from develop/1.12

* Committing clang-format changes

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

1 files changed, 55 insertions, 4 deletions

diff --git a/src/H5Ipkg.h b/src/H5Ipkg.h
index 425308f..1bcea26 100644
--- a/src/H5Ipkg.h
+++ b/src/H5Ipkg.h
@@ -29,14 +29,21 @@
 /* Get package's private header */
 #include "H5Iprivate.h"
 
-/* Other private headers needed by this file */
+/* uthash is an external, header-only hash table implementation.
+ *
+ * We include the file directly in src/ and #define a few functions
+ * to use our internal memory calls.
+ */
+#define uthash_malloc(sz)    H5MM_malloc(sz)
+#define uthash_free(ptr, sz) H5MM_free(ptr) /* Ignoring sz is intentional */
+#include "uthash.h"
 
 /**************************/
 /* Package Private Macros */
 /**************************/
 
 /*
- * Number of bits to use for ID Type in each atom. Increase if more types
+ * Number of bits to use for ID Type in each ID. Increase if more types
  * are needed (though this will decrease the number of available IDs per
  * type). This is the only number that must be changed since all other bit
  * field sizes and masks are calculated from TYPE_BITS.
@@ -47,23 +54,67 @@
 #define H5I_MAX_NUM_TYPES TYPE_MASK
 
 /*
- * Number of bits to use for the Atom index in each atom (assumes 8-bit
+ * Number of bits to use for the ID index in each ID (assumes 8-bit
  * bytes). We don't use the sign bit.
  */
 #define ID_BITS ((sizeof(hid_t) * 8) - (TYPE_BITS + 1))
 #define ID_MASK (((hid_t)1 << ID_BITS) - 1)
 
-/* Map an atom to an ID type number */
+/* Map an ID to an ID type number */
 #define H5I_TYPE(a) ((H5I_type_t)(((hid_t)(a) >> ID_BITS) & TYPE_MASK))
 
 /****************************/
 /* Package Private Typedefs */
 /****************************/
 
+/* ID information structure used */
+typedef struct H5I_id_info_t {
+    hid_t       id;        /* ID for this info */
+    unsigned    count;     /* Ref. count for this ID */
+    unsigned    app_count; /* Ref. count of application visible IDs */
+    const void *object;    /* Pointer associated with the ID */
+
+    /* Hash table ID fields */
+    hbool_t        marked; /* Marked for deletion */
+    UT_hash_handle hh;     /* Hash table handle (must be LAST) */
+} H5I_id_info_t;
+
+/* Type information structure used */
+typedef struct H5I_type_info_t {
+    const H5I_class_t *cls;          /* Pointer to ID class */
+    unsigned           init_count;   /* # of times this type has been initialized */
+    uint64_t           id_count;     /* Current number of IDs held */
+    uint64_t           nextid;       /* ID to use for the next object */
+    H5I_id_info_t *    last_id_info; /* Info for most recent ID looked up */
+    H5I_id_info_t *    hash_table;   /* Hash table pointer for this ID type */
+} H5I_type_info_t;
+
+/*****************************/
+/* Package Private Variables */
+/*****************************/
+
+/* Array of pointers to ID types */
+H5_DLLVAR H5I_type_info_t *H5I_type_info_array_g[H5I_MAX_NUM_TYPES];
+
+/* Variable to keep track of the number of types allocated.  Its value is the
+ * next type ID to be handed out, so it is always one greater than the number
+ * of types.
+ * Starts at 1 instead of 0 because it makes trace output look nicer.  If more
+ * types (or IDs within a type) are needed, adjust TYPE_BITS in H5Ipkg.h
+ * and/or increase size of hid_t
+ */
+H5_DLLVAR int H5I_next_type_g;
+
 /******************************/
 /* Package Private Prototypes */
 /******************************/
 
+H5_DLL int   H5I__destroy_type(H5I_type_t type);
+H5_DLL void *H5I__remove_verify(hid_t id, H5I_type_t type);
+H5_DLL int   H5I__inc_type_ref(H5I_type_t type);
+H5_DLL int   H5I__get_type_ref(H5I_type_t type);
+H5_DLL H5I_id_info_t *H5I__find_id(hid_t id);
+
 /* Testing functions */
 #ifdef H5I_TESTING
 H5_DLL ssize_t H5I__get_name_test(hid_t id, char *name /*out*/, size_t size, hbool_t *cached);