ed7d456e51
Tested platform: Kagiso only since it is only a comment block change. If it works in one machine, it should work in all, I hope. Still need to check the parallel build on copper.
229 lines
10 KiB
C
229 lines
10 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* 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@ncsa.uiuc.edu>
|
|
* Tuesday, May 2, 2006
|
|
*
|
|
* Purpose: This file contains declarations which are visible only within
|
|
* the H5FS package. Source files outside the H5FS package should
|
|
* include H5FSprivate.h instead.
|
|
*/
|
|
#ifndef H5FS_PACKAGE
|
|
#error "Do not include this file outside the H5FS package!"
|
|
#endif
|
|
|
|
#ifndef _H5FSpkg_H
|
|
#define _H5FSpkg_H
|
|
|
|
/* Uncomment this macro to enable extra sanity checking */
|
|
/* #define H5FS_DEBUG */
|
|
|
|
/* Get package's private header */
|
|
#include "H5FSprivate.h" /* File free space */
|
|
|
|
/* Other private headers needed by this file */
|
|
#include "H5ACprivate.h" /* Metadata cache */
|
|
#include "H5SLprivate.h" /* Skip lists */
|
|
|
|
/**************************/
|
|
/* Package Private Macros */
|
|
/**************************/
|
|
|
|
/* Size of signature information (on disk) */
|
|
#define H5FS_SIZEOF_MAGIC 4
|
|
|
|
/* Free space signatures */
|
|
#define H5FS_HDR_MAGIC "FSHD" /* Header */
|
|
#define H5FS_SINFO_MAGIC "FSSE" /* Serialized sections */
|
|
|
|
/* Size of checksum information (on disk) */
|
|
#define H5FS_SIZEOF_CHKSUM 4
|
|
|
|
/* "Standard" size of prefix information for free space metadata */
|
|
#define H5FS_METADATA_PREFIX_SIZE ( \
|
|
H5FS_SIZEOF_MAGIC /* Signature */ \
|
|
+ 1 /* Version */ \
|
|
+ H5FS_SIZEOF_CHKSUM /* Metadata checksum */ \
|
|
)
|
|
|
|
/* Size of the fractal heap header on disk */
|
|
#define H5FS_HEADER_SIZE(f) ( \
|
|
/* General metadata fields */ \
|
|
H5FS_METADATA_PREFIX_SIZE \
|
|
\
|
|
/* Free space header specific fields */ \
|
|
+ 1 /* Client ID */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* Total free space tracked */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* Total # of sections tracked */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* # of serializable sections tracked */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* # of ghost sections tracked */ \
|
|
+ 2 /* Number of section classes */ \
|
|
+ 2 /* Shrink percent */ \
|
|
+ 2 /* Expand percent */ \
|
|
+ 2 /* Size of address space for sections (log2 of value) */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* Max. size of section to track */ \
|
|
+ H5F_SIZEOF_ADDR(f) /* Address of serialized free space sections */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* Size of serialized free space sections used */ \
|
|
+ H5F_SIZEOF_SIZE(f) /* Allocated size of serialized free space sections */ \
|
|
)
|
|
|
|
/* Size of the free space serialized sections on disk */
|
|
#define H5FS_SINFO_PREFIX_SIZE(f) ( \
|
|
/* General metadata fields */ \
|
|
H5FS_METADATA_PREFIX_SIZE \
|
|
\
|
|
/* Free space serialized sections specific fields */ \
|
|
+ H5F_SIZEOF_ADDR(f) /* Address of free space header for these sections */ \
|
|
)
|
|
|
|
|
|
/****************************/
|
|
/* Package Private Typedefs */
|
|
/****************************/
|
|
|
|
/* Information for protecting a free space manager header */
|
|
typedef struct H5FS_prot_t {
|
|
size_t nclasses; /* Number of section classes */
|
|
const H5FS_section_class_t **classes; /* Array of section class info */
|
|
void *cls_init_udata; /* Pointer to class init user data */
|
|
} H5FS_prot_t;
|
|
|
|
/* Free space section bin info */
|
|
typedef struct H5FS_bin_t {
|
|
size_t tot_sect_count; /* Total # of sections in this bin */
|
|
size_t serial_sect_count; /* # of serializable sections in this bin */
|
|
size_t ghost_sect_count; /* # of un-serializable sections in this bin */
|
|
H5SL_t *bin_list; /* Skip list of differently sized sections */
|
|
} H5FS_bin_t;
|
|
|
|
/* Free space node for free space sections of the same size */
|
|
typedef struct H5FS_node_t {
|
|
hsize_t sect_size; /* Size of all sections on list */
|
|
size_t serial_count; /* # of serializable sections on list */
|
|
size_t ghost_count; /* # of un-serializable sections on list */
|
|
H5SL_t *sect_list; /* Skip list to hold pointers to actual free list section node */
|
|
} H5FS_node_t;
|
|
|
|
/* Information about sections managed */
|
|
typedef struct H5FS_sinfo_t {
|
|
/* Information for H5AC cache functions, _must_ be first field in structure */
|
|
H5AC_info_t cache_info;
|
|
|
|
/* Stored information */
|
|
H5FS_bin_t *bins; /* Array of lists of lists of free sections */
|
|
|
|
/* Computed/cached values */
|
|
unsigned nbins; /* Number of bins */
|
|
size_t serial_size; /* Total size of all serializable sections */
|
|
size_t tot_size_count; /* Total number of differently sized sections */
|
|
size_t serial_size_count; /* Total number of differently sized serializable sections */
|
|
size_t ghost_size_count; /* Total number of differently sized un-serializable sections */
|
|
unsigned sect_prefix_size; /* Size of the section serialization prefix (in bytes) */
|
|
unsigned sect_off_size; /* Size of a section offset (in bytes) */
|
|
unsigned sect_len_size; /* Size of a section length (in bytes) */
|
|
H5FS_t *fspace; /* Pointer to free space manager that owns sections */
|
|
|
|
/* Memory data structures (not stored directly) */
|
|
H5SL_t *merge_list; /* Skip list to hold sections for detecting merges */
|
|
} H5FS_sinfo_t;
|
|
|
|
/* Main free space info */
|
|
struct H5FS_t {
|
|
/* Information for H5AC cache functions, _must_ be first field in structure */
|
|
H5AC_info_t cache_info;
|
|
|
|
/* Stored information */
|
|
/* Statistics about sections managed */
|
|
hsize_t tot_space; /* Total amount of space tracked */
|
|
hsize_t tot_sect_count; /* Total # of sections tracked */
|
|
hsize_t serial_sect_count; /* # of serializable sections tracked */
|
|
hsize_t ghost_sect_count; /* # of un-serializable sections tracked */
|
|
|
|
/* Creation parameters */
|
|
H5FS_client_t client; /* Type of user of this free space manager */
|
|
unsigned nclasses; /* Number of section classes handled */
|
|
unsigned shrink_percent; /* Percent of "normal" serialized size to shrink serialized space at */
|
|
unsigned expand_percent; /* Percent of "normal" serialized size to expand serialized space at */
|
|
unsigned max_sect_addr; /* Size of address space free sections are within (log2 of actual value) */
|
|
hsize_t max_sect_size; /* Maximum size of section to track */
|
|
|
|
/* Serialized section information */
|
|
haddr_t sect_addr; /* Address of the section info in the file */
|
|
hsize_t sect_size; /* Size of the section info in the file */
|
|
hsize_t alloc_sect_size; /* Allocated size of the section info in the file */
|
|
|
|
/* Computed/cached values */
|
|
haddr_t addr; /* Address of free space header on disk */
|
|
H5FS_sinfo_t *sinfo; /* Section information */
|
|
|
|
/* Memory data structures (not stored directly) */
|
|
H5FS_section_class_t *sect_cls; /* Array of section classes for this free list */
|
|
};
|
|
|
|
|
|
/*****************************/
|
|
/* Package Private Variables */
|
|
/*****************************/
|
|
|
|
/* H5FS header inherits cache-like properties from H5AC */
|
|
H5_DLLVAR const H5AC_class_t H5AC_FSPACE_HDR[1];
|
|
|
|
/* H5FS section info inherits cache-like properties from H5AC */
|
|
H5_DLLVAR const H5AC_class_t H5AC_FSPACE_SINFO[1];
|
|
|
|
/* Declare a free list to manage the H5FS_node_t struct */
|
|
H5FL_EXTERN(H5FS_node_t);
|
|
|
|
/* Declare a free list to manage the H5FS_bin_t sequence information */
|
|
H5FL_SEQ_EXTERN(H5FS_bin_t);
|
|
|
|
/* Declare a free list to manage the H5FS_sinfo_t struct */
|
|
H5FL_EXTERN(H5FS_sinfo_t);
|
|
|
|
/* Declare a free list to manage the H5FS_t struct */
|
|
H5FL_EXTERN(H5FS_t);
|
|
|
|
|
|
/******************************/
|
|
/* Package Private Prototypes */
|
|
/******************************/
|
|
|
|
/* Free space manager header routines */
|
|
H5_DLL H5FS_t *H5FS_new(size_t nclasses, const H5FS_section_class_t *classes[],
|
|
void *cls_init_udata);
|
|
|
|
/* Free space section routines */
|
|
H5_DLL H5FS_sinfo_t *H5FS_sinfo_new(H5F_t *f, H5FS_t *fspace);
|
|
|
|
/* Debugging routines for dumping file structures */
|
|
H5_DLL herr_t H5FS_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr,
|
|
FILE *stream, int indent, int fwidth);
|
|
H5_DLL herr_t H5FS_sects_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr,
|
|
FILE *stream, int indent, int fwidth, haddr_t fs_addr, haddr_t client_addr);
|
|
|
|
/* Metadata cache callbacks */
|
|
H5_DLL herr_t H5FS_cache_hdr_dest(H5F_t *f, H5FS_t *hdr);
|
|
H5_DLL herr_t H5FS_cache_sinfo_dest(H5F_t *f, H5FS_sinfo_t *sinfo);
|
|
|
|
/* Sanity check routines */
|
|
#ifdef H5FS_DEBUG
|
|
H5_DLL herr_t H5FS_assert(const H5FS_t *fspace);
|
|
H5_DLL herr_t H5FS_sect_assert(const H5FS_t *fspace);
|
|
#endif /* H5FS_DEBUG */
|
|
|
|
#endif /* _H5FSpkg_H */
|
|
|