Repository Public License
1// ORIX Convert — Packages/EngineScientific/Sources/CHDF5Shim/shim.c2// Description: Implementation of the HDF5 shim (see CHDF5Shim.h).3// Author: Simon-Pierre Boucher — contact@spboucher.ai4#include "CHDF5Shim.h"5#include <hdf5_hl.h>6#include <pthread.h>7#include <stdatomic.h>8#include <stdio.h>9#include <stdlib.h>10#include <string.h>1112static pthread_once_t orix_once = PTHREAD_ONCE_INIT;13static int orix_init_status = -1;14static atomic_long orix_refusals = 0;1516static int orix_external_disabled = 0;1718static hid_t orix_refuse_traversal(const char *link_name, hid_t cur_group, const void *lnkdata, size_t lnkdata_size,19 hid_t lapl_id, hid_t dxpl_id) {20 (void)link_name; (void)cur_group; (void)lnkdata; (void)lnkdata_size; (void)lapl_id; (void)dxpl_id;21 atomic_fetch_add(&orix_refusals, 1);22 return H5I_INVALID_HID;23}2425// Same contract as the library's own query callback: copy the stored link value, return its size.26static ssize_t orix_query_external(const char *link_name, const void *lnkdata, size_t lnkdata_size, void *buf, size_t buf_size) {27 (void)link_name;28 if (buf) memcpy(buf, lnkdata, buf_size < lnkdata_size ? buf_size : lnkdata_size);29 return (ssize_t)lnkdata_size;30}3132static void orix_do_init(void) {33 // These must be in place before the library initialises itself: "::" is H5PL_NO_PLUGIN.34 setenv("HDF5_PLUGIN_PRELOAD", H5PL_NO_PLUGIN, 1);35 setenv("HDF5_PLUGIN_PATH", "/var/empty/orix-convert-hdf5-plugins-disabled", 1);36 unsetenv("HDF5_VOL_CONNECTOR");37 unsetenv("HDF5_DRIVER");38 unsetenv("HDF5_DRIVER_CONFIG");39 unsetenv("HDF5_USE_FILE_LOCKING");40 if (H5open() < 0) return;41 H5Eset_auto2(H5E_DEFAULT, NULL, NULL);42 H5PLset_loading_state(0);43 unsigned count = 0;44 if (H5PLsize(&count) >= 0) {45 while (count > 0) {46 if (H5PLremove(count - 1) < 0) break;47 count--;48 }49 }50 // Second line of defence against external links: replace the library's external-link class by one whose51 // traversal always fails. A link can still be listed and its target read (query), but no call can follow it,52 // whatever access property list it uses. (The first line is the refusing callback of the access property lists.)53 static const H5L_class_t refusing = {54 H5L_LINK_CLASS_T_VERS, H5L_TYPE_EXTERNAL, "external link (traversal disabled by ORIX Convert)",55 NULL, NULL, NULL, orix_refuse_traversal, NULL, orix_query_external56 };57 if (H5Lregister(&refusing) >= 0) orix_external_disabled = 1;58 H5Eclear2(H5E_DEFAULT);59 orix_init_status = 0;60}6162int orix_h5_init(void) {63 pthread_once(&orix_once, orix_do_init);64 return orix_init_status;65}6667int orix_h5_plugins_disabled(void) {68 unsigned state = 1, count = 1;69 if (H5PLget_loading_state(&state) < 0) return 0;70 if (H5PLsize(&count) < 0) return 0;71 return state == 0 && count == 0;72}7374typedef struct { char *buffer; size_t capacity; int found; } orix_error_sink;7576static herr_t orix_error_walk(unsigned n, const H5E_error2_t *e, void *data) {77 (void)n;78 orix_error_sink *sink = (orix_error_sink *)data;79 if (!sink->found && e && e->desc && e->desc[0] && sink->capacity > 0) {80 char minor[96] = "";81 H5Eget_msg(e->min_num, NULL, minor, sizeof minor);82 snprintf(sink->buffer, sink->capacity, "%s%s%s", e->desc, minor[0] ? " — " : "", minor);83 sink->found = 1;84 }85 return 0;86}8788void orix_h5_last_error(char *buffer, size_t capacity) {89 if (capacity == 0) return;90 buffer[0] = 0;91 orix_error_sink sink = { buffer, capacity, 0 };92 // H5E_WALK_UPWARD starts at the innermost (most specific) record.93 H5Ewalk2(H5E_DEFAULT, H5E_WALK_UPWARD, orix_error_walk, &sink);94 H5Eclear2(H5E_DEFAULT);95}9697hid_t orix_h5_type(orix_type_t type) {98 switch (type) {99 case ORIX_T_INT8: return H5T_NATIVE_INT8;100 case ORIX_T_UINT8: return H5T_NATIVE_UINT8;101 case ORIX_T_INT16: return H5T_NATIVE_INT16;102 case ORIX_T_UINT16: return H5T_NATIVE_UINT16;103 case ORIX_T_INT32: return H5T_NATIVE_INT32;104 case ORIX_T_UINT32: return H5T_NATIVE_UINT32;105 case ORIX_T_INT64: return H5T_NATIVE_INT64;106 case ORIX_T_UINT64: return H5T_NATIVE_UINT64;107 case ORIX_T_FLOAT: return H5T_NATIVE_FLOAT;108 case ORIX_T_DOUBLE: return H5T_NATIVE_DOUBLE;109 case ORIX_T_C_S1: return H5T_C_S1;110 case ORIX_T_STD_REF_OBJ: return H5T_STD_REF_OBJ;111 case ORIX_T_IEEE_F32BE: return H5T_IEEE_F32BE;112 case ORIX_T_NATIVE_HBOOL: return H5T_NATIVE_HBOOL;113 case ORIX_T_STD_REF: return H5T_STD_REF;114 case ORIX_T_FLOAT16: return H5T_IEEE_F16LE;115 case ORIX_T_STD_B8LE: return H5T_STD_B8LE;116 case ORIX_T_UNIX_D32LE: return H5T_UNIX_D32LE;117 }118 return H5I_INVALID_HID;119}120121hid_t orix_h5_plist_class(orix_plist_t cls) {122 switch (cls) {123 case ORIX_P_FILE_ACCESS: return H5P_FILE_ACCESS;124 case ORIX_P_FILE_CREATE: return H5P_FILE_CREATE;125 case ORIX_P_DATASET_CREATE: return H5P_DATASET_CREATE;126 case ORIX_P_DATASET_ACCESS: return H5P_DATASET_ACCESS;127 case ORIX_P_DATASET_XFER: return H5P_DATASET_XFER;128 case ORIX_P_LINK_ACCESS: return H5P_LINK_ACCESS;129 case ORIX_P_LINK_CREATE: return H5P_LINK_CREATE;130 case ORIX_P_GROUP_CREATE: return H5P_GROUP_CREATE;131 case ORIX_P_ATTRIBUTE_CREATE: return H5P_ATTRIBUTE_CREATE;132 case ORIX_P_DATATYPE_CREATE: return H5P_DATATYPE_CREATE;133 case ORIX_P_GROUP_ACCESS: return H5P_GROUP_ACCESS;134 case ORIX_P_DATATYPE_ACCESS: return H5P_DATATYPE_ACCESS;135 }136 return H5I_INVALID_HID;137}138139hid_t orix_h5_fapl(int forWriting) {140 hid_t fapl = H5Pcreate(H5P_FILE_ACCESS);141 if (fapl < 0) return fapl;142 H5Pset_file_locking(fapl, false, true);143 H5Pset_fclose_degree(fapl, H5F_CLOSE_STRONG);144 if (forWriting) H5Pset_libver_bounds(fapl, H5F_LIBVER_V18, H5F_LIBVER_V18);145 return fapl;146}147148static herr_t orix_refuse_external(const char *parent_file, const char *parent_group, const char *child_file,149 const char *child_object, unsigned *acc_flags, hid_t fapl, void *data) {150 (void)parent_file; (void)parent_group; (void)child_file; (void)child_object; (void)acc_flags; (void)fapl; (void)data;151 atomic_fetch_add(&orix_refusals, 1);152 return -1;153}154155hid_t orix_h5_safe_access_plist(orix_plist_t cls) {156 hid_t plist = H5Pcreate(orix_h5_plist_class(cls));157 if (plist < 0) return plist;158 H5Pset_elink_cb(plist, orix_refuse_external, NULL);159 H5Pset_nlinks(plist, 16);160 return plist;161}162163hid_t orix_h5_lapl_no_external(void) { return orix_h5_safe_access_plist(ORIX_P_LINK_ACCESS); }164165int orix_h5_external_links_disabled(void) { return orix_external_disabled; }166167long orix_h5_external_refusals(void) { return atomic_load(&orix_refusals); }168169typedef struct { char *buffer; size_t capacity; int count; } orix_scale_sink;170171static herr_t orix_scale_visit(hid_t dataset, unsigned dim, hid_t scale, void *data) {172 (void)dataset; (void)dim;173 orix_scale_sink *sink = (orix_scale_sink *)data;174 if (sink->count == 0 && sink->capacity > 0) {175 if (H5Iget_name(scale, sink->buffer, sink->capacity) < 0) sink->buffer[0] = 0;176 }177 sink->count++;178 return 0;179}180181int orix_h5_scale_path(hid_t dataset, unsigned index, char *buffer, size_t capacity) {182 if (capacity > 0) buffer[0] = 0;183 int attached = H5DSget_num_scales(dataset, index);184 if (attached <= 0) return attached;185 orix_scale_sink sink = { buffer, capacity, 0 };186 if (H5DSiterate_scales(dataset, index, NULL, orix_scale_visit, &sink) < 0) return -1;187 return sink.count;188}189190hsize_t orix_h5_unlimited(void) { return H5S_UNLIMITED; }191192size_t orix_h5_variable(void) { return H5T_VARIABLE; }193194void orix_h5_version(char *buffer, size_t capacity) {195 unsigned major = 0, minor = 0, release = 0;196 H5get_libversion(&major, &minor, &release);197 snprintf(buffer, capacity, "%u.%u.%u", major, minor, release);198}199