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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* 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 files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* This file contains public declarations for the H5E module.
*/
#ifndef _H5Epublic_H
#define _H5Epublic_H
#include <stdio.h> /*FILE arg of H5Eprint() */
/* Public headers needed by this file */
#include "H5public.h"
#include "H5Ipublic.h"
#ifndef NEW_ERR
#define H5E_DEFAULT 0
/* Take out _new later */
typedef enum H5E_type_t {
H5E_ERROR_new =-1,
H5E_MAJOR_new,
H5E_MINOR_new,
H5E_LIMIT_new
} H5E_type_t;
/* Information about an error; element of error stack */
typedef struct H5E_error_t_new {
hid_t cls_id; /*class ID */
hid_t maj_id; /*major error ID */
hid_t min_id; /*minor error number */
const char *func_name; /*function in which error occurred */
const char *file_name; /*file in which error occurred */
unsigned line; /*line in file where error occurs */
const char *desc; /*optional supplied description */
} H5E_error_t_new;
/* When this header is included from H5Eprivate.h, don't make calls to H5open() */
#undef H5OPEN
#ifndef _H5Eprivate_H
#define H5OPEN H5open(),
#else /* _H5Eprivate_H */
#define H5OPEN
#endif /* _H5Eprivate_H */
/* HDF5 error class */
#define H5E_ERR_CLS (H5OPEN H5E_ERR_CLS_g)
H5_DLLVAR hid_t H5E_ERR_CLS_g;
#ifdef TMP
/* HDF5 error class: major errors. */
hid_t H5E_NONE_MAJOR; /*special zero, no error */
hid_t H5E_ARGS; /*invalid arguments to routine */
hid_t H5E_RESOURCE; /*resource unavailable */
hid_t H5E_INTERNAL; /*Internal error (too specific to document in detail) */
hid_t H5E_FILE; /*file Accessability */
hid_t H5E_IO; /*Low-level I/O */
hid_t H5E_FUNC; /*function Entry/Exit */
hid_t H5E_ATOM; /*object Atom */
hid_t H5E_CACHE; /*object Cache */
hid_t H5E_BTREE; /*B-Tree Node */
hid_t H5E_SYM; /*symbol Table */
hid_t H5E_HEAP; /*Heap */
hid_t H5E_OHDR; /*object Header */
hid_t H5E_DATATYPE; /*Datatype */
hid_t H5E_DATASPACE; /*Dataspace */
hid_t H5E_DATASET; /*Dataset */
hid_t H5E_STORAGE; /*data storage */
hid_t H5E_PLIST; /*Property lists */
hid_t H5E_ATTR; /*Attribute */
hid_t H5E_PLINE; /*Data filters */
hid_t H5E_EFL; /*External file list */
hid_t H5E_REFERENCE; /*References */
hid_t H5E_VFL; /*Virtual File Layer */
hid_t H5E_TBBT; /*Threaded, Balanced, Binary Trees */
hid_t H5E_FPHDF5; /*Flexible Parallel HDF5 */
hid_t H5E_TST; /*Ternary Search Trees */
hid_t H5E_RS; /*Reference Counted Strings */
hid_t H5E_ERROR; /*Error API */
/* HDF5 error class: minor errors. */
hid_t H5E_NONE_MINOR; /*special zero, no error */
hid_t H5E_UNINITIALIZED; /*information is unitialized */
hid_t H5E_UNSUPPORTED; /*feature is unsupported */
hid_t H5E_BADTYPE; /*incorrect type found */
hid_t H5E_BADRANGE; /*argument out of range */
hid_t H5E_BADVALUE; /*bad value for argument */
/* Resource errors */
hid_t H5E_NOSPACE; /*no space available for allocation */
hid_t H5E_CANTCOPY; /*unable to copy object */
hid_t H5E_CANTFREE; /*unable to free object */
hid_t H5E_ALREADYEXISTS; /*Object already exists */
hid_t H5E_CANTLOCK; /*Unable to lock object */
hid_t H5E_CANTUNLOCK; /*Unable to unlock object */
hid_t H5E_CANTGC; /*Unable to garbage collect */
/* File accessability errors */
hid_t H5E_FILEEXISTS; /*file already exists */
hid_t H5E_FILEOPEN; /*file already open */
hid_t H5E_CANTCREATE; /*Can't create file */
hid_t H5E_CANTOPENFILE; /*Can't open file */
hid_t H5E_CANTCLOSEFILE; /*Can't close file */
hid_t H5E_NOTHDF5; /*not an HDF5 format file */
hid_t H5E_BADFILE; /*bad file ID accessed */
hid_t H5E_TRUNCATED; /*file has been truncated */
hid_t H5E_MOUNT; /*file mount error */
/* Generic low-level file I/O errors */
hid_t H5E_SEEKERROR; /*seek failed */
hid_t H5E_READERROR; /*read failed */
hid_t H5E_WRITEERROR; /*write failed */
hid_t H5E_CLOSEERROR; /*close failed */
hid_t H5E_OVERFLOW; /*address overflowed */
hid_t H5E_FCNTL; /*file fcntl failed */
/* Function entry/exit interface errors */
hid_t H5E_CANTINIT; /*Can't initialize object */
hid_t H5E_ALREADYINIT; /*object already initialized */
hid_t H5E_CANTRELEASE; /*Can't release object */
/* Object atom related errors */
hid_t H5E_BADATOM; /*Can't find atom information */
hid_t H5E_BADGROUP; /*Can't find group information */
hid_t H5E_CANTREGISTER; /*Can't register new atom */
hid_t H5E_CANTINC; /*Can't increment reference count */
hid_t H5E_CANTDEC; /*Can't decrement reference count */
hid_t H5E_NOIDS; /*Out of IDs for group */
/* Cache related errors */
hid_t H5E_CANTFLUSH; /*Can't flush object from cache */
hid_t H5E_CANTLOAD; /*Can't load object into cache */
hid_t H5E_PROTECT; /*protected object error */
hid_t H5E_NOTCACHED; /*object not currently cached */
/* B-tree related errors */
hid_t H5E_NOTFOUND; /*object not found */
hid_t H5E_EXISTS; /*object already exists */
hid_t H5E_CANTENCODE; /*Can't encode value */
hid_t H5E_CANTDECODE; /*Can't decode value */
hid_t H5E_CANTSPLIT; /*Can't split node */
hid_t H5E_CANTINSERT; /*Can't insert object */
hid_t H5E_CANTLIST; /*Can't list node */
/* Object header related errors */
hid_t H5E_LINKCOUNT; /*bad object header link count */
hid_t H5E_VERSION; /*wrong version number */
hid_t H5E_ALIGNMENT; /*alignment error */
hid_t H5E_BADMESG; /*unrecognized message */
hid_t H5E_CANTDELETE; /* Can't delete message */
/* Group related errors */
hid_t H5E_CANTOPENOBJ; /*Can't open object */
hid_t H5E_COMPLEN; /*name component is too long */
hid_t H5E_CWG; /*problem with current working group */
hid_t H5E_LINK; /*link count failure */
hid_t H5E_SLINK; /*symbolic link error */
/* Datatype conversion errors */
hid_t H5E_CANTCONVERT; /*Can't convert datatypes */
hid_t H5E_BADSIZE; /*Bad size for object */
/* Dataspace errors */
hid_t H5E_CANTCLIP; /*Can't clip hyperslab region */
hid_t H5E_CANTCOUNT; /*Can't count elements */
hid_t H5E_CANTSELECT; /*Can't select hyperslab */
hid_t H5E_CANTNEXT; /*Can't move to next iterator location */
hid_t H5E_BADSELECT; /*Invalid selection */
hid_t H5E_CANTCOMPARE; /*Can't compare objects */
/* Property list errors */
hid_t H5E_CANTGET; /*Can't get value */
hid_t H5E_CANTSET; /*Can't set value */
hid_t H5E_DUPCLASS; /*Duplicate class name in parent class */
/* Parallel errors */
hid_t H5E_MPI; /*some MPI function failed */
hid_t H5E_MPIERRSTR; /*MPI Error String */
/* FPHDF5 errors */
hid_t H5E_CANTMAKETREE; /*can't make a TBBT tree */
hid_t H5E_CANTRECV; /*can't receive messages from processes */
hid_t H5E_CANTSENDMDATA; /*can't send metadata message */
hid_t H5E_CANTCHANGE; /*can't register change on server */
hid_t H5E_CANTALLOC; /*can't allocate from file */
/* I/O pipeline errors */
hid_t H5E_NOFILTER; /*requested filter is not available */
hid_t H5E_CALLBACK; /*callback failed */
hid_t H5E_CANAPPLY; /*error from filter "can apply" callback */
hid_t H5E_SETLOCAL; /*error from filter "set local" callback */
#endif /* TMP */
#endif /* NEW_ERR */
/*
* One often needs to temporarily disable automatic error reporting when
* trying something that's likely or expected to fail. For instance, to
* determine if an object exists one can call H5Gget_objinfo() which will fail if
* the object doesn't exist. The code to try can be nested between calls to
* H5Eget_auto() and H5Eset_auto(), but it's easier just to use this macro
* like:
* H5E_BEGIN_TRY {
* ...stuff here that's likely to fail...
* } H5E_END_TRY;
*
* Warning: don't break, return, or longjmp() from the body of the loop or
* the error reporting won't be properly restored!
*/
#define H5E_BEGIN_TRY { \
H5E_auto_t H5E_saved_efunc; \
void *H5E_saved_edata; \
H5Eget_auto (&H5E_saved_efunc, &H5E_saved_edata); \
H5Eset_auto (NULL, NULL);
#define H5E_END_TRY \
H5Eset_auto (H5E_saved_efunc, H5E_saved_edata); \
}
/*
* Public API Convenience Macros for Error reporting - Documented
*/
/* Use the Standard C __FILE__ & __LINE__ macros instead of typing them in */
#define H5Epush_sim(func,maj,min,str) H5Epush(__FILE__,func,__LINE__,maj,min,str)
/*
* Public API Convenience Macros for Error reporting - Undocumented
*/
/* Use the Standard C __FILE__ & __LINE__ macros instead of typing them in */
/* And return after pushing error onto stack */
#define H5Epush_ret(func,maj,min,str,ret) { \
H5Epush(__FILE__,func,__LINE__,maj,min,str); \
return(ret); \
}
/* Use the Standard C __FILE__ & __LINE__ macros instead of typing them in */
/* And goto a label after pushing error onto stack */
#define H5Epush_goto(func,maj,min,str,label) { \
H5Epush(__FILE__,func,__LINE__,maj,min,str); \
goto label; \
}
/*
* Declare an enumerated type which holds all the valid major HDF error codes.
*/
typedef enum H5E_major_t {
H5E_NONE_MAJOR = 0, /*special zero, no error */
H5E_ARGS, /*invalid arguments to routine */
H5E_RESOURCE, /*resource unavailable */
H5E_INTERNAL, /* Internal error (too specific to document
* in detail)
*/
H5E_FILE, /*file Accessability */
H5E_IO, /*Low-level I/O */
H5E_FUNC, /*function Entry/Exit */
H5E_ATOM, /*object Atom */
H5E_CACHE, /*object Cache */
H5E_BTREE, /*B-Tree Node */
H5E_SYM, /*symbol Table */
H5E_HEAP, /*Heap */
H5E_OHDR, /*object Header */
H5E_DATATYPE, /*Datatype */
H5E_DATASPACE, /*Dataspace */
H5E_DATASET, /*Dataset */
H5E_STORAGE, /*data storage */
H5E_PLIST, /*Property lists */
H5E_ATTR, /*Attribute */
H5E_PLINE, /*Data filters */
H5E_EFL, /*External file list */
H5E_REFERENCE, /*References */
H5E_VFL, /*Virtual File Layer */
H5E_TBBT, /*Threaded, Balanced, Binary Trees */
H5E_FPHDF5, /*Flexible Parallel HDF5 */
H5E_TST, /*Ternary Search Trees */
H5E_RS, /*Reference Counted Strings */
H5E_ERROR /*Error API */
} H5E_major_t;
/* Declare an enumerated type which holds all the valid minor HDF error codes */
typedef enum H5E_minor_t {
H5E_NONE_MINOR = 0, /*special zero, no error */
/* Argument errors */
H5E_UNINITIALIZED, /*information is unitialized */
H5E_UNSUPPORTED, /*feature is unsupported */
H5E_BADTYPE, /*incorrect type found */
H5E_BADRANGE, /*argument out of range */
H5E_BADVALUE, /*bad value for argument */
/* Resource errors */
H5E_NOSPACE, /*no space available for allocation */
H5E_CANTCOPY, /*unable to copy object */
H5E_CANTFREE, /*unable to free object */
H5E_ALREADYEXISTS, /*Object already exists */
H5E_CANTLOCK, /*Unable to lock object */
H5E_CANTUNLOCK, /*Unable to unlock object */
H5E_CANTGC, /*Unable to garbage collect */
/* File accessability errors */
H5E_FILEEXISTS, /*file already exists */
H5E_FILEOPEN, /*file already open */
H5E_CANTCREATE, /*Can't create file */
H5E_CANTOPENFILE, /*Can't open file */
H5E_CANTCLOSEFILE, /*Can't close file */
H5E_NOTHDF5, /*not an HDF5 format file */
H5E_BADFILE, /*bad file ID accessed */
H5E_TRUNCATED, /*file has been truncated */
H5E_MOUNT, /*file mount error */
/* Generic low-level file I/O errors */
H5E_SEEKERROR, /*seek failed */
H5E_READERROR, /*read failed */
H5E_WRITEERROR, /*write failed */
H5E_CLOSEERROR, /*close failed */
H5E_OVERFLOW, /*address overflowed */
H5E_FCNTL, /*file fcntl failed */
/* Function entry/exit interface errors */
H5E_CANTINIT, /*Can't initialize object */
H5E_ALREADYINIT, /*object already initialized */
H5E_CANTRELEASE, /*Can't release object */
/* Object atom related errors */
H5E_BADATOM, /*Can't find atom information */
H5E_BADGROUP, /*Can't find group information */
H5E_CANTREGISTER, /*Can't register new atom */
H5E_CANTINC, /*Can't increment reference count */
H5E_CANTDEC, /*Can't decrement reference count */
H5E_NOIDS, /*Out of IDs for group */
/* Cache related errors */
H5E_CANTFLUSH, /*Can't flush object from cache */
H5E_CANTLOAD, /*Can't load object into cache */
H5E_PROTECT, /*protected object error */
H5E_NOTCACHED, /*object not currently cached */
/* B-tree related errors */
H5E_NOTFOUND, /*object not found */
H5E_EXISTS, /*object already exists */
H5E_CANTENCODE, /*Can't encode value */
H5E_CANTDECODE, /*Can't decode value */
H5E_CANTSPLIT, /*Can't split node */
H5E_CANTINSERT, /*Can't insert object */
H5E_CANTLIST, /*Can't list node */
/* Object header related errors */
H5E_LINKCOUNT, /*bad object header link count */
H5E_VERSION, /*wrong version number */
H5E_ALIGNMENT, /*alignment error */
H5E_BADMESG, /*unrecognized message */
H5E_CANTDELETE, /* Can't delete message */
/* Group related errors */
H5E_CANTOPENOBJ, /*Can't open object */
H5E_COMPLEN, /*name component is too long */
H5E_CWG, /*problem with current working group */
H5E_LINK, /*link count failure */
H5E_SLINK, /*symbolic link error */
/* Datatype conversion errors */
H5E_CANTCONVERT, /*Can't convert datatypes */
H5E_BADSIZE, /*Bad size for object */
/* Dataspace errors */
H5E_CANTCLIP, /*Can't clip hyperslab region */
H5E_CANTCOUNT, /*Can't count elements */
H5E_CANTSELECT, /*Can't select hyperslab */
H5E_CANTNEXT, /*Can't move to next iterator location */
H5E_BADSELECT, /*Invalid selection */
H5E_CANTCOMPARE, /*Can't compare objects */
/* Property list errors */
H5E_CANTGET, /*Can't get value */
H5E_CANTSET, /*Can't set value */
H5E_DUPCLASS, /*Duplicate class name in parent class */
/* Parallel errors */
H5E_MPI, /*some MPI function failed */
H5E_MPIERRSTR, /*MPI Error String */
/* FPHDF5 errors */
H5E_CANTMAKETREE, /*can't make a TBBT tree */
H5E_CANTRECV, /*can't receive messages from processes */
H5E_CANTSENDMDATA, /*can't send metadata message */
H5E_CANTCHANGE, /*can't register change on server */
H5E_CANTALLOC, /*can't allocate from file */
/* I/O pipeline errors */
H5E_NOFILTER, /*requested filter is not available */
H5E_CALLBACK, /*callback failed */
H5E_CANAPPLY, /*error from filter "can apply" callback */
H5E_SETLOCAL /*error from filter "set local" callback */
} H5E_minor_t;
/* Information about an error */
typedef struct H5E_error_t {
H5E_major_t maj_num; /*major error number */
H5E_minor_t min_num; /*minor error number */
const char *func_name; /*function in which error occurred */
const char *file_name; /*file in which error occurred */
unsigned line; /*line in file where error occurs */
const char *desc; /*optional supplied description */
} H5E_error_t;
/* Error stack traversal direction */
typedef enum H5E_direction_t {
H5E_WALK_UPWARD = 0, /*begin deep, end at API function */
H5E_WALK_DOWNWARD = 1 /*begin at API function, end deep */
} H5E_direction_t;
#ifdef __cplusplus
extern "C" {
#endif
/* Error stack traversal callback function */
typedef herr_t (*H5E_walk_t)(int n, H5E_error_t *err_desc, void *client_data);
typedef herr_t (*H5E_auto_t)(hid_t estack, void *client_data);
H5_DLL herr_t H5Eset_auto (H5E_auto_t func, void *client_data);
H5_DLL herr_t H5Eget_auto (H5E_auto_t *func, void **client_data);
H5_DLL herr_t H5Eclear (void);
H5_DLL herr_t H5Eprint (FILE *stream);
H5_DLL herr_t H5Ewalk (H5E_direction_t direction, H5E_walk_t func,
void *client_data);
H5_DLL const char *H5Eget_major (H5E_major_t major_number);
H5_DLL const char *H5Eget_minor (H5E_minor_t minor_number);
H5_DLL herr_t H5Epush(const char *file, const char *func,
unsigned line, H5E_major_t maj, H5E_minor_t min, const char *str);
/* New error API */
H5_DLL hid_t H5Eregister_class(const char *cls_name, const char *lib_name, const char *version);
H5_DLL herr_t H5Eunregister_class(hid_t class_id);
H5_DLL herr_t H5Eclose_msg(hid_t err_id);
H5_DLL hid_t H5Ecreate_msg(hid_t cls, H5E_type_t msg_type, const char *msg);
H5_DLL hid_t H5Eget_current_stack(void);
H5_DLL herr_t H5Eclose_stack(hid_t stack_id);
H5_DLL ssize_t H5Eget_class_name(hid_t class_id, char *name, size_t size);
H5_DLL ssize_t H5Eget_msg(hid_t msg_id, H5E_type_t *type, char *msg, size_t size);
H5_DLL int H5Eget_num(hid_t error_stack_id);
H5_DLL herr_t H5Eset_current_stack(hid_t err_stack_id);
H5_DLL herr_t H5Epush_new(hid_t err_stack, const char *file, const char *func, unsigned line,
hid_t maj_id, hid_t min_id, const char *msg, ...);
H5_DLL herr_t H5Epop(hid_t err_stack, size_t count);
H5_DLL herr_t H5Eclear_new(hid_t err_stack);
H5_DLL herr_t H5Eprint_new(hid_t err_stack, FILE *stream);
typedef herr_t (*H5E_walk_t_new)(int n, H5E_error_t_new *err_desc, void *client_data);
H5_DLL herr_t H5Ewalk_new(hid_t err_stack, H5E_direction_t direction, H5E_walk_t_new func,
void *client_data);
H5_DLL herr_t H5Eget_auto_new(hid_t estack_id, H5E_auto_t *func, void **client_data);
H5_DLL herr_t H5Eset_auto_new(hid_t estack_id, H5E_auto_t func, void *client_data);
#ifdef __cplusplus
}
#endif
#endif
|
