summaryrefslogtreecommitdiffstats
path: root/src/H5Opkg.h
blob: ee7104e30ea636a7720eef661380bf66a4f37c7a (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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * 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.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#if !(defined H5O_FRIEND || defined H5O_MODULE)
#error "Do not include this file outside the H5O package!"
#endif

#ifndef H5Opkg_H
#define H5Opkg_H

/* Get package's private header */
#include "H5Oprivate.h" /* Object headers		  	*/

/* Other private headers needed by this file */
#include "H5ACprivate.h" /* Metadata cache                       */
#include "H5FLprivate.h" /* Free Lists                           */

/* Object header macros */
#define H5O_NMESGS  8 /*initial number of messages	     */
#define H5O_NCHUNKS 2 /*initial number of chunks	     */
#define H5O_MIN_SIZE                                                                                         \
    22 /* Min. obj header data size (must be big enough for a message prefix and a continuation message) */
#define H5O_MSG_TYPES         26    /* # of types of messages            */
#define H5O_MAX_CRT_ORDER_IDX 65535 /* Max. creation order index value   */

/* Versions of object header structure */

/* Initial version of the object header format */
#define H5O_VERSION_1 1

/* Revised version - leaves out reserved bytes and alignment padding, and adds
 *      magic number as prefix and checksum as suffix for all chunks.
 */
#define H5O_VERSION_2 2

/* The latest version of the format.  Look through the 'flush'
 *      and 'size' callback for places to change when updating this. */
#define H5O_VERSION_LATEST H5O_VERSION_2

/*
 * Align messages on 8-byte boundaries because we would like to copy the
 * object header chunks directly into memory and operate on them there, even
 * on 64-bit architectures.  This allows us to reduce the number of disk I/O
 * requests with a minimum amount of mem-to-mem copies.
 *
 * Note: We no longer attempt to do this. - QAK, 10/16/06
 */
#define H5O_ALIGN_OLD(X)     (8 * (((X) + 7) / 8))
#define H5O_ALIGN_VERS(V, X) (((V) == H5O_VERSION_1) ? H5O_ALIGN_OLD(X) : (X))
#define H5O_ALIGN_OH(O, X)   H5O_ALIGN_VERS((O)->version, X)
#define H5O_ALIGN_F(F, X)    H5O_ALIGN_VERS(MAX(H5O_VERSION_1, (uint8_t)H5O_obj_ver_bounds[H5F_LOW_BOUND(F)]), X)

/* Size of checksum (on disk) */
#define H5O_SIZEOF_CHKSUM 4

/* ========= Object Creation properties ============ */
/* Default values for some of the object creation properties */
/* NOTE: The H5O_CRT_ATTR_MAX_COMPACT_DEF & H5O_CRT_ATTR_MIN_DENSE_DEF values
 *      are "built into" the file format, make certain existing files with
 *      default attribute phase change storage are handled correctly if they
 *      are changed.
 */
#define H5O_CRT_ATTR_MAX_COMPACT_DEF 8
#define H5O_CRT_ATTR_MIN_DENSE_DEF   6
#define H5O_CRT_OHDR_FLAGS_DEF       H5O_HDR_STORE_TIMES

/* Object header status flag definitions */
#define H5O_HDR_CHUNK0_1 0x00 /* Use 1-byte value for chunk #0 size */
#define H5O_HDR_CHUNK0_2 0x01 /* Use 2-byte value for chunk #0 size */
#define H5O_HDR_CHUNK0_4 0x02 /* Use 4-byte value for chunk #0 size */
#define H5O_HDR_CHUNK0_8 0x03 /* Use 8-byte value for chunk #0 size */

/*
 * Size of object header prefix.
 */
#define H5O_SIZEOF_HDR(O)                                                                                    \
    (((O)->version == H5O_VERSION_1)                                                                         \
         ? H5O_ALIGN_OLD(1 +                           /*version number	*/                                   \
                         1 +                           /*reserved 		*/                                       \
                         2 +                           /*number of messages	*/                               \
                         4 +                           /*reference count	*/                                  \
                         4)                            /*chunk data size	*/                                  \
         : (H5_SIZEOF_MAGIC +                          /*magic number  	*/                                   \
            1 +                                        /*version number 	*/                                  \
            1 +                                        /*flags		 	*/                                         \
            (((O)->flags & H5O_HDR_STORE_TIMES) ? (4 + /*access time		*/                                     \
                                                   4 + /*modification time	*/                                \
                                                   4 + /*change time		*/                                     \
                                                   4   /*birth time		*/                                      \
                                                   )                                                         \
                                                : 0) +                                                       \
            (((O)->flags & H5O_HDR_ATTR_STORE_PHASE_CHANGE) ? (2 + /*max compact attributes */               \
                                                               2   /*min dense attributes	*/                 \
                                                               )                                             \
                                                            : 0) +                                           \
            (1 << ((O)->flags & H5O_HDR_CHUNK0_SIZE)) + /*chunk 0 data size */                               \
            H5O_SIZEOF_CHKSUM)                          /*checksum size	*/                                   \
    )

/*
 * Size of object header message prefix
 */
#define H5O_SIZEOF_MSGHDR_VERS(V, C)                                                                         \
    (((V) == H5O_VERSION_1) ? H5O_ALIGN_OLD(2 + /*message type		*/                                           \
                                            2 + /*sizeof message data	*/                                     \
                                            1 + /*flags              	*/                                     \
                                            3)  /*reserved		*/                                               \
                            : (1 +              /*message type		*/                                           \
                               2 +              /*sizeof message data	*/                                     \
                               1 +              /*flags              	*/                                     \
                               ((C) ? (2        /*creation index     	*/                                     \
                                       )                                                                     \
                                    : 0)))
#define H5O_SIZEOF_MSGHDR_OH(O)                                                                              \
    (unsigned)H5O_SIZEOF_MSGHDR_VERS((O)->version, (O)->flags &H5O_HDR_ATTR_CRT_ORDER_TRACKED)
#define H5O_SIZEOF_MSGHDR_F(F, C)                                                                            \
    (unsigned)H5O_SIZEOF_MSGHDR_VERS(MAX((H5F_STORE_MSG_CRT_IDX(F) ? H5O_VERSION_LATEST : H5O_VERSION_1),    \
                                         (uint8_t)H5O_obj_ver_bounds[H5F_LOW_BOUND(F)]),                     \
                                     (C))

/*
 * Size of chunk "header" for each chunk
 */
#define H5O_SIZEOF_CHKHDR_VERS(V)                                                                            \
    (((V) == H5O_VERSION_1) ? 0 +                   /*no magic #  */                                         \
                                  0                 /*no checksum */                                         \
                            : H5_SIZEOF_MAGIC +     /*magic #  */                                            \
                                  H5O_SIZEOF_CHKSUM /*checksum */                                            \
    )
#define H5O_SIZEOF_CHKHDR_OH(O) H5O_SIZEOF_CHKHDR_VERS((O)->version)

/*
 * Size of checksum for each chunk
 */
#define H5O_SIZEOF_CHKSUM_VERS(V)                                                                            \
    (((V) == H5O_VERSION_1) ? 0                 /*no checksum */                                             \
                            : H5O_SIZEOF_CHKSUM /*checksum */                                                \
    )
#define H5O_SIZEOF_CHKSUM_OH(O) H5O_SIZEOF_CHKSUM_VERS((O)->version)

/* Input/output flags for decode functions */
#define H5O_DECODEIO_NOCHANGE 0x01u /* IN: do not modify values */
#define H5O_DECODEIO_DIRTY    0x02u /* OUT: message has been changed */

/* Macro to incremend ndecode_dirtied (only if we are debugging) */
#ifndef NDEBUG
#define INCR_NDECODE_DIRTIED(OH) (OH)->ndecode_dirtied++;
#else /* NDEBUG */
#define INCR_NDECODE_DIRTIED(OH) ;
#endif /* NDEBUG */

/* Load native information for a message, if it's not already present */
/* (Only works for messages with decode callback) */
#define H5O_LOAD_NATIVE(F, IOF, OH, MSG, ERR)                                                                \
    if (NULL == (MSG)->native) {                                                                             \
        const H5O_msg_class_t *msg_type = (MSG)->type;                                                       \
        unsigned               ioflags  = (IOF);                                                             \
                                                                                                             \
        /* Decode the message */                                                                             \
        assert(msg_type->decode);                                                                            \
        if (NULL == ((MSG)->native = (msg_type->decode)((F), (OH), (MSG)->flags, &ioflags, (MSG)->raw_size,  \
                                                        (MSG)->raw)))                                        \
            HGOTO_ERROR(H5E_OHDR, H5E_CANTDECODE, ERR, "unable to decode message");                          \
                                                                                                             \
        /* Mark the message dirty if it was changed by decoding */                                           \
        if ((ioflags & H5O_DECODEIO_DIRTY) && (H5F_get_intent((F)) & H5F_ACC_RDWR)) {                        \
            (MSG)->dirty = TRUE;                                                                             \
            /* Increment the count of messages dirtied by decoding, but */                                   \
            /* only ifndef NDEBUG */                                                                         \
            INCR_NDECODE_DIRTIED(OH)                                                                         \
        }                                                                                                    \
                                                                                                             \
        /* Set the message's "shared info", if it's shareable */                                             \
        if ((MSG)->flags & H5O_MSG_FLAG_SHAREABLE) {                                                         \
            assert(msg_type->share_flags &H5O_SHARE_IS_SHARABLE);                                            \
            H5O_UPDATE_SHARED((H5O_shared_t *)(MSG)->native, H5O_SHARE_TYPE_HERE, (F), msg_type->id,         \
                              (MSG)->crt_idx, (OH)->chunk[0].addr)                                           \
        } /* end if */                                                                                       \
                                                                                                             \
        /* Set the message's "creation index", if it has one */                                              \
        if (msg_type->set_crt_index) {                                                                       \
            /* Set the creation index for the message */                                                     \
            if ((msg_type->set_crt_index)((MSG)->native, (MSG)->crt_idx) < 0)                                \
                HGOTO_ERROR(H5E_OHDR, H5E_CANTSET, ERR, "unable to set creation index");                     \
        } /* end if */                                                                                       \
    }     /* end if */

/* Flags for a message class's "sharability" */
#define H5O_SHARE_IS_SHARABLE 0x01
#define H5O_SHARE_IN_OHDR     0x02

/* Set the object header size to speculatively read in */
/* (needs to be more than the object header prefix size to work at all and
 *      should be larger than the largest object type's default object header
 *      size to save the extra I/O operations) */
#define H5O_SPEC_READ_SIZE 512

/* The "message class" type */
struct H5O_msg_class_t {
    unsigned    id;          /*message type ID on disk   */
    const char *name;        /*for debugging             */
    size_t      native_size; /*size of native message    */
    unsigned    share_flags; /* Message sharing settings */
    void *(*decode)(H5F_t *, H5O_t *, unsigned, unsigned *, size_t, const uint8_t *);
    herr_t (*encode)(H5F_t *, hbool_t, uint8_t *, const void *);
    void *(*copy)(const void *, void *);                      /*copy native value         */
    size_t (*raw_size)(const H5F_t *, hbool_t, const void *); /*sizeof encoded message	*/
    herr_t (*reset)(void *);                                  /*free nested data structs  */
    herr_t (*free)(void *);                                   /*free main data struct  */
    herr_t (*del)(H5F_t *, H5O_t *, void *);  /* Delete space in file referenced by this message */
    herr_t (*link)(H5F_t *, H5O_t *, void *); /* Increment any links in file reference by this message */
    herr_t (*set_share)(void *, const H5O_shared_t *); /* Set shared information */
    htri_t (*can_share)(const void *);                 /* Is message allowed to be shared? */
    herr_t (*pre_copy_file)(H5F_t *, const void *, hbool_t *, const H5O_copy_t *,
                            void *); /*"pre copy" action when copying native value to file */
    void *(*copy_file)(H5F_t *, void *, H5F_t *, hbool_t *, unsigned *, H5O_copy_t *,
                       void *); /*copy native value to file */
    herr_t (*post_copy_file)(const H5O_loc_t *, const void *, H5O_loc_t *, void *, unsigned *,
                             H5O_copy_t *); /*"post copy" action when copying native value to file */
    herr_t (*get_crt_index)(const void *, H5O_msg_crt_idx_t *); /* Get message's creation index */
    herr_t (*set_crt_index)(void *, H5O_msg_crt_idx_t);         /* Set message's creation index */
    herr_t (*debug)(H5F_t *, const void *, FILE *, int, int);
};

struct H5O_mesg_t {
    const H5O_msg_class_t *type;     /* type of message                  */
    hbool_t                dirty;    /* raw out of date wrt native       */
    uint8_t                flags;    /* message flags                    */
    H5O_msg_crt_idx_t      crt_idx;  /* message creation index           */
    unsigned               chunkno;  /* chunk number for this mesg       */
    void                  *native;   /* native format message            */
    uint8_t               *raw;      /* pointer to raw data              */
    size_t                 raw_size; /* size with alignment              */
};

/* Struct for storing information about "best" message to move to new chunk */
typedef struct H5O_msg_alloc_info_t {
    int      msgno;      /* Index in message array */
    unsigned id;         /* Message type ID on disk */
    unsigned chunkno;    /* Index in chunk array */
    size_t   gap_size;   /* Size of any "gap" in the chunk immediately after message */
    size_t   null_size;  /* Size of any null message in the chunk immediately after message */
    size_t   total_size; /* Total size of "available" space around message */
    unsigned null_msgno; /* Message index of null message immediately after message */
} H5O_msg_alloc_info_t;

typedef struct H5O_chunk_t {
    haddr_t                   addr;        /*chunk file address		     */
    size_t                    size;        /*chunk size			     */
    size_t                    gap;         /*space at end of chunk too small for null message */
    uint8_t                  *image;       /*image of file			     */
    struct H5O_chunk_proxy_t *chunk_proxy; /* Pointer to a chunk's proxy when chunk protected */
} H5O_chunk_t;

struct H5O_t {
    H5AC_info_t cache_info; /* Information for metadata cache functions, _must_ be */
                            /* first field in structure */

    /* File-specific information (not stored) */
    size_t  sizeof_size; /* Size of file sizes 		     */
    size_t  sizeof_addr; /* Size of file addresses	     */
    hbool_t swmr_write;  /* Whether we are doing SWMR writes  */

    /* Debugging information (not stored) */
#ifdef H5O_ENABLE_BAD_MESG_COUNT
    hbool_t store_bad_mesg_count; /* Flag to indicate that a bad message count should be stored */
                                  /* (This is to simulate a bug in earlier
                                   *      versions of the library)
                                   */
#endif                            /* H5O_ENABLE_BAD_MESG_COUNT */
#ifndef NDEBUG
    size_t ndecode_dirtied; /* Number of messages dirtied by decoding */
#endif                      /* NDEBUG */

    /* Chunk management information (not stored) */
    size_t rc; /* Reference count of [continuation] chunks using this structure */

    /* Object information (stored) */
    hbool_t  has_refcount_msg; /* Whether the object has a ref. count message */
    unsigned nlink;            /*link count			     */
    uint8_t  version;          /*version number		     */
    uint8_t  flags;            /*flags				     */

    /* Time information (stored, for versions > 1 & H5O_HDR_STORE_TIMES flag set) */
    time_t atime; /*access time 			     */
    time_t mtime; /*modification time 		     */
    time_t ctime; /*change time 			     */
    time_t btime; /*birth time 			     */

    /* Attribute information (stored, for versions > 1) */
    unsigned max_compact; /* Maximum # of compact attributes   */
    unsigned min_dense;   /* Minimum # of "dense" attributes   */

    /* Message management (stored, encoded in chunks) */
    size_t      nmesgs;         /*number of messages		     */
    size_t      alloc_nmesgs;   /*number of message slots	     */
    H5O_mesg_t *mesg;           /*array of messages		     */
    size_t      link_msgs_seen; /* # of link messages seen when loading header */
    size_t      attr_msgs_seen; /* # of attribute messages seen when loading header */

    /* Chunk management (not stored) */
    size_t       nchunks;       /*number of chunks		     */
    size_t       alloc_nchunks; /*chunks allocated		     */
    H5O_chunk_t *chunk;         /*array of chunks		     */
    hbool_t      chunks_pinned; /* Whether chunks are pinned from ohdr protect */

    /* Object header proxy information (not stored) */
    H5AC_proxy_entry_t *proxy; /* Proxy cache entry for all ohdr entries */
};

/* Class for types of objects in file */
typedef struct H5O_obj_class_t {
    H5O_type_t  type;                               /*object type on disk	     */
    const char *name;                               /*for debugging		     */
    void *(*get_copy_file_udata)(void);             /*retrieve user data for 'copy file' operation */
    void (*free_copy_file_udata)(void *);           /*free user data for 'copy file' operation */
    htri_t (*isa)(const H5O_t *);                   /*if a header matches an object class */
    void *(*open)(const H5G_loc_t *, H5I_type_t *); /*open an object of this class */
    void *(*create)(H5F_t *, void *, H5G_loc_t *);  /*create an object of this class */
    H5O_loc_t *(*get_oloc)(hid_t);                  /*get the object header location for an object */
    herr_t (*bh_info)(const H5O_loc_t *loc, H5O_t *oh,
                      H5_ih_info_t *bh_info); /*get the index & heap info for an object */
    herr_t (*flush)(void *obj_ptr);           /*flush an opened object of this class */
} H5O_obj_class_t;

/* Node in skip list to map addresses from one file to another during object header copy */
typedef struct H5O_addr_map_t {
    H5_obj_t               src_obj_pos;   /* Location of source object */
    haddr_t                dst_addr;      /* Address of object in destination file */
    hbool_t                is_locked;     /* Indicate that the destination object is locked currently */
    hsize_t                inc_ref_count; /* Number of deferred increments to reference count */
    const H5O_obj_class_t *obj_class;     /* Object class */
    void                  *udata;         /* Object class copy file udata */
} H5O_addr_map_t;

/* Stack of continuation messages to interpret */
typedef struct H5O_cont_msgs_t {
    size_t      nmsgs;       /* Number of continuation messages found so far */
    size_t      alloc_nmsgs; /* Continuation messages allocated */
    H5O_cont_t *msgs;        /* Array of continuation messages */
} H5O_cont_msgs_t;

/* Common callback information for loading object header prefix from disk */
typedef struct H5O_common_cache_ud_t {
    H5F_t           *f;                /* Pointer to file for object header/chunk */
    unsigned         file_intent;      /* Read/write intent for file */
    unsigned         merged_null_msgs; /* Number of null messages merged together */
    H5O_cont_msgs_t *cont_msg_info;    /* Pointer to continuation messages to work on */
    haddr_t          addr;             /* Address of the prefix or chunk */
} H5O_common_cache_ud_t;

/* Callback information for loading object header prefix from disk */
typedef struct H5O_cache_ud_t {
    hbool_t               made_attempt;  /* Whether the deserialize routine was already attempted */
    unsigned              v1_pfx_nmesgs; /* Number of messages from v1 prefix header */
    size_t                chunk0_size;   /* Size of serialized first chunk    */
    H5O_t                *oh;            /* Partially deserialized object header, for later use */
    hbool_t               free_oh;       /* Whether to free the object header or not */
    H5O_common_cache_ud_t common;        /* Common object header cache callback info */
} H5O_cache_ud_t;

/* Structure representing each chunk in the cache */
typedef struct H5O_chunk_proxy_t {
    H5AC_info_t cache_info; /* Information for metadata cache functions, _must_ be */
                            /* first field in structure */

    H5F_t   *f;       /* Pointer to file for object header/chunk */
    H5O_t   *oh;      /* Object header for this chunk */
    unsigned chunkno; /* Chunk number for this chunk */

    /* Flush dependency parent information (not stored)
     *
     * The following field is used to store a pointer
     * to the in-core representation of a new chunk proxy's flush dependency
     * parent -- if it exists.  If it does not exist, this field will
     * contain NULL.
     *
     * If the file is opened in SWMR write mode, the flush dependency
     * parent of the chunk proxy will be either its object header
     * or the chunk with the continuation message that references this chunk.
     */
    void *fd_parent; /* Pointer to flush dependency parent */
} H5O_chunk_proxy_t;

/* Callback information for loading object header chunk from disk */
typedef struct H5O_chk_cache_ud_t {
    hbool_t               decoding; /* Whether the object header is being decoded */
    H5O_t                *oh;       /* Object header for this chunk */
    unsigned              chunkno;  /* Index of chunk being brought in (for re-loads) */
    size_t                size;     /* Size of chunk in the file */
    H5O_common_cache_ud_t common;   /* Common object header cache callback info */
} H5O_chk_cache_ud_t;

/* Header message ID to class mapping */
H5_DLLVAR const H5O_msg_class_t *const H5O_msg_class_g[H5O_MSG_TYPES];

/* Declare external the free list for H5O_t's */
H5FL_EXTERN(H5O_t);

/* Declare external the free list for H5O_mesg_t sequences */
H5FL_SEQ_EXTERN(H5O_mesg_t);

/* Declare external the free list for H5O_chunk_t sequences */
H5FL_SEQ_EXTERN(H5O_chunk_t);

/* Declare external the free list for chunk_image blocks */
H5FL_BLK_EXTERN(chunk_image);

/*
 * Object header messages
 */

/* Null Message. (0x0000) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_NULL[1];

/* Simple Dataspace Message. (0x0001) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_SDSPACE[1];

/* Link Information Message. (0x0002) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_LINFO[1];

/* Datatype Message. (0x0003) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_DTYPE[1];

/* Old Fill Value Message. (0x0004) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_FILL[1];

/* New Fill Value Message. (0x0005) */
/*
 * The new fill value message is fill value plus
 * space allocation time and fill value writing time and whether fill
 * value is defined.
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_FILL_NEW[1];

/* Link Message. (0x0006) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_LINK[1];

/* External File List Message. (0x0007) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_EFL[1];

/* Data Layout Message. (0x0008) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_LAYOUT[1];

#ifdef H5O_ENABLE_BOGUS
/* "Bogus valid" Message. (0x0009) */
/* "Bogus invalid" Message. (0x0019) */
/*
 * Used for debugging - should never be found in valid HDF5 file.
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_BOGUS_VALID[1];
H5_DLLVAR const H5O_msg_class_t H5O_MSG_BOGUS_INVALID[1];
#endif /* H5O_ENABLE_BOGUS */

/* Group Information Message. (0x000a) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_GINFO[1];

/* Filter pipeline message. (0x000b) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_PLINE[1];

/* Attribute Message. (0x000c) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_ATTR[1];

/* Object name message. (0x000d) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_NAME[1];

/* Modification Time Message. (0x000e) */
/*
 * The message is just a `time_t'.
 * (See also the "new" modification time message)
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_MTIME[1];

/* Shared Message information message (0x000f)
 * A message for the superblock extension, holding information about
 * the file-wide shared message "SOHM" table
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_SHMESG[1];

/* Object Header Continuation Message. (0x0010) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_CONT[1];

/* Symbol Table Message. (0x0011) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_STAB[1];

/* New Modification Time Message. (0x0012) */
/*
 * The message is just a `time_t'.
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_MTIME_NEW[1];

/* v1 B-tree 'K' value message (0x0013)
 * A message for the superblock extension, holding information about
 * the file-wide v1 B-tree 'K' values.
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_BTREEK[1];

/* Driver info message (0x0014)
 * A message for the superblock extension, holding information about
 * the file driver settings
 */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_DRVINFO[1];

/* Attribute Information Message. (0x0015) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_AINFO[1];

/* Reference Count Message. (0x0016) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_REFCOUNT[1];

/* Free-space Manager Info message. (0x0017) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_FSINFO[1];

/* Metadata Cache Image message. (0x0018) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_MDCI[1];

/* Placeholder for unknown message. (0x0019) */
H5_DLLVAR const H5O_msg_class_t H5O_MSG_UNKNOWN[1];

/*
 * Object header "object" types
 */

/* Group Object. (H5O_TYPE_GROUP - 0) */
H5_DLLVAR const H5O_obj_class_t H5O_OBJ_GROUP[1];

/* Dataset Object. (H5O_TYPE_DATASET - 1) */
H5_DLLVAR const H5O_obj_class_t H5O_OBJ_DATASET[1];

/* Datatype Object. (H5O_TYPE_NAMED_DATATYPE - 2) */
H5_DLLVAR const H5O_obj_class_t H5O_OBJ_DATATYPE[1];

/* Package-local function prototypes */
H5_DLL void *H5O__open_by_addr(const H5G_loc_t *loc, haddr_t addr, H5I_type_t *opened_type /*out*/);
H5_DLL void *H5O__open_by_idx(const H5G_loc_t *loc, const char *name, H5_index_t idx_type,
                              H5_iter_order_t order, hsize_t n, H5I_type_t *opened_type /*out*/);
H5_DLL const H5O_obj_class_t *H5O__obj_class(const H5O_loc_t *loc);
H5_DLL herr_t                 H5O__copy(const H5G_loc_t *src_loc, const char *src_name, H5G_loc_t *dst_loc,
                                        const char *dst_name, hid_t ocpypl_id, hid_t lcpl_id);
H5_DLL int                    H5O__link_oh(H5F_t *f, int adjust, H5O_t *oh, hbool_t *deleted);
H5_DLL herr_t H5O__visit(H5G_loc_t *loc, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order,
                         H5O_iterate2_t op, void *op_data, unsigned fields);
H5_DLL herr_t H5O__inc_rc(H5O_t *oh);
H5_DLL herr_t H5O__dec_rc(H5O_t *oh);
H5_DLL herr_t H5O__free(H5O_t *oh, hbool_t force);

/* Object header message routines */
H5_DLL herr_t   H5O__msg_alloc(H5F_t *f, H5O_t *oh, const H5O_msg_class_t *type, unsigned *mesg_flags,
                               void *mesg, size_t *mesg_idx);
H5_DLL herr_t   H5O__msg_append_real(H5F_t *f, H5O_t *oh, const H5O_msg_class_t *type, unsigned mesg_flags,
                                     unsigned update_flags, void *mesg);
H5_DLL herr_t   H5O__msg_write_real(H5F_t *f, H5O_t *oh, const H5O_msg_class_t *type, unsigned mesg_flags,
                                    unsigned update_flags, void *mesg);
H5_DLL herr_t   H5O__msg_free_mesg(H5O_mesg_t *mesg);
H5_DLL unsigned H5O__msg_count_real(const H5O_t *oh, const H5O_msg_class_t *type);
H5_DLL herr_t   H5O__msg_remove_real(H5F_t *f, H5O_t *oh, const H5O_msg_class_t *type, int sequence,
                                     H5O_operator_t op, void *op_data, hbool_t adj_link);
H5_DLL void *H5O__msg_copy_file(const H5O_msg_class_t *type, H5F_t *file_src, void *mesg_src, H5F_t *file_dst,
                                hbool_t *recompute_size, unsigned *mesg_flags, H5O_copy_t *cpy_info,
                                void *udata);
H5_DLL herr_t H5O__msg_iterate_real(H5F_t *f, H5O_t *oh, const H5O_msg_class_t *type,
                                    const H5O_mesg_operator_t *op, void *op_data);
H5_DLL herr_t H5O__flush_msgs(H5F_t *f, H5O_t *oh);
H5_DLL herr_t H5O__delete_mesg(H5F_t *f, H5O_t *open_oh, H5O_mesg_t *mesg);

/* Object header chunk routines */
H5_DLL herr_t             H5O__chunk_add(H5F_t *f, H5O_t *oh, unsigned idx, unsigned cont_chunkno);
H5_DLL H5O_chunk_proxy_t *H5O__chunk_protect(H5F_t *f, H5O_t *oh, unsigned idx);
H5_DLL herr_t             H5O__chunk_unprotect(H5F_t *f, H5O_chunk_proxy_t *chk_proxy, hbool_t chk_dirtied);
H5_DLL herr_t             H5O__chunk_update_idx(H5F_t *f, H5O_t *oh, unsigned idx);
H5_DLL herr_t             H5O__chunk_resize(H5O_t *oh, H5O_chunk_proxy_t *chk_proxy);
H5_DLL herr_t             H5O__chunk_delete(H5F_t *f, H5O_t *oh, unsigned idx);
H5_DLL herr_t             H5O__chunk_dest(H5O_chunk_proxy_t *chunk_proxy);

/* Cache corking functions */
H5_DLL herr_t H5O__disable_mdc_flushes(H5O_loc_t *oloc);
H5_DLL herr_t H5O__enable_mdc_flushes(H5O_loc_t *oloc);
H5_DLL herr_t H5O__are_mdc_flushes_disabled(const H5O_loc_t *oloc, hbool_t *are_disabled);

/* Collect storage info for btree and heap */
H5_DLL herr_t H5O__attr_bh_info(H5F_t *f, H5O_t *oh, H5_ih_info_t *bh_info);

/* Object header allocation routines */
H5_DLL herr_t H5O__alloc_msgs(H5O_t *oh, size_t min_alloc);
H5_DLL herr_t H5O__alloc_chunk(H5F_t *f, H5O_t *oh, size_t size, size_t found_null,
                               const H5O_msg_alloc_info_t *found_msg, size_t *new_idx);
H5_DLL herr_t H5O__alloc(H5F_t *f, H5O_t *oh, const H5O_msg_class_t *type, const void *mesg,
                         size_t *mesg_idx);
H5_DLL herr_t H5O__condense_header(H5F_t *f, H5O_t *oh);
H5_DLL herr_t H5O__release_mesg(H5F_t *f, H5O_t *oh, H5O_mesg_t *mesg, hbool_t adj_link);

/* Shared object operators */
H5_DLL void  *H5O__shared_decode(H5F_t *f, H5O_t *open_oh, unsigned *ioflags, const uint8_t *buf,
                                 const H5O_msg_class_t *type);
H5_DLL herr_t H5O__shared_encode(const H5F_t *f, uint8_t *buf /*out*/, const H5O_shared_t *sh_mesg);
H5_DLL size_t H5O__shared_size(const H5F_t *f, const H5O_shared_t *sh_mesg);
H5_DLL herr_t H5O__shared_delete(H5F_t *f, H5O_t *open_oh, const H5O_msg_class_t *mesg_type,
                                 H5O_shared_t *sh_mesg);
H5_DLL herr_t H5O__shared_link(H5F_t *f, H5O_t *open_oh, const H5O_msg_class_t *mesg_type,
                               H5O_shared_t *sh_mesg);
H5_DLL herr_t H5O__shared_copy_file(H5F_t *file_src, H5F_t *file_dst, const H5O_msg_class_t *mesg_type,
                                    const void *_native_src, void *_native_dst, hbool_t *recompute_size,
                                    unsigned *mesg_flags, H5O_copy_t *cpy_info, void *udata);
H5_DLL herr_t H5O__shared_post_copy_file(H5F_t *f, const H5O_msg_class_t *mesg_type,
                                         const H5O_shared_t *shared_src, H5O_shared_t *shared_dst,
                                         unsigned *mesg_flags, H5O_copy_t *cpy_info);
H5_DLL herr_t H5O__shared_debug(const H5O_shared_t *mesg, FILE *stream, int indent, int fwidth);

/* Attribute message operators */
H5_DLL herr_t H5O__attr_reset(void *_mesg);
H5_DLL herr_t H5O__attr_delete(H5F_t *f, H5O_t *open_oh, void *_mesg);
H5_DLL herr_t H5O__attr_link(H5F_t *f, H5O_t *open_oh, void *_mesg);
H5_DLL herr_t H5O__attr_count_real(H5F_t *f, H5O_t *oh, hsize_t *nattrs);

/* Arrays of versions for:
 * Object header, Attribute/Fill value/Filter pipeline messages
 */
/* Layout/Datatype/Dataspace arrays of versions are in H5Dpkg.h, H5Tpkg.h and H5Spkg.h */
H5_DLLVAR const unsigned H5O_obj_ver_bounds[H5F_LIBVER_NBOUNDS];
H5_DLLVAR const unsigned H5O_attr_ver_bounds[H5F_LIBVER_NBOUNDS];
H5_DLLVAR const unsigned H5O_fill_ver_bounds[H5F_LIBVER_NBOUNDS];
H5_DLLVAR const unsigned H5O_pline_ver_bounds[H5F_LIBVER_NBOUNDS];

/* Testing functions */
#ifdef H5O_TESTING
H5_DLL htri_t H5O__is_attr_empty_test(hid_t oid);
H5_DLL htri_t H5O__is_attr_dense_test(hid_t oid);
H5_DLL herr_t H5O__num_attrs_test(hid_t oid, hsize_t *nattrs);
H5_DLL herr_t H5O__attr_dense_info_test(hid_t oid, hsize_t *name_count, hsize_t *corder_count);
H5_DLL herr_t H5O__check_msg_marked_test(hid_t oid, hbool_t flag_val);
H5_DLL herr_t H5O__expunge_chunks_test(const H5O_loc_t *oloc);
H5_DLL herr_t H5O__get_rc_test(const H5O_loc_t *oloc, unsigned *rc);
H5_DLL herr_t H5O__msg_get_chunkno_test(hid_t oid, unsigned msg_type, unsigned *chunk_num);
H5_DLL herr_t H5O__msg_move_to_new_chunk_test(hid_t oid, unsigned msg_type);
#endif /* H5O_TESTING */

/* Object header debugging routines */
#ifdef H5O_DEBUG
H5_DLL herr_t H5O__assert(const H5O_t *oh);
#endif /* H5O_DEBUG */
H5_DLL herr_t H5O__debug_real(H5F_t *f, H5O_t *oh, haddr_t addr, FILE *stream, int indent, int fwidth);

#endif /* H5Opkg_H */