/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

 * 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     *

 * help@hdfgroup.org.                                                        *

 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*-------------------------------------------------------------------------

 *

 * Created:   H5Pfcpl.c

 *

 * Purpose:   File creation property list class routines

 *

 *-------------------------------------------------------------------------

 */

/****************/

/* Module Setup */

/****************/

#include "H5Pmodule.h" /* This source code file is part of the H5P module */

/***********/

/* Headers */

/***********/

#include "H5private.h"  /* Generic Functions      */

#include "H5Bprivate.h" /* B-tree subclass names    */

#include "H5Eprivate.h" /* Error handling     */

#include "H5Fprivate.h" /* Files        */

#include "H5Ppkg.h"     /* Property lists     */

/****************/

/* Local Macros */

/****************/

/* ========= File Creation properties ============ */

/* Definitions for the size of the file user block in bytes */

#define H5F_CRT_USER_BLOCK_SIZE sizeof(hsize_t)

#define H5F_CRT_USER_BLOCK_DEF  0

#define H5F_CRT_USER_BLOCK_ENC  H5P__encode_hsize_t

#define H5F_CRT_USER_BLOCK_DEC  H5P__decode_hsize_t

/* Definitions for the 1/2 rank for symbol table leaf nodes */

#define H5F_CRT_SYM_LEAF_SIZE sizeof(unsigned)

#define H5F_CRT_SYM_LEAF_ENC  H5P__encode_unsigned

#define H5F_CRT_SYM_LEAF_DEC  H5P__decode_unsigned

/* Definitions for the 1/2 rank for btree internal nodes    */

#define H5F_CRT_BTREE_RANK_SIZE sizeof(unsigned[H5B_NUM_BTREE_ID])

#define H5F_CRT_BTREE_RANK_DEF                                                                               \

    {                                                                                                        \

        HDF5_BTREE_SNODE_IK_DEF, HDF5_BTREE_CHUNK_IK_DEF                                                     \

    }

#define H5F_CRT_BTREE_RANK_ENC H5P__fcrt_btree_rank_enc

#define H5F_CRT_BTREE_RANK_DEC H5P__fcrt_btree_rank_dec

/* Definitions for byte number in an address                */

#define H5F_CRT_ADDR_BYTE_NUM_SIZE sizeof(uint8_t)

#define H5F_CRT_ADDR_BYTE_NUM_DEF  H5F_OBJ_ADDR_SIZE

#define H5F_CRT_ADDR_BYTE_NUM_ENC  H5P__encode_uint8_t

#define H5F_CRT_ADDR_BYTE_NUM_DEC  H5P__decode_uint8_t

/* Definitions for byte number for object size              */

#define H5F_CRT_OBJ_BYTE_NUM_SIZE sizeof(uint8_t)

#define H5F_CRT_OBJ_BYTE_NUM_DEF  H5F_OBJ_SIZE_SIZE

#define H5F_CRT_OBJ_BYTE_NUM_ENC  H5P__encode_uint8_t

#define H5F_CRT_OBJ_BYTE_NUM_DEC  H5P__decode_uint8_t

/* Definitions for version number of the superblock         */

#define H5F_CRT_SUPER_VERS_SIZE sizeof(unsigned)

#define H5F_CRT_SUPER_VERS_DEF  HDF5_SUPERBLOCK_VERSION_DEF

/* Definitions for shared object header messages */

#define H5F_CRT_SHMSG_NINDEXES_SIZE    sizeof(unsigned)

#define H5F_CRT_SHMSG_NINDEXES_DEF     (0)

#define H5F_CRT_SHMSG_NINDEXES_ENC     H5P__encode_unsigned

#define H5F_CRT_SHMSG_NINDEXES_DEC     H5P__decode_unsigned

#define H5F_CRT_SHMSG_INDEX_TYPES_SIZE sizeof(unsigned[H5O_SHMESG_MAX_NINDEXES])

#define H5F_CRT_SHMSG_INDEX_TYPES_DEF                                                                        \

    {                                                                                                        \

        0, 0, 0, 0, 0, 0                                                                                     \

    }

#define H5F_CRT_SHMSG_INDEX_TYPES_ENC    H5P__fcrt_shmsg_index_types_enc

#define H5F_CRT_SHMSG_INDEX_TYPES_DEC    H5P__fcrt_shmsg_index_types_dec

#define H5F_CRT_SHMSG_INDEX_MINSIZE_SIZE sizeof(unsigned[H5O_SHMESG_MAX_NINDEXES])

#define H5F_CRT_SHMSG_INDEX_MINSIZE_DEF                                                                      \

    {                                                                                                        \

        250, 250, 250, 250, 250, 250                                                                         \

    }

#define H5F_CRT_SHMSG_INDEX_MINSIZE_ENC H5P__fcrt_shmsg_index_minsize_enc

#define H5F_CRT_SHMSG_INDEX_MINSIZE_DEC H5P__fcrt_shmsg_index_minsize_dec

/* Definitions for shared object header list/btree phase change cutoffs */

#define H5F_CRT_SHMSG_LIST_MAX_SIZE  sizeof(unsigned)

#define H5F_CRT_SHMSG_LIST_MAX_DEF   (50)

#define H5F_CRT_SHMSG_LIST_MAX_ENC   H5P__encode_unsigned

#define H5F_CRT_SHMSG_LIST_MAX_DEC   H5P__decode_unsigned

#define H5F_CRT_SHMSG_BTREE_MIN_SIZE sizeof(unsigned)

#define H5F_CRT_SHMSG_BTREE_MIN_DEF  (40)

#define H5F_CRT_SHMSG_BTREE_MIN_ENC  H5P__encode_unsigned

#define H5F_CRT_SHMSG_BTREE_MIN_DEC  H5P__decode_unsigned

/* Definitions for file space handling strategy */

#define H5F_CRT_FILE_SPACE_STRATEGY_SIZE  sizeof(H5F_fspace_strategy_t)

#define H5F_CRT_FILE_SPACE_STRATEGY_DEF   H5F_FILE_SPACE_STRATEGY_DEF

#define H5F_CRT_FILE_SPACE_STRATEGY_ENC   H5P__fcrt_fspace_strategy_enc

#define H5F_CRT_FILE_SPACE_STRATEGY_DEC   H5P__fcrt_fspace_strategy_dec

#define H5F_CRT_FREE_SPACE_PERSIST_SIZE   sizeof(bool)

#define H5F_CRT_FREE_SPACE_PERSIST_DEF    H5F_FREE_SPACE_PERSIST_DEF

#define H5F_CRT_FREE_SPACE_PERSIST_ENC    H5P__encode_bool

#define H5F_CRT_FREE_SPACE_PERSIST_DEC    H5P__decode_bool

#define H5F_CRT_FREE_SPACE_THRESHOLD_SIZE sizeof(hsize_t)

#define H5F_CRT_FREE_SPACE_THRESHOLD_DEF  H5F_FREE_SPACE_THRESHOLD_DEF

#define H5F_CRT_FREE_SPACE_THRESHOLD_ENC  H5P__encode_hsize_t

#define H5F_CRT_FREE_SPACE_THRESHOLD_DEC  H5P__decode_hsize_t

/* Definitions for file space page size in support of level-2 page caching */

#define H5F_CRT_FILE_SPACE_PAGE_SIZE_SIZE sizeof(hsize_t)

#define H5F_CRT_FILE_SPACE_PAGE_SIZE_DEF  H5F_FILE_SPACE_PAGE_SIZE_DEF

#define H5F_CRT_FILE_SPACE_PAGE_SIZE_ENC  H5P__encode_hsize_t

#define H5F_CRT_FILE_SPACE_PAGE_SIZE_DEC  H5P__decode_hsize_t

/******************/

/* Local Typedefs */

/******************/

/********************/

/* Package Typedefs */

/********************/

/********************/

/* Local Prototypes */

/********************/

/* Property class callbacks */

static herr_t H5P__fcrt_reg_prop(H5P_genclass_t *pclass);

/* property callbacks */

static herr_t H5P__fcrt_btree_rank_enc(const void *value, void **_pp, size_t *size);

static herr_t H5P__fcrt_btree_rank_dec(const void **_pp, void *value);

static herr_t H5P__fcrt_shmsg_index_types_enc(const void *value, void **_pp, size_t *size);

static herr_t H5P__fcrt_shmsg_index_types_dec(const void **_pp, void *value);

static herr_t H5P__fcrt_shmsg_index_minsize_enc(const void *value, void **_pp, size_t *size);

static herr_t H5P__fcrt_shmsg_index_minsize_dec(const void **_pp, void *value);

static herr_t H5P__fcrt_fspace_strategy_enc(const void *value, void **_pp, size_t *size);

static herr_t H5P__fcrt_fspace_strategy_dec(const void **_pp, void *_value);

/*********************/

/* Package Variables */

/*********************/

/* File creation property list class library initialization object */

const H5P_libclass_t H5P_CLS_FCRT[1] = {{

    "file create",        /* Class name for debugging     */

    H5P_TYPE_FILE_CREATE, /* Class type                   */

    &H5P_CLS_GROUP_CREATE_g,   /* Parent class                 */

    &H5P_CLS_FILE_CREATE_g,    /* Pointer to class             */

    &H5P_CLS_FILE_CREATE_ID_g, /* Pointer to class ID          */

    &H5P_LST_FILE_CREATE_ID_g, /* Pointer to default property list ID */

    H5P__fcrt_reg_prop,        /* Default property registration routine */

    NULL, /* Class creation callback      */

    NULL, /* Class creation callback info */

    NULL, /* Class copy callback          */

    NULL, /* Class copy callback info     */

    NULL, /* Class close callback         */

    NULL  /* Class close callback info    */

}};

/*****************************/

/* Library Private Variables */

/*****************************/

/*******************/

/* Local Variables */

/*******************/

/* Property value defaults */

static const hsize_t  H5F_def_userblock_size_g = H5F_CRT_USER_BLOCK_DEF; /* Default userblock size */

static const unsigned H5F_def_sym_leaf_k_g =

    H5F_CRT_SYM_LEAF_DEF; /* Default size for symbol table leaf nodes */

static const unsigned H5F_def_btree_k_g[H5B_NUM_BTREE_ID] =

    H5F_CRT_BTREE_RANK_DEF; /* Default 'K' values for B-trees in file */

static const uint8_t H5F_def_sizeof_addr_g =

    H5F_CRT_ADDR_BYTE_NUM_DEF; /* Default size of addresses in the file */

static const uint8_t H5F_def_sizeof_size_g = H5F_CRT_OBJ_BYTE_NUM_DEF; /* Default size of sizes in the file */

static const unsigned H5F_def_superblock_ver_g   = H5F_CRT_SUPER_VERS_DEF; /* Default superblock version # */

static const unsigned H5F_def_num_sohm_indexes_g = H5F_CRT_SHMSG_NINDEXES_DEF;

static const unsigned H5F_def_sohm_index_flags_g[H5O_SHMESG_MAX_NINDEXES] = H5F_CRT_SHMSG_INDEX_TYPES_DEF;

static const unsigned H5F_def_sohm_index_minsizes_g[H5O_SHMESG_MAX_NINDEXES] =

    H5F_CRT_SHMSG_INDEX_MINSIZE_DEF;

static const unsigned              H5F_def_sohm_list_max_g        = H5F_CRT_SHMSG_LIST_MAX_DEF;

static const unsigned              H5F_def_sohm_btree_min_g       = H5F_CRT_SHMSG_BTREE_MIN_DEF;

static const H5F_fspace_strategy_t H5F_def_file_space_strategy_g  = H5F_CRT_FILE_SPACE_STRATEGY_DEF;

static const bool                  H5F_def_free_space_persist_g   = H5F_CRT_FREE_SPACE_PERSIST_DEF;

static const hsize_t               H5F_def_free_space_threshold_g = H5F_CRT_FREE_SPACE_THRESHOLD_DEF;

static const hsize_t               H5F_def_file_space_page_size_g = H5F_CRT_FILE_SPACE_PAGE_SIZE_DEF;

/*-------------------------------------------------------------------------

 * Function:    H5P__fcrt_reg_prop

 *

 * Purpose:     Register the file creation property list class's properties

 *

 * Return:      Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

static herr_t

H5P__fcrt_reg_prop(H5P_genclass_t *pclass)

{

    herr_t ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_PACKAGE

    /* Register the user block size */

    if (H5P__register_real(pclass, H5F_CRT_USER_BLOCK_NAME, H5F_CRT_USER_BLOCK_SIZE,

                           &H5F_def_userblock_size_g, NULL, NULL, NULL, H5F_CRT_USER_BLOCK_ENC,

                           H5F_CRT_USER_BLOCK_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the 1/2 rank for symbol table leaf nodes */

    if (H5P__register_real(pclass, H5F_CRT_SYM_LEAF_NAME, H5F_CRT_SYM_LEAF_SIZE, &H5F_def_sym_leaf_k_g, NULL,

                           NULL, NULL, H5F_CRT_SYM_LEAF_ENC, H5F_CRT_SYM_LEAF_DEC, NULL, NULL, NULL,

                           NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the 1/2 rank for btree internal nodes */

    if (H5P__register_real(pclass, H5F_CRT_BTREE_RANK_NAME, H5F_CRT_BTREE_RANK_SIZE, H5F_def_btree_k_g, NULL,

                           NULL, NULL, H5F_CRT_BTREE_RANK_ENC, H5F_CRT_BTREE_RANK_DEC, NULL, NULL, NULL,

                           NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the byte number for an address */

    if (H5P__register_real(pclass, H5F_CRT_ADDR_BYTE_NUM_NAME, H5F_CRT_ADDR_BYTE_NUM_SIZE,

                           &H5F_def_sizeof_addr_g, NULL, NULL, NULL, H5F_CRT_ADDR_BYTE_NUM_ENC,

                           H5F_CRT_ADDR_BYTE_NUM_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the byte number for object size */

    if (H5P__register_real(pclass, H5F_CRT_OBJ_BYTE_NUM_NAME, H5F_CRT_OBJ_BYTE_NUM_SIZE,

                           &H5F_def_sizeof_size_g, NULL, NULL, NULL, H5F_CRT_OBJ_BYTE_NUM_ENC,

                           H5F_CRT_OBJ_BYTE_NUM_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the superblock version number */

    /* (Note: this property should not have an encode/decode callback -QAK) */

    if (H5P__register_real(pclass, H5F_CRT_SUPER_VERS_NAME, H5F_CRT_SUPER_VERS_SIZE,

                           &H5F_def_superblock_ver_g, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,

                           NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the shared OH message information */

    if (H5P__register_real(pclass, H5F_CRT_SHMSG_NINDEXES_NAME, H5F_CRT_SHMSG_NINDEXES_SIZE,

                           &H5F_def_num_sohm_indexes_g, NULL, NULL, NULL, H5F_CRT_SHMSG_NINDEXES_ENC,

                           H5F_CRT_SHMSG_NINDEXES_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    if (H5P__register_real(pclass, H5F_CRT_SHMSG_INDEX_TYPES_NAME, H5F_CRT_SHMSG_INDEX_TYPES_SIZE,

                           &H5F_def_sohm_index_flags_g, NULL, NULL, NULL, H5F_CRT_SHMSG_INDEX_TYPES_ENC,

                           H5F_CRT_SHMSG_INDEX_TYPES_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    if (H5P__register_real(pclass, H5F_CRT_SHMSG_INDEX_MINSIZE_NAME, H5F_CRT_SHMSG_INDEX_MINSIZE_SIZE,

                           &H5F_def_sohm_index_minsizes_g, NULL, NULL, NULL, H5F_CRT_SHMSG_INDEX_MINSIZE_ENC,

                           H5F_CRT_SHMSG_INDEX_MINSIZE_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the shared OH cutoff size information */

    if (H5P__register_real(pclass, H5F_CRT_SHMSG_LIST_MAX_NAME, H5F_CRT_SHMSG_LIST_MAX_SIZE,

                           &H5F_def_sohm_list_max_g, NULL, NULL, NULL, H5F_CRT_SHMSG_LIST_MAX_ENC,

                           H5F_CRT_SHMSG_LIST_MAX_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    if (H5P__register_real(pclass, H5F_CRT_SHMSG_BTREE_MIN_NAME, H5F_CRT_SHMSG_BTREE_MIN_SIZE,

                           &H5F_def_sohm_btree_min_g, NULL, NULL, NULL, H5F_CRT_SHMSG_BTREE_MIN_ENC,

                           H5F_CRT_SHMSG_BTREE_MIN_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the file space handling strategy */

    if (H5P__register_real(pclass, H5F_CRT_FILE_SPACE_STRATEGY_NAME, H5F_CRT_FILE_SPACE_STRATEGY_SIZE,

                           &H5F_def_file_space_strategy_g, NULL, NULL, NULL, H5F_CRT_FILE_SPACE_STRATEGY_ENC,

                           H5F_CRT_FILE_SPACE_STRATEGY_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the free-space persist flag */

    if (H5P__register_real(pclass, H5F_CRT_FREE_SPACE_PERSIST_NAME, H5F_CRT_FREE_SPACE_PERSIST_SIZE,

                           &H5F_def_free_space_persist_g, NULL, NULL, NULL, H5F_CRT_FREE_SPACE_PERSIST_ENC,

                           H5F_CRT_FREE_SPACE_PERSIST_DEC, NULL, NULL, NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the free space section threshold */

    if (H5P__register_real(pclass, H5F_CRT_FREE_SPACE_THRESHOLD_NAME, H5F_CRT_FREE_SPACE_THRESHOLD_SIZE,

                           &H5F_def_free_space_threshold_g, NULL, NULL, NULL,

                           H5F_CRT_FREE_SPACE_THRESHOLD_ENC, H5F_CRT_FREE_SPACE_THRESHOLD_DEC, NULL, NULL,

                           NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

    /* Register the file space page size */

    if (H5P__register_real(pclass, H5F_CRT_FILE_SPACE_PAGE_SIZE_NAME, H5F_CRT_FILE_SPACE_PAGE_SIZE_SIZE,

                           &H5F_def_file_space_page_size_g, NULL, NULL, NULL,

                           H5F_CRT_FILE_SPACE_PAGE_SIZE_ENC, H5F_CRT_FILE_SPACE_PAGE_SIZE_DEC, NULL, NULL,

                           NULL, NULL) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");

done:

    FUNC_LEAVE_NOAPI(ret_value)

} /* end H5P__fcrt_reg_prop() */

/*-------------------------------------------------------------------------

 * Function:  H5Pset_userblock

 *

 * Purpose: Sets the userblock size field of a file creation property

 *    list.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pset_userblock(hid_t plist_id, hsize_t size)

{

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* return value */

    FUNC_ENTER_API(FAIL)

    /* Sanity check non-zero userblock sizes */

    if (size > 0) {

        /* Check that the userblock size is >=512 */

        if (size < 512)

            HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "userblock size is non-zero and less than 512");

        /* Check that the userblock size is a power of two */

        if (!POWER_OF_TWO(size))

            HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "userblock size is non-zero and not a power of two");

    } /* end if */

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, false)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Set value */

    if (H5P_set(plist, H5F_CRT_USER_BLOCK_NAME, &size) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set user block");

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pset_userblock() */

/*-------------------------------------------------------------------------

 * Function:  H5Pget_userblock

 *

 * Purpose: Queries the size of a user block in a file creation property

 *    list.

 *

 * Return:  Success:  Non-negative, size returned through SIZE argument.

 *

 *    Failure:  Negative

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pget_userblock(hid_t plist_id, hsize_t *size /*out*/)

{

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, true)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Get value */

    if (size)

        if (H5P_get(plist, H5F_CRT_USER_BLOCK_NAME, size) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get user block");

done:

    FUNC_LEAVE_API(ret_value)

}

/*-------------------------------------------------------------------------

 * Function:  H5Pset_sizes

 *

 * Purpose: Sets file size-of addresses and sizes.  PLIST_ID should be a

 *    file creation property list.  A value of zero causes the

 *    property to not change.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, size_t sizeof_size)

{

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* return value */

    FUNC_ENTER_API(FAIL)

    /* Check arguments */

    if (sizeof_addr) {

        if (sizeof_addr != 2 && sizeof_addr != 4 && sizeof_addr != 8 && sizeof_addr != 16)

            HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "file haddr_t size is not valid");

    } /* end if */

    if (sizeof_size) {

        if (sizeof_size != 2 && sizeof_size != 4 && sizeof_size != 8 && sizeof_size != 16)

            HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "file size_t size is not valid");

    } /* end if */

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, false)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Set value */

    if (sizeof_addr) {

        uint8_t tmp_sizeof_addr = (uint8_t)sizeof_addr;

        if (H5P_set(plist, H5F_CRT_ADDR_BYTE_NUM_NAME, &tmp_sizeof_addr) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set byte number for an address");

    } /* end if */

    if (sizeof_size) {

        uint8_t tmp_sizeof_size = (uint8_t)sizeof_size;

        if (H5P_set(plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &tmp_sizeof_size) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set byte number for object ");

    } /* end if */

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pset_sizes() */

/*-------------------------------------------------------------------------

 * Function:  H5Pget_sizes

 *

 * Purpose: Returns the size of address and size quantities stored in a

 *    file according to a file creation property list.  Either (or

 *    even both) SIZEOF_ADDR and SIZEOF_SIZE may be null pointers.

 *

 * Return:  Success:  Non-negative, sizes returned through arguments.

 *    Failure:  Negative

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pget_sizes(hid_t plist_id, size_t *sizeof_addr /*out*/, size_t *sizeof_size /*out*/)

{

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, true)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Get values */

    if (sizeof_addr) {

        uint8_t tmp_sizeof_addr;

        if (H5P_get(plist, H5F_CRT_ADDR_BYTE_NUM_NAME, &tmp_sizeof_addr) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get byte number for an address");

        *sizeof_addr = tmp_sizeof_addr;

    } /* end if */

    if (sizeof_size) {

        uint8_t tmp_sizeof_size;

        if (H5P_get(plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &tmp_sizeof_size) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get byte number for object ");

        *sizeof_size = tmp_sizeof_size;

    } /* end if */

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pget_sizes() */

/*-------------------------------------------------------------------------

 * Function:  H5Pset_sym_k

 *

 * Purpose: IK is one half the rank of a tree that stores a symbol

 *    table for a group.  Internal nodes of the symbol table are on

 *    average 75% full.  That is, the average rank of the tree is

 *    1.5 times the value of IK.

 *

 *    LK is one half of the number of symbols that can be stored in

 *    a symbol table node.  A symbol table node is the leaf of a

 *    symbol table tree which is used to store a group.  When

 *    symbols are inserted randomly into a group, the group's

 *    symbol table nodes are 75% full on average.  That is, they

 *    contain 1.5 times the number of symbols specified by LK.

 *

 *    Either (or even both) of IK and LK can be zero in which case

 *    that value is left unchanged.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pset_sym_k(hid_t plist_id, unsigned ik, unsigned lk)

{

    unsigned        btree_k[H5B_NUM_BTREE_ID];

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, false)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Set values */

    if (ik > 0) {

        if ((ik * 2) >= HDF5_BTREE_IK_MAX_ENTRIES)

            HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "istore IK value exceeds maximum B-tree entries");

        if (H5P_get(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for btree internal nodes");

        btree_k[H5B_SNODE_ID] = ik;

        if (H5P_set(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set rank for btree nodes");

    }

    if (lk > 0)

        if (H5P_set(plist, H5F_CRT_SYM_LEAF_NAME, &lk) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set rank for symbol table leaf nodes");

done:

    FUNC_LEAVE_API(ret_value)

}

/*-------------------------------------------------------------------------

 * Function:  H5Pget_sym_k

 *

 * Purpose: Retrieves the symbol table B-tree 1/2 rank (IK) and the

 *    symbol table leaf node 1/2 size (LK).  See H5Pset_sym_k() for

 *    details. Either (or even both) IK and LK may be null

 *    pointers.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pget_sym_k(hid_t plist_id, unsigned *ik /*out*/, unsigned *lk /*out*/)

{

    unsigned        btree_k[H5B_NUM_BTREE_ID];

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, true)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Get values */

    if (ik) {

        if (H5P_get(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for btree nodes");

        *ik = btree_k[H5B_SNODE_ID];

    }

    if (lk)

        if (H5P_get(plist, H5F_CRT_SYM_LEAF_NAME, lk) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for symbol table leaf nodes");

done:

    FUNC_LEAVE_API(ret_value)

}

/*-------------------------------------------------------------------------

 * Function:  H5Pset_istore_k

 *

 * Purpose: IK is one half the rank of a tree that stores chunked raw

 *    data.  On average, such a tree will be 75% full, or have an

 *    average rank of 1.5 times the value of IK.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pset_istore_k(hid_t plist_id, unsigned ik)

{

    unsigned        btree_k[H5B_NUM_BTREE_ID];

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Check arguments */

    if (ik == 0)

        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "istore IK value must be positive");

    if ((ik * 2) >= HDF5_BTREE_IK_MAX_ENTRIES)

        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "istore IK value exceeds maximum B-tree entries");

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, false)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Set value */

    if (H5P_get(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for btree internal nodes");

    btree_k[H5B_CHUNK_ID] = ik;

    if (H5P_set(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set rank for btree internal nodes");

done:

    FUNC_LEAVE_API(ret_value)

}

/*-------------------------------------------------------------------------

 * Function:  H5Pget_istore_k

 *

 * Purpose: Queries the 1/2 rank of an indexed storage B-tree.  See

 *    H5Pset_istore_k() for details.  The argument IK may be the

 *    null pointer.

 *

 * Return:  Success:  Non-negative, size returned through IK

 *

 *    Failure:  Negative

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pget_istore_k(hid_t plist_id, unsigned *ik /*out*/)

{

    unsigned        btree_k[H5B_NUM_BTREE_ID];

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, true)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Get value */

    if (ik) {

        if (H5P_get(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)

            HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for btree internal nodes");

        *ik = btree_k[H5B_CHUNK_ID];

    } /* end if */

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pget_istore_k() */

/*-------------------------------------------------------------------------

 * Function:       H5P__fcrt_btree_rank_enc

 *

 * Purpose:        Callback routine which is called whenever the index storage

 *                 btree in a file creation property list is encoded.

 *

 * Return:     Success: Non-negative

 *       Failure: Negative

 *

 *-------------------------------------------------------------------------

 */

static herr_t

H5P__fcrt_btree_rank_enc(const void *value, void **_pp, size_t *size)

{

    const unsigned *btree_k = (const unsigned *)value; /* Create local alias for values */

    uint8_t       **pp      = (uint8_t **)_pp;

    FUNC_ENTER_PACKAGE_NOERR

    /* Sanity check */

    assert(btree_k);

    assert(size);

    if (NULL != *pp) {

        unsigned u; /* Local index variable */

        /* Encode the size of an unsigned*/

        *(*pp)++ = (uint8_t)sizeof(unsigned);

        /* Encode all the btree  */

        for (u = 0; u < H5B_NUM_BTREE_ID; u++) {

            /* Encode the left split value */

            H5_ENCODE_UNSIGNED(*pp, *(const unsigned *)btree_k);

            btree_k++;

        } /* end for */

    }     /* end if */

    /* Size of type flags values */

    *size += 1 + (H5B_NUM_BTREE_ID * sizeof(unsigned));

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* end H5P__fcrt_btree_rank_enc() */

/*-------------------------------------------------------------------------

 * Function:       H5P__fcrt_btree_rank_dec

 *

 * Purpose:        Callback routine which is called whenever the index storage

 *                 btree in a file creation property list is decoded.

 *

 * Return:     Success: Non-negative

 *       Failure: Negative

 *

 *-------------------------------------------------------------------------

 */

static herr_t

H5P__fcrt_btree_rank_dec(const void **_pp, void *_value)

{

    unsigned       *btree_k = (unsigned *)_value;

    const uint8_t **pp      = (const uint8_t **)_pp;

    unsigned        enc_size;            /* Size of encoded property */

    unsigned        u;                   /* Local index variable */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_PACKAGE

    /* Sanity checks */

    assert(pp);

    assert(*pp);

    assert(btree_k);

    /* Decode the size */

    enc_size = *(*pp)++;

    if (enc_size != sizeof(unsigned))

        HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "unsigned value can't be decoded");

    /* Decode all the type flags */

    for (u = 0; u < H5B_NUM_BTREE_ID; u++)

        H5_DECODE_UNSIGNED(*pp, btree_k[u]);

done:

    FUNC_LEAVE_NOAPI(ret_value)

} /* end H5P__fcrt_btree_rank_dec() */

/*-------------------------------------------------------------------------

 * Function:  H5Pset_shared_mesg_nindexes

 *

 * Purpose: Set the number of Shared Object Header Message (SOHM)

 *              indexes specified in this property list.  If this is

 *              zero then shared object header messages are disabled

 *              for this file.

 *

 *              These indexes can then be configured with

 *              H5Pset_shared_mesg_index.  H5Pset_shared_mesg_phase_chage

 *              also controls settings for all indexes.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pset_shared_mesg_nindexes(hid_t plist_id, unsigned nindexes)

{

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Check argument */

    if (nindexes > H5O_SHMESG_MAX_NINDEXES)

        HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,

                    "number of indexes is greater than H5O_SHMESG_MAX_NINDEXES");

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, false)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    if (H5P_set(plist, H5F_CRT_SHMSG_NINDEXES_NAME, &nindexes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set number of indexes");

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pset_shared_mesg_nindexes() */

/*-------------------------------------------------------------------------

 * Function:  H5Pget_shared_mesg_nindexes

 *

 * Purpose: Get the number of Shared Object Header Message (SOHM)

 *              indexes specified in this property list.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pget_shared_mesg_nindexes(hid_t plist_id, unsigned *nindexes /*out*/)

{

    H5P_genplist_t *plist;               /* Property list pointer */

    herr_t          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, true)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    if (H5P_get(plist, H5F_CRT_SHMSG_NINDEXES_NAME, nindexes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get number of indexes");

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pget_shared_mesg_nindexes() */

/*-------------------------------------------------------------------------

 * Function:  H5Pset_shared_mesg_index

 *

 * Purpose: Configure a given shared message index.  Sets the types of

 *              message that should be stored in this index and the minimum

 *              size of a message in the index.

 *

 *              INDEX_NUM is zero-indexed (in a file with three indexes,

 *              they are numbered 0, 1, and 2).

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pset_shared_mesg_index(hid_t plist_id, unsigned index_num, unsigned mesg_type_flags, unsigned min_mesg_size)

{

    H5P_genplist_t *plist;                               /* Property list pointer */

    unsigned        nindexes;                            /* Number of SOHM indexes */

    unsigned        type_flags[H5O_SHMESG_MAX_NINDEXES]; /* Array of mesg_type_flags*/

    unsigned        minsizes[H5O_SHMESG_MAX_NINDEXES];   /* Array of min_mesg_sizes*/

    herr_t          ret_value = SUCCEED;                 /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Check arguments */

    if (mesg_type_flags > H5O_SHMESG_ALL_FLAG)

        HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "unrecognized flags in mesg_type_flags");

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, false)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Read the current number of indexes */

    if (H5P_get(plist, H5F_CRT_SHMSG_NINDEXES_NAME, &nindexes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get number of indexes");

    /* Range check */

    if (index_num >= nindexes)

        HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "index_num is too large; no such index");

    /* Get arrays of type flags and message sizes */

    if (H5P_get(plist, H5F_CRT_SHMSG_INDEX_TYPES_NAME, type_flags) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get current index type flags");

    if (H5P_get(plist, H5F_CRT_SHMSG_INDEX_MINSIZE_NAME, minsizes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get current min sizes");

    /* Set values in arrays */

    type_flags[index_num] = mesg_type_flags;

    minsizes[index_num]   = min_mesg_size;

    /* Write arrays back to plist */

    if (H5P_set(plist, H5F_CRT_SHMSG_INDEX_TYPES_NAME, type_flags) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set index type flags");

    if (H5P_set(plist, H5F_CRT_SHMSG_INDEX_MINSIZE_NAME, minsizes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set min mesg sizes");

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pset_shared_mesg_index() */

/*-------------------------------------------------------------------------

 * Function:  H5Pget_shared_mesg_index

 *

 * Purpose: Get information about a given shared message index.  Gets

 *              the types of message that are stored in the index and the

 *              minimum size of a message in the index.

 *

 * Return:  Non-negative on success/Negative on failure

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5Pget_shared_mesg_index(hid_t plist_id, unsigned index_num, unsigned *mesg_type_flags /*out*/,

                         unsigned *min_mesg_size /*out*/)

{

    H5P_genplist_t *plist;                               /* Property list pointer */

    unsigned        nindexes;                            /* Number of SOHM indexes */

    unsigned        type_flags[H5O_SHMESG_MAX_NINDEXES]; /* Array of mesg_type_flags*/

    unsigned        minsizes[H5O_SHMESG_MAX_NINDEXES];   /* Array of min_mesg_sizes*/

    herr_t          ret_value = SUCCEED;                 /* Return value */

    FUNC_ENTER_API(FAIL)

    /* Get the plist structure */

    if (NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_CREATE, true)))

        HGOTO_ERROR(H5E_ID, H5E_BADID, FAIL, "can't find object for ID");

    /* Read the current number of indexes */

    if (H5P_get(plist, H5F_CRT_SHMSG_NINDEXES_NAME, &nindexes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get number of indexes");

    if (index_num >= nindexes)

        HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,

                    "index_num is greater than number of indexes in property list");

    /* Get arrays of type flags and message sizes */

    if (H5P_get(plist, H5F_CRT_SHMSG_INDEX_TYPES_NAME, type_flags) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get current index type flags");

    if (H5P_get(plist, H5F_CRT_SHMSG_INDEX_MINSIZE_NAME, minsizes) < 0)

        HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get current min sizes");

    /* Get values from arrays */

    if (mesg_type_flags)

        *mesg_type_flags = type_flags[index_num];

    if (min_mesg_size)

        *min_mesg_size = minsizes[index_num];

done:

    FUNC_LEAVE_API(ret_value)

} /* end H5Pset_shared_mesg_index() */

/*-------------------------------------------------------------------------

 * Function:       H5P__fcrt_shmsg_index_types_enc

 *

 * Purpose:        Callback routine which is called whenever the shared

 *                 message index types in a file creation property list

 *                 are encoded.

 *

 * Return:     Success: Non-negative

 *       Failure: Negative

 *

 *-------------------------------------------------------------------------

 */

static herr_t

H5P__fcrt_shmsg_index_types_enc(const void *value, void **_pp, size_t *size)

{

    const unsigned *type_flags = (const unsigned *)value; /* Create local alias for values */

    uint8_t       **pp         = (uint8_t **)_pp;

    FUNC_ENTER_PACKAGE_NOERR

    /* Sanity check */

    assert(type_flags);

    assert(size);

    if (NULL != *pp) {

        unsigned u; /* Local index variable */

        /* Encode the size of a double*/

        *(*pp)++ = (uint8_t)sizeof(unsigned);

        /* Encode all the type flags */

        for (u = 0; u < H5O_SHMESG_MAX_NINDEXES; u++) {

            /* Encode the left split value */

            H5_ENCODE_UNSIGNED(*pp, *(const unsigned *)type_flags);

            type_flags++;

        } /* end for */

    }     /* end if */

    /* Size of type flags values */

    *size += 1 + (H5O_SHMESG_MAX_NINDEXES * sizeof(unsigned));

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* end H5P__fcrt_shmsg_index_types_enc() */

/*-------------------------------------------------------------------------

 * Function:       H5P__fcrt_shmsg_index_types_dec

 *

 * Purpose:        Callback routine which is called whenever the shared

 *                 message index types in a file creation property list

 *                 are decoded.

 *

 * Return:     Success: Non-negative

 *       Failure: Negative

 *

 *-------------------------------------------------------------------------

 */

static herr_t

H5P__fcrt_shmsg_index_types_dec(const void **_pp, void *_value)

{

    unsigned       *type_flags = (unsigned *)_value;