diff options
Diffstat (limited to 'src/H5EApkg.h')
| -rw-r--r-- | src/H5EApkg.h | 453 |
1 files changed, 453 insertions, 0 deletions
diff --git a/src/H5EApkg.h b/src/H5EApkg.h new file mode 100644 index 0000000..6e86a34 --- /dev/null +++ b/src/H5EApkg.h @@ -0,0 +1,453 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * 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 files COPYING and Copyright.html. COPYING can be found at the root * + * of the source code distribution tree; Copyright.html can be found at the * + * root level of an installed copy of the electronic HDF5 document set and * + * is linked from the top-level documents page. It can also be found at * + * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have * + * access to either file, you may request a copy from help@hdfgroup.org. * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +/* + * Programmer: Quincey Koziol <koziol@hdfgroup.org> + * Tuesday, June 17, 2008 + * + * Purpose: This file contains declarations which are visible only within + * the H5EA package. Source files outside the H5EA package should + * include H5EAprivate.h instead. + */ +#if !(defined(H5EA_PACKAGE) | defined(H5EA_MODULE)) +#error "Do not include this file outside the H5EA package!" +#endif + +#ifndef _H5EApkg_H +#define _H5EApkg_H + +/* Get package's private header */ +#include "H5EAprivate.h" + +/* Other private headers needed by this file */ +#include "H5FLprivate.h" /* Free Lists */ + + +/**************************/ +/* Package Private Macros */ +/**************************/ + +/* If this package header is being included in one of the H5EA modules, define + * the proper control macros for the generic FUNC_ENTER/LEAVE and error + * reporting macros. + */ +#ifdef H5EA_MODULE +#define H5_MY_PKG H5EA +#define H5_MY_PKG_ERR H5E_EARRAY +#define H5_MY_PKG_INIT NO +#endif /* H5EA_MODULE */ + +/* Fill value for extensible array test class */ +#ifdef H5EA_TESTING +#define H5EA_TEST_FILL ((uint64_t)ULLONG_MAX) +#endif /* H5EA_TESTING */ + +/* Size of checksum information (on disk) */ +#define H5EA_SIZEOF_CHKSUM 4 + +/* "Standard" size of prefix information for extensible array metadata */ +#define H5EA_METADATA_PREFIX_SIZE(c) ( \ + H5_SIZEOF_MAGIC /* Signature */ \ + + 1 /* Version */ \ + + ((c) ? H5EA_SIZEOF_CHKSUM : 0) /* Metadata checksum */ \ + ) + +/* Size of the extensible array header on disk */ +#define H5EA_HEADER_SIZE(h) ( \ + /* General metadata fields */ \ + H5EA_METADATA_PREFIX_SIZE(TRUE) \ + \ + /* General array information */ \ + + 1 /* Array type */ \ + + 1 /* Element Size */ \ + + 1 /* Max. # of elements bits */ \ + + 1 /* # of elements to store in index block */ \ + + 1 /* Min. # elements per data block */ \ + + 1 /* Min. # of data block pointers for a super block */ \ + + 1 /* Log2(Max. # of elements in data block page) - i.e. # of bits needed to store max. # of elements in data block page */ \ + \ + /* Extensible Array statistics fields */ \ + + (h)->sizeof_size /* Number of super blocks created */ \ + + (h)->sizeof_size /* Size of super blocks created */ \ + + (h)->sizeof_size /* Number of data blocks created */ \ + + (h)->sizeof_size /* Size of data blocks created */ \ + + (h)->sizeof_size /* Max. index set */ \ + + (h)->sizeof_size /* Number of elements 'realized' */ \ + \ + /* Extensible Array Header specific fields */ \ + + (h)->sizeof_addr /* File address of index block */ \ + ) + +/* Size of the extensible array index block on disk */ +#define H5EA_IBLOCK_SIZE(i) ( \ + /* General metadata fields */ \ + H5EA_METADATA_PREFIX_SIZE(TRUE) \ + \ + /* Sanity-checking fields */ \ + + 1 /* Array type */ \ + + (i)->hdr->sizeof_addr /* File address of array owning the block */ \ + \ + /* Extensible Array Index Block specific fields */ \ + + ((size_t)(i)->hdr->cparam.idx_blk_elmts * (size_t)(i)->hdr->cparam.raw_elmt_size) /* Elements in index block */ \ + + ((i)->ndblk_addrs * (i)->hdr->sizeof_addr) /* Data block addresses in index block */ \ + + ((i)->nsblk_addrs * (i)->hdr->sizeof_addr) /* Super block addresses in index block */ \ + ) + +/* Size of the extensible array super block on disk */ +#define H5EA_SBLOCK_SIZE(s) ( \ + /* General metadata fields */ \ + H5EA_METADATA_PREFIX_SIZE(TRUE) \ + \ + /* Sanity-checking fields */ \ + + 1 /* Array type */ \ + + (s)->hdr->sizeof_addr /* File address of array owning the block */ \ + + (s)->hdr->arr_off_size /* Offset of the block in the array */ \ + \ + /* Extensible Array Super Block specific fields */ \ + + ((s)->ndblks * (s)->dblk_page_init_size) /* Data block 'page init' bitmasks in super block (can be 0 if no pages) */ \ + + ((s)->ndblks * (s)->hdr->sizeof_addr) /* Data block addresses in super block */ \ + ) + +/* Size of the extensible array data block prefix on disk */ +#define H5EA_DBLOCK_PREFIX_SIZE(d) ( \ + /* General metadata fields */ \ + H5EA_METADATA_PREFIX_SIZE(TRUE) \ + \ + /* Sanity-checking fields */ \ + + 1 /* Array type */ \ + + (d)->hdr->sizeof_addr /* File address of array owning the block */ \ + + (d)->hdr->arr_off_size /* Offset of the block in the array */ \ + ) + +/* Size of the extensible array data block on disk */ +#define H5EA_DBLOCK_SIZE(d) ( \ + /* Data block prefix size */ \ + H5EA_DBLOCK_PREFIX_SIZE(d) \ + \ + /* Extensible Array Data Block specific fields */ \ + + ((d)->nelmts * (size_t)(d)->hdr->cparam.raw_elmt_size) /* Elements in data block */ \ + + ((d)->npages * H5EA_SIZEOF_CHKSUM) /* Checksum for each page */ \ + ) + +/* Size of the extensible array data block page on disk */ +#define H5EA_DBLK_PAGE_SIZE(p) ( \ + + ((p)->hdr->dblk_page_nelmts * (size_t)(p)->hdr->cparam.raw_elmt_size) /* Elements in data block page */ \ + + H5EA_SIZEOF_CHKSUM /* Checksum for each page */ \ + ) + +/* Compute the # of bytes required to store an offset into a given buffer size */ +#define H5EA_SIZEOF_OFFSET_BITS(b) (((b) + 7) / 8) + +/* Compute the first super block index that will hold a certain # of data block pointers */ +#define H5EA_SBLK_FIRST_IDX(m) (2 * H5V_log2_of2((uint32_t)m)) + +/****************************/ +/* Package Private Typedefs */ +/****************************/ + +/* Information for each super block in extensible array */ +typedef struct H5EA_sblk_info_t { + size_t ndblks; /* Number of data blocks for a super block */ + size_t dblk_nelmts; /* Number of elements in each data block for super block */ + hsize_t start_idx; /* Index of first element in super block */ + hsize_t start_dblk; /* Index of first data block in super block */ +} H5EA_sblk_info_t; + +/* The extensible array header information */ +/* (Each extensible array header has certain information that is shared across + * all the blocks in that extensible array) + */ +typedef struct H5EA_hdr_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Extensible array configuration/creation parameters (stored in header) */ + H5EA_create_t cparam; /* Creation parameters for extensible array */ + + /* Index block information (stored in header) */ + haddr_t idx_blk_addr; /* Address of index block in header */ + + /* Statistics for array (stored in index block, actually) */ + /* (header and index number/size fields not stored) */ + H5EA_stat_t stats; /* Statistics for extensible array */ + + /* Data block element buffer factory info (not stored in header) */ + struct { + size_t nalloc; /* Number of factories allocated */ + H5FL_fac_head_t **fac; /* Array of factories for data block element buffers */ + } elmt_fac; + + /* Computed/cached values (not stored in header) */ + size_t rc; /* Reference count of heap's components using heap header */ + haddr_t addr; /* Address of header in file */ + size_t size; /* Size of header in file */ + H5F_t *f; /* Pointer to file for extensible array */ + size_t file_rc; /* Reference count of files using array header */ + hbool_t pending_delete; /* Array is pending deletion */ + size_t sizeof_addr; /* Size of file addresses */ + size_t sizeof_size; /* Size of file sizes */ + unsigned char arr_off_size; /* Size of array offsets (in bytes) */ + + /* Super block information (not stored) */ + size_t nsblks; /* Number of superblocks needed for array */ + H5EA_sblk_info_t *sblk_info; /* Array of information for each super block */ + + /* Data block information (not stored) */ + size_t dblk_page_nelmts; /* # of elements per data block page */ + + /* Client information (not stored) */ + void *cb_ctx; /* Callback context */ +} H5EA_hdr_t; + +/* The extensible array index block information */ +typedef struct H5EA_iblock_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Extensible array information (stored) */ + void *elmts; /* Buffer for elements stored in index block */ + haddr_t *dblk_addrs; /* Buffer for addresses of data blocks in index block */ + haddr_t *sblk_addrs; /* Buffer for addresses of super blocks in index block */ + + /* Internal array information (not stored) */ + size_t rc; /* Reference count of objects using this block */ + H5EA_hdr_t *hdr; /* Shared array header info */ + haddr_t addr; /* Address of this index block on disk */ + size_t size; /* Size of index block on disk */ + + /* Computed/cached values (not stored) */ + size_t nsblks; /* # of super blocks whose data block addresses are in index block */ + size_t ndblk_addrs; /* Number of pointers to data blocks in index block */ + size_t nsblk_addrs; /* Number of pointers to super blocks in index block */ +} H5EA_iblock_t; + +/* The extensible array super block information */ +typedef struct H5EA_sblock_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Extensible array information (stored) */ + hsize_t block_off; /* Offset of the block within the array's address space */ + haddr_t *dblk_addrs; /* Addresses of data blocks in super block */ + uint8_t *page_init; /* Bitmap of whether a data block page is initialized */ + + /* Internal array information (not stored) */ + size_t rc; /* Reference count of objects using this block */ + H5EA_hdr_t *hdr; /* Shared array header info */ + H5EA_iblock_t *parent; /* Parent object for super block (index block) */ + haddr_t addr; /* Address of this index block on disk */ + size_t size; /* Size of index block on disk */ + + /* Computed/cached values (not stored) */ + unsigned idx; /* Super block index within the extensible array */ + size_t ndblks; /* # of data block addresses that are in super block */ + size_t dblk_nelmts; /* # of elements for data blocks reachable through this super block */ + size_t dblk_npages; /* # of pages in each data block */ + size_t dblk_page_init_size; /* Size of 'page init' bitmask for each data block */ + size_t dblk_page_size; /* Size of a data block page */ +} H5EA_sblock_t; + +/* The extensible array data block information */ +typedef struct H5EA_dblock_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Extensible array information (stored) */ + hsize_t block_off; /* Offset of the block within the array's address space */ + void *elmts; /* Buffer for elements stored in data block */ + + /* Internal array information (not stored) */ + H5EA_hdr_t *hdr; /* Shared array header info */ + void *parent; /* Parent object for data block (index or super block) */ + haddr_t addr; /* Address of this data block on disk */ + size_t size; /* Size of data block on disk */ + + /* Computed/cached values (not stored) */ + size_t nelmts; /* Number of elements in block */ + size_t npages; /* Nummber of pages in a block (zero if not paged) */ +} H5EA_dblock_t; + +/* The extensible array data block page information */ +typedef struct H5EA_dbk_page_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Extensible array information (stored) */ + void *elmts; /* Buffer for elements stored in data block page */ + + /* Internal array information (not stored) */ + H5EA_hdr_t *hdr; /* Shared array header info */ + H5EA_sblock_t *parent; /* Parent object for data block page (super block) */ + haddr_t addr; /* Address of this data block page on disk */ + size_t size; /* Size of data block page on disk */ + + /* Computed/cached values (not stored) */ + /* <none> */ +} H5EA_dblk_page_t; + +/* Extensible array */ +struct H5EA_t { + H5EA_hdr_t *hdr; /* Pointer to internal extensible array header info */ + H5F_t *f; /* Pointer to file for extensible array */ +}; + +/* Metadata cache callback user data types */ + +/* Info needed for loading data block page */ +typedef struct H5EA_dblk_page_load_ud_t { + H5EA_sblock_t *parent; /* Pointer to parent object for data block page (super block) */ +} H5EA_dblk_page_load_ud_t; + +/* Info needed for loading data block */ +typedef struct H5EA_dblock_load_ud_t { + void *parent; /* Pointer to parent object for data block (index or super block) */ + size_t nelmts; /* Number of elements in data block */ +} H5EA_dblock_load_ud_t; + +/* Info needed for loading super block */ +typedef struct H5EA_sblock_load_ud_t { + H5EA_iblock_t *parent; /* Pointer to parent object for super block (index block) */ + unsigned sblk_idx; /* Index of super block */ +} H5EA_sblock_load_ud_t; + +#ifdef H5EA_TESTING +typedef struct H5EA__ctx_cb_t { + herr_t (*encode)(const void *elmt, size_t nelmts, void *udata); /* Perform action during encode step */ + void *udata; /* User data for encode action */ +} H5EA__ctx_cb_t; +#endif /* H5EA_TESTING */ + +/*****************************/ +/* Package Private Variables */ +/*****************************/ + +/* H5EA header inherits cache-like properties from H5AC */ +H5_DLLVAR const H5AC_class_t H5AC_EARRAY_HDR[1]; + +/* H5EA index block inherits cache-like properties from H5AC */ +H5_DLLVAR const H5AC_class_t H5AC_EARRAY_IBLOCK[1]; + +/* H5EA index block inherits cache-like properties from H5AC */ +H5_DLLVAR const H5AC_class_t H5AC_EARRAY_SBLOCK[1]; + +/* H5EA data block inherits cache-like properties from H5AC */ +H5_DLLVAR const H5AC_class_t H5AC_EARRAY_DBLOCK[1]; + +/* H5EA data block page inherits cache-like properties from H5AC */ +H5_DLLVAR const H5AC_class_t H5AC_EARRAY_DBLK_PAGE[1]; + +/* Internal extensible array testing class */ +#ifdef H5EA_TESTING +H5_DLLVAR const H5EA_class_t H5EA_CLS_TEST[1]; +#endif /* H5EA_TESTING */ + +/* Array of extensible array client ID -> client class mappings */ +extern const H5EA_class_t *const H5EA_client_class_g[]; + + +/******************************/ +/* Package Private Prototypes */ +/******************************/ + +/* Generic routines */ +H5_DLL herr_t H5EA__create_flush_depend(H5EA_hdr_t *hdr, H5AC_info_t *parent_entry, + H5AC_info_t *child_entry); +H5_DLL herr_t H5EA__destroy_flush_depend(H5EA_hdr_t *hdr, H5AC_info_t *parent_entry, + H5AC_info_t *child_entry); + +/* Header routines */ +H5_DLL H5EA_hdr_t *H5EA__hdr_alloc(H5F_t *f); +H5_DLL herr_t H5EA__hdr_init(H5EA_hdr_t *hdr, void *ctx_udata); +H5_DLL haddr_t H5EA__hdr_create(H5F_t *f, hid_t dxpl_id, const H5EA_create_t *cparam, + void *ctx_udata); +H5_DLL void *H5EA__hdr_alloc_elmts(H5EA_hdr_t *hdr, size_t nelmts); +H5_DLL herr_t H5EA__hdr_free_elmts(H5EA_hdr_t *hdr, size_t nelmts, void *elmts); +H5_DLL herr_t H5EA__hdr_incr(H5EA_hdr_t *hdr); +H5_DLL herr_t H5EA__hdr_decr(H5EA_hdr_t *hdr); +H5_DLL herr_t H5EA__hdr_fuse_incr(H5EA_hdr_t *hdr); +H5_DLL size_t H5EA__hdr_fuse_decr(H5EA_hdr_t *hdr); +H5_DLL herr_t H5EA__hdr_modified(H5EA_hdr_t *hdr); +H5_DLL herr_t H5EA__hdr_delete(H5EA_hdr_t *hdr, hid_t dxpl_id); +H5_DLL herr_t H5EA__hdr_dest(H5EA_hdr_t *hdr); + +/* Index block routines */ +H5_DLL H5EA_iblock_t *H5EA__iblock_alloc(H5EA_hdr_t *hdr); +H5_DLL haddr_t H5EA__iblock_create(H5EA_hdr_t *hdr, hid_t dxpl_id, + hbool_t *stats_changed); +H5_DLL H5EA_iblock_t *H5EA__iblock_protect(H5EA_hdr_t *hdr, hid_t dxpl_id, + H5AC_protect_t rw); +H5_DLL herr_t H5EA__iblock_unprotect(H5EA_iblock_t *iblock, hid_t dxpl_id, + unsigned cache_flags); +H5_DLL herr_t H5EA__iblock_delete(H5EA_hdr_t *hdr, hid_t dxpl_id); +H5_DLL herr_t H5EA__iblock_dest(H5F_t *f, H5EA_iblock_t *iblock); + +/* Super block routines */ +H5_DLL H5EA_sblock_t *H5EA__sblock_alloc(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, + unsigned sblk_idx); +H5_DLL haddr_t H5EA__sblock_create(H5EA_hdr_t *hdr, hid_t dxpl_id, + H5EA_iblock_t *parent, hbool_t *stats_changed, unsigned sblk_idx); +H5_DLL H5EA_sblock_t *H5EA__sblock_protect(H5EA_hdr_t *hdr, hid_t dxpl_id, + H5EA_iblock_t *parent, haddr_t sblk_addr, unsigned sblk_idx, H5AC_protect_t rw); +H5_DLL herr_t H5EA__sblock_unprotect(H5EA_sblock_t *sblock, hid_t dxpl_id, + unsigned cache_flags); +H5_DLL herr_t H5EA__sblock_delete(H5EA_hdr_t *hdr, hid_t dxpl_id, + H5EA_iblock_t *parent, haddr_t sblk_addr, unsigned sblk_idx); +H5_DLL herr_t H5EA__sblock_dest(H5F_t *f, H5EA_sblock_t *sblock); + +/* Data block routines */ +H5_DLL H5EA_dblock_t *H5EA__dblock_alloc(H5EA_hdr_t *hdr, void *parent, + size_t nelmts); +H5_DLL haddr_t H5EA__dblock_create(H5EA_hdr_t *hdr, hid_t dxpl_id, void *parent, + hbool_t *stats_changed, hsize_t dblk_off, size_t nelmts); +H5_DLL unsigned H5EA__dblock_sblk_idx(const H5EA_hdr_t *hdr, hsize_t idx); +H5_DLL H5EA_dblock_t *H5EA__dblock_protect(H5EA_hdr_t *hdr, hid_t dxpl_id, + void *parent, haddr_t dblk_addr, size_t dblk_nelmts, H5AC_protect_t rw); +H5_DLL herr_t H5EA__dblock_unprotect(H5EA_dblock_t *dblock, hid_t dxpl_id, + unsigned cache_flags); +H5_DLL herr_t H5EA__dblock_delete(H5EA_hdr_t *hdr, hid_t dxpl_id, void *parent, + haddr_t dblk_addr, size_t dblk_nelmts); +H5_DLL herr_t H5EA__dblock_dest(H5F_t *f, H5EA_dblock_t *dblock); + +/* Data block page routines */ +H5_DLL H5EA_dblk_page_t *H5EA__dblk_page_alloc(H5EA_hdr_t *hdr, H5EA_sblock_t *parent); +H5_DLL herr_t H5EA__dblk_page_create(H5EA_hdr_t *hdr, hid_t dxpl_id, + H5EA_sblock_t *parent, haddr_t addr); +H5_DLL H5EA_dblk_page_t *H5EA__dblk_page_protect(H5EA_hdr_t *hdr, hid_t dxpl_id, + H5EA_sblock_t *parent, haddr_t dblk_page_addr, H5AC_protect_t rw); +H5_DLL herr_t H5EA__dblk_page_unprotect(H5EA_dblk_page_t *dblk_page, + hid_t dxpl_id, unsigned cache_flags); +H5_DLL herr_t H5EA__dblk_page_dest(H5EA_dblk_page_t *dblk_page); + +/* Debugging routines for dumping file structures */ +H5_DLL herr_t H5EA__hdr_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, + FILE *stream, int indent, int fwidth, const H5EA_class_t *cls); +H5_DLL herr_t H5EA__iblock_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, + FILE *stream, int indent, int fwidth, const H5EA_class_t *cls, + haddr_t hdr_addr); +H5_DLL herr_t H5EA__sblock_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, + FILE *stream, int indent, int fwidth, const H5EA_class_t *cls, + haddr_t hdr_addr, unsigned sblk_idx); +H5_DLL herr_t H5EA__dblock_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, + FILE *stream, int indent, int fwidth, const H5EA_class_t *cls, + haddr_t hdr_addr, size_t dblk_nelmts); + +/* Testing routines */ +#ifdef H5EA_TESTING +H5_DLL herr_t H5EA_get_cparam_test(const H5EA_t *ea, H5EA_create_t *cparam); +H5_DLL int H5EA_cmp_cparam_test(const H5EA_create_t *cparam1, const H5EA_create_t *cparam2); +#endif /* H5EA_TESTING */ + +#endif /* _H5EApkg_H */ + |