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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
/****************************************************************************
* 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. *
* *
****************************************************************************/
/*
* Reference counted string algorithms.
*
* These are used for various internal strings which get copied multiple times.
*
*/
#include "H5Eprivate.h" /* Error handling */
#include "H5FLprivate.h" /* Free lists */
#include "H5RSprivate.h" /* Reference-counted strings */
#define PABLO_MASK H5RS_mask
/* Interface initialization */
static int interface_initialize_g = 0;
#define INTERFACE_INIT NULL
/* Declare a free list to manage the H5RS_str_t struct */
H5FL_DEFINE_STATIC(H5RS_str_t);
/* Declare the PQ free list for the wrapped strings */
H5FL_BLK_DEFINE(str_buf);
/*--------------------------------------------------------------------------
NAME
H5RS_xstrdup
PURPOSE
Duplicate the string being reference counted
USAGE
char *H5RS_xstrdup(s)
const char *s; IN: String to duplicate
RETURNS
Returns a pointer to a new string on success, NULL on failure.
DESCRIPTION
Duplicate a string buffer being reference counted. Use this instead of
[H5MM_][x]strdup, in order to use the free-list memory routines.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static char *
H5RS_xstrdup(const char *s)
{
char *ret_value; /* Return value */
FUNC_ENTER_NOINIT(H5RS_xstrdup);
if (s) {
ret_value = H5FL_BLK_MALLOC(str_buf,HDstrlen(s) + 1);
assert (ret_value);
HDstrcpy(ret_value, s);
} /* end if */
else
ret_value=NULL;
FUNC_LEAVE(ret_value);
} /* end H5RS_xstrdup() */
/*--------------------------------------------------------------------------
NAME
H5RS_create
PURPOSE
Create a reference counted string
USAGE
H5RS_str_t *H5RS_create(s)
const char *s; IN: String to initialize ref-counted string with
RETURNS
Returns a pointer to a new ref-counted string on success, NULL on failure.
DESCRIPTION
Create a reference counted string. The string passed in is copied into an
internal buffer.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5RS_str_t *
H5RS_create(const char *s)
{
H5RS_str_t *ret_value=NULL; /* Return value */
FUNC_ENTER_NOAPI(H5RS_create,NULL);
/* Allocate ref-counted string structure */
if((ret_value=H5FL_MALLOC(H5RS_str_t))==NULL)
HGOTO_ERROR(H5E_RS,H5E_NOSPACE,NULL,"memory allocation failed");
/* Set the internal fields */
ret_value->s=H5RS_xstrdup(s);
ret_value->wrapped=0;
ret_value->n=1;
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_create() */
/*--------------------------------------------------------------------------
NAME
H5RS_wrap
PURPOSE
"Wrap" a reference counted string around an existing string
USAGE
H5RS_str_t *H5RS_wrap(s)
const char *s; IN: String to wrap ref-counted string around
RETURNS
Returns a pointer to a new ref-counted string on success, NULL on failure.
DESCRIPTION
Wrap a reference counted string around an existing string, which is not
duplicated, unless its reference count gets incremented.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5RS_str_t *
H5RS_wrap(char *s)
{
H5RS_str_t *ret_value=NULL; /* Return value */
FUNC_ENTER_NOAPI(H5RS_wrap,NULL);
/* Allocate ref-counted string structure */
if((ret_value=H5FL_MALLOC(H5RS_str_t))==NULL)
HGOTO_ERROR(H5E_RS,H5E_NOSPACE,NULL,"memory allocation failed");
/* Set the internal fields */
ret_value->s=s;
ret_value->wrapped=1;
ret_value->n=1;
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_wrap() */
/*--------------------------------------------------------------------------
NAME
H5RS_own
PURPOSE
Transfer ownership of a regular string to a reference counted string
USAGE
H5RS_str_t *H5RS_own(s)
const char *s; IN: String to transfer ownership of
RETURNS
Returns a pointer to a new ref-counted string on success, NULL on failure.
DESCRIPTION
Transfer ownership of a dynamically allocated string to a reference counted
string. The routine which passed in the string should not attempt to free
it, the reference counting string routines will do that when the reference
count drops to zero.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5RS_str_t *
H5RS_own(char *s)
{
H5RS_str_t *ret_value=NULL; /* Return value */
FUNC_ENTER_NOAPI(H5RS_own,NULL);
/* Allocate ref-counted string structure */
if((ret_value=H5FL_MALLOC(H5RS_str_t))==NULL)
HGOTO_ERROR(H5E_RS,H5E_NOSPACE,NULL,"memory allocation failed");
/* Set the internal fields */
ret_value->s=s;
ret_value->wrapped=0;
ret_value->n=1;
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_own() */
/*--------------------------------------------------------------------------
NAME
H5RS_decr
PURPOSE
Decrement the reference count for a ref-counted string
USAGE
herr_t H5RS_decr(rs)
H5RS_str_t *rs; IN/OUT: Ref-counted string to decrement count of
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Decrement the reference count for a reference counted string. If the
reference count drops to zero, the reference counted string is deleted.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5RS_decr(H5RS_str_t *rs)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5RS_decr,FAIL);
/* Sanity check */
assert(rs);
assert(rs->n > 0);
/* Decrement reference count for string */
if((--rs->n)==0) {
if(!rs->wrapped)
H5FL_BLK_FREE(str_buf,rs->s);
H5FL_FREE(H5RS_str_t,rs);
} /* end if */
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_decr() */
/*--------------------------------------------------------------------------
NAME
H5RS_incr
PURPOSE
Increment the reference count for a ref-counted string
USAGE
herr_t H5RS_incr(rs)
H5RS_str_t *rs; IN/OUT: Ref-counted string to increment count of
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Increment the reference count for a reference counted string.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5RS_incr(H5RS_str_t *rs)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5RS_incr,FAIL);
/* Sanity check */
assert(rs);
assert(rs->n > 0);
/* If the ref-counted string started life as a wrapper around an existing
* string, duplicate the string now, so that the wrapped string can go out
* scope appropriately.
*/
if(rs->wrapped) {
rs->s=H5RS_xstrdup(rs->s);
rs->wrapped=0;
} /* end if */
/* Increment reference count for string */
rs->n++;
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_incr() */
/*--------------------------------------------------------------------------
NAME
H5RS_dup
PURPOSE
"Duplicate" a ref-counted string
USAGE
H5RS_str_t H5RS_incr(rs)
H5RS_str_t *rs; IN/OUT: Ref-counted string to "duplicate"
RETURNS
Returns a pointer to ref-counted string on success, NULL on failure.
DESCRIPTION
Increment the reference count for the reference counted string and return
a pointer to it.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
H5RS_str_t *
H5RS_dup(H5RS_str_t *ret_value)
{
FUNC_ENTER_NOAPI(H5RS_dup,NULL);
/* Check for valid reference counted string */
if(ret_value!=NULL)
/* Increment reference count for string */
ret_value->n++;
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_dup() */
/*--------------------------------------------------------------------------
NAME
H5RS_cmp
PURPOSE
Compare two ref-counted strings
USAGE
int H5RS_cmp(rs1,rs2)
const H5RS_str_t *rs1; IN: First Ref-counted string to compare
const H5RS_str_t *rs2; IN: Second Ref-counted string to compare
RETURNS
Returns positive, negative or 0 for comparison of two r-strings [same as
strcmp()]
DESCRIPTION
Compare two ref-counted strings and return a value indicating their sort
order [same as strcmp()]
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5RS_cmp(const H5RS_str_t *rs1, const H5RS_str_t *rs2)
{
/* Can't return invalid value from this function */
FUNC_ENTER_NOINIT(H5RS_cmp);
/* Sanity check */
assert(rs1);
assert(rs1->s);
assert(rs2);
assert(rs2->s);
FUNC_LEAVE(HDstrcmp(rs1->s,rs2->s));
} /* end H5RS_cmp() */
/*--------------------------------------------------------------------------
NAME
H5RS_len
PURPOSE
Compute the length of a ref-counted string
USAGE
ssize_t H5RS_cmp(rs)
const H5RS_str_t *rs; IN: Ref-counted string to compute length of
RETURNS
Returns non-negative value on success, negative value on failure
DESCRIPTION
Compute the length of a ref-counted string. [same as strlen()]
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
ssize_t
H5RS_len(const H5RS_str_t *rs)
{
ssize_t ret_value; /* Return value */
FUNC_ENTER_NOAPI(H5RS_len,FAIL);
/* Sanity check */
assert(rs);
assert(rs->s);
ret_value=HDstrlen(rs->s);
done:
FUNC_LEAVE(ret_value);
} /* end H5RS_len() */
|
