summaryrefslogtreecommitdiffstats
path: root/src/H5VLnative_blob.c
blob: b16b40721f81b304b189042caa31500491687eb9 (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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * 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://support.hdfgroup.org/ftp/HDF5/releases.  *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Purpose:     Blob callbacks for the native VOL connector
 */

/***********/
/* Headers */
/***********/
#include "H5private.h"          /* Generic Functions                    */
#include "H5Eprivate.h"         /* Error handling                       */
#include "H5Fprivate.h"         /* File access				*/
#include "H5HGprivate.h"	/* Global Heaps				*/
#include "H5VLnative_private.h" /* Native VOL connector                 */


/****************/
/* Local Macros */
/****************/


/******************/
/* Local Typedefs */
/******************/


/********************/
/* Local Prototypes */
/********************/


/*********************/
/* Package Variables */
/*********************/


/*****************************/
/* Library Private Variables */
/*****************************/


/*******************/
/* Local Variables */
/*******************/



/*-------------------------------------------------------------------------
 * Function:    H5VL__native_blob_put
 *
 * Purpose:     Handles the blob 'put' callback
 *
 * Return:      SUCCEED / FAIL
 *
 * Programmer:	Quincey Koziol
 *		Friday, August 15, 2019
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5VL__native_blob_put(void *obj, const void *buf, size_t size, void *blob_id,
    void H5_ATTR_UNUSED *ctx)
{
    H5F_t *f = (H5F_t *)obj;            /* Retrieve file pointer */
    uint8_t *id = (uint8_t *)blob_id;   /* Pointer to blob ID */
    H5HG_t hobjid;                      /* New VL sequence's heap ID */
    herr_t ret_value = SUCCEED;         /* Return value */

    FUNC_ENTER_PACKAGE

    /* Check parameters */
    HDassert(f);
    HDassert(size == 0 || buf);
    HDassert(id);

    /* Write the VL information to disk (allocates space also) */
    if(H5HG_insert(f, size, (void *)buf, &hobjid) < 0)
        HGOTO_ERROR(H5E_VOL, H5E_WRITEERROR, FAIL, "unable to write blob information")

    /* Encode the heap information */
    H5F_addr_encode(f, &id, hobjid.addr);
    UINT32ENCODE(id, hobjid.idx);

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL__native_blob_put() */


/*-------------------------------------------------------------------------
 * Function:    H5VL__native_blob_get
 *
 * Purpose:     Handles the blob 'get' callback
 *
 * Return:      SUCCEED / FAIL
 *
 * Programmer:	Quincey Koziol
 *		Friday, August 15, 2019
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5VL__native_blob_get(void *obj, const void *blob_id, void *buf, size_t *size,
    void H5_ATTR_UNUSED *ctx)
{
    H5F_t *f = (H5F_t *)obj;            /* Retrieve file pointer */
    const uint8_t *id = (const uint8_t *)blob_id; /* Pointer to the disk blob ID */
    H5HG_t hobjid;                      /* Global heap ID for sequence */
    herr_t ret_value = SUCCEED;         /* Return value */

    FUNC_ENTER_PACKAGE

    /* Sanity check */
    HDassert(f);
    HDassert(id);
    HDassert(buf);

    /* Get the heap information */
    H5F_addr_decode(f, &id, &hobjid.addr);
    UINT32DECODE(id, hobjid.idx);

    /* Check if this sequence actually has any data */
    if(hobjid.addr > 0)
        /* Read the VL information from disk */
        if(NULL == H5HG_read(f, &hobjid, buf, size))
            HGOTO_ERROR(H5E_VOL, H5E_READERROR, FAIL, "unable to read VL information")

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL__native_blob_get() */


/*-------------------------------------------------------------------------
 * Function:    H5VL__native_blob_specific
 *
 * Purpose:     Handles the blob 'specific' callback
 *
 * Return:      SUCCEED / FAIL
 *
 * Programmer:	Quincey Koziol
 *		Friday, August 15, 2019
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5VL__native_blob_specific(void *obj, void *blob_id,
    H5VL_blob_specific_t specific_type, va_list arguments)
{
    H5F_t *f = (H5F_t *)obj;        /* Retrieve file pointer */
    herr_t ret_value = SUCCEED;     /* Return value */

    FUNC_ENTER_PACKAGE

    /* Sanity check */
    HDassert(f);
    HDassert(blob_id);

    switch(specific_type) {
        case H5VL_BLOB_GETSIZE:
            {
                const uint8_t *id = (const uint8_t *)blob_id; /* Pointer to the blob ID */
                size_t *size = HDva_arg(arguments, size_t *);
                H5HG_t hobjid;              /* blob's heap ID */

                /* Get heap information */
                H5F_addr_decode(f, &id, &(hobjid.addr));
                UINT32DECODE(id, hobjid.idx);

                /* Free heap object */
                if(hobjid.addr > 0) {
                    if(H5HG_get_obj_size(f, &hobjid, size) < 0)
                        HGOTO_ERROR(H5E_VOL, H5E_CANTREMOVE, FAIL, "unable to remove heap object")
                } /* end if */
                else
                    *size = 0;  /* Return '0' size for 'nil' blob ID */

                break;
            }

        case H5VL_BLOB_ISNULL:
            {
                const uint8_t *id = (const uint8_t *)blob_id; /* Pointer to the blob ID */
                hbool_t *isnull = HDva_arg(arguments, hbool_t *);
                haddr_t addr;               /* Sequence's heap address */

                /* Get the heap address */
                H5F_addr_decode(f, &id, &addr);

                /* Check if heap address is 'nil' */
                *isnull = (addr == 0 ? TRUE : FALSE);

                break;
            }

        case H5VL_BLOB_SETNULL:
            {
                uint8_t *id = (uint8_t *)blob_id; /* Pointer to the blob ID */
                /* Encode the "nil" heap pointer information */
                H5F_addr_encode(f, &id, (haddr_t)0);
                UINT32ENCODE(id, 0);

                break;
            }

        case H5VL_BLOB_DELETE:
            {
                const uint8_t *id = (const uint8_t *)blob_id; /* Pointer to the blob ID */
                H5HG_t hobjid;              /* VL sequence's heap ID */

                /* Get heap information */
                H5F_addr_decode(f, &id, &hobjid.addr);
                UINT32DECODE(id, hobjid.idx);

                /* Free heap object */
                if(hobjid.addr > 0)
                    if(H5HG_remove(f, &hobjid) < 0)
                        HGOTO_ERROR(H5E_VOL, H5E_CANTREMOVE, FAIL, "unable to remove heap object")

                break;
            }

        default:
            HGOTO_ERROR(H5E_VOL, H5E_UNSUPPORTED, FAIL, "invalid specific operation")
    } /* end switch */

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL__native_blob_specific() */