1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 2 * Copyright by The HDF Group. * 3 * Copyright by the Board of Trustees of the University of Illinois. * 4 * All rights reserved. * 5 * * 6 * This file is part of HDF5. The full HDF5 copyright notice, including * 7 * terms governing use, modification, and redistribution, is contained in * 8 * the COPYING file, which can be found at the root of the source code * 9 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. * 10 * If you do not have access to either file, you may request a copy from * 11 * help@hdfgroup.org. * 12 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 13 14 /* 15 * This file contains function prototypes for each exported function in the 16 * H5P module. 17 */ 18 #ifndef _H5Ppublic_H 19 #define _H5Ppublic_H 20 21 /* System headers needed by this file */ 22 23 /* Public headers needed by this file */ 24 #include "H5public.h" 25 #include "H5ACpublic.h" 26 #include "H5Dpublic.h" 27 #include "H5Fpublic.h" 28 #include "H5FDpublic.h" 29 #include "H5Ipublic.h" 30 #include "H5Lpublic.h" 31 #include "H5Opublic.h" 32 #include "H5MMpublic.h" 33 #include "H5Tpublic.h" 34 #include "H5Zpublic.h" 35 36 37 /*****************/ 38 /* Public Macros */ 39 /*****************/ 40 41 /* When this header is included from a private HDF5 header, don't make calls to H5open() */ 42 #undef H5OPEN 43 #ifndef _H5private_H 44 #define H5OPEN H5open(), 45 #else /* _H5private_H */ 46 #define H5OPEN 47 #endif /* _H5private_H */ 48 49 /* 50 * The library's property list classes 51 */ 52 53 #define H5P_ROOT (H5OPEN H5P_CLS_ROOT_ID_g) 54 #define H5P_OBJECT_CREATE (H5OPEN H5P_CLS_OBJECT_CREATE_ID_g) 55 #define H5P_FILE_CREATE (H5OPEN H5P_CLS_FILE_CREATE_ID_g) 56 #define H5P_FILE_ACCESS (H5OPEN H5P_CLS_FILE_ACCESS_ID_g) 57 #define H5P_DATASET_CREATE (H5OPEN H5P_CLS_DATASET_CREATE_ID_g) 58 #define H5P_DATASET_ACCESS (H5OPEN H5P_CLS_DATASET_ACCESS_ID_g) 59 #define H5P_DATASET_XFER (H5OPEN H5P_CLS_DATASET_XFER_ID_g) 60 #define H5P_FILE_MOUNT (H5OPEN H5P_CLS_FILE_MOUNT_ID_g) 61 #define H5P_GROUP_CREATE (H5OPEN H5P_CLS_GROUP_CREATE_ID_g) 62 #define H5P_GROUP_ACCESS (H5OPEN H5P_CLS_GROUP_ACCESS_ID_g) 63 #define H5P_DATATYPE_CREATE (H5OPEN H5P_CLS_DATATYPE_CREATE_ID_g) 64 #define H5P_DATATYPE_ACCESS (H5OPEN H5P_CLS_DATATYPE_ACCESS_ID_g) 65 #define H5P_STRING_CREATE (H5OPEN H5P_CLS_STRING_CREATE_ID_g) 66 #define H5P_ATTRIBUTE_CREATE (H5OPEN H5P_CLS_ATTRIBUTE_CREATE_ID_g) 67 #define H5P_ATTRIBUTE_ACCESS (H5OPEN H5P_CLS_ATTRIBUTE_ACCESS_ID_g) 68 #define H5P_OBJECT_COPY (H5OPEN H5P_CLS_OBJECT_COPY_ID_g) 69 #define H5P_LINK_CREATE (H5OPEN H5P_CLS_LINK_CREATE_ID_g) 70 #define H5P_LINK_ACCESS (H5OPEN H5P_CLS_LINK_ACCESS_ID_g) 71 72 /* 73 * The library's default property lists 74 */ 75 #define H5P_FILE_CREATE_DEFAULT (H5OPEN H5P_LST_FILE_CREATE_ID_g) 76 #define H5P_FILE_ACCESS_DEFAULT (H5OPEN H5P_LST_FILE_ACCESS_ID_g) 77 #define H5P_DATASET_CREATE_DEFAULT (H5OPEN H5P_LST_DATASET_CREATE_ID_g) 78 #define H5P_DATASET_ACCESS_DEFAULT (H5OPEN H5P_LST_DATASET_ACCESS_ID_g) 79 #define H5P_DATASET_XFER_DEFAULT (H5OPEN H5P_LST_DATASET_XFER_ID_g) 80 #define H5P_FILE_MOUNT_DEFAULT (H5OPEN H5P_LST_FILE_MOUNT_ID_g) 81 #define H5P_GROUP_CREATE_DEFAULT (H5OPEN H5P_LST_GROUP_CREATE_ID_g) 82 #define H5P_GROUP_ACCESS_DEFAULT (H5OPEN H5P_LST_GROUP_ACCESS_ID_g) 83 #define H5P_DATATYPE_CREATE_DEFAULT (H5OPEN H5P_LST_DATATYPE_CREATE_ID_g) 84 #define H5P_DATATYPE_ACCESS_DEFAULT (H5OPEN H5P_LST_DATATYPE_ACCESS_ID_g) 85 #define H5P_ATTRIBUTE_CREATE_DEFAULT (H5OPEN H5P_LST_ATTRIBUTE_CREATE_ID_g) 86 #define H5P_ATTRIBUTE_ACCESS_DEFAULT (H5OPEN H5P_LST_ATTRIBUTE_ACCESS_ID_g) 87 #define H5P_OBJECT_COPY_DEFAULT (H5OPEN H5P_LST_OBJECT_COPY_ID_g) 88 #define H5P_LINK_CREATE_DEFAULT (H5OPEN H5P_LST_LINK_CREATE_ID_g) 89 #define H5P_LINK_ACCESS_DEFAULT (H5OPEN H5P_LST_LINK_ACCESS_ID_g) 90 91 /* Common creation order flags (for links in groups and attributes on objects) */ 92 #define H5P_CRT_ORDER_TRACKED 0x0001 93 #define H5P_CRT_ORDER_INDEXED 0x0002 94 95 /* Default value for all property list classes */ 96 #define H5P_DEFAULT (hid_t)0 97 98 #ifdef __cplusplus 99 extern "C" { 100 #endif 101 102 /*******************/ 103 /* Public Typedefs */ 104 /*******************/ 105 106 107 /* Define property list class callback function pointer types */ 108 typedef herr_t (*H5P_cls_create_func_t)(hid_t prop_id, void *create_data); 109 typedef herr_t (*H5P_cls_copy_func_t)(hid_t new_prop_id, hid_t old_prop_id, 110 void *copy_data); 111 typedef herr_t (*H5P_cls_close_func_t)(hid_t prop_id, void *close_data); 112 113 /* Define property list callback function pointer types */ 114 typedef herr_t (*H5P_prp_cb1_t)(const char *name, size_t size, void *value); 115 typedef herr_t (*H5P_prp_cb2_t)(hid_t prop_id, const char *name, size_t size, void *value); 116 typedef H5P_prp_cb1_t H5P_prp_create_func_t; 117 typedef H5P_prp_cb2_t H5P_prp_set_func_t; 118 typedef H5P_prp_cb2_t H5P_prp_get_func_t; 119 typedef herr_t (*H5P_prp_encode_func_t)(const void *value, void **buf, size_t *size); 120 typedef herr_t (*H5P_prp_decode_func_t)(const void **buf, void *value); 121 typedef H5P_prp_cb2_t H5P_prp_delete_func_t; 122 typedef H5P_prp_cb1_t H5P_prp_copy_func_t; 123 typedef int (*H5P_prp_compare_func_t)(const void *value1, const void *value2, size_t size); 124 typedef H5P_prp_cb1_t H5P_prp_close_func_t; 125 126 /* Define property list iteration function type */ 127 typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data); 128 129 /* Actual IO mode property */ 130 typedef enum H5D_mpio_actual_chunk_opt_mode_t { 131 /* The default value, H5D_MPIO_NO_CHUNK_OPTIMIZATION, is used for all I/O 132 * operations that do not use chunk optimizations, including non-collective 133 * I/O and contiguous collective I/O. 134 */ 135 H5D_MPIO_NO_CHUNK_OPTIMIZATION = 0, 136 H5D_MPIO_LINK_CHUNK, 137 H5D_MPIO_MULTI_CHUNK 138 } H5D_mpio_actual_chunk_opt_mode_t; 139 140 typedef enum H5D_mpio_actual_io_mode_t { 141 /* The following four values are conveniently defined as a bit field so that 142 * we can switch from the default to indpendent or collective and then to 143 * mixed without having to check the original value. 144 * 145 * NO_COLLECTIVE means that either collective I/O wasn't requested or that 146 * no I/O took place. 147 * 148 * CHUNK_INDEPENDENT means that collective I/O was requested, but the 149 * chunk optimization scheme chose independent I/O for each chunk. 150 */ 151 H5D_MPIO_NO_COLLECTIVE = 0x0, 152 H5D_MPIO_CHUNK_INDEPENDENT = 0x1, 153 H5D_MPIO_CHUNK_COLLECTIVE = 0x2, 154 H5D_MPIO_CHUNK_MIXED = 0x1 | 0x2, 155 156 /* The contiguous case is separate from the bit field. */ 157 H5D_MPIO_CONTIGUOUS_COLLECTIVE = 0x4 158 } H5D_mpio_actual_io_mode_t; 159 160 /* Broken collective IO property */ 161 typedef enum H5D_mpio_no_collective_cause_t { 162 H5D_MPIO_COLLECTIVE = 0x00, 163 H5D_MPIO_SET_INDEPENDENT = 0x01, 164 H5D_MPIO_DATATYPE_CONVERSION = 0x02, 165 H5D_MPIO_DATA_TRANSFORMS = 0x04, 166 H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED = 0x08, 167 H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES = 0x10, 168 H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET = 0x20, 169 H5D_MPIO_FILTERS = 0x40 170 } H5D_mpio_no_collective_cause_t; 171 172 /********************/ 173 /* Public Variables */ 174 /********************/ 175 176 /* Property list class IDs */ 177 /* (Internal to library, do not use! Use macros above) */ 178 H5_DLLVAR hid_t H5P_CLS_ROOT_ID_g; 179 H5_DLLVAR hid_t H5P_CLS_OBJECT_CREATE_ID_g; 180 H5_DLLVAR hid_t H5P_CLS_FILE_CREATE_ID_g; 181 H5_DLLVAR hid_t H5P_CLS_FILE_ACCESS_ID_g; 182 H5_DLLVAR hid_t H5P_CLS_DATASET_CREATE_ID_g; 183 H5_DLLVAR hid_t H5P_CLS_DATASET_ACCESS_ID_g; 184 H5_DLLVAR hid_t H5P_CLS_DATASET_XFER_ID_g; 185 H5_DLLVAR hid_t H5P_CLS_FILE_MOUNT_ID_g; 186 H5_DLLVAR hid_t H5P_CLS_GROUP_CREATE_ID_g; 187 H5_DLLVAR hid_t H5P_CLS_GROUP_ACCESS_ID_g; 188 H5_DLLVAR hid_t H5P_CLS_DATATYPE_CREATE_ID_g; 189 H5_DLLVAR hid_t H5P_CLS_DATATYPE_ACCESS_ID_g; 190 H5_DLLVAR hid_t H5P_CLS_STRING_CREATE_ID_g; 191 H5_DLLVAR hid_t H5P_CLS_ATTRIBUTE_CREATE_ID_g; 192 H5_DLLVAR hid_t H5P_CLS_ATTRIBUTE_ACCESS_ID_g; 193 H5_DLLVAR hid_t H5P_CLS_OBJECT_COPY_ID_g; 194 H5_DLLVAR hid_t H5P_CLS_LINK_CREATE_ID_g; 195 H5_DLLVAR hid_t H5P_CLS_LINK_ACCESS_ID_g; 196 197 /* Default roperty list IDs */ 198 /* (Internal to library, do not use! Use macros above) */ 199 H5_DLLVAR hid_t H5P_LST_FILE_CREATE_ID_g; 200 H5_DLLVAR hid_t H5P_LST_FILE_ACCESS_ID_g; 201 H5_DLLVAR hid_t H5P_LST_DATASET_CREATE_ID_g; 202 H5_DLLVAR hid_t H5P_LST_DATASET_ACCESS_ID_g; 203 H5_DLLVAR hid_t H5P_LST_DATASET_XFER_ID_g; 204 H5_DLLVAR hid_t H5P_LST_FILE_MOUNT_ID_g; 205 H5_DLLVAR hid_t H5P_LST_GROUP_CREATE_ID_g; 206 H5_DLLVAR hid_t H5P_LST_GROUP_ACCESS_ID_g; 207 H5_DLLVAR hid_t H5P_LST_DATATYPE_CREATE_ID_g; 208 H5_DLLVAR hid_t H5P_LST_DATATYPE_ACCESS_ID_g; 209 H5_DLLVAR hid_t H5P_LST_ATTRIBUTE_CREATE_ID_g; 210 H5_DLLVAR hid_t H5P_LST_ATTRIBUTE_ACCESS_ID_g; 211 H5_DLLVAR hid_t H5P_LST_OBJECT_COPY_ID_g; 212 H5_DLLVAR hid_t H5P_LST_LINK_CREATE_ID_g; 213 H5_DLLVAR hid_t H5P_LST_LINK_ACCESS_ID_g; 214 215 /*********************/ 216 /* Public Prototypes */ 217 /*********************/ 218 219 /* Generic property list routines */ 220 H5_DLL hid_t H5Pcreate_class(hid_t parent, const char *name, 221 H5P_cls_create_func_t cls_create, void *create_data, 222 H5P_cls_copy_func_t cls_copy, void *copy_data, 223 H5P_cls_close_func_t cls_close, void *close_data); 224 H5_DLL char *H5Pget_class_name(hid_t pclass_id); 225 H5_DLL hid_t H5Pcreate(hid_t cls_id); 226 H5_DLL herr_t H5Pregister2(hid_t cls_id, const char *name, size_t size, 227 void *def_value, H5P_prp_create_func_t prp_create, 228 H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, 229 H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t prp_copy, 230 H5P_prp_compare_func_t prp_cmp, H5P_prp_close_func_t prp_close); 231 H5_DLL herr_t H5Pinsert2(hid_t plist_id, const char *name, size_t size, 232 void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, 233 H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy, 234 H5P_prp_compare_func_t prp_cmp, H5P_prp_close_func_t prp_close); 235 H5_DLL herr_t H5Pset(hid_t plist_id, const char *name, const void *value); 236 H5_DLL htri_t H5Pexist(hid_t plist_id, const char *name); 237 H5_DLL herr_t H5Pencode(hid_t plist_id, void *buf, size_t *nalloc); 238 H5_DLL hid_t H5Pdecode(const void *buf); 239 H5_DLL herr_t H5Pget_size(hid_t id, const char *name, size_t *size); 240 H5_DLL herr_t H5Pget_nprops(hid_t id, size_t *nprops); 241 H5_DLL hid_t H5Pget_class(hid_t plist_id); 242 H5_DLL hid_t H5Pget_class_parent(hid_t pclass_id); 243 H5_DLL herr_t H5Pget(hid_t plist_id, const char *name, void * value); 244 H5_DLL htri_t H5Pequal(hid_t id1, hid_t id2); 245 H5_DLL htri_t H5Pisa_class(hid_t plist_id, hid_t pclass_id); 246 H5_DLL int H5Piterate(hid_t id, int *idx, H5P_iterate_t iter_func, 247 void *iter_data); 248 H5_DLL herr_t H5Pcopy_prop(hid_t dst_id, hid_t src_id, const char *name); 249 H5_DLL herr_t H5Premove(hid_t plist_id, const char *name); 250 H5_DLL herr_t H5Punregister(hid_t pclass_id, const char *name); 251 H5_DLL herr_t H5Pclose_class(hid_t plist_id); 252 H5_DLL herr_t H5Pclose(hid_t plist_id); 253 H5_DLL hid_t H5Pcopy(hid_t plist_id); 254 255 /* Object creation property list (OCPL) routines */ 256 H5_DLL herr_t H5Pset_attr_phase_change(hid_t plist_id, unsigned max_compact, unsigned min_dense); 257 H5_DLL herr_t H5Pget_attr_phase_change(hid_t plist_id, unsigned *max_compact, unsigned *min_dense); 258 H5_DLL herr_t H5Pset_attr_creation_order(hid_t plist_id, unsigned crt_order_flags); 259 H5_DLL herr_t H5Pget_attr_creation_order(hid_t plist_id, unsigned *crt_order_flags); 260 H5_DLL herr_t H5Pset_obj_track_times(hid_t plist_id, hbool_t track_times); 261 H5_DLL herr_t H5Pget_obj_track_times(hid_t plist_id, hbool_t *track_times); 262 H5_DLL herr_t H5Pmodify_filter(hid_t plist_id, H5Z_filter_t filter, 263 unsigned int flags, size_t cd_nelmts, 264 const unsigned int cd_values[/*cd_nelmts*/]); 265 H5_DLL herr_t H5Pset_filter(hid_t plist_id, H5Z_filter_t filter, 266 unsigned int flags, size_t cd_nelmts, 267 const unsigned int c_values[]); 268 H5_DLL int H5Pget_nfilters(hid_t plist_id); 269 H5_DLL H5Z_filter_t H5Pget_filter2(hid_t plist_id, unsigned filter, 270 unsigned int *flags/*out*/, 271 size_t *cd_nelmts/*out*/, 272 unsigned cd_values[]/*out*/, 273 size_t namelen, char name[], 274 unsigned *filter_config /*out*/); 275 H5_DLL herr_t H5Pget_filter_by_id2(hid_t plist_id, H5Z_filter_t id, 276 unsigned int *flags/*out*/, size_t *cd_nelmts/*out*/, 277 unsigned cd_values[]/*out*/, size_t namelen, char name[]/*out*/, 278 unsigned *filter_config/*out*/); 279 H5_DLL htri_t H5Pall_filters_avail(hid_t plist_id); 280 H5_DLL herr_t H5Premove_filter(hid_t plist_id, H5Z_filter_t filter); 281 H5_DLL herr_t H5Pset_deflate(hid_t plist_id, unsigned aggression); 282 H5_DLL herr_t H5Pset_fletcher32(hid_t plist_id); 283 284 /* File creation property list (FCPL) routines */ 285 H5_DLL herr_t H5Pset_userblock(hid_t plist_id, hsize_t size); 286 H5_DLL herr_t H5Pget_userblock(hid_t plist_id, hsize_t *size); 287 H5_DLL herr_t H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, 288 size_t sizeof_size); 289 H5_DLL herr_t H5Pget_sizes(hid_t plist_id, size_t *sizeof_addr/*out*/, 290 size_t *sizeof_size/*out*/); 291 H5_DLL herr_t H5Pset_sym_k(hid_t plist_id, unsigned ik, unsigned lk); 292 H5_DLL herr_t H5Pget_sym_k(hid_t plist_id, unsigned *ik/*out*/, unsigned *lk/*out*/); 293 H5_DLL herr_t H5Pset_istore_k(hid_t plist_id, unsigned ik); 294 H5_DLL herr_t H5Pget_istore_k(hid_t plist_id, unsigned *ik/*out*/); 295 H5_DLL herr_t H5Pset_shared_mesg_nindexes(hid_t plist_id, unsigned nindexes); 296 H5_DLL herr_t H5Pget_shared_mesg_nindexes(hid_t plist_id, unsigned *nindexes); 297 H5_DLL herr_t H5Pset_shared_mesg_index(hid_t plist_id, unsigned index_num, unsigned mesg_type_flags, unsigned min_mesg_size); 298 H5_DLL herr_t H5Pget_shared_mesg_index(hid_t plist_id, unsigned index_num, unsigned *mesg_type_flags, unsigned *min_mesg_size); 299 H5_DLL herr_t H5Pset_shared_mesg_phase_change(hid_t plist_id, unsigned max_list, unsigned min_btree); 300 H5_DLL herr_t H5Pget_shared_mesg_phase_change(hid_t plist_id, unsigned *max_list, unsigned *min_btree); 301 H5_DLL herr_t H5Pset_file_space_strategy(hid_t plist_id, H5F_fspace_strategy_t strategy, hbool_t persist, hsize_t threshold); 302 H5_DLL herr_t H5Pget_file_space_strategy(hid_t plist_id, H5F_fspace_strategy_t *strategy, hbool_t *persist, hsize_t *threshold); 303 H5_DLL herr_t H5Pset_file_space_page_size(hid_t plist_id, hsize_t fsp_size); 304 H5_DLL herr_t H5Pget_file_space_page_size(hid_t plist_id, hsize_t *fsp_size); 305 306 /* File access property list (FAPL) routines */ 307 H5_DLL herr_t H5Pset_alignment(hid_t fapl_id, hsize_t threshold, 308 hsize_t alignment); 309 H5_DLL herr_t H5Pget_alignment(hid_t fapl_id, hsize_t *threshold/*out*/, 310 hsize_t *alignment/*out*/); 311 H5_DLL herr_t H5Pset_driver(hid_t plist_id, hid_t driver_id, 312 const void *driver_info); 313 H5_DLL hid_t H5Pget_driver(hid_t plist_id); 314 H5_DLL const void *H5Pget_driver_info(hid_t plist_id); 315 H5_DLL herr_t H5Pset_family_offset(hid_t fapl_id, hsize_t offset); 316 H5_DLL herr_t H5Pget_family_offset(hid_t fapl_id, hsize_t *offset); 317 H5_DLL herr_t H5Pset_multi_type(hid_t fapl_id, H5FD_mem_t type); 318 H5_DLL herr_t H5Pget_multi_type(hid_t fapl_id, H5FD_mem_t *type); 319 H5_DLL herr_t H5Pset_cache(hid_t plist_id, int mdc_nelmts, 320 size_t rdcc_nslots, size_t rdcc_nbytes, 321 double rdcc_w0); 322 H5_DLL herr_t H5Pget_cache(hid_t plist_id, 323 int *mdc_nelmts, /* out */ 324 size_t *rdcc_nslots/*out*/, 325 size_t *rdcc_nbytes/*out*/, double *rdcc_w0); 326 H5_DLL herr_t H5Pset_mdc_config(hid_t plist_id, 327 H5AC_cache_config_t * config_ptr); 328 H5_DLL herr_t H5Pget_mdc_config(hid_t plist_id, 329 H5AC_cache_config_t * config_ptr); /* out */ 330 H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref); 331 H5_DLL herr_t H5Pget_gc_references(hid_t fapl_id, unsigned *gc_ref/*out*/); 332 H5_DLL herr_t H5Pset_fclose_degree(hid_t fapl_id, H5F_close_degree_t degree); 333 H5_DLL herr_t H5Pget_fclose_degree(hid_t fapl_id, H5F_close_degree_t *degree); 334 H5_DLL herr_t H5Pset_meta_block_size(hid_t fapl_id, hsize_t size); 335 H5_DLL herr_t H5Pget_meta_block_size(hid_t fapl_id, hsize_t *size/*out*/); 336 H5_DLL herr_t H5Pset_sieve_buf_size(hid_t fapl_id, size_t size); 337 H5_DLL herr_t H5Pget_sieve_buf_size(hid_t fapl_id, size_t *size/*out*/); 338 H5_DLL herr_t H5Pset_small_data_block_size(hid_t fapl_id, hsize_t size); 339 H5_DLL herr_t H5Pget_small_data_block_size(hid_t fapl_id, hsize_t *size/*out*/); 340 H5_DLL herr_t H5Pset_libver_bounds(hid_t plist_id, H5F_libver_t low, 341 H5F_libver_t high); 342 H5_DLL herr_t H5Pget_libver_bounds(hid_t plist_id, H5F_libver_t *low, 343 H5F_libver_t *high); 344 H5_DLL herr_t H5Pset_elink_file_cache_size(hid_t plist_id, unsigned efc_size); 345 H5_DLL herr_t H5Pget_elink_file_cache_size(hid_t plist_id, unsigned *efc_size); 346 H5_DLL herr_t H5Pset_file_image(hid_t fapl_id, void *buf_ptr, size_t buf_len); 347 H5_DLL herr_t H5Pget_file_image(hid_t fapl_id, void **buf_ptr_ptr, size_t *buf_len_ptr); 348 H5_DLL herr_t H5Pset_file_image_callbacks(hid_t fapl_id, 349 H5FD_file_image_callbacks_t *callbacks_ptr); 350 H5_DLL herr_t H5Pget_file_image_callbacks(hid_t fapl_id, 351 H5FD_file_image_callbacks_t *callbacks_ptr); 352 H5_DLL herr_t H5Pset_core_write_tracking(hid_t fapl_id, hbool_t is_enabled, size_t page_size); 353 H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, size_t *page_size); 354 H5_DLL herr_t H5Pset_metadata_read_attempts(hid_t plist_id, unsigned attempts); 355 H5_DLL herr_t H5Pget_metadata_read_attempts(hid_t plist_id, unsigned *attempts); 356 H5_DLL herr_t H5Pset_object_flush_cb(hid_t plist_id, H5F_flush_cb_t func, void *udata); 357 H5_DLL herr_t H5Pget_object_flush_cb(hid_t plist_id, H5F_flush_cb_t *func, void **udata); 358 H5_DLL herr_t H5Pset_mdc_log_options(hid_t plist_id, hbool_t is_enabled, const char *location, hbool_t start_on_access); 359 H5_DLL herr_t H5Pget_mdc_log_options(hid_t plist_id, hbool_t *is_enabled, char *location, size_t *location_size, hbool_t *start_on_access); 360 H5_DLL herr_t H5Pset_evict_on_close(hid_t fapl_id, hbool_t evict_on_close); 361 H5_DLL herr_t H5Pget_evict_on_close(hid_t fapl_id, hbool_t *evict_on_close); 362 #ifdef H5_HAVE_PARALLEL 363 H5_DLL herr_t H5Pset_all_coll_metadata_ops(hid_t plist_id, hbool_t is_collective); 364 H5_DLL herr_t H5Pget_all_coll_metadata_ops(hid_t plist_id, hbool_t *is_collective); 365 H5_DLL herr_t H5Pset_coll_metadata_write(hid_t plist_id, hbool_t is_collective); 366 H5_DLL herr_t H5Pget_coll_metadata_write(hid_t plist_id, hbool_t *is_collective); 367 #endif /* H5_HAVE_PARALLEL */ 368 H5_DLL herr_t H5Pset_mdc_image_config(hid_t plist_id, H5AC_cache_image_config_t *config_ptr); 369 H5_DLL herr_t H5Pget_mdc_image_config(hid_t plist_id, H5AC_cache_image_config_t *config_ptr /*out*/); 370 H5_DLL herr_t H5Pset_page_buffer_size(hid_t plist_id, size_t buf_size, unsigned min_meta_per, unsigned min_raw_per); 371 H5_DLL herr_t H5Pget_page_buffer_size(hid_t plist_id, size_t *buf_size, unsigned *min_meta_per, unsigned *min_raw_per); 372 373 /* Dataset creation property list (DCPL) routines */ 374 H5_DLL herr_t H5Pset_layout(hid_t plist_id, H5D_layout_t layout); 375 H5_DLL H5D_layout_t H5Pget_layout(hid_t plist_id); 376 H5_DLL herr_t H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*/]); 377 H5_DLL int H5Pget_chunk(hid_t plist_id, int max_ndims, hsize_t dim[]/*out*/); 378 H5_DLL herr_t H5Pset_virtual(hid_t dcpl_id, hid_t vspace_id, 379 const char *src_file_name, const char *src_dset_name, hid_t src_space_id); 380 H5_DLL herr_t H5Pget_virtual_count(hid_t dcpl_id, size_t *count/*out*/); 381 H5_DLL hid_t H5Pget_virtual_vspace(hid_t dcpl_id, size_t index); 382 H5_DLL hid_t H5Pget_virtual_srcspace(hid_t dcpl_id, size_t index); 383 H5_DLL ssize_t H5Pget_virtual_filename(hid_t dcpl_id, size_t index, 384 char *name/*out*/, size_t size); 385 H5_DLL ssize_t H5Pget_virtual_dsetname(hid_t dcpl_id, size_t index, 386 char *name/*out*/, size_t size); 387 H5_DLL herr_t H5Pset_external(hid_t plist_id, const char *name, off_t offset, 388 hsize_t size); 389 H5_DLL herr_t H5Pset_chunk_opts(hid_t plist_id, unsigned opts); 390 H5_DLL herr_t H5Pget_chunk_opts(hid_t plist_id, unsigned *opts); 391 H5_DLL int H5Pget_external_count(hid_t plist_id); 392 H5_DLL herr_t H5Pget_external(hid_t plist_id, unsigned idx, size_t name_size, 393 char *name/*out*/, off_t *offset/*out*/, 394 hsize_t *size/*out*/); 395 H5_DLL herr_t H5Pset_szip(hid_t plist_id, unsigned options_mask, unsigned pixels_per_block); 396 H5_DLL herr_t H5Pset_shuffle(hid_t plist_id); 397 H5_DLL herr_t H5Pset_nbit(hid_t plist_id); 398 H5_DLL herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type, int scale_factor); 399 H5_DLL herr_t H5Pset_fill_value(hid_t plist_id, hid_t type_id, 400 const void *value); 401 H5_DLL herr_t H5Pget_fill_value(hid_t plist_id, hid_t type_id, 402 void *value/*out*/); 403 H5_DLL herr_t H5Pfill_value_defined(hid_t plist, H5D_fill_value_t *status); 404 H5_DLL herr_t H5Pset_alloc_time(hid_t plist_id, H5D_alloc_time_t 405 alloc_time); 406 H5_DLL herr_t H5Pget_alloc_time(hid_t plist_id, H5D_alloc_time_t 407 *alloc_time/*out*/); 408 H5_DLL herr_t H5Pset_fill_time(hid_t plist_id, H5D_fill_time_t fill_time); 409 H5_DLL herr_t H5Pget_fill_time(hid_t plist_id, H5D_fill_time_t 410 *fill_time/*out*/); 411 412 /* Dataset access property list (DAPL) routines */ 413 H5_DLL herr_t H5Pset_chunk_cache(hid_t dapl_id, size_t rdcc_nslots, 414 size_t rdcc_nbytes, double rdcc_w0); 415 H5_DLL herr_t H5Pget_chunk_cache(hid_t dapl_id, 416 size_t *rdcc_nslots/*out*/, 417 size_t *rdcc_nbytes/*out*/, 418 double *rdcc_w0/*out*/); 419 H5_DLL herr_t H5Pset_virtual_view(hid_t plist_id, H5D_vds_view_t view); 420 H5_DLL herr_t H5Pget_virtual_view(hid_t plist_id, H5D_vds_view_t *view); 421 H5_DLL herr_t H5Pset_virtual_printf_gap(hid_t plist_id, hsize_t gap_size); 422 H5_DLL herr_t H5Pget_virtual_printf_gap(hid_t plist_id, hsize_t *gap_size); 423 H5_DLL herr_t H5Pset_append_flush(hid_t plist_id, unsigned ndims, 424 const hsize_t boundary[], H5D_append_cb_t func, void *udata); 425 H5_DLL herr_t H5Pget_append_flush(hid_t plist_id, unsigned dims, 426 hsize_t boundary[], H5D_append_cb_t *func, void **udata); 427 H5_DLL herr_t H5Pset_efile_prefix(hid_t dapl_id, const char* prefix); 428 H5_DLL ssize_t H5Pget_efile_prefix(hid_t dapl_id, char* prefix /*out*/, size_t size); 429 430 /* Dataset xfer property list (DXPL) routines */ 431 H5_DLL herr_t H5Pset_data_transform(hid_t plist_id, const char* expression); 432 H5_DLL ssize_t H5Pget_data_transform(hid_t plist_id, char* expression /*out*/, size_t size); 433 H5_DLL herr_t H5Pset_buffer(hid_t plist_id, size_t size, void *tconv, 434 void *bkg); 435 H5_DLL size_t H5Pget_buffer(hid_t plist_id, void **tconv/*out*/, 436 void **bkg/*out*/); 437 H5_DLL herr_t H5Pset_preserve(hid_t plist_id, hbool_t status); 438 H5_DLL int H5Pget_preserve(hid_t plist_id); 439 H5_DLL herr_t H5Pset_edc_check(hid_t plist_id, H5Z_EDC_t check); 440 H5_DLL H5Z_EDC_t H5Pget_edc_check(hid_t plist_id); 441 H5_DLL herr_t H5Pset_filter_callback(hid_t plist_id, H5Z_filter_func_t func, 442 void* op_data); 443 H5_DLL herr_t H5Pset_btree_ratios(hid_t plist_id, double left, double middle, 444 double right); 445 H5_DLL herr_t H5Pget_btree_ratios(hid_t plist_id, double *left/*out*/, 446 double *middle/*out*/, 447 double *right/*out*/); 448 H5_DLL herr_t H5Pset_vlen_mem_manager(hid_t plist_id, 449 H5MM_allocate_t alloc_func, 450 void *alloc_info, H5MM_free_t free_func, 451 void *free_info); 452 H5_DLL herr_t H5Pget_vlen_mem_manager(hid_t plist_id, 453 H5MM_allocate_t *alloc_func, 454 void **alloc_info, 455 H5MM_free_t *free_func, 456 void **free_info); 457 H5_DLL herr_t H5Pset_hyper_vector_size(hid_t fapl_id, size_t size); 458 H5_DLL herr_t H5Pget_hyper_vector_size(hid_t fapl_id, size_t *size/*out*/); 459 H5_DLL herr_t H5Pset_type_conv_cb(hid_t dxpl_id, H5T_conv_except_func_t op, void* operate_data); 460 H5_DLL herr_t H5Pget_type_conv_cb(hid_t dxpl_id, H5T_conv_except_func_t *op, void** operate_data); 461 #ifdef H5_HAVE_PARALLEL 462 H5_DLL herr_t H5Pget_mpio_actual_chunk_opt_mode(hid_t plist_id, H5D_mpio_actual_chunk_opt_mode_t *actual_chunk_opt_mode); 463 H5_DLL herr_t H5Pget_mpio_actual_io_mode(hid_t plist_id, H5D_mpio_actual_io_mode_t *actual_io_mode); 464 H5_DLL herr_t H5Pget_mpio_no_collective_cause(hid_t plist_id, uint32_t *local_no_collective_cause, uint32_t *global_no_collective_cause); 465 #endif /* H5_HAVE_PARALLEL */ 466 467 /* Link creation property list (LCPL) routines */ 468 H5_DLL herr_t H5Pset_create_intermediate_group(hid_t plist_id, unsigned crt_intmd); 469 H5_DLL herr_t H5Pget_create_intermediate_group(hid_t plist_id, unsigned *crt_intmd /*out*/); 470 471 /* Group creation property list (GCPL) routines */ 472 H5_DLL herr_t H5Pset_local_heap_size_hint(hid_t plist_id, size_t size_hint); 473 H5_DLL herr_t H5Pget_local_heap_size_hint(hid_t plist_id, size_t *size_hint /*out*/); 474 H5_DLL herr_t H5Pset_link_phase_change(hid_t plist_id, unsigned max_compact, unsigned min_dense); 475 H5_DLL herr_t H5Pget_link_phase_change(hid_t plist_id, unsigned *max_compact /*out*/, unsigned *min_dense /*out*/); 476 H5_DLL herr_t H5Pset_est_link_info(hid_t plist_id, unsigned est_num_entries, unsigned est_name_len); 477 H5_DLL herr_t H5Pget_est_link_info(hid_t plist_id, unsigned *est_num_entries /* out */, unsigned *est_name_len /* out */); 478 H5_DLL herr_t H5Pset_link_creation_order(hid_t plist_id, unsigned crt_order_flags); 479 H5_DLL herr_t H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_flags /* out */); 480 481 /* String creation property list (STRCPL) routines */ 482 H5_DLL herr_t H5Pset_char_encoding(hid_t plist_id, H5T_cset_t encoding); 483 H5_DLL herr_t H5Pget_char_encoding(hid_t plist_id, H5T_cset_t *encoding /*out*/); 484 485 /* Link access property list (LAPL) routines */ 486 H5_DLL herr_t H5Pset_nlinks(hid_t plist_id, size_t nlinks); 487 H5_DLL herr_t H5Pget_nlinks(hid_t plist_id, size_t *nlinks); 488 H5_DLL herr_t H5Pset_elink_prefix(hid_t plist_id, const char *prefix); 489 H5_DLL ssize_t H5Pget_elink_prefix(hid_t plist_id, char *prefix, size_t size); 490 H5_DLL hid_t H5Pget_elink_fapl(hid_t lapl_id); 491 H5_DLL herr_t H5Pset_elink_fapl(hid_t lapl_id, hid_t fapl_id); 492 H5_DLL herr_t H5Pset_elink_acc_flags(hid_t lapl_id, unsigned flags); 493 H5_DLL herr_t H5Pget_elink_acc_flags(hid_t lapl_id, unsigned *flags); 494 H5_DLL herr_t H5Pset_elink_cb(hid_t lapl_id, H5L_elink_traverse_t func, void *op_data); 495 H5_DLL herr_t H5Pget_elink_cb(hid_t lapl_id, H5L_elink_traverse_t *func, void **op_data); 496 497 /* Object copy property list (OCPYPL) routines */ 498 H5_DLL herr_t H5Pset_copy_object(hid_t plist_id, unsigned crt_intmd); 499 H5_DLL herr_t H5Pget_copy_object(hid_t plist_id, unsigned *crt_intmd /*out*/); 500 H5_DLL herr_t H5Padd_merge_committed_dtype_path(hid_t plist_id, const char *path); 501 H5_DLL herr_t H5Pfree_merge_committed_dtype_paths(hid_t plist_id); 502 H5_DLL herr_t H5Pset_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t func, void *op_data); 503 H5_DLL herr_t H5Pget_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t *func, void **op_data); 504 505 /* Symbols defined for compatibility with previous versions of the HDF5 API. 506 * 507 * Use of these symbols is deprecated. 508 */ 509 #ifndef H5_NO_DEPRECATED_SYMBOLS 510 511 /* Macros */ 512 513 /* We renamed the "root" of the property list class hierarchy */ 514 #define H5P_NO_CLASS H5P_ROOT 515 516 517 /* Typedefs */ 518 519 520 /* Function prototypes */ 521 H5_DLL herr_t H5Pregister1(hid_t cls_id, const char *name, size_t size, 522 void *def_value, H5P_prp_create_func_t prp_create, 523 H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, 524 H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t prp_copy, 525 H5P_prp_close_func_t prp_close); 526 H5_DLL herr_t H5Pinsert1(hid_t plist_id, const char *name, size_t size, 527 void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, 528 H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy, 529 H5P_prp_close_func_t prp_close); 530 H5_DLL H5Z_filter_t H5Pget_filter1(hid_t plist_id, unsigned filter, 531 unsigned int *flags/*out*/, size_t *cd_nelmts/*out*/, 532 unsigned cd_values[]/*out*/, size_t namelen, char name[]); 533 H5_DLL herr_t H5Pget_filter_by_id1(hid_t plist_id, H5Z_filter_t id, 534 unsigned int *flags/*out*/, size_t *cd_nelmts/*out*/, 535 unsigned cd_values[]/*out*/, size_t namelen, char name[]/*out*/); 536 H5_DLL herr_t H5Pget_version(hid_t plist_id, unsigned *boot/*out*/, 537 unsigned *freelist/*out*/, unsigned *stab/*out*/, 538 unsigned *shhdr/*out*/); 539 H5_DLL herr_t H5Pset_file_space(hid_t plist_id, H5F_file_space_type_t strategy, hsize_t threshold); 540 H5_DLL herr_t H5Pget_file_space(hid_t plist_id, H5F_file_space_type_t *strategy, hsize_t *threshold); 541 #endif /* H5_NO_DEPRECATED_SYMBOLS */ 542 543 #ifdef __cplusplus 544 } 545 #endif 546 #endif /* _H5Ppublic_H */ 547 548