summaryrefslogtreecommitdiffstats
path: root/src/H5Iprivate.h
blob: 4d3e4ef512a4f720f39869efa05c05a934125907 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/****************************************************************************
 * 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>

/* 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
#define H5I_ATTRID_HASHSIZE         64
#define H5I_TEMPBUFID_HASHSIZE      64
#define H5I_RAGGED_HASHSIZE         64
#define H5I_REFID_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    */
    size_t      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) (void * obj, const void * key);

/* Private Functions in H5I.c */
__DLL__ intn H5I_init_group(H5I_type_t grp, size_t hash_size, uintn reserved,
			    herr_t (*free_func)(void *));
__DLL__ herr_t H5I_destroy_group(H5I_type_t grp);
__DLL__ hid_t H5I_register(H5I_type_t grp, void *object);
__DLL__ void *H5I_object(hid_t id);
__DLL__ H5I_type_t H5I_get_type(hid_t id);
__DLL__ void *H5I_remove(hid_t id);
__DLL__ void *H5I_search(H5I_type_t grp, H5I_search_func_t func,
			 const void *key);
__DLL__ intn H5I_dec_ref(hid_t id);
__DLL__ hid_t H5I_inc_ref(hid_t id);

#endif