summaryrefslogtreecommitdiffstats
path: root/src/H5Iprivate.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5Iprivate.h')
-rw-r--r--src/H5Iprivate.h107
1 files changed, 107 insertions, 0 deletions
diff --git a/src/H5Iprivate.h b/src/H5Iprivate.h
new file mode 100644
index 0000000..c339390
--- /dev/null
+++ b/src/H5Iprivate.h
@@ -0,0 +1,107 @@
+/****************************************************************************
+ * NCSA HDF *
+ * Software Development Group *
+ * National Center for Supercomputing Applications *
+ * University of Illinois at Urbana-Champaign *
+ * 605 E. Springfield, Champaign IL 61820 *
+ * *
+ * For conditions of distribution and use, see the accompanying *
+ * hdf/COPYING file. *
+ * *
+ ****************************************************************************/
+
+/*-----------------------------------------------------------------------------
+ * File: H5Iprivate.h
+ * Purpose: header file for ID API
+ *---------------------------------------------------------------------------*/
+
+/* avoid re-inclusion */
+#ifndef _H5Iprivate_H
+#define _H5Iprivate_H
+
+#include <H5Ipublic.h> /*include Public Definitions */
+
+/* Private headers needed by this file */
+#include <H5private.h>
+
+/* ID Feature controls */
+
+/*
+ * Define the following macro for fast hash calculations (but limited
+ * hash sizes)
+ */
+#define HASH_SIZE_POWER_2
+
+/* Define the following macro for atom caching over all the atoms */
+#define IDS_ARE_CACHED
+
+#ifdef IDS_ARE_CACHED
+# define ID_CACHE_SIZE 4 /*# of previous atoms cached */
+#endif
+
+/* Map an atom to a Group number */
+#define ID_TO_GROUP(a) ((H5I_group_t)((((hid_t)(a))>> \
+ ((sizeof(hid_t)*8)-GROUP_BITS))&GROUP_MASK))
+
+#ifdef HASH_SIZE_POWER_2
+
+/*
+ * Map an ID to a hash location (assumes s is a power of 2 and smaller
+ * than the ID_MASK constant).
+ */
+# define ID_TO_LOC(a,s) ((hid_t)(a)&((s)-1))
+#else
+
+/*
+ * Map an ID to a hash location.
+ */
+# define ID_TO_LOC(a,s) (((hid_t)(a)&ID_MASK)%(s))
+#endif
+
+/* Default sizes of the hash-tables for various atom groups */
+#define H5I_ERRSTACK_HASHSIZE 64
+#define H5I_FILEID_HASHSIZE 64
+#define H5I_TEMPID_HASHSIZE 64
+#define H5I_DATATYPEID_HASHSIZE 64
+#define H5I_DATASPACEID_HASHSIZE 64
+#define H5I_DATASETID_HASHSIZE 64
+#define H5I_OID_HASHSIZE 64
+#define H5I_GROUPID_HASHSIZE 64
+
+/* Atom information structure used */
+typedef struct H5I_id_info_t {
+ hid_t id; /* ID for this info */
+ uintn count; /* ref. count for this atom */
+ void *obj_ptr; /* pointer associated with the atom */
+ struct H5I_id_info_t *next; /* link to next atom (in case of hash-clash)*/
+} H5I_id_info_t;
+
+/* ID group structure used */
+typedef struct {
+ uintn count; /*# of times this group has been initialized */
+ uintn reserved; /*# of IDs to reserve for constant IDs */
+ uintn wrapped; /*whether the id count has wrapped around */
+ intn hash_size; /*sizeof the hash table to store the IDs in*/
+ uintn ids; /*current number of IDs held */
+ uintn nextid; /*ID to use for the next atom */
+ herr_t (*free_func)(void*);/*func to call to release object */
+ H5I_id_info_t **id_list; /*pointer to an array of ptrs to IDs */
+} H5I_id_group_t;
+
+/* Type of the function to compare objects & keys */
+typedef intn (*H5I_search_func_t) (const void * obj, const void * key);
+
+/* Private Functions in H5I.c */
+intn H5I_init_group (H5I_group_t grp, intn hash_size, uintn reserved,
+ herr_t (*free_func)(void *));
+herr_t H5I_destroy_group (H5I_group_t grp);
+hid_t H5I_register (H5I_group_t grp, void *object);
+void *H5I_object (hid_t id);
+H5I_group_t H5I_group (hid_t id);
+void *H5I_remove (hid_t id);
+void *H5I_search (H5I_group_t grp, H5I_search_func_t func, const void *key);
+void H5I_term_interface (void);
+intn H5I_dec_ref (hid_t id);
+hid_t H5I_inc_ref (hid_t id);
+
+#endif