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

 * 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:   H5Abtree2.c

 *

 * Purpose:   v2 B-tree callbacks for indexing attributes on objects

 *

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

 */

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

/* Module Setup */

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

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

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

/* Headers */

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

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

#include "H5Apkg.h"      /* Attributes          */

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

#include "H5MMprivate.h" /* Memory management     */

#include "H5SMprivate.h" /* Shared object header messages        */

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

/* Local Macros */

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

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

/* Local Typedefs */

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

/*

 * Data exchange structure for dense attribute storage.  This structure is

 * passed through the fractal heap layer to compare attributes.

 */

typedef struct H5A_fh_ud_cmp_t {

    /* downward */

    H5F_t                          *f;             /* Pointer to file that fractal heap is in */

    const char                     *name;          /* Name of attribute to compare      */

    const H5A_dense_bt2_name_rec_t *record;        /* v2 B-tree record for attribute */

    H5A_bt2_found_t                 found_op;      /* Callback when correct attribute is found */

    void                           *found_op_data; /* Callback data when correct attribute is found */

    /* upward */

    int cmp; /* Comparison of two attribute names */

} H5A_fh_ud_cmp_t;

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

/* Package Typedefs */

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

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

/* Local Prototypes */

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

/* v2 B-tree function callbacks */

/* v2 B-tree driver callbacks for 'creation order' index */

static herr_t H5A__dense_btree2_corder_store(void *native, const void *udata);

static herr_t H5A__dense_btree2_corder_compare(const void *rec1, const void *rec2, int *result);

static herr_t H5A__dense_btree2_corder_encode(uint8_t *raw, const void *native, void *ctx);

static herr_t H5A__dense_btree2_corder_decode(const uint8_t *raw, void *native, void *ctx);

static herr_t H5A__dense_btree2_corder_debug(FILE *stream, int indent, int fwidth, const void *record,

                                             const void *_udata);

/* v2 B-tree driver callbacks for 'name' index */

static herr_t H5A__dense_btree2_name_store(void *native, const void *udata);

static herr_t H5A__dense_btree2_name_compare(const void *rec1, const void *rec2, int *result);

static herr_t H5A__dense_btree2_name_encode(uint8_t *raw, const void *native, void *ctx);

static herr_t H5A__dense_btree2_name_decode(const uint8_t *raw, void *native, void *ctx);

static herr_t H5A__dense_btree2_name_debug(FILE *stream, int indent, int fwidth, const void *record,

                                           const void *_udata);

/* Fractal heap function callbacks */

static herr_t H5A__dense_fh_name_cmp(const void *obj, size_t obj_len, void *op_data);

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

/* Package Variables */

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

/* v2 B-tree class for indexing 'name' field of attributes */

const H5B2_class_t H5A_BT2_NAME[1] = {{

    /* B-tree class information */

    H5B2_ATTR_DENSE_NAME_ID,          /* Type of B-tree */

    "H5B2_ATTR_DENSE_NAME_ID",        /* Name of B-tree class */

    sizeof(H5A_dense_bt2_name_rec_t), /* Size of native record */

    NULL,                             /* Create client callback context */

    NULL,                             /* Destroy client callback context */

    H5A__dense_btree2_name_store,     /* Record storage callback */

    H5A__dense_btree2_name_compare,   /* Record comparison callback */

    H5A__dense_btree2_name_encode,    /* Record encoding callback */

    H5A__dense_btree2_name_decode,    /* Record decoding callback */

    H5A__dense_btree2_name_debug      /* Record debugging callback */

}};

/* v2 B-tree class for indexing 'creation order' field of attributes */

const H5B2_class_t H5A_BT2_CORDER[1] = {{

    /* B-tree class information */

    H5B2_ATTR_DENSE_CORDER_ID,          /* Type of B-tree */

    "H5B2_ATTR_DENSE_CORDER_ID",        /* Name of B-tree class */

    sizeof(H5A_dense_bt2_corder_rec_t), /* Size of native record */

    NULL,                               /* Create client callback context */

    NULL,                               /* Destroy client callback context */

    H5A__dense_btree2_corder_store,     /* Record storage callback */

    H5A__dense_btree2_corder_compare,   /* Record comparison callback */

    H5A__dense_btree2_corder_encode,    /* Record encoding callback */

    H5A__dense_btree2_corder_decode,    /* Record decoding callback */

    H5A__dense_btree2_corder_debug      /* Record debugging callback */

}};

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

/* Library Private Variables */

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

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

/* Local Variables */

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

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

 * Function:  H5A__dense_fh_name_cmp

 *

 * Purpose: Compares the name of a attribute in a fractal heap to another

 *              name

 *

 * Return:  SUCCEED/FAIL

 *

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

 */

static herr_t

H5A__dense_fh_name_cmp(const void *obj, size_t obj_len, void *_udata)

{

    H5A_fh_ud_cmp_t *udata = (H5A_fh_ud_cmp_t *)_udata; /* User data for 'op' callback */

    H5A_t           *attr  = NULL;                      /* Pointer to attribute created from heap object */

    bool   took_ownership  = false;   /* Whether the "found" operator took ownership of the attribute */

    herr_t ret_value       = SUCCEED; /* Return value */

    FUNC_ENTER_PACKAGE

    /* Decode attribute information */

    if (NULL ==

        (attr = (H5A_t *)H5O_msg_decode(udata->f, NULL, H5O_ATTR_ID, obj_len, (const unsigned char *)obj)))

        HGOTO_ERROR(H5E_OHDR, H5E_CANTDECODE, FAIL, "can't decode attribute");

    /* Compare the string values */

    udata->cmp = strcmp(udata->name, attr->shared->name);

    /* Check for correct attribute & callback to make */

    if (udata->cmp == 0 && udata->found_op) {

        /* Check whether we should "reconstitute" the shared message info */

        if (udata->record->flags & H5O_MSG_FLAG_SHARED)

            H5SM_reconstitute(&(attr->sh_loc), udata->f, H5O_ATTR_ID, udata->record->id);

        /* Set the creation order index for the attribute */

        attr->shared->crt_idx = udata->record->corder;

        /* Make callback */

        if ((udata->found_op)(attr, &took_ownership, udata->found_op_data) < 0)

            HGOTO_ERROR(H5E_OHDR, H5E_CANTOPERATE, FAIL, "attribute found callback failed");

    } /* end if */

done:

    /* Release the space allocated for the attribute */

    if (attr && !took_ownership)

        H5O_msg_free(H5O_ATTR_ID, attr);

    FUNC_LEAVE_NOAPI(ret_value)

} /* end H5A__dense_fh_name_cmp() */

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

 * Function:  H5A__dense_btree2_name_store

 *

 * Purpose: Store user information into native record for v2 B-tree

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_name_store(void *_nrecord, const void *_udata)

{

    const H5A_bt2_ud_ins_t   *udata   = (const H5A_bt2_ud_ins_t *)_udata;

    H5A_dense_bt2_name_rec_t *nrecord = (H5A_dense_bt2_name_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    /* Copy user information info native record */

    nrecord->id     = udata->id;

    nrecord->flags  = udata->common.flags;

    nrecord->corder = udata->common.corder;

    nrecord->hash   = udata->common.name_hash;

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_name_store() */

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

 * Function:  H5A__dense_btree2_name_compare

 *

 * Purpose: Compare two native information records, according to some key

 *

 * Return:  <0 if rec1 < rec2

 *              =0 if rec1 == rec2

 *              >0 if rec1 > rec2

 *

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

 */

static herr_t

H5A__dense_btree2_name_compare(const void *_bt2_udata, const void *_bt2_rec, int *result)

{

    const H5A_bt2_ud_common_t      *bt2_udata = (const H5A_bt2_ud_common_t *)_bt2_udata;

    const H5A_dense_bt2_name_rec_t *bt2_rec   = (const H5A_dense_bt2_name_rec_t *)_bt2_rec;

    herr_t                          ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_PACKAGE

    /* Sanity check */

    assert(bt2_udata);

    assert(bt2_rec);

    /* Check hash value */

    if (bt2_udata->name_hash < bt2_rec->hash)

        *result = (-1);

    else if (bt2_udata->name_hash > bt2_rec->hash)

        *result = 1;

    else {

        H5A_fh_ud_cmp_t fh_udata; /* User data for fractal heap 'op' callback */

        H5HF_t         *fheap;    /* Fractal heap handle to use for finding object */

        /* Sanity check */

        assert(bt2_udata->name_hash == bt2_rec->hash);

        /* Prepare user data for callback */

        /* down */

        fh_udata.f             = bt2_udata->f;

        fh_udata.name          = bt2_udata->name;

        fh_udata.record        = bt2_rec;

        fh_udata.found_op      = bt2_udata->found_op;

        fh_udata.found_op_data = bt2_udata->found_op_data;

        /* up */

        fh_udata.cmp = 0;

        /* Check for attribute in shared storage */

        if (bt2_rec->flags & H5O_MSG_FLAG_SHARED)

            fheap = bt2_udata->shared_fheap;

        else

            fheap = bt2_udata->fheap;

        assert(fheap);

        /* Check if the user's attribute and the B-tree's attribute have the same name */

        if (H5HF_op(fheap, &bt2_rec->id, H5A__dense_fh_name_cmp, &fh_udata) < 0)

            HGOTO_ERROR(H5E_HEAP, H5E_CANTCOMPARE, FAIL, "can't compare btree2 records");

        /* Callback will set comparison value */

        *result = fh_udata.cmp;

    } /* end else */

done:

    FUNC_LEAVE_NOAPI(ret_value)

} /* H5A__dense_btree2_name_compare() */

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

 * Function:  H5A__dense_btree2_name_encode

 *

 * Purpose: Encode native information into raw form for storing on disk

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_name_encode(uint8_t *raw, const void *_nrecord, void H5_ATTR_UNUSED *ctx)

{

    const H5A_dense_bt2_name_rec_t *nrecord = (const H5A_dense_bt2_name_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    /* Encode the record's fields */

    H5MM_memcpy(raw, nrecord->id.id, (size_t)H5O_FHEAP_ID_LEN);

    raw += H5O_FHEAP_ID_LEN;

    *raw++ = nrecord->flags;

    UINT32ENCODE(raw, nrecord->corder);

    UINT32ENCODE(raw, nrecord->hash);

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_name_encode() */

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

 * Function:  H5A__dense_btree2_name_decode

 *

 * Purpose: Decode raw disk form of record into native form

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_name_decode(const uint8_t *raw, void *_nrecord, void H5_ATTR_UNUSED *ctx)

{

    H5A_dense_bt2_name_rec_t *nrecord = (H5A_dense_bt2_name_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    /* Decode the record's fields */

    H5MM_memcpy(nrecord->id.id, raw, (size_t)H5O_FHEAP_ID_LEN);

    raw += H5O_FHEAP_ID_LEN;

    nrecord->flags = *raw++;

    UINT32DECODE(raw, nrecord->corder);

    UINT32DECODE(raw, nrecord->hash);

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_name_decode() */

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

 * Function:  H5A__dense_btree2_name_debug

 *

 * Purpose: Debug native form of record

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_name_debug(FILE *stream, int indent, int fwidth, const void *_nrecord,

                             const void H5_ATTR_UNUSED *_udata)

{

    const H5A_dense_bt2_name_rec_t *nrecord = (const H5A_dense_bt2_name_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    fprintf(stream, "%*s%-*s {%016" PRIx64 ", %02" PRIx8 ", %u, %08" PRIx32 "}\n", indent, "", fwidth,

            "Record:", nrecord->id.val, nrecord->flags, (unsigned)nrecord->corder, nrecord->hash);

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_name_debug() */

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

 * Function:  H5A__dense_btree2_corder_store

 *

 * Purpose: Store user information into native record for v2 B-tree

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_corder_store(void *_nrecord, const void *_udata)

{

    const H5A_bt2_ud_ins_t     *udata   = (const H5A_bt2_ud_ins_t *)_udata;

    H5A_dense_bt2_corder_rec_t *nrecord = (H5A_dense_bt2_corder_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    /* Copy user information info native record */

    nrecord->id     = udata->id;

    nrecord->flags  = udata->common.flags;

    nrecord->corder = udata->common.corder;

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_corder_store() */

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

 * Function:  H5A__dense_btree2_corder_compare

 *

 * Purpose: Compare two native information records, according to some key

 *

 * Return:  <0 if rec1 < rec2

 *              =0 if rec1 == rec2

 *              >0 if rec1 > rec2

 *

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

 */

static herr_t

H5A__dense_btree2_corder_compare(const void *_bt2_udata, const void *_bt2_rec, int *result)

{

    const H5A_bt2_ud_common_t        *bt2_udata = (const H5A_bt2_ud_common_t *)_bt2_udata;

    const H5A_dense_bt2_corder_rec_t *bt2_rec   = (const H5A_dense_bt2_corder_rec_t *)_bt2_rec;

    FUNC_ENTER_PACKAGE_NOERR

    /* Sanity check */

    assert(bt2_udata);

    assert(bt2_rec);

    /* Check creation order value */

    if (bt2_udata->corder < bt2_rec->corder)

        *result = -1;

    else if (bt2_udata->corder > bt2_rec->corder)

        *result = 1;

    else

        *result = 0;

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_corder_compare() */

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

 * Function:  H5A__dense_btree2_corder_encode

 *

 * Purpose: Encode native information into raw form for storing on disk

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_corder_encode(uint8_t *raw, const void *_nrecord, void H5_ATTR_UNUSED *ctx)

{

    const H5A_dense_bt2_corder_rec_t *nrecord = (const H5A_dense_bt2_corder_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    /* Encode the record's fields */

    H5MM_memcpy(raw, nrecord->id.id, (size_t)H5O_FHEAP_ID_LEN);

    raw += H5O_FHEAP_ID_LEN;

    *raw++ = nrecord->flags;

    UINT32ENCODE(raw, nrecord->corder);

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_corder_encode() */

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

 * Function:  H5A__dense_btree2_corder_decode

 *

 * Purpose: Decode raw disk form of record into native form

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_corder_decode(const uint8_t *raw, void *_nrecord, void H5_ATTR_UNUSED *ctx)

{

    H5A_dense_bt2_corder_rec_t *nrecord = (H5A_dense_bt2_corder_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    /* Decode the record's fields */

    H5MM_memcpy(nrecord->id.id, raw, (size_t)H5O_FHEAP_ID_LEN);

    raw += H5O_FHEAP_ID_LEN;

    nrecord->flags = *raw++;

    UINT32DECODE(raw, nrecord->corder);

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_corder_decode() */

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

 * Function:  H5A__dense_btree2_corder_debug

 *

 * Purpose: Debug native form of record

 *

 * Return:  Success:  non-negative

 *    Failure:  negative

 *

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

 */

static herr_t

H5A__dense_btree2_corder_debug(FILE *stream, int indent, int fwidth, const void *_nrecord,

                               const void H5_ATTR_UNUSED *_udata)

{

    const H5A_dense_bt2_corder_rec_t *nrecord = (const H5A_dense_bt2_corder_rec_t *)_nrecord;

    FUNC_ENTER_PACKAGE_NOERR

    fprintf(stream, "%*s%-*s {%016" PRIx64 ", %02" PRIx8 ", %u}\n", indent, "", fwidth,

            "Record:", nrecord->id.val, nrecord->flags, (unsigned)nrecord->corder);

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* H5A__dense_btree2_corder_debug() */