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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Created: H5Ocache_image.c
* June 21, 2015
* John Mainzer
*
* Purpose: A message indicating that a metadata cache image block
* of the indicated length exists at the specified offset
* in the HDF5 file.
*
* The mdci_msg only appears in the superblock extension.
*
*-------------------------------------------------------------------------
*/
#include "H5Omodule.h" /* This source code file is part of the H5O module */
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Fprivate.h" /* Files */
#include "H5FLprivate.h" /* Free Lists */
#include "H5Opkg.h" /* Object headers */
#include "H5MFprivate.h" /* File space management */
/* Callbacks for message class */
static void *H5O__mdci_decode(H5F_t *f, H5O_t *open_oh, unsigned mesg_flags,
unsigned *ioflags, size_t p_size, const uint8_t *p);
static herr_t H5O__mdci_encode(H5F_t *f, hbool_t disable_shared,
uint8_t *p, const void *_mesg);
static void *H5O__mdci_copy(const void *_mesg, void *_dest);
static size_t H5O__mdci_size(const H5F_t *f, hbool_t disable_shared,
const void *_mesg);
static herr_t H5O__mdci_free(void *mesg);
static herr_t H5O__mdci_delete(H5F_t *f, H5O_t *open_oh, void *_mesg);
static herr_t H5O__mdci_debug(H5F_t *f, const void *_mesg, FILE *stream,
int indent, int fwidth);
/* This message derives from H5O message class */
const H5O_msg_class_t H5O_MSG_MDCI[1] = {{
H5O_MDCI_MSG_ID, /* message id number */
"mdci", /* message name for debugging */
sizeof(H5O_mdci_t), /* native message size */
0, /* messages are sharable? */
H5O__mdci_decode, /* decode message */
H5O__mdci_encode, /* encode message */
H5O__mdci_copy, /* copy method */
H5O__mdci_size, /* size of mdc image message */
NULL, /* reset method */
H5O__mdci_free, /* free method */
H5O__mdci_delete, /* file delete method */
NULL, /* link method */
NULL, /* set share method */
NULL, /* can share method */
NULL, /* pre copy native value to file */
NULL, /* copy native value to file */
NULL, /* post copy native value to file */
NULL, /* get creation index */
NULL, /* set creation index */
H5O__mdci_debug /* debugging */
}};
/* Only one version of the metadata cache image message at present */
#define H5O_MDCI_VERSION_0 0
/* Declare the free list for H5O_mdci_t's */
H5FL_DEFINE(H5O_mdci_t);
/*-------------------------------------------------------------------------
* Function: H5O__mdci_decode
*
* Purpose: Decode a metadata cache image message and return a
* pointer to a newly allocated H5O_mdci_t struct.
*
* Return: Success: Ptr to new message in native struct.
* Failure: NULL
*
* Programmer: John Mainzer
* 6/22/15
*
*-------------------------------------------------------------------------
*/
static void *
H5O__mdci_decode(H5F_t *f, H5O_t H5_ATTR_UNUSED *open_oh,
unsigned H5_ATTR_UNUSED mesg_flags, unsigned H5_ATTR_UNUSED *ioflags,
size_t H5_ATTR_UNUSED p_size, const uint8_t *p)
{
H5O_mdci_t *mesg; /* Native message */
void *ret_value = NULL; /* Return value */
FUNC_ENTER_STATIC
/* Sanity check */
HDassert(f);
HDassert(p);
/* Version of message */
if(*p++ != H5O_MDCI_VERSION_0)
HGOTO_ERROR(H5E_OHDR, H5E_CANTLOAD, NULL, "bad version number for message")
/* Allocate space for message */
if(NULL == (mesg = (H5O_mdci_t *)H5FL_MALLOC(H5O_mdci_t)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for metadata cache image message")
/* Decode */
H5F_addr_decode(f, &p, &(mesg->addr));
H5F_DECODE_LENGTH(f, p, mesg->size);
/* Set return value */
ret_value = (void *)mesg;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5O__mdci_decode() */
/*-------------------------------------------------------------------------
* Function: H5O__mdci_encode
*
* Purpose: Encode metadata cache image message
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: John Mainzer
* 6/22/15
*
*-------------------------------------------------------------------------
*/
static herr_t
H5O__mdci_encode(H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared,
uint8_t *p, const void *_mesg)
{
const H5O_mdci_t *mesg = (const H5O_mdci_t *)_mesg;
FUNC_ENTER_STATIC_NOERR
/* Sanity check */
HDassert(f);
HDassert(p);
HDassert(mesg);
/* encode */
*p++ = H5O_MDCI_VERSION_0;
H5F_addr_encode(f, &p, mesg->addr);
H5F_ENCODE_LENGTH(f, p, mesg->size);
FUNC_LEAVE_NOAPI(SUCCEED)
} /* end H5O__mdci_encode() */
/*-------------------------------------------------------------------------
* Function: H5O__mdci_copy
*
* Purpose: Copies a message from _MESG to _DEST, allocating _DEST if
* necessary.
*
* Return: Success: Ptr to _DEST
* Failure: NULL
*
* Programmer: John Mainzer
* 6/22/15
*
*-------------------------------------------------------------------------
*/
static void *
H5O__mdci_copy(const void *_mesg, void *_dest)
{
const H5O_mdci_t *mesg = (const H5O_mdci_t *)_mesg;
H5O_mdci_t *dest = (H5O_mdci_t *) _dest;
void *ret_value = NULL; /* Return value */
FUNC_ENTER_STATIC
/* check args */
HDassert(mesg);
if(!dest && NULL == (dest = H5FL_MALLOC(H5O_mdci_t)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
/* copy */
*dest = *mesg;
/* Set return value */
ret_value = dest;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5O_mdci__copy() */
/*-------------------------------------------------------------------------
* Function: H5O__mdci_size
*
* Purpose: Returns the size of the raw message in bytes not counting
* the message type or size fields, but only the data fields.
* This function doesn't take into account alignment.
*
* Return: Success: Message data size in bytes without alignment.
*
* Failure: zero
*
* Programmer: John Mainzer
* 6/22/15
*
*-------------------------------------------------------------------------
*/
static size_t
H5O__mdci_size(const H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared,
const void H5_ATTR_UNUSED *_mesg)
{
size_t ret_value = 0; /* Return value */
FUNC_ENTER_STATIC_NOERR
/* Set return value */
ret_value = (size_t)( 1 + /* Version number */
H5F_SIZEOF_ADDR(f) + /* addr of metadata cache */
/* image block */
H5F_SIZEOF_SIZE(f) ); /* length of metadata cache */
/* image block */
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5O__mdci_size() */
/*-------------------------------------------------------------------------
* Function: H5O__mdci_free
*
* Purpose: Free the message
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: John Mainzer
* 6/22/15
*
*-------------------------------------------------------------------------
*/
static herr_t
H5O__mdci_free(void *mesg)
{
FUNC_ENTER_STATIC_NOERR
HDassert(mesg);
mesg = H5FL_FREE(H5O_mdci_t, mesg);
FUNC_LEAVE_NOAPI(SUCCEED)
} /* end H5O__mdci_free() */
/*-------------------------------------------------------------------------
* Function: H5O__mdci_delete
*
* Purpose: Free file space referenced by message
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Wednesday, March 19, 2003
*
*-------------------------------------------------------------------------
*/
static herr_t
H5O__mdci_delete(H5F_t *f, H5O_t *open_oh, void *_mesg)
{
H5O_mdci_t *mesg = (H5O_mdci_t *)_mesg;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_STATIC
/* check args */
HDassert(f);
HDassert(open_oh);
HDassert(mesg);
/* Free file space for cache image */
if(H5F_addr_defined(mesg->addr)) {
/* The space for the cache image block was allocated directly
* from the VFD layer at the end of file. As this was the
* last file space allocation before shutdown, the cache image
* should still be the last item in the file.
*
* If the hack to work around the self referential free space
* manager issue is in use, file space for the non-empty self
* referential free space managers was also allocated from VFD
* layer at the end of file. Since these allocations directly
* preceeded the cache image allocation they should be directly
* adjacent to the cache image block at the end of file.
*
* In this case, just call H5MF_tidy_self_referential_fsm_hack().
*
* That routine will float the self referential free space
* managers, and reduce the eoa to its value just prior to
* allocation of space for same. Since the cache image appears
* just after the self referential free space managers, this
* will release the file space for the cache image as well.
*
* Note that in this case, there must not have been any file
* space allocations / deallocations prior to the free of the
* cache image. Verify this to the extent possible.
*
* If the hack to work around the persistent self referential
* free space manager issue is NOT in use, just call H5MF_xfree()
* to release the cache iamge. In principle, we should be able
* to just reduce the EOA to the base address of the cache
* image block, as there shouldn't be any file space allocation
* before the first metadata cache access. However, given
* time constraints, I don't want to go there now.
*/
if(H5F_FIRST_ALLOC_DEALLOC(f)) {
HDassert(HADDR_UNDEF != H5F_EOA_PRE_FSM_FSALLOC(f));
HDassert(H5F_addr_ge(mesg->addr, H5F_EOA_PRE_FSM_FSALLOC(f)));
if(H5MF_tidy_self_referential_fsm_hack(f) < 0)
HGOTO_ERROR(H5E_OHDR, H5E_CANTFREE, FAIL, "tidy of self referential fsm hack failed")
} /* end if */
else {
if(H5MF_xfree(f, H5FD_MEM_SUPER, mesg->addr, mesg->size) < 0)
HGOTO_ERROR(H5E_OHDR, H5E_CANTFREE, FAIL, "unable to free file space for cache image block")
} /* end else */
} /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5O__mdci_delete() */
/*-------------------------------------------------------------------------
* Function: H5O__mdci_debug
*
* Purpose: Prints debugging info.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: John Mainzer
* 6/22/15
*
*-------------------------------------------------------------------------
*/
static herr_t
H5O__mdci_debug(H5F_t H5_ATTR_UNUSED *f, const void *_mesg, FILE *stream,
int indent, int fwidth)
{
const H5O_mdci_t *mdci = (const H5O_mdci_t *) _mesg;
FUNC_ENTER_STATIC_NOERR
/* check args */
HDassert(f);
HDassert(mdci);
HDassert(stream);
HDassert(indent >= 0);
HDassert(fwidth >= 0);
HDfprintf(stream, "%*s%-*s %a\n", indent, "", fwidth,
"Metadata Cache Image Block address:", mdci->addr);
HDfprintf(stream, "%*s%-*s %Hu\n", indent, "", fwidth,
"Metadata Cache Image Block size in bytes:", mdci->size);
FUNC_LEAVE_NOAPI(SUCCEED)
} /* end H5O__mdci_debug() */
|