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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Reference counting buffer algorithms.
*
* These are used for various internal buffers which are shared.
*
* The module used to be H5RC, but changed to H5UC because of
* conflicting requirement for the use of H5RC.
*
*/
#include "H5Eprivate.h" /* Error handling */
#include "H5FLprivate.h" /* Free lists */
#include "H5UCprivate.h" /* Reference-counted buffers */
/* Private typedefs & structs */
/* Declare a free list to manage the H5UC_t struct */
H5FL_DEFINE_STATIC(H5UC_t);
/*--------------------------------------------------------------------------
NAME
H5UC_create
PURPOSE
Create a reference counted object
USAGE
H5UC_t *H5UC_create(o,free)
const void *o; IN: Object to initialize ref-counted object with
H5UC_free_func_t free; IN: Function to call when ref-count drop to zero
RETURNS
Returns a pointer to a new ref-counted object on success, NULL on failure.
DESCRIPTION
Create a reference counted object. The object is not duplicated, it is
assumed to be owned by the reference counted object now and will be freed
with the 'free' function when the reference count drops to zero.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5UC_t *
H5UC_create(void *o, H5UC_free_func_t free_func)
{
H5UC_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI(NULL)
/* Sanity check */
assert(o);
assert(free_func);
/* Allocate ref-counted string structure */
if (NULL == (ret_value = H5FL_MALLOC(H5UC_t)))
HGOTO_ERROR(H5E_RS, H5E_NOSPACE, NULL, "memory allocation failed");
/* Set the internal fields */
ret_value->o = o;
ret_value->n = 1;
ret_value->free_func = free_func;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5UC_create() */
/*--------------------------------------------------------------------------
NAME
H5UC_decr
PURPOSE
Decrement the reference count for a ref-counted object
USAGE
herr_t H5UC_decr(rc)
H5UC_t *rc; IN: Ref-counted object to decrement count for
RETURNS
SUCCEED/FAIL
DESCRIPTION
Decrements the reference count for a ref-counted object, calling the
object's free function if ref-count drops to zero.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5UC_decr(H5UC_t *rc)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* Sanity check */
assert(rc);
assert(rc->o);
assert(rc->n > 0);
assert(rc->free_func);
/* Decrement reference count */
rc->n--;
/* Check if we should delete this object now */
if (rc->n == 0) {
if ((rc->free_func)(rc->o) < 0) {
rc = H5FL_FREE(H5UC_t, rc);
HGOTO_ERROR(H5E_RS, H5E_CANTFREE, FAIL, "memory release failed");
} /* end if */
rc = H5FL_FREE(H5UC_t, rc);
} /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5UC_decr() */
|
