mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-27 02:10:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
22fa1e8009
hdf5/src/H5Fquery.c
Larry Knox 89fbe00dec Merge pull request #426 in HDFFV/hdf5 from ~LRKNOX/hdf5_lrk:hdf5_1_10 to hdf5_1_10 
* commit '54957d37f5aa73912763dbb6e308555e863c43f4':
  Commit copyright header change for src/H5PLpkg.c which was added after running script to make changes.
  Add new files in release_docs to MANIFEST. Cimmit changes to Makefile.in(s) and H5PL.c that resulted from running autogen.sh.
  Merge pull request #407 in HDFFV/hdf5 from ~LRKNOX/hdf5_lrk:hdf5_1_10_1 to hdf5_1_10_1
  Change copyright headers to replace url referring to file to be removed and replace it with new url for COPYING file.
2017-04-25 16:05:36 -05:00

1383 lines
38 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Created: H5Fquery.c
* Jan 10 2008
* Quincey Koziol <koziol@hdfgroup.org>
*
* Purpose: File structure query routines.
*
*-------------------------------------------------------------------------
*/
/****************/
/* Module Setup */
/****************/
#include "H5Fmodule.h" /* This source code file is part of the H5F module */
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Fpkg.h" /* File access */
#include "H5FDprivate.h" /* File drivers */
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Package Typedefs */
/********************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/*-------------------------------------------------------------------------
* Function: H5F_get_intent
*
* Purpose: Quick and dirty routine to retrieve the file's 'intent' flags
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'intent' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_intent(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->shared->flags)
} /* end H5F_get_intent() */
/*-------------------------------------------------------------------------
* Function: H5F_get_open_name
*
* Purpose: Retrieve the name used to open a file.
*
* Return: Success: The name of the file.
* Failure: ? (should not happen)
*
* Programmer: Neil Fortner
* December 15 2008
*
*-------------------------------------------------------------------------
*/
char *
H5F_get_open_name(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->open_name);
FUNC_LEAVE_NOAPI(f->open_name)
} /* end H5F_get_open_name() */
/*-------------------------------------------------------------------------
* Function: H5F_get_actual_name
*
* Purpose: Retrieve the actual name of a file, after resolving symlinks, etc.
*
* Return: Success: The name of the file.
* Failure: ? (should not happen)
*
* Programmer: Quincey Koziol
* November 25 2009
*
*-------------------------------------------------------------------------
*/
char *
H5F_get_actual_name(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->actual_name);
FUNC_LEAVE_NOAPI(f->actual_name)
} /* end H5F_get_actual_name() */
/*-------------------------------------------------------------------------
* Function: H5F_get_extpath
*
* Purpose: Retrieve the file's 'extpath' flags
* This is used by H5L_extern_traverse() and H5D_build_extfile_prefix() to retrieve the main file's location
* when searching the target file.
*
* Return: 'extpath' on success/abort on failure (shouldn't fail)
*
* Programmer: Vailin Choi, April 2, 2008
*
*-------------------------------------------------------------------------
*/
char *
H5F_get_extpath(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->extpath);
FUNC_LEAVE_NOAPI(f->extpath)
} /* end H5F_get_extpath() */
/*-------------------------------------------------------------------------
* Function: H5F_get_shared
*
* Purpose: Retrieve the file's 'shared' pointer
*
* Return: 'shared' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
H5F_file_t *
H5F_get_shared(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->shared)
} /* end H5F_get_shared() */
/*-------------------------------------------------------------------------
* Function: H5F_same_shared
*
* Purpose: Determine if two files have the same shared file pointer
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 19, 2011
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_same_shared(const H5F_t *f1, const H5F_t *f2)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f1);
HDassert(f1->shared);
HDassert(f2);
HDassert(f2->shared);
FUNC_LEAVE_NOAPI(f1->shared == f2->shared)
} /* end H5F_same_shared() */
/*-------------------------------------------------------------------------
* Function: H5F_get_nopen_objs
*
* Purpose: Retrieve the file's 'nopen_objs' value
*
* Return: 'nopen_objs' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_nopen_objs(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->nopen_objs)
} /* end H5F_get_nopen_objs() */
/*-------------------------------------------------------------------------
* Function: H5F_get_file_id
*
* Purpose: Retrieve the file's 'file_id' value
*
* Return: 'file_id' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_file_id(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->file_id)
} /* end H5F_get_file_id() */
/*-------------------------------------------------------------------------
* Function: H5F_get_parent
*
* Purpose: Retrieve the file's 'parent' pointer
*
* Return: 'parent' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 19, 2011
*
*-------------------------------------------------------------------------
*/
H5F_t *
H5F_get_parent(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->parent)
} /* end H5F_get_parent() */
/*-------------------------------------------------------------------------
* Function: H5F_get_nmounts
*
* Purpose: Retrieve the file's 'nmounts' value
*
* Return: 'nmounts' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_nmounts(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->nmounts)
} /* end H5F_get_nmounts() */
/*-------------------------------------------------------------------------
* Function: H5F_get_read_attempts
*
* Purpose: Retrieve the file's 'read_attempts' value
*
* Return: '# of read attempts' on success/abort on failure (shouldn't fail)
*
* Programmer: Vaili Choi; Sept 2013
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_read_attempts(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->shared->read_attempts)
} /* end H5F_get_read_attempts() */
/*-------------------------------------------------------------------------
* Function: H5F_get_fcpl
*
* Purpose: Retrieve the value of a file's FCPL.
*
* Return: Success: The FCPL for the file.
*
* Failure: ? (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* May 25 2005
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_fcpl(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->fcpl_id)
} /* end H5F_get_fcpl() */
/*-------------------------------------------------------------------------
* Function: H5F_sizeof_addr
*
* Purpose: Quick and dirty routine to retrieve the size of the file's size_t
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'sizeof_addr' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
*-------------------------------------------------------------------------
*/
uint8_t
H5F_sizeof_addr(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sizeof_addr)
} /* end H5F_sizeof_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_sizeof_size
*
* Purpose: Quick and dirty routine to retrieve the size of the file's off_t
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'sizeof_size' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
*-------------------------------------------------------------------------
*/
uint8_t
H5F_sizeof_size(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sizeof_size)
} /* H5F_sizeof_size() */
/*-------------------------------------------------------------------------
* Function: H5F_get_sohm_addr
*
* Purpose: Retrieve the file's 'sohm_addr' value
*
* Return: 'sohm_addr' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
haddr_t
H5F_get_sohm_addr(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sohm_addr)
} /* end H5F_get_sohm_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_get_sohm_vers
*
* Purpose: Retrieve the file's 'sohm_vers' value
*
* Return: 'sohm_vers' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_sohm_vers(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sohm_vers)
} /* end H5F_get_sohm_vers() */
/*-------------------------------------------------------------------------
* Function: H5F_get_sohm_nindexes
*
* Purpose: Retrieve the file's 'sohm_nindexes' value
*
* Return: 'sohm_nindexes' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_sohm_nindexes(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sohm_nindexes)
} /* end H5F_get_sohm_nindexes() */
/*-------------------------------------------------------------------------
* Function: H5F_sym_leaf_k
*
* Purpose: Replaced a macro to retrieve the symbol table leaf size,
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the symbol table leaf size is
* returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Raymond Lu
* slu@ncsa.uiuc.edu
* Oct 14 2001
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_sym_leaf_k(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->sblock);
FUNC_LEAVE_NOAPI(f->shared->sblock->sym_leaf_k)
} /* end H5F_sym_leaf_k() */
/*-------------------------------------------------------------------------
* Function: H5F_Kvalue
*
* Purpose: Replaced a macro to retrieve a B-tree key value for a certain
* type, now that the generic properties are being used to store
* the B-tree values.
*
* Return: Success: Non-negative, and the B-tree key value is
* returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Raymond Lu
* slu@ncsa.uiuc.edu
* Oct 14 2001
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_Kvalue(const H5F_t *f, const H5B_class_t *type)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->sblock);
HDassert(type);
FUNC_LEAVE_NOAPI(f->shared->sblock->btree_k[type->id])
} /* end H5F_Kvalue() */
/*-------------------------------------------------------------------------
* Function: H5F_get_nrefs
*
* Purpose: Retrieve the file's 'nrefs' value
*
* Return: 'nrefs' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_nrefs(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->nrefs)
} /* end H5F_get_nrefs() */
/*-------------------------------------------------------------------------
* Function: H5F_rdcc_nslots
*
* Purpose: Replaced a macro to retrieve the raw data cache number of slots,
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the raw data cache number of
* of slots is returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jun 1 2004
*
*-------------------------------------------------------------------------
*/
size_t
H5F_rdcc_nslots(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->rdcc_nslots)
} /* end H5F_rdcc_nelmts() */
/*-------------------------------------------------------------------------
* Function: H5F_rdcc_nbytes
*
* Purpose: Replaced a macro to retrieve the raw data cache number of bytes,
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the raw data cache number of
* of bytes is returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jun 1 2004
*
*-------------------------------------------------------------------------
*/
size_t
H5F_rdcc_nbytes(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->rdcc_nbytes)
} /* end H5F_rdcc_nbytes() */
/*-------------------------------------------------------------------------
* Function: H5F_rdcc_w0
*
* Purpose: Replaced a macro to retrieve the raw data cache 'w0' value
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the raw data cache 'w0' value
* is returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jun 2 2004
*
*-------------------------------------------------------------------------
*/
double
H5F_rdcc_w0(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->rdcc_w0)
} /* end H5F_rdcc_w0() */
/*-------------------------------------------------------------------------
* Function: H5F_get_base_addr
*
* Purpose: Quick and dirty routine to retrieve the file's 'base_addr' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Raymond Lu <slu@ncsa.uiuc.edu>
* December 20, 2002
*
*-------------------------------------------------------------------------
*/
haddr_t
H5F_get_base_addr(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->sblock);
FUNC_LEAVE_NOAPI(f->shared->sblock->base_addr)
} /* end H5F_get_base_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_grp_btree_shared
*
* Purpose: Replaced a macro to retrieve the shared B-tree node info
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-void, and the shared B-tree node info
* is returned.
*
* Failure: void (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jul 5 2004
*
*-------------------------------------------------------------------------
*/
H5UC_t *
H5F_grp_btree_shared(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->grp_btree_shared)
} /* end H5F_grp_btree_shared() */
/*-------------------------------------------------------------------------
* Function: H5F_sieve_buf_size
*
* Purpose: Replaced a macro to retrieve the dataset sieve buffer size
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-void, and the dataset sieve buffer size
* is returned.
*
* Failure: void (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jul 8 2005
*
*-------------------------------------------------------------------------
*/
size_t
H5F_sieve_buf_size(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sieve_buf_size)
} /* end H5F_sieve_buf_size() */
/*-------------------------------------------------------------------------
* Function: H5F_gc_ref
*
* Purpose: Replaced a macro to retrieve the "garbage collect
* references flag" now that the generic properties are being used
* to store the values.
*
* Return: Success: The "garbage collect references flag"
* is returned.
*
* Failure: (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jul 8 2005
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_gc_ref(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->gc_ref)
} /* end H5F_gc_ref() */
/*-------------------------------------------------------------------------
* Function: H5F_use_latest_flags
*
* Purpose: Retrieve the 'latest version support' for the file.
*
* Return: Success: Non-negative, the requested 'version support'
*
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Mar 5 2007
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_use_latest_flags(const H5F_t *f, unsigned fl)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->latest_flags & (fl))
} /* end H5F_use_latest_flags() */
/*-------------------------------------------------------------------------
* Function: H5F_get_fc_degree
*
* Purpose: Retrieve the 'file close degree' for the file.
*
* Return: Success: Non-negative, the 'file close degree'
*
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Mar 5 2007
*
*-------------------------------------------------------------------------
*/
H5F_close_degree_t
H5F_get_fc_degree(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->fc_degree)
} /* end H5F_get_fc_degree() */
/*-------------------------------------------------------------------------
* Function: H5F_get_evict_on_close
*
* Purpose: Checks if evict-on-close is desired for objects in the
* file.
*
* Return: Success: Flag indicating whether the evict-on-close
* property was set for the file.
* Failure: (can't happen)
*
* Programmer: Dana Robinson
* Spring 2016
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_get_evict_on_close(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->evict_on_close)
} /* end H5F_get_evict_on_close() */
/*-------------------------------------------------------------------------
* Function: H5F_store_msg_crt_idx
*
* Purpose: Retrieve the 'store message creation index' flag for the file.
*
* Return: Success: Non-negative, the 'store message creation index' flag
*
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Mar 6 2007
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_store_msg_crt_idx(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->store_msg_crt_idx)
} /* end H5F_store_msg_crt_idx() */
/*-------------------------------------------------------------------------
* Function: H5F_has_feature
*
* Purpose: Check if a file has a particular feature enabled
*
* Return: Success: Non-negative - TRUE or FALSE
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* May 31 2004
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_has_feature(const H5F_t *f, unsigned feature)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI((hbool_t)(f->shared->lf->feature_flags&feature))
} /* end H5F_has_feature() */
/*-------------------------------------------------------------------------
* Function: H5F_get_driver_id
*
* Purpose: Quick and dirty routine to retrieve the file's 'driver_id' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'driver_id' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* October 10, 2000
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_driver_id(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->lf);
FUNC_LEAVE_NOAPI(f->shared->lf->driver_id)
} /* end H5F_get_driver_id() */
/*-------------------------------------------------------------------------
* Function: H5F_get_fileno
*
* Purpose: Quick and dirty routine to retrieve the file's 'fileno' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* March 27, 2002
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_fileno(const H5F_t *f, unsigned long *filenum)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(FAIL)
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->lf);
HDassert(filenum);
/* Retrieve the file's serial number */
if(H5FD_get_fileno(f->shared->lf, filenum) < 0)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, FAIL, "can't retrieve fileno")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_fileno() */
/*-------------------------------------------------------------------------
* Function: H5F_get_eoa
*
* Purpose: Quick and dirty routine to retrieve the file's 'eoa' value
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* June 1, 2004
*
*-------------------------------------------------------------------------
*/
haddr_t
H5F_get_eoa(const H5F_t *f, H5FD_mem_t type)
{
haddr_t ret_value = HADDR_UNDEF; /* Return value */
FUNC_ENTER_NOAPI(HADDR_UNDEF)
HDassert(f);
HDassert(f->shared);
/* Dispatch to driver */
if(HADDR_UNDEF == (ret_value = H5FD_get_eoa(f->shared->lf, type)))
HGOTO_ERROR(H5E_VFL, H5E_CANTINIT, HADDR_UNDEF, "driver get_eoa request failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_eoa() */
/*-------------------------------------------------------------------------
* Function: H5F_get_vfd_handle
*
* Purpose: Returns a pointer to the file handle of the low-level file
* driver. This is the private function for H5Fget_vfd_handle.
*
* Return: Success: Non-negative.
* Failure: negative.
*
* Programmer: Raymond Lu
* Sep. 16, 2002
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_vfd_handle(const H5F_t *file, hid_t fapl, void **file_handle)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* Sanity check */
HDassert(file);
HDassert(file_handle);
/* Get the VFD handle */
if(H5FD_get_vfd_handle(file->shared->lf, fapl, file_handle) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get file handle for file driver")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_vfd_handle() */
/*-------------------------------------------------------------------------
* Function: H5F_is_tmp_addr
*
* Purpose: Quick and dirty routine to determine if an address is in
* the 'temporary' file space.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* June 11, 2009
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_is_tmp_addr(const H5F_t *f, haddr_t addr)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(H5F_addr_le(f->shared->tmp_addr, addr))
} /* end H5F_is_tmp_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_use_tmp_space
*
* Purpose: Quick and dirty routine to determine if using temporary
* file space is allowed for this file.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* July 1, 2009
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_use_tmp_space(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->use_tmp_space)
} /* end H5F_use_tmp_space() */
#ifdef H5_HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5F_coll_md_read
*
* Purpose: Retrieve the 'collective metadata reads' flag for the file.
*
* Return: Success: Non-negative, the 'collective metadata reads' flag
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Feb 10 2016
*
*-------------------------------------------------------------------------
*/
H5P_coll_md_read_flag_t
H5F_coll_md_read(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->coll_md_read)
} /* end H5F_coll_md_read() */
#endif /* H5_HAVE_PARALLEL */
/*-------------------------------------------------------------------------
* Function: H5F_use_mdc_logging
*
* Purpose: Quick and dirty routine to determine if using MDC logging
* is enabled for this file.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* June 5, 2016
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_use_mdc_logging(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->use_mdc_logging)
} /* end H5F_use_mdc_logging() */
/*-------------------------------------------------------------------------
* Function: H5F_start_mdc_log_on_access
*
* Purpose: Quick and dirty routine to determine if we should start MDC
* logging on access for this file.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* June 5, 2016
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_start_mdc_log_on_access(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->start_mdc_log_on_access)
} /* end H5F_start_mdc_log_on_access() */
/*-------------------------------------------------------------------------
* Function: H5F_mdc_log_location
*
* Purpose: Quick and dirty routine to retrieve the MDC log location
* for this file.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* June 5, 2016
*
*-------------------------------------------------------------------------
*/
char *
H5F_mdc_log_location(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->mdc_log_location)
} /* end H5F_mdc_log_location() */
/*-------------------------------------------------------------------------
* Function: H5F_get_alignment
*
* Purpose: Retrieve the 'alignment' for the file.
*
* Return: Success: Non-negative, the 'alignment'
*
* Failure: (can't happen)
*
* Programmer: Vailin Choi; Dec 2012
*
*-------------------------------------------------------------------------
*/
hsize_t
H5F_get_alignment(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->alignment)
} /* end H5F_get_alignment() */
/*-------------------------------------------------------------------------
* Function: H5F_get_threshold
*
* Purpose: Retrieve the 'threshold' for alignment in the file.
*
* Return: Success: Non-negative, the 'threshold'
*
* Failure: (can't happen)
*
* Programmer: Vailin Choi; Dec 2012
*
*-------------------------------------------------------------------------
*/
hsize_t
H5F_get_threshold(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->threshold)
} /* end H5F_get_threshold() */
/*-------------------------------------------------------------------------
* Function: H5F_get_pgend_meta_thres
*
* Purpose: Retrieve the 'page end meta threshold size' for the file.
*
* Return: Success: Non-negative, the 'pgend_meta_thres'
*
* Failure: (can't happen)
*
* Programmer: Vailin Choi; Dec 2012
*
*-------------------------------------------------------------------------
*/
hsize_t
H5F_get_pgend_meta_thres(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->pgend_meta_thres)
} /* end H5F_get_pgend_meta_thres() */
/*-------------------------------------------------------------------------
* Function: H5F_get_point_of_no_return
*
* Purpose: Retrieve the 'point of no return' value for the file.
*
* Return: Success: Non-negative, the 'point_of_no_return'
* Failure: (can't happen)
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_get_point_of_no_return(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->point_of_no_return)
} /* end H5F_get_point_of_no_return() */
/*-------------------------------------------------------------------------
* Function: H5F_get_first_alloc_dealloc
*
* Purpose: Retrieve the 'first alloc / dealloc' value for the file.
*
* Return: Success: Non-negative, the 'first_alloc_dealloc'
* Failure: (can't happen)
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_get_first_alloc_dealloc(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->first_alloc_dealloc)
} /* end H5F_get_first_alloc_dealloc() */
/*-------------------------------------------------------------------------
* Function: H5F_get_eoa_pre_fsm_fsalloc
*
* Purpose: Retrieve the 'EOA pre-FSM fsalloc' value for the file.
*
* Return: Success: Non-negative, the 'EOA pre-FSM fsalloc'
* Failure: (can't happen)
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_get_eoa_pre_fsm_fsalloc(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->eoa_pre_fsm_fsalloc)
} /* end H5F_get_eoa_pre_fsm_fsalloc() */
Reference in New Issue View Git Blame Copy Permalink