diff options
Diffstat (limited to 'src/H5B2pkg.h')
| -rw-r--r-- | src/H5B2pkg.h | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/src/H5B2pkg.h b/src/H5B2pkg.h new file mode 100644 index 0000000..1f98cac --- /dev/null +++ b/src/H5B2pkg.h @@ -0,0 +1,118 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * + * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +/* + * Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu> + * Monday, January 31, 2005 + * + * Purpose: This file contains declarations which are visible only within + * the H5B2 package. Source files outside the H5B2 package should + * include H5B2private.h instead. + */ +#ifndef H5B2_PACKAGE +#error "Do not include this file outside the H5B2 package!" +#endif + +#ifndef _H5B2pkg_H +#define _H5B2pkg_H + +/* Get package's private header */ +#include "H5B2private.h" + +/* Other private headers needed by this file */ +#include "H5ACprivate.h" /* Metadata cache */ +#include "H5FLprivate.h" /* Free Lists */ +#include "H5RCprivate.h" /* Reference counted object functions */ + +/**************************/ +/* Package Private Macros */ +/**************************/ + +/* Size of signature information (on disk) */ +#define H5B2_SIZEOF_MAGIC 4 + +/* B-tree signatures */ +#define H5B2_HDR_MAGIC "BTHD" /* Header */ +#define H5B2_LEAF_MAGIC "BTLF" /* Leaf node */ + +/****************************/ +/* Package Private Typedefs */ +/****************************/ + +/* A "node pointer" to another B-tree node */ +typedef struct { + haddr_t addr; /* Address of other node */ + unsigned node_nrec; /* Number of records used in node pointed to */ + hsize_t all_nrec; /* Number of records in node pointed to and all it's children */ +} H5B2_node_ptr_t; + +/* Each B-tree has certain information that can be shared across all + * the instances of nodes in that B-tree. + */ +typedef struct H5B2_shared_t { + /* Shared internal data structures */ + const H5B2_class_t *type; /* Type of tree */ + uint8_t *page; /* Disk page */ + H5FL_fac_head_t *int_fac; /* Factory for internal node native key blocks */ + H5FL_fac_head_t *leaf_fac; /* Factory for leaf node native key blocks */ + H5FL_fac_head_t *node_ptr_fac; /* Factory for internal node node pointer blocks */ + size_t *int_nat_off; /* Array of offsets of native keys in internal node block */ + size_t *leaf_nat_off; /* Array of offsets of native keys in leaf node block */ + size_t *node_ptr_off; /* Array of offsets of node pointers in internal node block */ + + /* Information set by user */ + unsigned split_percent; /* Percent full at which to split the node, when inserting */ + unsigned merge_percent; /* Percent full at which to merge the node, when deleting */ + size_t node_size; /* Size of all nodes, in bytes */ + size_t rkey_size; /* Size of "raw" (on disk) key, in bytes */ + + /* Derived information from user's information */ + size_t internal_nrec; /* Number of records which fit into an internal node */ + size_t split_int_nrec; /* Number of records to split an internal node at */ + size_t merge_int_nrec; /* Number of records to merge an internal node at */ + size_t leaf_nrec; /* Number of records which fit into a leaf node */ + size_t split_leaf_nrec; /* Number of records to split a leaf node at */ + size_t merge_leaf_nrec; /* Number of records to merge a leaf node at */ +} H5B2_shared_t; + +/* The B-tree information */ +typedef struct H5B2_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Internal B-tree information */ + unsigned depth; /* B-tree's overall depth */ + H5B2_node_ptr_t root; /* Node pointer to root node in B-tree */ + H5RC_t *shared; /* Ref-counted shared info */ +} H5B2_t; + +/* B-tree leaf information */ +typedef struct H5B2_leaf_t { + /* Information for H5AC cache functions, _must_ be first field in structure */ + H5AC_info_t cache_info; + + /* Internal B-tree information */ + H5RC_t *shared; /* Ref-counted shared info */ + uint8_t *leaf_native; /* Pointer to native keys */ + unsigned nrec; /* Number of records in leaf node */ +} H5B2_leaf_t; + +/******************************/ +/* Package Private Prototypes */ +/******************************/ +H5_DLL herr_t H5B2_hdr_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, + FILE *stream, int indent, int fwidth, const H5B2_class_t *type); + +#endif /* _H5B2pkg_H */ + |