H5SMprivate.h

00001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00002  * Copyright by The HDF Group.                                               *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
00013  * access to either file, you may request a copy from help@hdfgroup.org.     *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 /*
00017  * Programmer:  James Laird <jlaird@ncsa.uiuc.edu>
00018  *              Thursday, March 2, 2006
00019  *
00020  * Purpose:     This file contains private declarations for the H5SM
00021  *              shared object header messages module.
00022  */
00023 #ifndef _H5SMprivate_H
00024 #define _H5SMprivate_H
00025 
00026 #include "H5Oprivate.h"         /* Object headers                       */
00027 #include "H5Pprivate.h"         /* Property lists                       */
00028 
00029 /****************************/
00030 /* Library Private Typedefs */
00031 /****************************/
00032 
00033 /* Forward references of package typedefs */
00034 typedef struct H5SM_master_table_t H5SM_master_table_t;
00035 
00036 
00037 /******************************/
00038 /* Library Private Prototypes */
00039 /******************************/
00040 
00041 /* Generally useful shared message routines */
00042 H5_DLL herr_t H5SM_init(H5F_t *f, H5P_genplist_t *fc_plist,
00043     const H5O_loc_t *ext_loc, hid_t dxpl_id);
00044 H5_DLL htri_t H5SM_can_share(H5F_t *f, hid_t dxpl_id, H5SM_master_table_t *table,
00045     ssize_t *sohm_index_num, unsigned type_id, const void *mesg);
00046 H5_DLL htri_t H5SM_try_share(H5F_t *f, hid_t dxpl_id, H5O_t *open_oh,
00047     unsigned type_id, void *mesg, unsigned *mesg_flags);
00048 H5_DLL herr_t H5SM_delete(H5F_t *f, hid_t dxpl_id, H5O_t *open_oh,
00049     H5O_shared_t *sh_mesg);
00050 H5_DLL herr_t H5SM_get_info(const H5O_loc_t *ext_loc, H5P_genplist_t *fc_plist,
00051     hid_t dxpl_id);
00052 H5_DLL htri_t H5SM_type_shared(H5F_t *f, unsigned type_id, hid_t dxpl_id);
00053 H5_DLL herr_t H5SM_get_fheap_addr(H5F_t *f, hid_t dxpl_id, unsigned type_id,
00054     haddr_t *fheap_addr);
00055 H5_DLL herr_t H5SM_reconstitute(H5O_shared_t *sh_mesg, H5F_t *f,
00056     unsigned msg_type_id, H5O_fheap_id_t heap_id);
00057 H5_DLL herr_t H5SM_get_refcount(H5F_t *f, hid_t dxpl_id, unsigned type_id,
00058     const H5O_shared_t *sh_mesg, hsize_t *ref_count);
00059 H5_DLL herr_t H5SM_ih_size(H5F_t *f, hid_t dxpl_id, H5F_info_t *bh_info);
00060 
00061 
00062 /* Debugging routines */
00063 H5_DLL herr_t H5SM_table_debug(H5F_t *f, hid_t dxpl_id, haddr_t table_addr,
00064     FILE *stream, int indent, int fwidth, unsigned table_vers,
00065     unsigned num_indexes);
00066 H5_DLL herr_t H5SM_list_debug(H5F_t *f, hid_t dxpl_id, haddr_t list_addr,
00067     FILE *stream, int indent, int fwidth, unsigned list_vers, size_t num_messages);
00068 
00069 #endif /*_H5SMprivate_H*/
00070