hikyuu2/extern-libs/hdf5/include/H5HGprivate.h
2015-01-07 01:26:14 +08:00

79 lines
3.1 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: Robb Matzke <matzke@llnl.gov>
* Friday, March 27, 1998
*/
#ifndef _H5HGprivate_H
#define _H5HGprivate_H
/* Include package's public header */
#include "H5HGpublic.h"
/* Private headers needed by this file. */
#include "H5Fprivate.h" /* File access */
/* Information to locate object in global heap */
typedef struct H5HG_t {
haddr_t addr; /*address of collection */
size_t idx; /*object ID within collection */
} H5HG_t;
/* Typedef for heap in memory (defined in H5HGpkg.h) */
typedef struct H5HG_heap_t H5HG_heap_t;
/*
* Limit global heap collections to the some reasonable size. This is
* fairly arbitrary, but needs to be small enough that no more than H5HG_MAXIDX
* objects will be allocated from a single heap.
*/
#define H5HG_MAXSIZE 65536
/* If the module using this macro is allowed access to the private variables, access them directly */
#ifdef H5HG_PACKAGE
#define H5HG_ADDR(H) ((H)->addr)
#define H5HG_SIZE(H) ((H)->size)
#define H5HG_FREE_SIZE(H) ((H)->obj[0].size)
#else /* H5HG_PACKAGE */
#define H5HG_ADDR(H) (H5HG_get_addr(H))
#define H5HG_SIZE(H) (H5HG_get_size(H))
#define H5HG_FREE_SIZE(H) (H5HG_get_free_size(H))
#endif /* H5HG_PACKAGE */
/* Main global heap routines */
H5_DLL herr_t H5HG_insert(H5F_t *f, hid_t dxpl_id, size_t size, void *obj,
H5HG_t *hobj/*out*/);
H5_DLL void *H5HG_read(H5F_t *f, hid_t dxpl_id, H5HG_t *hobj, void *object, size_t *buf_size/*out*/);
H5_DLL int H5HG_link(H5F_t *f, hid_t dxpl_id, const H5HG_t *hobj, int adjust);
H5_DLL herr_t H5HG_remove(H5F_t *f, hid_t dxpl_id, H5HG_t *hobj);
/* Support routines */
H5_DLL herr_t H5HG_extend(H5F_t *f, hid_t dxpl_id, haddr_t addr, size_t need);
/* Query routines */
H5_DLL haddr_t H5HG_get_addr(const H5HG_heap_t *h);
H5_DLL size_t H5HG_get_size(const H5HG_heap_t *h);
H5_DLL size_t H5HG_get_free_size(const H5HG_heap_t *h);
/* Debugging functions */
H5_DLL herr_t H5HG_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, FILE *stream, int indent,
int fwidth);
#endif /* _H5HGprivate_H */