[R-pkg-team] Bug#1087826: r-bioc-rhdf5: FTBFS with HDF5 1.14: ‘H5I_REFERENCE’ undeclared (first use in this function)
Gilles Filippini
pini at debian.org
Tue Nov 19 08:46:16 GMT 2024
Source: r-bioc-rhdf5
Version: 2.48.0+dfsg-3
Severity: important
Tags: ftbfs patch
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Control: usertag -1 + ftbfs-hdf5-1.14
Hi,
During a test rebuild against HDF5 1.14 currently in experimental
r-bioc-rhdf5 failed to build from source with:
gcc -I"/usr/share/R/include" -DNDEBUG -I'/usr/lib/R/site-library/Rhdf5lib/include' -fpic -g -O2 -ffile-prefix-map=/build/reproducible-path/r-base-4.4.2=. -fstack-protector-strong -fstack-clash-protection -Wformat -Werror=format-security -fcf-protection -Wdate-time -D_FORTIFY_SOURCE=2 -c H5constants.c -o H5constants.o
H5constants.c: In function ‘_H5constants’:
H5constants.c:156:36: error: ‘H5I_REFERENCE’ undeclared (first use in this function); did you mean ‘H5T_REFERENCE’?
156 | H5I_REFERENCE, H5I_VFL, H5I_GENPROP_CLS, H5I_GENPROP_LST,
| ^~~~~~~~~~~~~
| H5T_REFERENCE
H5constants.c:156:36: note: each undeclared identifier is reported only once for each function it appears in
make[1]: *** [/usr/lib/R/etc/Makeconf:195: H5constants.o] Error 1
Please find attached a patch proposal which should fix this issue.
Best,
_g.
- -- System Information:
Debian Release: 12.0
Architecture: amd64 (x86_64)
Kernel: Linux 6.1.0-26-amd64 (SMP w/12 CPU threads; PREEMPT)
Kernel taint flags: TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled
-----BEGIN PGP SIGNATURE-----
iQEzBAEBCgAdFiEEoJObzArDE05WtIyR7+hsbH/+z4MFAmc8UE0ACgkQ7+hsbH/+
z4PBsAf/XLR9kF0vJGGy43zqbi5Idu3GmcI+JEyCpZVlbsnmnzxFt6FNpN+9z1js
SeUDJD4TRIHIrLDzbA3ZWu0CJDF5IQIH0Jp/hSQ7h+stRKoCL/9Q2Y32eIkBqLNQ
nLZQxFN0fgrl1xV7rAp9Rl0eC4V6aCB7ZOF4an31B7yOYbsjVbHxH+Dak0vwqJ79
YoPi1fqfBwDnyXVEgmBsiNMSwL5bRn9UruiUJ+R4+bFXpsqBlIXpjG/GG2Gy2A0u
RdLt1Z/N/KmHlYoQS7kxpMCio1HLLEMhYvfH7jCqJSApCPcyqvbbLKOe47/CDmzE
k2EqHiTGyDef3Cel5jC28YHJrRVaIw==
=MaDQ
-----END PGP SIGNATURE-----
-------------- next part --------------
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/changelog r-bioc-rhdf5-2.48.0+dfsg/debian/changelog
--- r-bioc-rhdf5-2.48.0+dfsg/debian/changelog 2024-10-02 12:16:20.000000000 +0200
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/changelog 2024-11-18 12:26:57.000000000 +0100
@@ -1,3 +1,10 @@
+r-bioc-rhdf5 (2.48.0+dfsg-3.1) UNRELEASED; urgency=medium
+
+ * Non-maintainer upload.
+ * Support HDF5 1.14
+
+ -- Gilles Filippini <pini at debian.org> Mon, 18 Nov 2024 12:26:57 +0100
+
r-bioc-rhdf5 (2.48.0+dfsg-3) unstable; urgency=medium
* Team upload.
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5private.h r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5private.h
--- r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5private.h 1970-01-01 01:00:00.000000000 +0100
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5private.h 2024-11-18 12:26:57.000000000 +0100
@@ -0,0 +1,1767 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group. *
+ * 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://www.hdfgroup.org/licenses. *
+ * If you do not have access to either file, you may request a copy from *
+ * help at hdfgroup.org. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * Purpose: This file is included by all HDF5 library source files to
+ * define common things which are not defined in the HDF5 API.
+ * The configuration constants like H5_HAVE_UNISTD_H etc. are
+ * defined in H5config.h which is included by H5public.h.
+ */
+
+#ifndef H5private_H
+#define H5private_H
+
+#include "H5public.h" /* Include Public Definitions */
+
+#include <assert.h>
+#include <ctype.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <fenv.h>
+#include <setjmp.h>
+#include <signal.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+
+/* Define __STDC_WANT_IEC_60559_TYPES_EXT__ for _FloatN support, if available */
+#define __STDC_WANT_IEC_60559_TYPES_EXT__
+#include <float.h>
+#include <math.h>
+
+/* POSIX headers */
+#ifdef H5_HAVE_SYS_TIME_H
+#include <sys/time.h>
+#endif
+#ifdef H5_HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+#ifdef H5_HAVE_PWD_H
+#include <pwd.h>
+#endif
+#ifdef H5_HAVE_WAITPID
+#include <sys/wait.h>
+#endif
+
+/* Include the Pthreads header, if necessary */
+#if defined(H5_HAVE_THREADSAFE) && defined(H5_HAVE_PTHREAD_H)
+#include <pthread.h>
+#endif
+
+/*
+ * The `struct stat' data type for stat() and fstat(). This is a POSIX file
+ * but often appears on non-POSIX systems also. The `struct stat' is required
+ * for HDF5 to compile, although only a few fields are actually used.
+ */
+#ifdef H5_HAVE_SYS_STAT_H
+#include <sys/stat.h>
+#endif
+
+/*
+ * flock() in sys/file.h is used for the implementation of file locking.
+ */
+#if defined(H5_HAVE_FLOCK) && defined(H5_HAVE_SYS_FILE_H)
+#include <sys/file.h>
+#endif
+
+/*
+ * Resource usage is not Posix.1 but HDF5 uses it anyway for some performance
+ * and debugging code if available.
+ */
+#ifdef H5_HAVE_SYS_RESOURCE_H
+#include <sys/resource.h>
+#endif
+
+/*
+ * Unix ioctls. These are used by h5ls (and perhaps others) to determine a
+ * reasonable output width.
+ */
+#ifdef H5_HAVE_SYS_IOCTL_H
+#include <sys/ioctl.h>
+#endif
+
+/*
+ * Dynamic library handling. These are needed for dynamically loading I/O
+ * filters and VFDs.
+ */
+#ifdef H5_HAVE_DLFCN_H
+#include <dlfcn.h>
+#endif
+#ifdef H5_HAVE_DIRENT_H
+#include <dirent.h>
+#endif
+
+/* Define the default VFD for this platform. Since the removal of the
+ * Windows VFD, this is sec2 for all platforms.
+ *
+ * Note well: if you change the default, then be sure to change
+ * H5_default_vfd_init() to call that default's initializer. Also,
+ * make sure that the initializer for each *non*-default VFD calls
+ * H5_init_library(); also, make sure that the initializer for default
+ * VFD does *not* call H5_init_library().
+ */
+#define H5_DEFAULT_VFD H5FD_SEC2
+#define H5_DEFAULT_VFD_NAME "sec2"
+
+/* Define the default VOL driver */
+#define H5_DEFAULT_VOL H5VL_NATIVE
+
+#ifdef H5_HAVE_WIN32_API
+
+/* The following two defines must be before any windows headers are included */
+#define WIN32_LEAN_AND_MEAN /* Exclude rarely-used stuff from Windows headers */
+#define NOGDI /* Exclude Graphic Display Interface macros */
+
+/* InitOnceExecuteOnce() requires 0x0600 to work on MinGW w/ Win32 threads */
+#if defined(H5_HAVE_MINGW) && defined(H5_HAVE_THREADSAFE)
+#if !defined(_WIN32_WINNT) || (_WIN32_WINNT < 0x0600)
+#undef _WIN32_WINNT
+#define _WIN32_WINNT 0x0600
+#endif
+#endif
+
+#include <windows.h>
+
+#include <direct.h> /* For _getcwd() */
+#include <io.h> /* POSIX I/O */
+#include <winsock2.h> /* For GetUserName() */
+#include <shlwapi.h> /* For StrStrIA */
+
+#ifdef H5_HAVE_THREADSAFE
+#include <process.h> /* For _beginthread() */
+#endif
+
+#endif /*H5_HAVE_WIN32_API*/
+
+#ifndef F_OK
+#define F_OK 00
+#define W_OK 02
+#define R_OK 04
+#endif
+
+/* uthash is an external, header-only hash table implementation.
+ *
+ * We include the file directly in src/ and #define a few functions
+ * to use our internal memory calls.
+ */
+#define uthash_malloc(sz) H5MM_malloc(sz)
+#define uthash_free(ptr, sz) H5MM_free(ptr) /* Ignoring sz is intentional */
+#define HASH_NONFATAL_OOM 1 /* Don't abort() on out-of-memory */
+
+/*
+ * Does the compiler support the __builtin_expect() syntax?
+ * It's not a problem if not.
+ */
+#if H5_HAVE_BUILTIN_EXPECT
+#define H5_LIKELY(expression) __builtin_expect(!!(expression), 1)
+#define H5_UNLIKELY(expression) __builtin_expect(!!(expression), 0)
+#else
+#define H5_LIKELY(expression) (expression)
+#define H5_UNLIKELY(expression) (expression)
+#endif
+
+/*
+ * Does the compiler support the __attribute__(()) syntax? It's no
+ * big deal if we don't.
+ *
+ * Note that Solaris Studio supports attribute, but does not support the
+ * attributes we use.
+ *
+ * When using H5_ATTR_FALLTHROUGH, you should also include a comment that
+ * says FALLTHROUGH to reduce warnings on compilers that don't use
+ * attributes but do respect fall-through comments.
+ *
+ * H5_ATTR_CONST is redefined in tools/h5repack/dynlib_rpk.c to quiet
+ * gcc warnings (it has to use the public API and can't include this
+ * file). Be sure to update that file if the #ifdefs change here.
+ */
+/* clang-format off */
+#if defined(H5_HAVE_ATTRIBUTE) && !defined(__SUNPRO_C)
+# define H5_ATTR_FORMAT(X, Y, Z) __attribute__((format(X, Y, Z)))
+# define H5_ATTR_UNUSED __attribute__((unused))
+
+# ifdef H5_HAVE_PARALLEL
+# define H5_ATTR_PARALLEL_UNUSED __attribute__((unused))
+# define H5_ATTR_PARALLEL_USED /*void*/
+# else
+# define H5_ATTR_PARALLEL_UNUSED /*void*/
+# define H5_ATTR_PARALLEL_USED __attribute__((unused))
+# endif
+
+# ifdef H5_NO_DEPRECATED_SYMBOLS
+# define H5_ATTR_DEPRECATED_USED H5_ATTR_UNUSED
+# else
+# define H5_ATTR_DEPRECATED_USED /*void*/
+# endif
+
+# ifndef NDEBUG
+# define H5_ATTR_NDEBUG_UNUSED /*void*/
+# else
+# define H5_ATTR_NDEBUG_UNUSED H5_ATTR_UNUSED
+# endif
+
+# define H5_ATTR_NORETURN __attribute__((noreturn))
+# define H5_ATTR_CONST __attribute__((const))
+# define H5_ATTR_PURE __attribute__((pure))
+
+# if defined(__clang__) || defined(__GNUC__) && __GNUC__ >= 7 && !defined(__INTEL_COMPILER)
+# define H5_ATTR_FALLTHROUGH __attribute__((fallthrough));
+# else
+# define H5_ATTR_FALLTHROUGH /* FALLTHROUGH */
+# endif
+
+# if defined(__GNUC__) && !defined(__INTEL_COMPILER)
+# define H5_ATTR_MALLOC __attribute__((malloc))
+# else
+# define H5_ATTR_MALLOC /*void*/
+# endif
+
+/* Turns off optimizations for a function. Goes after the return type.
+ * Not generally needed in the library, but ancient versions of clang
+ * (7.3.3, possibly others) have trouble with some of the onion VFD decode
+ * functions and need the optimizer turned off. This macro can go away when
+ * we figure out what's going on and can engineer another solution.
+ */
+# if defined(__clang__)
+# define H5_ATTR_NO_OPTIMIZE __attribute__((optnone))
+# else
+# define H5_ATTR_NO_OPTIMIZE /*void*/
+# endif
+
+#else
+# define H5_ATTR_FORMAT(X, Y, Z) /*void*/
+# define H5_ATTR_UNUSED /*void*/
+# define H5_ATTR_NDEBUG_UNUSED /*void*/
+# define H5_ATTR_DEPRECATED_USED /*void*/
+# define H5_ATTR_PARALLEL_UNUSED /*void*/
+# define H5_ATTR_PARALLEL_USED /*void*/
+# define H5_ATTR_NORETURN /*void*/
+# define H5_ATTR_CONST /*void*/
+# define H5_ATTR_PURE /*void*/
+# define H5_ATTR_FALLTHROUGH /*void*/
+# define H5_ATTR_MALLOC /*void*/
+# define H5_ATTR_NO_OPTIMIZE /*void*/
+#endif
+/* clang-format on */
+
+/*
+ * Networking headers used by the mirror VFD and related tests and utilities.
+ */
+#ifdef H5_HAVE_ARPA_INET_H
+#include <arpa/inet.h>
+#endif
+#ifdef H5_HAVE_NETDB_H
+#include <netdb.h>
+#endif
+#ifdef H5_HAVE_NETINET_IN_H
+#include <netinet/in.h>
+#endif
+#ifdef H5_HAVE_SYS_SOCKET_H
+#include <sys/socket.h>
+#endif
+
+/*
+ * Status return values for the `herr_t' type.
+ * Since some unix/c routines use 0 and -1 (or more precisely, non-negative
+ * vs. negative) as their return code, and some assumption had been made in
+ * the code about that, it is important to keep these constants the same
+ * values. When checking the success or failure of an integer-valued
+ * function, remember to compare against zero and not one of these two
+ * values.
+ */
+#define SUCCEED 0
+#define FAIL (-1)
+
+/* number of members in an array */
+#ifndef NELMTS
+#define NELMTS(X) (sizeof(X) / sizeof(X[0]))
+#endif
+
+/* minimum of two, three, or four values */
+#undef MIN
+#define MIN(a, b) (((a) < (b)) ? (a) : (b))
+#define MIN2(a, b) MIN(a, b)
+#define MIN3(a, b, c) MIN(a, MIN(b, c))
+#define MIN4(a, b, c, d) MIN(MIN(a, b), MIN(c, d))
+
+/* maximum of two, three, or four values */
+#undef MAX
+#define MAX(a, b) (((a) > (b)) ? (a) : (b))
+#define MAX2(a, b) MAX(a, b)
+#define MAX3(a, b, c) MAX(a, MAX(b, c))
+#define MAX4(a, b, c, d) MAX(MAX(a, b), MAX(c, d))
+
+/* limit the middle value to be within a range (inclusive) */
+#define RANGE(LO, X, HI) MAX(LO, MIN(X, HI))
+
+/* Macro for checking if two ranges overlap one another */
+/*
+ * Check for the inverse of whether the ranges are disjoint. If they are
+ * disjoint, then the low bound of one of the ranges must be greater than the
+ * high bound of the other.
+ */
+/* (Assumes that low & high bounds are _inclusive_) */
+#define H5_RANGE_OVERLAP(L1, H1, L2, H2) (!((L1) > (H2) || (L2) > (H1)))
+
+/* absolute value */
+#ifndef ABS
+#define ABS(a) (((a) >= 0) ? (a) : -(a))
+#endif
+
+/* sign of argument */
+#ifndef SIGN
+#define SIGN(a) ((a) > 0 ? 1 : (a) < 0 ? -1 : 0)
+#endif
+
+/* test for number that is a power of 2 */
+/* (from: http://graphics.stanford.edu/~seander/bithacks.html#DetermineIfPowerOf2) */
+#define POWER_OF_TWO(n) (!(n & (n - 1)) && n)
+
+/* Raise an integer to a power of 2 */
+#define H5_EXP2(n) (1 << (n))
+
+/* Check if a read of size bytes starting at ptr would overflow past
+ * the last valid byte, pointed to by buffer_end. Note that 'size'
+ * is expected to be of type size_t. Providing values of other
+ * datatypes may cause warnings due to the comparison against
+ * PTRDIFF_MAX and comparison of < 0 after conversion to ptrdiff_t.
+ * For the time being, these can be suppressed with
+ * H5_GCC_CLANG_DIAG_OFF("type-limits")/H5_GCC_CLANG_DIAG_ON("type-limits")
+ */
+/* clang-format off */
+#define H5_IS_BUFFER_OVERFLOW(ptr, size, buffer_end) \
+ ( \
+ /* Trivial case */ \
+ ((size) != 0) && \
+ ( \
+ /* Bad precondition */ \
+ ((ptr) > (buffer_end)) || \
+ /* Account for (likely unintentional) negative 'size' */ \
+ (((size_t)(size) <= PTRDIFF_MAX) && ((ptrdiff_t)(size) < 0)) || \
+ /* Typical overflow */ \
+ ((size_t)(size) > (size_t)((((const uint8_t *)buffer_end) - ((const uint8_t *)ptr)) + 1)) \
+ ) \
+ )
+/* clang-format on */
+
+/* Variant of H5_IS_BUFFER_OVERFLOW, used with functions such as H5Tdecode()
+ * that don't take a size parameter, where we need to skip the bounds checks.
+ *
+ * This is a separate macro since we don't want to inflict that behavior on
+ * the entire library.
+ */
+#define H5_IS_KNOWN_BUFFER_OVERFLOW(skip, ptr, size, buffer_end) \
+ (skip ? false : H5_IS_BUFFER_OVERFLOW(ptr, size, buffer_end))
+
+/*
+ * HDF Boolean type.
+ */
+#ifndef FALSE
+#define FALSE false
+#endif
+#ifndef TRUE
+#define TRUE true
+#endif
+
+/*
+ * The max value for ssize_t.
+ *
+ * Only needed where ssize_t isn't a thing (e.g., Windows)
+ */
+#ifndef SSIZE_MAX
+#define SSIZE_MAX ((ssize_t)(((size_t)1 << (8 * sizeof(ssize_t) - 1)) - 1))
+#endif
+
+/*
+ * Maximum & minimum values for HDF5 typedefs.
+ */
+#define HSIZET_MAX ((hsize_t)ULLONG_MAX)
+#define HSSIZET_MAX ((hssize_t)LLONG_MAX)
+#define HSSIZET_MIN (~(HSSIZET_MAX))
+
+#ifdef H5_HAVE_PARALLEL
+
+/* Define a type for safely sending size_t values with MPI */
+#if SIZE_MAX == UCHAR_MAX
+#define H5_SIZE_T_AS_MPI_TYPE MPI_UNSIGNED_CHAR
+#elif SIZE_MAX == USHRT_MAX
+#define H5_SIZE_T_AS_MPI_TYPE MPI_UNSIGNED_SHORT
+#elif SIZE_MAX == UINT_MAX
+#define H5_SIZE_T_AS_MPI_TYPE MPI_UNSIGNED
+#elif SIZE_MAX == ULONG_MAX
+#define H5_SIZE_T_AS_MPI_TYPE MPI_UNSIGNED_LONG
+#elif SIZE_MAX == ULLONG_MAX
+#define H5_SIZE_T_AS_MPI_TYPE MPI_UNSIGNED_LONG_LONG
+#else
+#error "no suitable MPI type for size_t"
+#endif
+
+#endif /* H5_HAVE_PARALLEL */
+
+/*
+ * Types and max sizes for POSIX I/O.
+ * OS X (Darwin) is odd since the max I/O size does not match the types.
+ */
+#if defined(H5_HAVE_WIN32_API)
+#define h5_posix_io_t unsigned int
+#define h5_posix_io_ret_t int
+#define H5_POSIX_MAX_IO_BYTES INT_MAX
+#elif defined(H5_HAVE_DARWIN)
+#define h5_posix_io_t size_t
+#define h5_posix_io_ret_t ssize_t
+#define H5_POSIX_MAX_IO_BYTES INT_MAX
+#else
+#define h5_posix_io_t size_t
+#define h5_posix_io_ret_t ssize_t
+#define H5_POSIX_MAX_IO_BYTES SSIZE_MAX
+#endif
+
+/* POSIX I/O mode used as the third parameter to open/_open
+ * when creating a new file (O_CREAT is set).
+ */
+#if defined(H5_HAVE_WIN32_API)
+#define H5_POSIX_CREATE_MODE_RW (_S_IREAD | _S_IWRITE)
+#else
+#define H5_POSIX_CREATE_MODE_RW 0666
+#endif
+
+/* Represents an empty asynchronous request handle.
+ * Used in the VOL code.
+ */
+#define H5_REQUEST_NULL NULL
+
+/* clang-format off */
+/* Address-related macros */
+#define H5_addr_overflow(X,Z) (HADDR_UNDEF == (X) || \
+ HADDR_UNDEF == (X) + (haddr_t)(Z) || \
+ (X) + (haddr_t)(Z) < (X))
+#define H5_addr_defined(X) ((X) != HADDR_UNDEF)
+/* The H5_addr_eq() macro guarantees that Y is not HADDR_UNDEF by making
+ * certain that X is not HADDR_UNDEF and then checking that X equals Y
+ */
+#define H5_addr_eq(X,Y) ((X) != HADDR_UNDEF && (X) == (Y))
+#define H5_addr_ne(X,Y) (!H5_addr_eq((X),(Y)))
+#define H5_addr_lt(X,Y) ((X) != HADDR_UNDEF && \
+ (Y) != HADDR_UNDEF && \
+ (X) < (Y))
+#define H5_addr_le(X,Y) ((X) != HADDR_UNDEF && \
+ (Y) != HADDR_UNDEF && \
+ (X) <= (Y))
+#define H5_addr_gt(X,Y) ((X) != HADDR_UNDEF && \
+ (Y) != HADDR_UNDEF && \
+ (X) > (Y))
+#define H5_addr_ge(X,Y) ((X) != HADDR_UNDEF && \
+ (Y) != HADDR_UNDEF && \
+ (X) >= (Y))
+#define H5_addr_cmp(X,Y) (H5_addr_eq((X), (Y)) ? 0 : \
+ (H5_addr_lt((X), (Y)) ? -1 : 1))
+#define H5_addr_overlap(O1,L1,O2,L2) H5_RANGE_OVERLAP(O1, ((O1)+(L1)-1), O2, ((O2)+(L2)-1))
+/* clang-format on */
+
+/*
+ * Methods to compare the equality of floating-point values:
+ *
+ * 1. H5_XXX_ABS_EQUAL - check if the difference is smaller than the
+ * Epsilon value. The Epsilon values, FLT_EPSILON, DBL_EPSILON,
+ * and LDBL_EPSILON, are defined by compiler in float.h.
+ *
+ * 2. H5_XXX_REL_EQUAL - check if the relative difference is smaller than a
+ * predefined value M. See if two values are relatively equal.
+ * It's the developer's responsibility not to pass in the value 0, which
+ * may cause the equation to fail.
+ */
+#define H5_FLT_ABS_EQUAL(X, Y) (fabsf((X) - (Y)) < FLT_EPSILON)
+#define H5_DBL_ABS_EQUAL(X, Y) (fabs((X) - (Y)) < DBL_EPSILON)
+#define H5_LDBL_ABS_EQUAL(X, Y) (fabsl((X) - (Y)) < LDBL_EPSILON)
+
+#ifdef H5_HAVE__FLOAT16
+#ifdef H5_HAVE_FABSF16
+#define H5_FLT16_ABS_EQUAL(X, Y) (fabsf16((X) - (Y)) < FLT16_EPSILON)
+#else
+#define H5_FLT16_ABS_EQUAL(X, Y) H5_FLT_ABS_EQUAL((float)X, (float)Y)
+#endif
+#endif
+
+#define H5_FLT_REL_EQUAL(X, Y, M) (fabsf(((Y) - (X)) / (X)) < (M))
+#define H5_DBL_REL_EQUAL(X, Y, M) (fabs(((Y) - (X)) / (X)) < (M))
+#define H5_LDBL_REL_EQUAL(X, Y, M) (fabsl(((Y) - (X)) / (X)) < (M))
+
+#ifdef H5_HAVE__FLOAT16
+#ifdef H5_HAVE_FABSF16
+#define H5_FLT16_REL_EQUAL(X, Y, M) (fabsf16(((Y) - (X)) / (X)) < (M))
+#else
+#define H5_FLT16_REL_EQUAL(X, Y, M) H5_FLT_REL_EQUAL((float)X, (float)Y, M)
+#endif
+#endif
+
+/* KiB, MiB, GiB, TiB, PiB, EiB - Used in profiling and timing code */
+#define H5_KB (1024.0F)
+#define H5_MB (1024.0F * 1024.0F)
+#define H5_GB (1024.0F * 1024.0F * 1024.0F)
+#define H5_TB (1024.0F * 1024.0F * 1024.0F * 1024.0F)
+#define H5_PB (1024.0F * 1024.0F * 1024.0F * 1024.0F * 1024.0F)
+#define H5_EB (1024.0F * 1024.0F * 1024.0F * 1024.0F * 1024.0F * 1024.0F)
+
+#ifndef H5_HAVE_FLOCK
+/* flock() operations. Used in the source so we have to define them when
+ * the call is not available (e.g.: Windows). These should NOT be used
+ * with system-provided flock() calls since the values will come from the
+ * header file.
+ */
+#define LOCK_SH 0x01
+#define LOCK_EX 0x02
+#define LOCK_NB 0x04
+#define LOCK_UN 0x08
+#endif /* H5_HAVE_FLOCK */
+
+/* Macros for enabling/disabling particular GCC / clang warnings
+ *
+ * These are duplicated in H5FDmulti.c (we don't want to put them in the
+ * public header and the multi VFD can't use private headers). If you make
+ * changes here, be sure to update those as well.
+ *
+ * (see the following web-sites for more info:
+ * http://www.dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
+ * http://gcc.gnu.org/onlinedocs/gcc/Diagnostic-Pragmas.html#Diagnostic-Pragmas
+ */
+#define H5_DIAG_JOINSTR(x, y) x y
+#define H5_DIAG_DO_PRAGMA(x) _Pragma(#x)
+#define H5_DIAG_PRAGMA(x) H5_DIAG_DO_PRAGMA(GCC diagnostic x)
+
+/* Allow suppression of compiler diagnostics unless H5_SHOW_ALL_WARNINGS is
+ * defined (enabled with '--enable-show-all-warnings' configure option).
+ */
+#ifndef H5_SHOW_ALL_WARNINGS
+#define H5_DIAG_OFF(x) H5_DIAG_PRAGMA(push) H5_DIAG_PRAGMA(ignored H5_DIAG_JOINSTR("-W", x))
+#define H5_DIAG_ON(x) H5_DIAG_PRAGMA(pop)
+#else
+#define H5_DIAG_OFF(x)
+#define H5_DIAG_ON(x)
+#endif
+
+/* Macros for enabling/disabling particular GCC-only warnings.
+ * These pragmas are only implemented usefully in gcc 4.6+
+ */
+#if (((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
+#define H5_GCC_DIAG_OFF(x) H5_DIAG_OFF(x)
+#define H5_GCC_DIAG_ON(x) H5_DIAG_ON(x)
+#else
+#define H5_GCC_DIAG_OFF(x)
+#define H5_GCC_DIAG_ON(x)
+#endif
+
+/* Macros for enabling/disabling particular clang-only warnings.
+ */
+#if defined(__clang__)
+#define H5_CLANG_DIAG_OFF(x) H5_DIAG_OFF(x)
+#define H5_CLANG_DIAG_ON(x) H5_DIAG_ON(x)
+#else
+#define H5_CLANG_DIAG_OFF(x)
+#define H5_CLANG_DIAG_ON(x)
+#endif
+
+/* Macros for enabling/disabling particular GCC / clang warnings.
+ * These macros should be used for warnings supported by both gcc and clang.
+ */
+#if (((__GNUC__ * 100) + __GNUC_MINOR__) >= 406) || defined(__clang__)
+#define H5_GCC_CLANG_DIAG_OFF(x) H5_DIAG_OFF(x)
+#define H5_GCC_CLANG_DIAG_ON(x) H5_DIAG_ON(x)
+#else
+#define H5_GCC_CLANG_DIAG_OFF(x)
+#define H5_GCC_CLANG_DIAG_ON(x)
+#endif
+
+/* If necessary, create a typedef for library usage of the
+ * _Float16 type to avoid issues when compiling the library
+ * with the -pedantic flag or similar where we get warnings
+ * about _Float16 not being an ISO C type.
+ *
+ * Due to the inclusion of H5private.h from the C++ wrappers,
+ * this typedef creation must be avoided when __cplusplus is
+ * defined to avoid build failures on ARM64 Macs. GCC and
+ * Clang either do not currently provide a _Float16 type for
+ * C++ on ARM64, or may need an additional compile-time flag.
+ */
+#if defined(H5_HAVE__FLOAT16) && !defined(__cplusplus)
+#if defined(__GNUC__)
+__extension__ typedef _Float16 H5__Float16;
+#else
+typedef _Float16 H5__Float16;
+#endif
+#endif
+
+/* Function pointer typedef for qsort */
+typedef int (*H5_sort_func_cb_t)(const void *, const void *);
+
+/* Typedefs and functions for timing certain parts of the library. */
+
+/* A set of elapsed/user/system times emitted as a time point by the
+ * platform-independent timers.
+ */
+typedef struct {
+ double user; /* User time in seconds */
+ double system; /* System time in seconds */
+ double elapsed; /* Elapsed (wall clock) time in seconds */
+} H5_timevals_t;
+
+/* Timer structure for platform-independent timers */
+typedef struct {
+ H5_timevals_t initial; /* Current interval start time */
+ H5_timevals_t final_interval; /* Last interval elapsed time */
+ H5_timevals_t total; /* Total elapsed time for all intervals */
+ bool is_running; /* Whether timer is running */
+} H5_timer_t;
+
+/* Returns library bandwidth as a pretty string */
+H5_DLL void H5_bandwidth(char *buf /*out*/, size_t bufsize, double nbytes, double nseconds);
+
+/* Timer functionality */
+H5_DLL time_t H5_now(void);
+H5_DLL uint64_t H5_now_usec(void);
+H5_DLL herr_t H5_timer_init(H5_timer_t *timer /*in,out*/);
+H5_DLL herr_t H5_timer_start(H5_timer_t *timer /*in,out*/);
+H5_DLL herr_t H5_timer_stop(H5_timer_t *timer /*in,out*/);
+H5_DLL herr_t H5_timer_get_times(H5_timer_t timer, H5_timevals_t *times /*in,out*/);
+H5_DLL herr_t H5_timer_get_total_times(H5_timer_t timer, H5_timevals_t *times /*in,out*/);
+H5_DLL char *H5_timer_get_time_string(double seconds);
+H5_DLL char *H5_strcasestr(const char *haystack, const char *needle);
+
+/* Depth of object copy */
+typedef enum {
+ H5_COPY_SHALLOW, /* Shallow copy from source to destination, just copy field pointers */
+ H5_COPY_DEEP /* Deep copy from source to destination, including duplicating fields pointed to */
+} H5_copy_depth_t;
+
+/* Common object copying udata (right now only used for groups and datasets) */
+typedef struct H5O_copy_file_ud_common_t {
+ struct H5O_pline_t *src_pline; /* Copy of filter pipeline for object */
+} H5O_copy_file_ud_common_t;
+
+/* Unique object "position" */
+typedef struct {
+ unsigned long fileno; /* The unique identifier for the file of the object */
+ haddr_t addr; /* The unique address of the object's header in that file */
+} H5_obj_t;
+
+#define H5_SIZEOF_H5_STAT_SIZE_T H5_SIZEOF_OFF_T
+
+/* Put all Windows-specific definitions in H5win32defs.h so we
+ * can (mostly) assume a POSIX platform. Not all of the POSIX calls
+ * will have a Windows equivalent so some #ifdef protection is still
+ * necessary (e.g., fork()).
+ */
+
+/* Platform-independent definitions for struct stat and off_t */
+#ifndef H5_HAVE_WIN32_API
+/* These definitions differ in Windows and are defined in
+ * H5win32defs for that platform.
+ */
+typedef struct stat h5_stat_t;
+typedef off_t h5_stat_size_t;
+#define HDoff_t off_t
+#endif
+
+/* Redefinions of some POSIX and C functions (mainly to deal with Windows) */
+
+#ifndef HDaccess
+#define HDaccess(F, M) access(F, M)
+#endif
+#ifndef HDchdir
+#define HDchdir(S) chdir(S)
+#endif
+#ifndef HDclose
+#define HDclose(F) close(F)
+#endif
+#ifndef HDclosedir
+#define HDclosedir(D) closedir(D)
+#endif
+#ifndef HDcreat
+#define HDcreat(S, M) creat(S, M)
+#endif
+#ifndef HDfdopen
+#define HDfdopen(N, S) fdopen(N, S)
+#endif
+#ifndef HDfileno
+#define HDfileno(F) fileno(F)
+#endif
+
+/* Since flock is so prevalent, always build these functions
+ * when possible to avoid them becoming dead code.
+ */
+#ifdef H5_HAVE_FCNTL
+H5_DLL int Pflock(int fd, int operation);
+#endif
+H5_DLL H5_ATTR_CONST int Nflock(int fd, int operation);
+
+#ifndef HDflock
+/* NOTE: flock(2) is not present on all POSIX systems.
+ * If it is not present, we try a flock() equivalent based on
+ * fcntl(2), then fall back to a function that always succeeds
+ * if it is not present at all (Windows uses a separate Wflock()
+ * function).
+ */
+#if defined(H5_HAVE_FLOCK)
+#define HDflock(F, L) flock(F, L)
+#elif defined(H5_HAVE_FCNTL)
+#define HDflock(F, L) Pflock(F, L)
+#else
+#define HDflock(F, L) Nflock(F, L)
+#endif
+
+#endif /* HDflock */
+
+#ifndef HDfseek
+#define HDfseek(F, O, W) fseeko(F, O, W)
+#endif
+#ifndef HDfstat
+#define HDfstat(F, B) fstat(F, B)
+#endif
+#ifndef HDftell
+#define HDftell(F) ftell(F)
+#endif
+#ifndef HDftruncate
+#define HDftruncate(F, L) ftruncate(F, L)
+#endif
+#ifndef HDgetcwd
+#define HDgetcwd(S, Z) getcwd(S, Z)
+#endif
+#ifndef HDgetdcwd
+#define HDgetdcwd(D, S, Z) getcwd(S, Z)
+#endif
+
+/* Windows only - set to zero on other systems */
+#ifndef HDgetdrive
+#define HDgetdrive() 0
+#endif
+
+#ifndef HDgetpid
+#define HDgetpid() getpid()
+#endif
+#ifndef HDgettimeofday
+#define HDgettimeofday(S, P) gettimeofday(S, P)
+#endif
+#ifndef HDisatty
+#define HDisatty(F) isatty(F)
+#endif
+#ifndef HDlseek
+#define HDlseek(F, O, W) lseek(F, O, W)
+#endif
+#ifndef HDlstat
+#define HDlstat(S, B) lstat(S, B)
+#endif
+#ifndef HDmkdir
+#define HDmkdir(S, M) mkdir(S, M)
+#endif
+#ifndef HDnanosleep
+#define HDnanosleep(N, O) nanosleep(N, O)
+#endif
+#ifndef HDopen
+#define HDopen(F, ...) open(F, __VA_ARGS__)
+#endif
+#ifndef HDopendir
+#define HDopendir(S) opendir(S)
+#endif
+#ifndef HDpread
+#define HDpread(F, B, C, O) pread(F, B, C, O)
+#endif
+#ifndef HDpwrite
+#define HDpwrite(F, B, C, O) pwrite(F, B, C, O)
+#endif
+
+/* clang-format off */
+#ifdef H5_HAVE_RAND_R
+# ifndef HDrandom
+# define HDrandom() HDrand()
+# endif
+ H5_DLL int HDrand(void);
+# ifndef HDsrandom
+# define HDsrandom(S) HDsrand(S)
+# endif
+ H5_DLL void HDsrand(unsigned int seed);
+#elif defined(H5_HAVE_RANDOM)
+# ifndef HDrand
+# define HDrand() random()
+# endif
+# ifndef HDrandom
+# define HDrandom() random()
+# endif
+# ifndef HDsrand
+# define HDsrand(S) srandom(S)
+# endif
+# ifndef HDsrandom
+# define HDsrandom(S) srandom(S)
+# endif
+#else
+# ifndef HDrand
+# define HDrand() rand()
+# endif
+# ifndef HDrandom
+# define HDrandom() rand()
+# endif
+# ifndef HDsrand
+# define HDsrand(S) srand(S)
+# endif
+# ifndef HDsrandom
+# define HDsrandom(S) srand(S)
+# endif
+#endif
+/* clang-format on */
+
+#ifndef HDread
+#define HDread(F, M, Z) read(F, M, Z)
+#endif
+#ifndef HDreaddir
+#define HDreaddir(D) readdir(D)
+#endif
+#ifndef HDrealpath
+#define HDrealpath(F1, F2) realpath(F1, F2)
+#endif
+#ifndef HDremove
+#define HDremove(S) remove(S)
+#endif
+#ifndef HDrmdir
+#define HDrmdir(S) rmdir(S)
+#endif
+#ifndef HDsetenv
+#define HDsetenv(N, V, O) setenv(N, V, O)
+#endif
+#ifndef HDsetvbuf
+#define HDsetvbuf(F, S, M, Z) setvbuf(F, S, M, Z)
+#endif
+#ifndef HDshutdown
+#define HDshutdown(A, B) shutdown((A), (B))
+#endif
+#ifndef HDsigaction
+#define HDsigaction(S, A, O) sigaction((S), (A), (O))
+#endif
+#ifndef HDsigemptyset
+#define HDsigemptyset(S) sigemptyset(S)
+#endif
+#ifndef HDsleep
+#define HDsleep(N) sleep(N)
+#endif
+#ifndef HDstat
+#define HDstat(S, B) stat(S, B)
+#endif
+#ifndef HDstrcasestr
+#if defined(H5_HAVE_STRCASESTR)
+#define HDstrcasestr(X, Y) strcasestr(X, Y)
+#else
+#define HDstrcasestr(X, Y) H5_strcasestr(X, Y)
+#endif
+#endif
+#ifndef HDstrcasecmp
+#define HDstrcasecmp(X, Y) strcasecmp(X, Y)
+#endif
+#ifndef HDstrndup
+#define HDstrndup(S, N) strndup(S, N)
+#endif
+#ifndef HDstrtok_r
+#define HDstrtok_r(X, Y, Z) strtok_r(X, Y, Z)
+#endif
+#ifndef HDunlink
+#define HDunlink(S) unlink(S)
+#endif
+#ifndef HDunsetenv
+#define HDunsetenv(S) unsetenv(S)
+#endif
+
+#ifndef HDvasprintf
+#ifdef H5_HAVE_VASPRINTF
+#define HDvasprintf(RET, FMT, A) vasprintf(RET, FMT, A)
+#else
+H5_DLL int HDvasprintf(char **bufp, const char *fmt, va_list _ap);
+#endif
+#endif
+
+#ifndef HDwrite
+#define HDwrite(F, M, Z) write(F, M, Z)
+#endif
+
+/* Macro for "stringizing" an integer in the C preprocessor (use H5_TOSTRING) */
+/* (use H5_TOSTRING, H5_STRINGIZE is just part of the implementation) */
+#define H5_STRINGIZE(x) #x
+#define H5_TOSTRING(x) H5_STRINGIZE(x)
+
+/* Macro for "gluing" together items, for re-scanning macros */
+#define H5_GLUE(x, y) x##y
+#define H5_GLUE3(x, y, z) x##y##z
+#define H5_GLUE4(w, x, y, z) w##x##y##z
+
+/*
+ * A macro for detecting over/under-flow when casting between types
+ */
+#ifndef NDEBUG
+#define H5_CHECK_OVERFLOW(var, vartype, casttype) \
+ do { \
+ casttype _tmp_overflow = (casttype)(var); \
+ assert((var) == (vartype)_tmp_overflow); \
+ } while (0)
+#else /* NDEBUG */
+#define H5_CHECK_OVERFLOW(var, vartype, casttype)
+#endif /* NDEBUG */
+
+/*
+ * A macro for detecting over/under-flow when assigning between types
+ */
+#ifndef NDEBUG
+#define ASSIGN_TO_SMALLER_SIZE(dst, dsttype, src, srctype) \
+ { \
+ srctype _tmp_src = (srctype)(src); \
+ dsttype _tmp_dst = (dsttype)(_tmp_src); \
+ assert(_tmp_src == (srctype)_tmp_dst); \
+ (dst) = _tmp_dst; \
+ }
+
+#define ASSIGN_TO_LARGER_SIZE_SAME_SIGNED(dst, dsttype, src, srctype) (dst) = (dsttype)(src);
+
+#define ASSIGN_TO_LARGER_SIZE_SIGNED_TO_UNSIGNED(dst, dsttype, src, srctype) \
+ { \
+ srctype _tmp_src = (srctype)(src); \
+ dsttype _tmp_dst = (dsttype)(_tmp_src); \
+ assert(_tmp_src >= 0); \
+ assert(_tmp_src == (srctype)_tmp_dst); \
+ (dst) = _tmp_dst; \
+ }
+
+#define ASSIGN_TO_LARGER_SIZE_UNSIGNED_TO_SIGNED(dst, dsttype, src, srctype) (dst) = (dsttype)(src);
+
+#define ASSIGN_TO_SAME_SIZE_UNSIGNED_TO_SIGNED(dst, dsttype, src, srctype) \
+ { \
+ srctype _tmp_src = (srctype)(src); \
+ dsttype _tmp_dst = (dsttype)(_tmp_src); \
+ assert(_tmp_dst >= 0); \
+ assert(_tmp_src == (srctype)_tmp_dst); \
+ (dst) = _tmp_dst; \
+ }
+
+#define ASSIGN_TO_SAME_SIZE_SIGNED_TO_UNSIGNED(dst, dsttype, src, srctype) \
+ { \
+ srctype _tmp_src = (srctype)(src); \
+ dsttype _tmp_dst = (dsttype)(_tmp_src); \
+ assert(_tmp_src >= 0); \
+ assert(_tmp_src == (srctype)_tmp_dst); \
+ (dst) = _tmp_dst; \
+ }
+
+#define ASSIGN_TO_SAME_SIZE_SAME_SIGNED(dst, dsttype, src, srctype) (dst) = (dsttype)(src);
+
+/* Include the generated overflow header file */
+#include "H5overflow.h"
+
+/* Assign a variable to one of a different size (think safer dst = (dsttype)src").
+ * The code generated by the macro checks for overflows.
+ *
+ * Use w##x##y##z instead of H5_GLUE4(w, x, y, z) because srctype
+ * or dsttype on some systems (e.g., NetBSD 8 and earlier) may
+ * supply some standard types using a macro---e.g.,
+ * #define uint8_t __uint8_t. The preprocessor will expand the
+ * macros before it evaluates H5_GLUE4(), and that will generate
+ * an unexpected name such as ASSIGN___uint8_t_TO___uint16_t.
+ * The preprocessor does not expand macros in w##x##y##z, so
+ * that will always generate the expected name.
+ */
+#define H5_CHECKED_ASSIGN(dst, dsttype, src, srctype) \
+ do { \
+ ASSIGN_##srctype##_TO_##dsttype(dst, dsttype, src, srctype) \
+ } while (0)
+
+#else /* NDEBUG */
+#define H5_CHECKED_ASSIGN(dst, dsttype, src, srctype) \
+ do { \
+ (dst) = (dsttype)(src); \
+ } while (0)
+#endif /* NDEBUG */
+
+#if defined(H5_HAVE_WINDOW_PATH)
+
+/* directory delimiter for Windows: slash and backslash are acceptable on Windows */
+#define H5_DIR_SLASH_SEPC '/'
+#define H5_DIR_SEPC '\\'
+#define H5_DIR_SEPS "\\"
+#define H5_CHECK_DELIMITER(SS) ((SS == H5_DIR_SEPC) || (SS == H5_DIR_SLASH_SEPC))
+#define H5_CHECK_ABSOLUTE(NAME) ((isalpha(NAME[0])) && (NAME[1] == ':') && (H5_CHECK_DELIMITER(NAME[2])))
+#define H5_CHECK_ABS_DRIVE(NAME) ((isalpha(NAME[0])) && (NAME[1] == ':'))
+#define H5_CHECK_ABS_PATH(NAME) (H5_CHECK_DELIMITER(NAME[0]))
+
+#define H5_GET_LAST_DELIMITER(NAME, ptr) \
+ { \
+ char *slash, *backslash; \
+ \
+ slash = strrchr(NAME, H5_DIR_SLASH_SEPC); \
+ backslash = strrchr(NAME, H5_DIR_SEPC); \
+ if (backslash > slash) \
+ (ptr = backslash); \
+ else \
+ (ptr = slash); \
+ }
+
+#else /* H5_HAVE_WINDOW_PATH */
+
+#define H5_DIR_SEPC '/'
+#define H5_DIR_SEPS "/"
+#define H5_CHECK_DELIMITER(SS) (SS == H5_DIR_SEPC)
+#define H5_CHECK_ABSOLUTE(NAME) (H5_CHECK_DELIMITER(*NAME))
+#define H5_CHECK_ABS_DRIVE(NAME) (0)
+#define H5_CHECK_ABS_PATH(NAME) (0)
+#define H5_GET_LAST_DELIMITER(NAME, ptr) ptr = strrchr(NAME, H5_DIR_SEPC);
+
+#endif /* H5_HAVE_WINDOW_PATH */
+
+#define H5_COLON_SEPC ':'
+
+/*
+ * These macros check whether debugging has been requested for a certain
+ * package at run-time. Code for debugging is conditionally compiled by
+ * defining constants like `H5X_DEBUG'. In order to see the output though
+ * the code must be enabled at run-time with an environment variable
+ * HDF5_DEBUG which is a list of packages to debug.
+ *
+ * Note: If you add/remove items from this enum then be sure to update the
+ * information about the package in H5_init_library().
+ */
+typedef enum {
+ H5_PKG_A, /* Attributes */
+ H5_PKG_AC, /* Metadata cache */
+ H5_PKG_B, /* B-trees */
+ H5_PKG_D, /* Datasets */
+ H5_PKG_E, /* Error handling */
+ H5_PKG_F, /* Files */
+ H5_PKG_G, /* Groups */
+ H5_PKG_HG, /* Global heaps */
+ H5_PKG_HL, /* Local heaps */
+ H5_PKG_I, /* IDs */
+ H5_PKG_M, /* Maps */
+ H5_PKG_MF, /* File memory management */
+ H5_PKG_MM, /* Core memory management */
+ H5_PKG_O, /* Object headers */
+ H5_PKG_P, /* Property lists */
+ H5_PKG_S, /* Dataspaces */
+ H5_PKG_T, /* Datatypes */
+ H5_PKG_V, /* Vector functions */
+ H5_PKG_VL, /* VOL functions */
+ H5_PKG_Z, /* Raw data filters */
+ H5_NPKGS /* Must be last */
+} H5_pkg_t;
+
+typedef struct H5_debug_open_stream_t {
+ FILE *stream; /* Open output stream */
+ struct H5_debug_open_stream_t *next; /* Next open output stream */
+} H5_debug_open_stream_t;
+
+typedef struct H5_debug_t {
+ FILE *trace; /*API trace output stream */
+ bool ttop; /*Show only top-level calls? */
+ bool ttimes; /*Show trace event times? */
+ struct {
+ const char *name; /*package name */
+ FILE *stream; /*output stream or NULL */
+ } pkg[H5_NPKGS];
+ H5_debug_open_stream_t *open_stream; /* Stack of open output streams */
+} H5_debug_t;
+
+#ifdef H5_HAVE_PARALLEL
+
+/*
+ * Check that the MPI library version is at least version
+ * `mpi_version` and subversion `mpi_subversion`
+ */
+#define H5_CHECK_MPI_VERSION(mpi_version, mpi_subversion) \
+ ((MPI_VERSION > (mpi_version)) || \
+ ((MPI_VERSION == (mpi_version)) && (MPI_SUBVERSION >= (mpi_subversion))))
+
+extern bool H5_coll_api_sanity_check_g;
+#endif /* H5_HAVE_PARALLEL */
+
+extern H5_debug_t H5_debug_g;
+#define H5DEBUG(X) (H5_debug_g.pkg[H5_PKG_##X].stream)
+
+/* Embedded build information */
+extern const char H5build_settings[];
+
+/*-------------------------------------------------------------------------
+ * Purpose: These macros are used to track arguments in event sets and are
+ * inserted automatically into H5ES_insert() by the bin/trace script
+ *
+ * Arguments: C - Caller
+ * T - Argument types encoded as a string
+ * A0-An - Arguments. The number at the end of the macro name
+ * indicates the number of arguments.
+ *
+ *-------------------------------------------------------------------------
+ */
+#define H5ARG_TRACE0(C, T) C, T
+#define H5ARG_TRACE1(C, T, A0) C, T, #A0, A0
+#define H5ARG_TRACE2(C, T, A0, A1) C, T, #A0, A0, #A1, A1
+#define H5ARG_TRACE3(C, T, A0, A1, A2) C, T, #A0, A0, #A1, A1, #A2, A2
+#define H5ARG_TRACE4(C, T, A0, A1, A2, A3) C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3
+#define H5ARG_TRACE5(C, T, A0, A1, A2, A3, A4) C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4
+#define H5ARG_TRACE6(C, T, A0, A1, A2, A3, A4, A5) C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5
+#define H5ARG_TRACE7(C, T, A0, A1, A2, A3, A4, A5, A6) \
+ C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5, #A6, A6
+#define H5ARG_TRACE8(C, T, A0, A1, A2, A3, A4, A5, A6, A7) \
+ C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5, #A6, A6, #A7, A7
+#define H5ARG_TRACE9(C, T, A0, A1, A2, A3, A4, A5, A6, A7, A8) \
+ C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5, #A6, A6, #A7, A7, #A8, A8
+#define H5ARG_TRACE10(C, T, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) \
+ C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5, #A6, A6, #A7, A7, #A8, A8, #A9, A9
+#define H5ARG_TRACE11(C, T, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) \
+ C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5, #A6, A6, #A7, A7, #A8, A8, #A9, A9, #A10, A10
+#define H5ARG_TRACE12(C, T, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) \
+ C, T, #A0, A0, #A1, A1, #A2, A2, #A3, A3, #A4, A4, #A5, A5, #A6, A6, #A7, A7, #A8, A8, #A9, A9, #A10, \
+ A10, #A11, A11
+
+struct H5RS_str_t;
+H5_DLL double H5_trace(const double *calltime, const char *func, const char *type, ...);
+H5_DLL herr_t H5_trace_args(struct H5RS_str_t *rs, const char *type, va_list ap);
+
+/*-------------------------------------------------------------------------
+ * Purpose: Register function entry for library initialization and code
+ * profiling.
+ *
+ * Notes: Every file must have a file-scope variable called
+ * `initialize_interface_g' of type bool which is initialized
+ * to false.
+ *
+ * Don't use local variable initializers which contain
+ * calls to other library functions since the initializer
+ * would happen before the FUNC_ENTER() gets called. Don't
+ * use initializers that require special cleanup code to
+ * execute if FUNC_ENTER() fails since a failing FUNC_ENTER()
+ * returns immediately without branching to the `done' label.
+ *-------------------------------------------------------------------------
+ */
+
+/* `S' is the name of a function which is being tested to check if it's
+ * an API function.
+ *
+ * BADNESS:
+ * - Underscore at positions 2 or 3 (0-indexed string). Handles
+ * H5_ and H5X_.
+ * - Underscore at position 4 if position 3 is uppercase or a digit.
+ * Handles H5XY_.
+ */
+#define H5_IS_API(S) \
+ ('_' != ((const char *)S)[2] /* underscore at position 2 */ \
+ && '_' != ((const char *)S)[3] /* underscore at position 3 */ \
+ && !( /* NOT */ \
+ ((const char *)S)[4] /* pos 4 exists */ \
+ && (isupper((int)S[3]) || isdigit((int)S[3])) /* pos 3 dig | uc */ \
+ && '_' == ((const char *)S)[4] /* pos 4 underscore */ \
+ ))
+
+/* `S' is the name of a function which is being tested to check if it's */
+/* a public API function */
+#define H5_IS_PUB(S) \
+ (((isdigit((int)S[1]) || isupper((int)S[1])) && islower((int)S[2])) || \
+ ((isdigit((int)S[2]) || isupper((int)S[2])) && islower((int)S[3])) || \
+ (!S[4] || ((isdigit((int)S[3]) || isupper((int)S[3])) && islower((int)S[4]))))
+
+/* `S' is the name of a function which is being tested to check if it's */
+/* a private library function */
+#define H5_IS_PRIV(S) \
+ (((isdigit((int)S[1]) || isupper((int)S[1])) && '_' == S[2] && islower((int)S[3])) || \
+ ((isdigit((int)S[2]) || isupper((int)S[2])) && '_' == S[3] && islower((int)S[4])) || \
+ ((isdigit((int)S[3]) || isupper((int)S[3])) && '_' == S[4] && islower((int)S[5])))
+
+/* `S' is the name of a function which is being tested to check if it's */
+/* a package private function */
+#define H5_IS_PKG(S) \
+ (((isdigit((int)S[1]) || isupper((int)S[1])) && '_' == S[2] && '_' == S[3] && islower((int)S[4])) || \
+ ((isdigit((int)S[2]) || isupper((int)S[2])) && '_' == S[3] && '_' == S[4] && islower((int)S[5])) || \
+ ((isdigit((int)S[3]) || isupper((int)S[3])) && '_' == S[4] && '_' == S[5] && islower((int)S[6])))
+
+/* global library version information string */
+extern char H5_lib_vers_info_g[];
+
+#include "H5TSprivate.h"
+
+/* Lock headers */
+#ifdef H5_HAVE_THREADSAFE
+
+/* replacement structure for original global variable */
+typedef struct H5_api_struct {
+ H5TS_mutex_t init_lock; /* API entrance mutex */
+ bool H5_libinit_g; /* Has the library been initialized? */
+ bool H5_libterm_g; /* Is the library being shutdown? */
+} H5_api_t;
+
+/* Macros for accessing the global variables */
+#define H5_INIT_GLOBAL (H5_g.H5_libinit_g)
+#define H5_TERM_GLOBAL (H5_g.H5_libterm_g)
+
+/* Macro for first thread initialization */
+#ifdef H5_HAVE_WIN_THREADS
+#define H5_FIRST_THREAD_INIT InitOnceExecuteOnce(&H5TS_first_init_g, H5TS_win32_process_enter, NULL, NULL);
+#else
+#define H5_FIRST_THREAD_INIT pthread_once(&H5TS_first_init_g, H5TS_pthread_first_thread_init);
+#endif
+
+/* Macros for threadsafe HDF5 Phase I locks */
+#define H5_API_LOCK H5TS_mutex_lock(&H5_g.init_lock);
+#define H5_API_UNLOCK H5TS_mutex_unlock(&H5_g.init_lock);
+
+/* Macros for thread cancellation-safe mechanism */
+#define H5_API_UNSET_CANCEL H5TS_cancel_count_inc();
+
+#define H5_API_SET_CANCEL H5TS_cancel_count_dec();
+
+extern H5_api_t H5_g;
+
+#else /* H5_HAVE_THREADSAFE */
+
+/* disable any first thread init mechanism */
+#define H5_FIRST_THREAD_INIT
+
+/* disable locks (sequential version) */
+#define H5_API_LOCK
+#define H5_API_UNLOCK
+
+/* disable cancellability (sequential version) */
+#define H5_API_UNSET_CANCEL
+#define H5_API_SET_CANCEL
+
+/* extern global variables */
+extern bool H5_libinit_g; /* Has the library been initialized? */
+extern bool H5_libterm_g; /* Is the library being shutdown? */
+
+/* Macros for accessing the global variables */
+#define H5_INIT_GLOBAL (H5_libinit_g)
+#define H5_TERM_GLOBAL (H5_libterm_g)
+
+#endif /* H5_HAVE_THREADSAFE */
+
+/* Forward declaration of H5CXpush() / H5CXpop() */
+/* (Including H5CXprivate.h creates bad circular dependencies - QAK, 3/18/2018) */
+H5_DLL herr_t H5CX_push(void);
+H5_DLL herr_t H5CX_pop(bool update_dxpl_props);
+
+#ifndef NDEBUG
+#define FUNC_ENTER_CHECK_NAME(asrt) \
+ { \
+ static bool func_check = false; \
+ \
+ if (H5_UNLIKELY(!func_check)) { \
+ /* Check function naming status */ \
+ assert(asrt && \
+ "Function naming conventions are incorrect - check H5_IS_API|PUB|PRIV|PKG macros in " \
+ "H5private.h (this is usually due to an incorrect number of underscores)"); \
+ \
+ /* Don't check again */ \
+ func_check = true; \
+ } /* end if */ \
+ } /* end scope */
+#else /* NDEBUG */
+#define FUNC_ENTER_CHECK_NAME(asrt)
+#endif /* NDEBUG */
+
+#define FUNC_ENTER_COMMON(asrt) \
+ bool err_occurred = false; \
+ \
+ FUNC_ENTER_CHECK_NAME(asrt);
+
+#define FUNC_ENTER_COMMON_NOERR(asrt) FUNC_ENTER_CHECK_NAME(asrt);
+
+/* Threadsafety initialization code for API routines */
+#define FUNC_ENTER_API_THREADSAFE \
+ /* Initialize the thread-safe code */ \
+ H5_FIRST_THREAD_INIT \
+ \
+ /* Grab the mutex for the library */ \
+ H5_API_UNSET_CANCEL \
+ H5_API_LOCK
+
+#define FUNC_ENTER_API_COMMON \
+ FUNC_ENTER_COMMON(H5_IS_API(__func__)); \
+ FUNC_ENTER_API_THREADSAFE;
+
+#define FUNC_ENTER_API_INIT(err) \
+ /* Initialize the library */ \
+ if (H5_UNLIKELY(!H5_INIT_GLOBAL && !H5_TERM_GLOBAL)) { \
+ if (H5_UNLIKELY(H5_init_library() < 0)) \
+ HGOTO_ERROR(H5E_FUNC, H5E_CANTINIT, err, "library initialization failed"); \
+ }
+
+#define FUNC_ENTER_API_PUSH(err) \
+ /* Push the API context */ \
+ if (H5_UNLIKELY(H5CX_push() < 0)) \
+ HGOTO_ERROR(H5E_FUNC, H5E_CANTSET, err, "can't set API context"); \
+ else \
+ api_ctx_pushed = true;
+
+/* Use this macro for all "normal" API functions */
+#define FUNC_ENTER_API(err) \
+ { \
+ { \
+ bool api_ctx_pushed = false; \
+ \
+ FUNC_ENTER_API_COMMON \
+ FUNC_ENTER_API_INIT(err); \
+ FUNC_ENTER_API_PUSH(err); \
+ /* Clear thread error stack entering public functions */ \
+ H5E_clear_stack(); \
+ {
+
+/*
+ * Use this macro for API functions that shouldn't clear the error stack
+ * like H5Eprint and H5Ewalk.
+ */
+#define FUNC_ENTER_API_NOCLEAR(err) \
+ { \
+ { \
+ bool api_ctx_pushed = false; \
+ \
+ FUNC_ENTER_API_COMMON \
+ FUNC_ENTER_API_INIT(err); \
+ FUNC_ENTER_API_PUSH(err); \
+ {
+
+/*
+ * Use this macro for API functions that shouldn't perform _any_ initialization
+ * of the library or an interface, just perform tracing, etc. Examples
+ * are: H5allocate_memory, H5is_library_threadsafe, public VOL callback
+ * wrappers (e.g. H5VLfile_create, H5VLdataset_read, etc.), etc.
+ *
+ */
+#define FUNC_ENTER_API_NOINIT \
+ { \
+ { \
+ { \
+ FUNC_ENTER_API_COMMON \
+ {
+
+/*
+ * Use this macro for API functions that shouldn't perform _any_ initialization
+ * of the library or an interface or push themselves on the function
+ * stack, just perform tracing, etc. Examples
+ * are: H5close, H5check_version, etc.
+ *
+ */
+#define FUNC_ENTER_API_NOINIT_NOERR_NOFS \
+ { \
+ { \
+ { \
+ { \
+ FUNC_ENTER_COMMON_NOERR(H5_IS_API(__func__)); \
+ FUNC_ENTER_API_THREADSAFE; \
+ {
+
+/*
+ * Use this macro for API functions that should only perform initialization
+ * of the library or an interface, but not push any state (API context,
+ * function name, etc.) examples are: H5open.
+ *
+ */
+#define FUNC_ENTER_API_NOPUSH(err) \
+ { \
+ { \
+ { \
+ { \
+ { \
+ FUNC_ENTER_COMMON(H5_IS_API(__func__)); \
+ FUNC_ENTER_API_THREADSAFE; \
+ FUNC_ENTER_API_INIT(err); \
+ {
+
+/*
+ * Use this macro for API functions that shouldn't perform _any_ initialization
+ * of the library or an interface, or push themselves on the function
+ * stack, or perform tracing, etc. This macro _only_ sanity checks the
+ * API name itself. Examples are: H5TSmutex_acquire,
+ *
+ */
+#define FUNC_ENTER_API_NAMECHECK_ONLY \
+ { \
+ { \
+ { \
+ { \
+ { \
+ { \
+ FUNC_ENTER_COMMON_NOERR(H5_IS_API(__func__)); \
+ {
+
+/* Use this macro for all "normal" non-API functions */
+#define FUNC_ENTER_NOAPI(err) \
+ { \
+ FUNC_ENTER_COMMON(!H5_IS_API(__func__)); \
+ {
+
+/* Use this macro for all non-API functions, which propagate errors, but don't issue them */
+#define FUNC_ENTER_NOAPI_NOERR \
+ { \
+ FUNC_ENTER_COMMON_NOERR(!H5_IS_API(__func__)); \
+ {
+
+/*
+ * Use this macro for non-API functions which fall into these categories:
+ * - static functions, since they must be called from a function in the
+ * interface, the library and interface must already be
+ * initialized.
+ * - functions which are called during library shutdown, since we don't
+ * want to re-initialize the library.
+ */
+#define FUNC_ENTER_NOAPI_NOINIT \
+ { \
+ FUNC_ENTER_COMMON(!H5_IS_API(__func__)); \
+ {
+
+/*
+ * Use this macro for non-API functions which fall into these categories:
+ * - static functions, since they must be called from a function in the
+ * interface, the library and interface must already be
+ * initialized.
+ * - functions which are called during library shutdown, since we don't
+ * want to re-initialize the library.
+ * - functions that propagate, but don't issue errors
+ */
+#define FUNC_ENTER_NOAPI_NOINIT_NOERR \
+ { \
+ FUNC_ENTER_COMMON_NOERR(!H5_IS_API(__func__)); \
+ {
+
+/*
+ * Use this macro for non-API functions that shouldn't perform _any_ initialization
+ * of the library or an interface, or push themselves on the function
+ * stack, or perform tracing, etc. This macro _only_ sanity checks the
+ * API name itself. Examples are private routines in the H5TS package.
+ *
+ */
+#define FUNC_ENTER_NOAPI_NAMECHECK_ONLY \
+ { \
+ FUNC_ENTER_COMMON_NOERR(!H5_IS_API(__func__));
+
+/* Use the following two macros as replacements for the FUNC_ENTER_NOAPI
+ * and FUNC_ENTER_NOAPI_NOINIT macros when the function needs to set
+ * up a metadata tag. */
+#define FUNC_ENTER_NOAPI_TAG(tag, err) \
+ { \
+ haddr_t prev_tag = HADDR_UNDEF; \
+ \
+ FUNC_ENTER_COMMON(!H5_IS_API(__func__)); \
+ H5AC_tag(tag, &prev_tag); \
+ {
+
+#define FUNC_ENTER_NOAPI_NOINIT_TAG(tag) \
+ { \
+ haddr_t prev_tag = HADDR_UNDEF; \
+ \
+ FUNC_ENTER_COMMON(!H5_IS_API(__func__)); \
+ H5AC_tag(tag, &prev_tag); \
+ {
+
+/* Use this macro for all "normal" package-level functions */
+#define FUNC_ENTER_PACKAGE \
+ { \
+ FUNC_ENTER_COMMON(H5_IS_PKG(__func__)); \
+ {
+
+/* Use this macro for package-level functions which propagate errors, but don't issue them */
+#define FUNC_ENTER_PACKAGE_NOERR \
+ { \
+ FUNC_ENTER_COMMON_NOERR(H5_IS_PKG(__func__)); \
+ {
+
+/* Use the following macro as replacement for the FUNC_ENTER_PACKAGE
+ * macro when the function needs to set up a metadata tag. */
+#define FUNC_ENTER_PACKAGE_TAG(tag) \
+ { \
+ haddr_t prev_tag = HADDR_UNDEF; \
+ \
+ FUNC_ENTER_COMMON(H5_IS_PKG(__func__)); \
+ H5AC_tag(tag, &prev_tag); \
+ {
+
+/* Use this macro for staticly-scoped functions which propagate errors, but don't issue them */
+/* And that shouldn't push their name on the function stack */
+#define FUNC_ENTER_PACKAGE_NOERR_NOFS \
+ { \
+ FUNC_ENTER_COMMON_NOERR(H5_IS_PKG(__func__)); \
+ {
+
+/*
+ * Use this macro for non-API functions that shouldn't perform _any_ initialization
+ * of the library or an interface, or push themselves on the function
+ * stack, or perform tracing, etc. This macro _only_ sanity checks the
+ * API name itself. Examples are static routines in the H5TS package.
+ *
+ */
+#define FUNC_ENTER_PACKAGE_NAMECHECK_ONLY \
+ { \
+ FUNC_ENTER_COMMON_NOERR(H5_IS_PKG(__func__));
+
+/*-------------------------------------------------------------------------
+ * Purpose: Register function exit for code profiling. This should be
+ * the last statement executed by a function.
+ *-------------------------------------------------------------------------
+ */
+/* Threadsafety termination code for API routines */
+#define FUNC_LEAVE_API_THREADSAFE \
+ H5_API_UNLOCK \
+ H5_API_SET_CANCEL
+
+#define FUNC_LEAVE_API(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ if (H5_LIKELY(api_ctx_pushed)) { \
+ (void)H5CX_pop(true); \
+ api_ctx_pushed = false; \
+ } \
+ if (H5_UNLIKELY(err_occurred)) \
+ (void)H5E_dump_api_stack(); \
+ FUNC_LEAVE_API_THREADSAFE \
+ return (ret_value); \
+ } \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Use this macro to match the FUNC_ENTER_API_NOINIT macro */
+#define FUNC_LEAVE_API_NOINIT(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ if (H5_UNLIKELY(err_occurred)) \
+ (void)H5E_dump_api_stack(); \
+ FUNC_LEAVE_API_THREADSAFE \
+ return (ret_value); \
+ } \
+ } \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Use this macro to match the FUNC_ENTER_API_NOINIT_NOERR_NOFS macro */
+#define FUNC_LEAVE_API_NOFS(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ FUNC_LEAVE_API_THREADSAFE \
+ return (ret_value); \
+ } \
+ } \
+ } \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Use this macro to match the FUNC_ENTER_API_NOPUSH macro */
+#define FUNC_LEAVE_API_NOPUSH(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ if (H5_UNLIKELY(err_occurred)) \
+ (void)H5E_dump_api_stack(); \
+ FUNC_LEAVE_API_THREADSAFE \
+ return (ret_value); \
+ } \
+ } \
+ } \
+ } \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Use this macro to match the FUNC_ENTER_API_NAMECHECK_ONLY macro */
+#define FUNC_LEAVE_API_NAMECHECK_ONLY(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ return (ret_value); \
+ } \
+ } \
+ } \
+ } \
+ } \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+#define FUNC_LEAVE_NOAPI(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ return (ret_value); \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+#define FUNC_LEAVE_NOAPI_VOID \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ return; \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Use these macros to match the FUNC_ENTER_NOAPI_NAMECHECK_ONLY macro */
+#define FUNC_LEAVE_NOAPI_NAMECHECK_ONLY(ret_value) \
+ return (ret_value); \
+ } /*end scope from beginning of FUNC_ENTER*/
+#define FUNC_LEAVE_NOAPI_VOID_NAMECHECK_ONLY \
+ return; \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Use this macro when exiting a function that set up a metadata tag */
+#define FUNC_LEAVE_NOAPI_TAG(ret_value) \
+ ; \
+ } /*end scope from end of FUNC_ENTER*/ \
+ H5AC_tag(prev_tag, NULL); \
+ return (ret_value); \
+ } /*end scope from beginning of FUNC_ENTER*/
+
+/* Macro to begin/end tagging (when FUNC_ENTER_*TAG macros are insufficient).
+ * Make sure to use HGOTO_ERROR_TAG and HGOTO_DONE_TAG between these macros! */
+#define H5_BEGIN_TAG(tag) \
+ { \
+ haddr_t prv_tag = HADDR_UNDEF; \
+ H5AC_tag(tag, &prv_tag);
+
+#define H5_END_TAG \
+ H5AC_tag(prv_tag, NULL); \
+ }
+
+/* Compile-time "assert" macro */
+#define HDcompile_assert(e) ((void)sizeof(char[!!(e) ? 1 : -1]))
+/* Variants that are correct, but generate compile-time warnings in some circumstances:
+ #define HDcompile_assert(e) do { enum { compile_assert__ = 1 / (e) }; } while(0)
+ #define HDcompile_assert(e) do { typedef struct { unsigned int b: (e); } x; } while(0)
+*/
+
+/* Private typedefs */
+
+/* Union for const/non-const pointer for use by functions that manipulate
+ * pointers but do not write to their targets or return pointers to const
+ * specified locations. Also used for I/O functions that work for read and
+ * write - these functions are expected to never write to these locations in the
+ * write case. This helps us avoid compiler warnings. */
+typedef union {
+ void *vp;
+ const void *cvp;
+} H5_flexible_const_ptr_t;
+
+/* File-independent encode/decode routines */
+
+/* Private functions, not part of the publicly documented API */
+H5_DLL herr_t H5_init_library(void);
+H5_DLL void H5_term_library(void);
+
+/* Functions to terminate interfaces */
+H5_DLL int H5A_term_package(void);
+H5_DLL int H5A_top_term_package(void);
+H5_DLL int H5AC_term_package(void);
+H5_DLL int H5CX_term_package(void);
+H5_DLL int H5D_term_package(void);
+H5_DLL int H5D_top_term_package(void);
+H5_DLL int H5E_term_package(void);
+H5_DLL int H5ES_term_package(void);
+H5_DLL int H5F_term_package(void);
+H5_DLL int H5FD_term_package(void);
+H5_DLL int H5FL_term_package(void);
+H5_DLL int H5FS_term_package(void);
+H5_DLL int H5G_term_package(void);
+H5_DLL int H5G_top_term_package(void);
+H5_DLL int H5I_term_package(void);
+H5_DLL int H5L_term_package(void);
+H5_DLL int H5M_term_package(void);
+H5_DLL int H5M_top_term_package(void);
+H5_DLL int H5P_term_package(void);
+H5_DLL int H5PL_term_package(void);
+H5_DLL int H5R_term_package(void);
+H5_DLL int H5R_top_term_package(void);
+H5_DLL int H5S_term_package(void);
+H5_DLL int H5S_top_term_package(void);
+H5_DLL int H5SL_term_package(void);
+H5_DLL int H5T_term_package(void);
+H5_DLL int H5T_top_term_package(void);
+H5_DLL int H5VL_term_package(void);
+H5_DLL int H5Z_term_package(void);
+
+/* Checksum functions */
+H5_DLL uint32_t H5_checksum_fletcher32(const void *data, size_t len);
+H5_DLL uint32_t H5_checksum_crc(const void *data, size_t len);
+H5_DLL uint32_t H5_checksum_lookup3(const void *data, size_t len, uint32_t initval);
+H5_DLL uint32_t H5_checksum_metadata(const void *data, size_t len, uint32_t initval);
+H5_DLL uint32_t H5_hash_string(const char *str);
+
+/* Time related routines */
+H5_DLL time_t H5_make_time(struct tm *tm);
+H5_DLL void H5_nanosleep(uint64_t nanosec);
+H5_DLL double H5_get_time(void);
+
+/* Functions for building paths, etc. */
+H5_DLL herr_t H5_build_extpath(const char *name, char **extpath /*out*/);
+H5_DLL herr_t H5_combine_path(const char *path1, const char *path2, char **full_name /*out*/);
+H5_DLL herr_t H5_dirname(const char *path, char **dirname /*out*/);
+H5_DLL herr_t H5_basename(const char *path, char **basename /*out*/);
+
+/* getopt(3) equivalent that papers over the lack of long options on BSD
+ * and lack of Windows support.
+ */
+H5_DLLVAR int H5_opterr; /* get_option prints errors if this is on */
+H5_DLLVAR int H5_optind; /* token pointer */
+H5_DLLVAR const char *H5_optarg; /* flag argument (or value) */
+
+enum h5_arg_level {
+ no_arg = 0, /* doesn't take an argument */
+ require_arg, /* requires an argument */
+ optional_arg /* argument is optional */
+};
+
+/*
+ * get_option determines which options are specified on the command line and
+ * returns a pointer to any arguments possibly associated with the option in
+ * the ``H5_optarg'' variable. get_option returns the shortname equivalent of
+ * the option. The long options are specified in the following way:
+ *
+ * struct h5_long_options foo[] = {
+ * { "filename", require_arg, 'f' },
+ * { "append", no_arg, 'a' },
+ * { "width", require_arg, 'w' },
+ * { NULL, 0, 0 }
+ * };
+ *
+ * Long named options can have arguments specified as either:
+ *
+ * ``--param=arg'' or ``--param arg''
+ *
+ * Short named options can have arguments specified as either:
+ *
+ * ``-w80'' or ``-w 80''
+ *
+ * and can have more than one short named option specified at one time:
+ *
+ * -aw80
+ *
+ * in which case those options which expect an argument need to come at the
+ * end.
+ */
+struct h5_long_options {
+ const char *name; /* Name of the long option */
+ enum h5_arg_level has_arg; /* Whether we should look for an arg */
+ char shortval; /* The shortname equivalent of long arg
+ * this gets returned from get_option
+ */
+};
+
+H5_DLL int H5_get_option(int argc, const char *const *argv, const char *opt,
+ const struct h5_long_options *l_opt);
+
+#ifdef H5_HAVE_PARALLEL
+/* Generic MPI functions */
+H5_DLL hsize_t H5_mpi_set_bigio_count(hsize_t new_count);
+H5_DLL hsize_t H5_mpi_get_bigio_count(void);
+H5_DLL herr_t H5_mpi_comm_dup(MPI_Comm comm, MPI_Comm *comm_new);
+H5_DLL herr_t H5_mpi_info_dup(MPI_Info info, MPI_Info *info_new);
+H5_DLL herr_t H5_mpi_comm_free(MPI_Comm *comm);
+H5_DLL herr_t H5_mpi_info_free(MPI_Info *info);
+H5_DLL herr_t H5_mpi_comm_cmp(MPI_Comm comm1, MPI_Comm comm2, int *result);
+H5_DLL herr_t H5_mpi_info_cmp(MPI_Info info1, MPI_Info info2, int *result);
+H5_DLL herr_t H5_mpio_create_large_type(hsize_t num_elements, MPI_Aint stride_bytes, MPI_Datatype old_type,
+ MPI_Datatype *new_type);
+H5_DLL herr_t H5_mpio_gatherv_alloc(void *send_buf, int send_count, MPI_Datatype send_type,
+ const int recv_counts[], const int displacements[],
+ MPI_Datatype recv_type, bool allgather, int root, MPI_Comm comm,
+ int mpi_rank, int mpi_size, void **out_buf, size_t *out_buf_num_entries);
+H5_DLL herr_t H5_mpio_gatherv_alloc_simple(void *send_buf, int send_count, MPI_Datatype send_type,
+ MPI_Datatype recv_type, bool allgather, int root, MPI_Comm comm,
+ int mpi_rank, int mpi_size, void **out_buf,
+ size_t *out_buf_num_entries);
+H5_DLL herr_t H5_mpio_get_file_sync_required(MPI_File fh, bool *file_sync_required);
+#endif /* H5_HAVE_PARALLEL */
+
+/* Functions for debugging */
+H5_DLL herr_t H5_buffer_dump(FILE *stream, int indent, const uint8_t *buf, const uint8_t *marker,
+ size_t buf_offset, size_t buf_size);
+
+#endif /* H5private_H */
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5TSprivate.h r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5TSprivate.h
--- r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5TSprivate.h 1970-01-01 01:00:00.000000000 +0100
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/H5TSprivate.h 2024-11-18 12:26:37.000000000 +0100
@@ -0,0 +1,137 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group. *
+ * 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://www.hdfgroup.org/licenses. *
+ * If you do not have access to either file, you may request a copy from *
+ * help at hdfgroup.org. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*-------------------------------------------------------------------------
+ *
+ * Created: H5TSprivate.h
+ *
+ * Purpose: Thread-safety abstractions used by the library
+ *
+ *-------------------------------------------------------------------------
+ */
+#ifndef H5TSprivate_H_
+#define H5TSprivate_H_
+
+#ifdef H5_HAVE_THREADSAFE
+/* Include package's public headers */
+#include "H5TSdevelop.h"
+
+#ifdef H5_HAVE_WIN_THREADS
+
+/* Library level data structures */
+
+/* Mutexes, Threads, and Attributes */
+typedef struct H5TS_mutex_struct {
+ CRITICAL_SECTION CriticalSection;
+} H5TS_mutex_t;
+
+/* Portability wrappers around Windows Threads types */
+typedef CRITICAL_SECTION H5TS_mutex_simple_t;
+typedef HANDLE H5TS_thread_t;
+typedef HANDLE H5TS_attr_t;
+typedef DWORD H5TS_key_t;
+typedef INIT_ONCE H5TS_once_t;
+
+/* Defines */
+/* not used on windows side, but need to be defined to something */
+#define H5TS_SCOPE_SYSTEM 0
+#define H5TS_SCOPE_PROCESS 0
+#define H5TS_CALL_CONV WINAPI
+
+/* Portability function aliases */
+#define H5TS_get_thread_local_value(key) TlsGetValue(key)
+#define H5TS_set_thread_local_value(key, value) TlsSetValue(key, value)
+#define H5TS_attr_init(attr_ptr) 0
+#define H5TS_attr_setscope(attr_ptr, scope) 0
+#define H5TS_attr_destroy(attr_ptr) 0
+#define H5TS_wait_for_thread(thread) WaitForSingleObject(thread, INFINITE)
+#define H5TS_mutex_init(mutex) InitializeCriticalSection(mutex)
+#define H5TS_mutex_lock_simple(mutex) EnterCriticalSection(mutex)
+#define H5TS_mutex_unlock_simple(mutex) LeaveCriticalSection(mutex)
+
+/* Functions called from DllMain */
+H5_DLL BOOL CALLBACK H5TS_win32_process_enter(PINIT_ONCE InitOnce, PVOID Parameter, PVOID *lpContex);
+H5_DLL void H5TS_win32_process_exit(void);
+H5_DLL herr_t H5TS_win32_thread_enter(void);
+H5_DLL herr_t H5TS_win32_thread_exit(void);
+
+#define H5TS_thread_id() ((uint64_t)GetCurrentThreadId())
+
+#else /* H5_HAVE_WIN_THREADS */
+
+/* Library level data structures */
+
+/* Mutexes, Threads, and Attributes */
+typedef struct H5TS_mutex_struct {
+ pthread_t owner_thread; /* current lock owner */
+ pthread_mutex_t atomic_lock; /* lock for atomicity of new mechanism */
+ pthread_cond_t cond_var; /* condition variable */
+ unsigned int lock_count;
+
+ pthread_mutex_t atomic_lock2; /* lock for attempt_lock_count */
+ unsigned int attempt_lock_count;
+} H5TS_mutex_t;
+
+/* Portability wrappers around pthread types */
+typedef pthread_t H5TS_thread_t;
+typedef pthread_attr_t H5TS_attr_t;
+typedef pthread_mutex_t H5TS_mutex_simple_t;
+typedef pthread_key_t H5TS_key_t;
+typedef pthread_once_t H5TS_once_t;
+
+/* Scope Definitions */
+#define H5TS_SCOPE_SYSTEM PTHREAD_SCOPE_SYSTEM
+#define H5TS_SCOPE_PROCESS PTHREAD_SCOPE_PROCESS
+#define H5TS_CALL_CONV /* unused - Windows only */
+
+/* Portability function aliases */
+#define H5TS_get_thread_local_value(key) pthread_getspecific(key)
+#define H5TS_set_thread_local_value(key, value) pthread_setspecific(key, value)
+#define H5TS_attr_init(attr_ptr) pthread_attr_init((attr_ptr))
+#define H5TS_attr_setscope(attr_ptr, scope) pthread_attr_setscope(attr_ptr, scope)
+#define H5TS_attr_destroy(attr_ptr) pthread_attr_destroy(attr_ptr)
+#define H5TS_wait_for_thread(thread) pthread_join(thread, NULL)
+#define H5TS_mutex_init(mutex) pthread_mutex_init(mutex, NULL)
+#define H5TS_mutex_lock_simple(mutex) pthread_mutex_lock(mutex)
+#define H5TS_mutex_unlock_simple(mutex) pthread_mutex_unlock(mutex)
+
+/* Pthread-only routines */
+H5_DLL uint64_t H5TS_thread_id(void);
+H5_DLL void H5TS_pthread_first_thread_init(void);
+
+#endif /* H5_HAVE_WIN_THREADS */
+
+/* Library-scope global variables */
+extern H5TS_once_t H5TS_first_init_g; /* Library initialization */
+extern H5TS_key_t H5TS_errstk_key_g; /* Error stacks */
+#ifdef H5_HAVE_CODESTACK
+extern H5TS_key_t H5TS_funcstk_key_g; /* Function stacks */
+#endif /* H5_HAVE_CODESTACK */
+extern H5TS_key_t H5TS_apictx_key_g; /* API contexts */
+
+/* Library-scope routines */
+/* (Only used within H5private.h macros) */
+H5_DLL herr_t H5TS_mutex_lock(H5TS_mutex_t *mutex);
+H5_DLL herr_t H5TS_mutex_unlock(H5TS_mutex_t *mutex);
+H5_DLL herr_t H5TS_cancel_count_inc(void);
+H5_DLL herr_t H5TS_cancel_count_dec(void);
+
+/* Testing routines */
+H5_DLL H5TS_thread_t H5TS_create_thread(void *(*func)(void *), H5TS_attr_t *attr, void *udata);
+
+#else /* H5_HAVE_THREADSAFE */
+
+#define H5TS_thread_id() ((uint64_t)0)
+
+#endif /* H5_HAVE_THREADSAFE */
+
+#endif /* H5TSprivate_H_ */
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/README r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/README
--- r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/README 1970-01-01 01:00:00.000000000 +0100
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/hdf5-1.14-private/README 2024-11-18 12:25:34.000000000 +0100
@@ -0,0 +1,6 @@
+r-bioc-rhdf5 is using H5private.h
+
+While this is totally broken to use this private header file
+it is provided here as a copy of the source code of
+ libhdf5-dev 1.15.5+repack-1
+
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/patches/hdf5-1.14.patch r-bioc-rhdf5-2.48.0+dfsg/debian/patches/hdf5-1.14.patch
--- r-bioc-rhdf5-2.48.0+dfsg/debian/patches/hdf5-1.14.patch 1970-01-01 01:00:00.000000000 +0100
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/patches/hdf5-1.14.patch 2024-11-18 12:23:42.000000000 +0100
@@ -0,0 +1,31 @@
+Index: r-bioc-rhdf5-2.48.0+dfsg/src/H5constants.c
+===================================================================
+--- r-bioc-rhdf5-2.48.0+dfsg.orig/src/H5constants.c
++++ r-bioc-rhdf5-2.48.0+dfsg/src/H5constants.c
+@@ -153,11 +153,11 @@ SEXP _H5constants( ) {
+
+ int const_H5I_TYPE[15] = { H5I_FILE, H5I_GROUP, H5I_DATATYPE, H5I_DATASPACE, H5I_DATASET, H5I_ATTR,
+ H5I_BADID, H5I_UNINIT,
+- H5I_REFERENCE, H5I_VFL, H5I_GENPROP_CLS, H5I_GENPROP_LST,
++ H5I_VFL, H5I_GENPROP_CLS, H5I_GENPROP_LST,
+ H5I_ERROR_CLASS, H5I_ERROR_MSG, H5I_ERROR_STACK };
+ const char *name_H5I_TYPE[] = { "H5I_FILE", "H5I_GROUP", "H5I_DATATYPE", "H5I_DATASPACE", "H5I_DATASET", "H5I_ATTR",
+ "H5I_BADID", "H5I_UNINIT",
+- "H5I_REFERENCE", "H5I_VFL", "H5I_GENPROP_CLS", "H5I_GENPROP_LST",
++ "H5I_VFL", "H5I_GENPROP_CLS", "H5I_GENPROP_LST",
+ "H5I_ERROR_CLASS", "H5I_ERROR_MSG", "H5I_ERROR_STACK" };
+ addVector_int(i++, Rval, groupnames, "H5I_TYPE", 15, const_H5I_TYPE, name_H5I_TYPE);
+
+Index: r-bioc-rhdf5-2.48.0+dfsg/src/Makevars
+===================================================================
+--- r-bioc-rhdf5-2.48.0+dfsg.orig/src/Makevars
++++ r-bioc-rhdf5-2.48.0+dfsg/src/Makevars
+@@ -1,7 +1,7 @@
+ RHDF5_LIBS="/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH`/hdf5/serial/"
+ PKG_LIBS=/usr/lib/R/site-library/Rhdf5lib/libs/Rhdf5lib.so -L$(RHDF5_LIBS) -lhdf5
+
+-#PKG_CFLAGS = -Wall
++PKG_CFLAGS = -DH5_USE_110_API # -Wall
+
+ # uncomment below to print the contents of $(PKG_LIBS)
+ # $(info $$PKG_LIBS is [${PKG_LIBS}])
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/patches/series r-bioc-rhdf5-2.48.0+dfsg/debian/patches/series
--- r-bioc-rhdf5-2.48.0+dfsg/debian/patches/series 2024-10-01 13:09:42.000000000 +0200
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/patches/series 2024-11-18 12:22:03.000000000 +0100
@@ -3,3 +3,4 @@
#h5ls.patch
fix-hdf5deref.patch
skip_failing_tests.patch
+hdf5-1.14.patch
diff -Nru r-bioc-rhdf5-2.48.0+dfsg/debian/rules r-bioc-rhdf5-2.48.0+dfsg/debian/rules
--- r-bioc-rhdf5-2.48.0+dfsg/debian/rules 2024-10-01 11:48:29.000000000 +0200
+++ r-bioc-rhdf5-2.48.0+dfsg/debian/rules 2024-11-18 12:26:57.000000000 +0100
@@ -1,12 +1,22 @@
#!/usr/bin/make -f
+H5_VERSION = $(shell h5cc -showconfig | grep 'Version' | sed 's/.* //;s/\./ /g')
+
+ifeq (1 14,$(wordlist 1,2,$(H5_VERSION)))
+ H5_PRIVATE = hdf5-1.14-private
+else
+ H5_PRIVATE = hdf5-private
+endif
+
%:
dh $@ --buildsystem R
-execute_before_dh_auto_install:
- # see debian/hdf5-private/README
- ln -s $(CURDIR)/debian/hdf5-private/H5private.h $(CURDIR)/src/H5private.h
- ln -s $(CURDIR)/debian/hdf5-private/H5TSprivate.h $(CURDIR)/src/H5TSprivate.h
-
-execute_after_dh_auto_install:
- rm src/H5private.h src/H5TSprivate.h
+override_dh_auto_configure:
+ # see debian/$(H5_PRIVATE)/README
+ ln -s $(CURDIR)/debian/$(H5_PRIVATE)/H5private.h $(CURDIR)/src/H5private.h
+ ln -s $(CURDIR)/debian/$(H5_PRIVATE)/H5TSprivate.h $(CURDIR)/src/H5TSprivate.h
+ dh_auto_configure
+
+override_dh_auto_clean:
+ dh_auto_clean
+ rm -f src/H5private.h src/H5TSprivate.h
More information about the R-pkg-team
mailing list