forked from HDFGroup/hdf5
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathH5EAdbg.c
427 lines (366 loc) · 18.5 KB
/
H5EAdbg.c
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 LICENSE 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 *
* [email protected]. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Created: H5EAdbg.c
*
* Purpose: Dump debugging information about an extensible array.
*
*-------------------------------------------------------------------------
*/
/**********************/
/* Module Declaration */
/**********************/
#include "H5EAmodule.h" /* This source code file is part of the H5EA module */
/***********************/
/* Other Packages Used */
/***********************/
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5EApkg.h" /* Extensible Arrays */
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Package Typedefs */
/********************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/*-------------------------------------------------------------------------
* Function: H5EA__hdr_debug
*
* Purpose: Prints debugging info about a extensible array header.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5EA__hdr_debug(H5F_t *f, haddr_t addr, FILE *stream, int indent, int fwidth, const H5EA_class_t *cls,
haddr_t obj_addr)
{
/* Local variables */
H5EA_hdr_t *hdr = NULL; /* Shared extensible array header */
void *dbg_ctx = NULL; /* Extensible array debugging context */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_PACKAGE
/* Check arguments */
assert(f);
assert(H5_addr_defined(addr));
assert(H5_addr_defined(obj_addr));
assert(stream);
assert(indent >= 0);
assert(fwidth >= 0);
assert(cls);
/* Check for debugging context callback available */
if (cls->crt_dbg_ctx)
/* Create debugging context */
if (NULL == (dbg_ctx = cls->crt_dbg_ctx(f, obj_addr)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTGET, FAIL, "unable to create fixed array debugging context");
/* Load the extensible array header */
if (NULL == (hdr = H5EA__hdr_protect(f, addr, dbg_ctx, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL, "unable to load extensible array header");
/* Print opening message */
fprintf(stream, "%*sExtensible Array Header...\n", indent, "");
/* Print the values */
fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth, "Array class ID:", hdr->cparam.cls->name);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth, "Header size:", hdr->size);
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Raw Element Size:", (unsigned)hdr->cparam.raw_elmt_size);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth,
"Native Element Size (on this platform):", hdr->cparam.cls->nat_elmt_size);
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Log2(Max. # of elements in array):", (unsigned)hdr->cparam.max_nelmts_bits);
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"# of elements in index block:", (unsigned)hdr->cparam.idx_blk_elmts);
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Min. # of elements per data block:", (unsigned)hdr->cparam.data_blk_min_elmts);
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Min. # of data block pointers for a super block:", (unsigned)hdr->cparam.sup_blk_min_data_ptrs);
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Log2(Max. # of elements in data block page):", (unsigned)hdr->cparam.max_dblk_page_nelmts_bits);
fprintf(stream, "%*s%-*s %" PRIuHSIZE "\n", indent, "", fwidth,
"Highest element index stored (+1):", hdr->stats.stored.max_idx_set);
fprintf(stream, "%*s%-*s %" PRIuHSIZE "\n", indent, "", fwidth,
"Number of super blocks created:", hdr->stats.stored.nsuper_blks);
fprintf(stream, "%*s%-*s %" PRIuHSIZE "\n", indent, "", fwidth,
"Number of data blocks created:", hdr->stats.stored.ndata_blks);
fprintf(stream, "%*s%-*s %" PRIuHSIZE "\n", indent, "", fwidth,
"Number of elements 'realized':", hdr->stats.stored.nelmts);
fprintf(stream, "%*s%-*s %" PRIuHADDR "\n", indent, "", fwidth,
"Index Block Address:", hdr->idx_blk_addr);
done:
if (dbg_ctx && cls->dst_dbg_ctx(dbg_ctx) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTRELEASE, FAIL,
"unable to release extensible array debugging context");
if (hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array header");
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5EA__hdr_debug() */
/*-------------------------------------------------------------------------
* Function: H5EA__iblock_debug
*
* Purpose: Prints debugging info about a extensible array index block.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5EA__iblock_debug(H5F_t *f, haddr_t H5_ATTR_UNUSED addr, FILE *stream, int indent, int fwidth,
const H5EA_class_t *cls, haddr_t hdr_addr, haddr_t obj_addr)
{
/* Local variables */
H5EA_hdr_t *hdr = NULL; /* Shared extensible array header */
H5EA_iblock_t *iblock = NULL; /* Extensible array index block */
void *dbg_ctx = NULL; /* Extensible array context */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_PACKAGE
/* Check arguments */
assert(f);
assert(H5_addr_defined(addr));
assert(stream);
assert(indent >= 0);
assert(fwidth >= 0);
assert(cls);
assert(H5_addr_defined(hdr_addr));
assert(H5_addr_defined(obj_addr));
/* Check for debugging context callback available */
if (cls->crt_dbg_ctx)
/* Create debugging context */
if (NULL == (dbg_ctx = cls->crt_dbg_ctx(f, obj_addr)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTGET, FAIL, "unable to create extensible array debugging context");
/* Load the extensible array header */
if (NULL == (hdr = H5EA__hdr_protect(f, hdr_addr, dbg_ctx, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL, "unable to load extensible array header");
/* Sanity check */
assert(H5_addr_eq(hdr->idx_blk_addr, addr));
/* Protect index block */
if (NULL == (iblock = H5EA__iblock_protect(hdr, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL,
"unable to protect extensible array index block, address = %llu",
(unsigned long long)hdr->idx_blk_addr);
/* Print opening message */
fprintf(stream, "%*sExtensible Array Index Block...\n", indent, "");
/* Print the values */
fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth, "Array class ID:", hdr->cparam.cls->name);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth, "Index Block size:", iblock->size);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth,
"# of data block addresses in index block:", iblock->ndblk_addrs);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth,
"# of super block addresses in index block:", iblock->nsblk_addrs);
/* Check if there are any elements in index block */
if (hdr->cparam.idx_blk_elmts > 0) {
unsigned u; /* Local index variable */
/* Print the elements in the index block */
fprintf(stream, "%*sElements in Index Block:\n", indent, "");
for (u = 0; u < hdr->cparam.idx_blk_elmts; u++) {
/* Call the class's 'debug' callback */
if ((hdr->cparam.cls->debug)(stream, (indent + 3), MAX(0, (fwidth - 3)), (hsize_t)u,
((uint8_t *)iblock->elmts) + (hdr->cparam.cls->nat_elmt_size * u)) <
0)
HGOTO_ERROR(H5E_EARRAY, H5E_CANTGET, FAIL, "can't get element for debugging");
} /* end for */
} /* end if */
/* Check if there are any data block addresses in index block */
if (iblock->ndblk_addrs > 0) {
char temp_str[128]; /* Temporary string, for formatting */
unsigned u; /* Local index variable */
/* Print the data block addresses in the index block */
fprintf(stream, "%*sData Block Addresses in Index Block:\n", indent, "");
for (u = 0; u < iblock->ndblk_addrs; u++) {
/* Print address */
snprintf(temp_str, sizeof(temp_str), "Address #%u:", u);
fprintf(stream, "%*s%-*s %" PRIuHADDR "\n", (indent + 3), "", MAX(0, (fwidth - 3)), temp_str,
iblock->dblk_addrs[u]);
} /* end for */
} /* end if */
/* Check if there are any super block addresses in index block */
if (iblock->nsblk_addrs > 0) {
char temp_str[128]; /* Temporary string, for formatting */
unsigned u; /* Local index variable */
/* Print the super block addresses in the index block */
fprintf(stream, "%*sSuper Block Addresses in Index Block:\n", indent, "");
for (u = 0; u < iblock->nsblk_addrs; u++) {
/* Print address */
snprintf(temp_str, sizeof(temp_str), "Address #%u:", u);
fprintf(stream, "%*s%-*s %" PRIuHADDR "\n", (indent + 3), "", MAX(0, (fwidth - 3)), temp_str,
iblock->sblk_addrs[u]);
} /* end for */
} /* end if */
done:
if (dbg_ctx && cls->dst_dbg_ctx(dbg_ctx) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTRELEASE, FAIL,
"unable to release extensible array debugging context");
if (iblock && H5EA__iblock_unprotect(iblock, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array index block");
if (hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array header");
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5EA__iblock_debug() */
/*-------------------------------------------------------------------------
* Function: H5EA__sblock_debug
*
* Purpose: Prints debugging info about a extensible array super block.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5EA__sblock_debug(H5F_t *f, haddr_t addr, FILE *stream, int indent, int fwidth, const H5EA_class_t *cls,
haddr_t hdr_addr, unsigned sblk_idx, haddr_t obj_addr)
{
/* Local variables */
H5EA_hdr_t *hdr = NULL; /* Shared extensible array header */
H5EA_sblock_t *sblock = NULL; /* Extensible array super block */
void *dbg_ctx = NULL; /* Extensible array context */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_PACKAGE
/* Check arguments */
assert(f);
assert(H5_addr_defined(addr));
assert(stream);
assert(indent >= 0);
assert(fwidth >= 0);
assert(cls);
assert(H5_addr_defined(hdr_addr));
assert(H5_addr_defined(obj_addr));
/* Check for debugging context callback available */
if (cls->crt_dbg_ctx)
/* Create debugging context */
if (NULL == (dbg_ctx = cls->crt_dbg_ctx(f, obj_addr)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTGET, FAIL, "unable to create extensible array debugging context");
/* Load the extensible array header */
if (NULL == (hdr = H5EA__hdr_protect(f, hdr_addr, dbg_ctx, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL, "unable to load extensible array header");
/* Protect super block */
/* (Note: setting parent of super block to 'hdr' for this operation should be OK -QAK) */
if (NULL ==
(sblock = H5EA__sblock_protect(hdr, (H5EA_iblock_t *)hdr, addr, sblk_idx, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL,
"unable to protect extensible array super block, address = %llu",
(unsigned long long)addr);
/* Print opening message */
fprintf(stream, "%*sExtensible Array Super Block...\n", indent, "");
/* Print the values */
fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth, "Array class ID:", hdr->cparam.cls->name);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth, "Super Block size:", sblock->size);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth,
"# of data block addresses in super block:", sblock->ndblks);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth,
"# of elements in data blocks from this super block:", sblock->dblk_nelmts);
/* Check if there are any data block addresses in super block */
if (sblock->ndblks > 0) {
char temp_str[128]; /* Temporary string, for formatting */
unsigned u; /* Local index variable */
/* Print the data block addresses in the super block */
fprintf(stream, "%*sData Block Addresses in Super Block:\n", indent, "");
for (u = 0; u < sblock->ndblks; u++) {
/* Print address */
snprintf(temp_str, sizeof(temp_str), "Address #%u:", u);
fprintf(stream, "%*s%-*s %" PRIuHADDR "\n", (indent + 3), "", MAX(0, (fwidth - 3)), temp_str,
sblock->dblk_addrs[u]);
} /* end for */
} /* end if */
done:
if (dbg_ctx && cls->dst_dbg_ctx(dbg_ctx) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTRELEASE, FAIL,
"unable to release extensible array debugging context");
if (sblock && H5EA__sblock_unprotect(sblock, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array super block");
if (hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array header");
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5EA__sblock_debug() */
/*-------------------------------------------------------------------------
* Function: H5EA__dblock_debug
*
* Purpose: Prints debugging info about a extensible array data block.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5EA__dblock_debug(H5F_t *f, haddr_t addr, FILE *stream, int indent, int fwidth, const H5EA_class_t *cls,
haddr_t hdr_addr, size_t dblk_nelmts, haddr_t obj_addr)
{
/* Local variables */
H5EA_hdr_t *hdr = NULL; /* Shared extensible array header */
H5EA_dblock_t *dblock = NULL; /* Extensible array data block */
void *dbg_ctx = NULL; /* Extensible array context */
size_t u; /* Local index variable */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_PACKAGE
/* Check arguments */
assert(f);
assert(H5_addr_defined(addr));
assert(stream);
assert(indent >= 0);
assert(fwidth >= 0);
assert(cls);
assert(H5_addr_defined(hdr_addr));
assert(H5_addr_defined(obj_addr));
assert(dblk_nelmts > 0);
/* Check for debugging context callback available */
if (cls->crt_dbg_ctx)
/* Create debugging context */
if (NULL == (dbg_ctx = cls->crt_dbg_ctx(f, obj_addr)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTGET, FAIL, "unable to create extensible array debugging context");
/* Load the extensible array header */
if (NULL == (hdr = H5EA__hdr_protect(f, hdr_addr, dbg_ctx, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL, "unable to load extensible array header");
/* Protect data block */
/* (Note: setting parent of data block to 'hdr' for this operation should be OK -QAK) */
if (NULL == (dblock = H5EA__dblock_protect(hdr, hdr, addr, dblk_nelmts, H5AC__READ_ONLY_FLAG)))
HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL,
"unable to protect extensible array data block, address = %" PRIuHADDR, addr);
/* Print opening message */
fprintf(stream, "%*sExtensible Array data Block...\n", indent, "");
/* Print the values */
fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth, "Array class ID:", hdr->cparam.cls->name);
fprintf(stream, "%*s%-*s %zu\n", indent, "", fwidth, "Data Block size:", dblock->size);
/* Print the elements in the index block */
fprintf(stream, "%*sElements:\n", indent, "");
for (u = 0; u < dblk_nelmts; u++) {
/* Call the class's 'debug' callback */
if ((hdr->cparam.cls->debug)(stream, (indent + 3), MAX(0, (fwidth - 3)), (hsize_t)u,
((uint8_t *)dblock->elmts) + (hdr->cparam.cls->nat_elmt_size * u)) < 0)
HGOTO_ERROR(H5E_EARRAY, H5E_CANTGET, FAIL, "can't get element for debugging");
} /* end for */
done:
if (dbg_ctx && cls->dst_dbg_ctx(dbg_ctx) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTRELEASE, FAIL,
"unable to release extensible array debugging context");
if (dblock && H5EA__dblock_unprotect(dblock, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array data block");
if (hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array header");
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5EA__dblock_debug() */