mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-27 02:10:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Jan ws changes (#282)

Browse Source 
* OESS-98 convert plugin option to FetchContent, add tests

* Fixes for pkcfg files because of plugin option

* OESS-98 fix tools test for plugins

* Keep doxygen comments under 100 chars long - format hint

* Whitespace

* HDFFV-11144 - Reclassify CMake messages

* HDFFV-11099/11100 added help text

* Reworked switch statement to compare string instead

* Fix typo

* Whitespace fixes except for H5Tprivate.h typo fix
This commit is contained in:
Allen Byrne 2021-01-27 08:15:34 -06:00 committed by GitHub
parent 799ec0fde4
commit 9524dc494f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 114 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

182
src/H5Fpublic.h
View File

@ -1002,7 +1002,8 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <tr>
* <td><em>hbool_t</em> <code>open_trace_file</code> </td>
* <td>OUT: Boolean field indicating whether the <code>trace_file_name</code> field should be used to
* open a trace file for the cache. This field will always be set to <code>0</code> in this context.</td>
* open a trace file for the cache. This field will always be set to <code>0</code> in this
* context.</td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>close_trace_file</code> </td>
@ -1011,7 +1012,8 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <tr>
* <td><em>char*</em><code>trace_file_name</code> </td>
* <td>OUT: Full path name of the trace file to be opened if the <code>open_trace_file</code> field is
* set to <code>1</code>. This field will always be set to the empty string in this context.</td></tr> <tr>
* set to <code>1</code>. This field will always be set to the empty string in this context.</td></tr>
* <tr>
* <td><em>hbool_t</em> <code>evictions_enabled</code> </td>
* <td>OUT: Boolean flag indicating whether metadata cache entry evictions are
* enabled.</td>
@ -1055,9 +1057,9 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <tr>
* <td><em>enum H5C_cache_incr_mode</em> <code>incr_mode</code> </td>
* <td>OUT: Enumerated value indicating the operational mode of the automatic cache size increase code.
* At present, only the following values are legal:<p>\c H5C_incr__off: Automatic cache size increase is
* disabled.</p><p>\c H5C_incr__threshold: Automatic cache size increase is enabled using the hit rate
* threshold algorithm.</p></td>
* At present, only the following values are legal:<p>\c H5C_incr__off: Automatic cache size increase
* is disabled.</p><p>\c H5C_incr__threshold: Automatic cache size increase is enabled using the hit
* rate threshold algorithm.</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>lower_hr_threshold</code> </td>
@ -1084,7 +1086,7 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <td>OUT: Enumerated value indicating the operational mode of the flash cache size increase code. At
* present, only the following values are legal:<p>\c H5C_flash_incr__off: Flash cache size increase is
* disabled.</p><p>\c H5C_flash_incr__add_space: Flash cache size increase is enabled using the add
* space algorithm.</p></td>
* space algorithm.</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>flash_threshold</code> </td>
@ -1096,7 +1098,7 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <td><em>double</em> <code>flash_multiple</code> </td>
* <td>OUT: The factor by which the size of the triggering entry / entry size increase is multiplied to
* obtain the initial cache size increment. This increment may be reduced to reflect existing free
* space in the cache and the <code>max_size</code> field above.</td>
* space in the cache and the <code>max_size</code> field above.</td>
* </tr>
* </table>
*
@ -1108,11 +1110,12 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <tr>
* <td><em>enum H5C_cache_decr_mode</em> <code>decr_mode</code> </td>
* <td>OUT: Enumerated value indicating the operational mode of the automatic cache size decrease code.
* At present, the following values are legal:<p>H5C_decr__off: Automatic cache size decrease is disabled, and
* the remaining decrement fields are ignored.</p><p>H5C_decr__threshold: Automatic cache size decrease is
* enabled using the hit rate threshold algorithm.</p><p>H5C_decr__age_out: Automatic cache size decrease is
* enabled using the ageout algorithm.</p><p>H5C_decr__age_out_with_threshold: Automatic cache size decrease
* is enabled using the ageout with hit rate threshold algorithm</p></td>
* At present, the following values are legal:<p>H5C_decr__off: Automatic cache size decrease is
* disabled, and the remaining decrement fields are ignored.</p><p>H5C_decr__threshold: Automatic
* cache size decrease is enabled using the hit rate threshold algorithm.</p><p>H5C_decr__age_out:
* Automatic cache size decrease is enabled using the ageout algorithm.</p>
* <p>H5C_decr__age_out_with_threshold: Automatic cache size decrease is enabled using the ageout
* with hit rate threshold algorithm</p></td>
* </tr>
* <tr><td><em>double</em> <code>upper_hr_threshold</code> </td>
* <td>OUT: Upper hit rate threshold. This value is only used if the decr_mode is either
@ -1156,7 +1159,7 @@ H5_DLL ssize_t H5Fget_file_image(hid_t file_id, void *buf_ptr, size_t buf_len);
* <td>OUT: Threshold number of bytes of dirty metadata generation for triggering synchronizations of the
* metadata caches serving the target file in the parallel case.<p>Synchronization occurs whenever the
* number of bytes of dirty metadata created since the last synchronization exceeds this
* limit.</p></td>
* limit.</p></td>
* </tr>
* </table>
*
@ -1193,56 +1196,58 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>hbool_t</em> <code>rpt_fcn_enabled</code></td>
* <td>IN: Boolean flag indicating whether the adaptive cache resize report function is enabled. This
* field should almost always be set to disabled (<code>0</code>). Since resize algorithm activity is
* reported via stdout, it MUST be set to disabled (<code>0</code>) on Windows machines.<p>The report function
* is not supported code, and can be expected to change between versions of the library. Use it at your own
* risk.</p></td>
* reported via stdout, it MUST be set to disabled (<code>0</code>) on Windows machines.<p>The report
* function is not supported code, and can be expected to change between versions of the library. Use
* it at your own risk.</p></td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>open_trace_File</code></td>
* <td>IN: Boolean field indicating whether the <code>trace_file_name</code> field should be used to open
* a trace file for the cache.<p>The trace file is a debuging feature that allows the capture of top
* level metadata cache requests for purposes of debugging and/or optimization. This field should normally be
* set to <code>0</code>, as trace file collection imposes considerable overhead.</p><p>This field should only
* be set to <code>1</code> when the <code>trace_file_name</code> contains the full path of the desired trace
* file, and either there is no open trace file on the cache, or the <code>close_trace_file</code>
* field is also <code>1</code>.</p><p>The trace file feature is unsupported unless used at the direction of
* The HDF Group. It is intended to allow The HDF Group to collect a trace of cache activity in cases of
* occult failures and/or poor performance seen in the field, so as to aid in reproduction in the lab. If you
* use it absent the direction of The HDF Group, you are on your own.</p></td>
* level metadata cache requests for purposes of debugging and/or optimization. This field should
* <p>This field should only normally be set to <code>0</code>, as trace file collection imposes
* considerable overhead.</p> be set to <code>1</code> when the <code>trace_file_name</code> contains
* the full path of the desired trace file, and either there is no open trace file on the cache, or the
* <code>close_trace_file</code> field is also <code>1</code>.</p><p>The trace file feature is
* unsupported unless used at the direction of The HDF Group. It is intended to allow The HDF Group to
* collect a trace of cache activity in cases of occult failures and/or poor performance seen in the
* field, so as to aid in reproduction in the lab. If you use it absent the direction of The HDF Group,
* you are on your own.</p></td>
* </tr>
* <tr><td><em>hbool_t</em> <code>close_trace_file</code></td>
* <td>IN: Boolean field indicating whether the current trace file (if any) should be closed.<p>See the
* above comments on the <code>open_trace_file</code> field. This field should be set to
* <code>0</code> unless there is an open trace file on the cache that you wish to close.</p><p>The trace file
* feature is unsupported unless used at the direction of The HDF Group. It is intended to allow The HDF Group
* to collect a trace of cache activity in cases of occult failures and/or poor performance seen in the field,
* so as to aid in reproduction in the lab. If you use it absent the direction of The HDF Group, you are on
* your own.</p></td>
* above comments on the <code>open_trace_file</code> field. This field should be set to
* <code>0</code> unless there is an open trace file on the cache that you wish to close.</p><p>The
* trace file feature is unsupported unless used at the direction of The HDF Group. It is intended to
* allow The HDF Group to collect a trace of cache activity in cases of occult failures and/or poor
* performance seen in the field, so as to aid in reproduction in the lab. If you use it absent the
* direction of The HDF Group, you are on your own.</p></td>
* </tr>
* <tr>
* <td><em>char</em> <code>trace_file_name[]</code></td>
* <td>IN: Full path of the trace file to be opened if the <code>open_trace_file</code> field is set
* to <code>1</code>.<p>In the parallel case, an ascii representation of the mpi rank of the process
* will be appended to the file name to yield a unique trace file name for each process.</p><p>The length of
* the path must not exceed #H5AC__MAX_TRACE_FILE_NAME_LEN characters.</p><p>The trace file feature is
* unsupported unless used at the direction of The HDF Group. It is intended to allow The HDF Group
* to collect a trace of cache activity in cases of occult failures and/or poor performance seen in the field,
* so as to aid in reproduction in the lab. If you use it absent the direction of The HDF Group, you are on
* your own.</p></td>
* will be appended to the file name to yield a unique trace file name for each process.</p><p>The
* length of the path must not exceed #H5AC__MAX_TRACE_FILE_NAME_LEN characters.</p><p>The trace file
* feature is unsupported unless used at the direction of The HDF Group. It is intended to allow The
* HDF Group to collect a trace of cache activity in cases of occult failures and/or poor performance
* seen in the field, so as to aid in reproduction in the lab. If you use it absent the direction of
* The HDF Group, you are on your own.</p></td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>evictions_enabled</code></td>
* <td>IN: A boolean flag indicating whether evictions from the metadata cache are enabled. This flag is
* initially set to enabled (<code>1</code>).<p>In rare circumstances, the raw data throughput
* requirements may be so high that the user wishes to postpone metadata writes so as to reserve I/O
* throughput for raw data. The <code>evictions_enabled</code> field exists to allow this. However, this is an
* extreme step, and you have no business doing it unless you have read the User Guide section on metadata
* caching, and have considered all other options carefully.</p><p>The <code>evictions_enabled</code> field
* may not be set to disabled (<code>0</code>) unless all adaptive cache resizing code is disabled via the
* <code>incr_mode</code>, <code>flash_incr_mode</code>, and <code>decr_mode</code> fields.</p><p>When this
* flag is set to disabled (<code>0</code>), the metadata cache will not attempt to evict entries to make
* space for new entries, and thus will grow without bound.</p><p>Evictions will be re-enabled when
* this field is set back to <code>1</code>. This should be done as soon as possible.</p></td>
* requirements may be so high that the user wishes to postpone metadata writes so as to reserve I/O
* throughput for raw data. The <code>evictions_enabled</code> field exists to allow this. However,
* this is an extreme step, and you have no business doing it unless you have read the User Guide
* section on metadata caching, and have considered all other options carefully.</p><p>The
* <code>evictions_enabled</code> field may not be set to disabled (<code>0</code>) unless all adaptive
* cache resizing code is disabled via the <code>incr_mode</code>, <code>flash_incr_mode</code>, and
* <code>decr_mode</code> fields.</p><p>When this flag is set to disabled (<code>0</code>), the
* metadata cache will not attempt to evict entries to make space for new entries, and thus will grow
* without bound.</p><p>Evictions will be re-enabled when this field is set back to <code>1</code>.
* This should be done as soon as possible.</p></td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>set_initial_size</code></td>
@ -1253,23 +1258,23 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>size_t</em> <code>initial_size</code></td>
* <td>IN: If <code>set_initial_size</code> is set to <code>1</code>, then <code>initial_size</code> must
* contain the desired initial size in bytes. This value must lie in the closed interval
* <code>[min_size, max_size]</code>. (see below)</td>
* <code>[min_size, max_size]</code>. (see below)</td>
* </tr>
* <tr><td><em>double</em> <code>min_clean_fraction</code></td>
* <td>IN: This field specifies the minimum fraction of the cache that must be kept either clean or
* empty.<p>The value must lie in the interval [0.0, 1.0]. 0.01 is a good place to start in the serial
* case. In the parallel case, a larger value is needed -- see <a
* href="/display/HDF5/Metadata+Caching+in+HDF5">Metadata Caching in HDF5</a> in the collection "Advanced
* Topics in HDF5."</p></td>
* case. In the parallel case, a larger value is needed -- see <a
* href="/display/HDF5/Metadata+Caching+in+HDF5">Metadata Caching in HDF5</a> in the collection
* "Advanced Topics in HDF5."</p></td>
* </tr>
* <tr><td><em>size_t</em> <code>max_size</code></td>
* <td>IN: Upper bound (in bytes) on the range of values that the adaptive cache resize code can select
* as the maximum cache size.</td>
* as the maximum cache size.</td>
* </tr>
* <tr>
* <td><em>size_t</em> <code>min_size</code></td>
* <td>IN: Lower bound (in bytes) on the range of values that the adaptive cache resize code can select
* as the maximum cache size.</td>
* as the maximum cache size.</td>
* </tr>
* <tr><td><em>long int</em> <code>epoch_length</code></td>
* <td>IN: Number of cache accesses between runs of the adaptive cache resize code. 50,000 is a good
@ -1283,24 +1288,24 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>enum H5C_cache_incr_mode</em> <code>incr_mode</code></td>
* <td>IN: Enumerated value indicating the operational mode of the automatic cache size increase code. At
* present, only two values are legal:<p>\c H5C_incr__off: Automatic cache size increase is disabled,
* and the remaining increment fields are ignored.</p><p>\c H5C_incr__threshold: Automatic cache size increase
* is enabled using the hit rate threshold algorithm.</p></td>
* and the remaining increment fields are ignored.</p><p>\c H5C_incr__threshold: Automatic cache size
* increase is enabled using the hit rate threshold algorithm.</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>lower_hr_threshold</code></td>
* <td>IN: Hit rate threshold used by the hit rate threshold cache size increment algorithm.<p>When the
* hit rate over an epoch is below this threshold and the cache is full, the maximum size of the
* cache is multiplied by increment (below), and then clipped as necessary to stay within max_size, and
* possibly max_increment.</p><p>This field must lie in the interval [0.0, 1.0]. 0.8 or 0.9 is a good starting
* point.</p></td>
* hit rate over an epoch is below this threshold and the cache is full, the maximum size of the
* cache is multiplied by increment (below), and then clipped as necessary to stay within max_size, and
* possibly max_increment.</p><p>This field must lie in the interval [0.0, 1.0]. 0.8 or 0.9 is a good
* starting point.</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>increment</code></td>
* <td>IN: Factor by which the hit rate threshold cache size increment algorithm multiplies the current
* maximum cache size to obtain a tentative new cache size.<p>The actual cache size increase will be
* clipped to satisfy the max_size specified in the general configuration, and possibly max_increment
* below.</p><p>The parameter must be greater than or equal to 1.0 -- 2.0 is a reasonable value.</p><p>If you
* set it to 1.0, you will effectively disable cache size increases.</p></td>
* clipped to satisfy the max_size specified in the general configuration, and possibly max_increment
* below.</p><p>The parameter must be greater than or equal to 1.0 -- 2.0 is a reasonable
* value.</p><p>If you set it to 1.0, you will effectively disable cache size increases.</p></td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>apply_max_increment</code></td>
@ -1316,21 +1321,21 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>enum H5C_cache_flash_incr_mode</em> <code>flash_incr_mode</code></td>
* <td>IN: Enumerated value indicating the operational mode of the flash cache size increase code. At
* present, only the following values are legal:<p>\c H5C_flash_incr__off: Flash cache size increase is
* disabled.</p><p>\c H5C_flash_incr__add_space: Flash cache size increase is enabled using the add
* space algorithm.</p></td>
* disabled.</p><p>\c H5C_flash_incr__add_space: Flash cache size increase is enabled using the add
* space algorithm.</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>flash_threshold</code></td>
* <td>IN: The factor by which the current maximum cache size is multiplied to obtain the minimum size
* entry / entry size increase which may trigger a flash cache size increase.<p>At present, this value
* must lie in the range [0.1, 1.0].</p></td>
* must lie in the range [0.1, 1.0].</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>flash_multiple</code></td>
* <td>IN: The factor by which the size of the triggering entry / entry size increase is multiplied to
* obtain the initial cache size increment. This increment may be reduced to reflect existing free
* space in the cache and the <code>max_size</code> field above.<p>At present, this field must lie in the
* range [0.1, 10.0].</p></td>
* space in the cache and the <code>max_size</code> field above.<p>At present, this field must lie in
* the range [0.1, 10.0].</p></td>
* </tr>
* </table>
*
@ -1340,29 +1345,30 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>enum H5C_cache_decr_mode</em> <code>decr_mode</code></td>
* <td>IN: Enumerated value indicating the operational mode of the automatic cache size decrease code. At
* present, the following values are legal:<p>\c H5C_decr__off: Automatic cache size decrease is
* disabled.</p><p>\c H5C_decr__threshold: Automatic cache size decrease is enabled using the hit
* rate threshold algorithm.</p><p>\c H5C_decr__age_out: Automatic cache size decrease is enabled using the
* ageout algorithm.</p><p>\c H5C_decr__age_out_with_threshold: Automatic cache size decrease is enabled using
* the ageout with hit rate threshold algorithm</p></td>
* disabled.</p><p>\c H5C_decr__threshold: Automatic cache size decrease is enabled using the hit
* rate threshold algorithm.</p><p>\c H5C_decr__age_out: Automatic cache size decrease is enabled using
* the ageout algorithm.</p><p>\c H5C_decr__age_out_with_threshold: Automatic cache size decrease is
* enabled using the ageout with hit rate threshold algorithm</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>upper_hr_threshold</code></td>
* <td>IN: Hit rate threshold for the hit rate threshold and ageout with hit rate threshold cache size
* decrement algorithms.<p>When \c decr_mode is \c H5C_decr__threshold, and the hit rate over a given
* epoch exceeds the supplied threshold, the current maximum cache size is multiplied by decrement to obtain a
* tentative new (and smaller) maximum cache size.</p><p>When \c decr_mode is \c
* H5C_decr__age_out_with_threshold, there is no attempt to find and evict aged out entries unless the hit
* rate in the previous epoch exceeded the supplied threshold.</p><p>This field must lie in the interval
* [0.0, 1.0].</p><p>For \c H5C_incr__threshold, .9995 or .99995 is a good place to start.</p><p>For \c
* H5C_decr__age_out_with_threshold, .999 might be more useful.</p></td>
* epoch exceeds the supplied threshold, the current maximum cache size is multiplied by decrement to
* obtain a tentative new (and smaller) maximum cache size.</p><p>When \c decr_mode is \c
* H5C_decr__age_out_with_threshold, there is no attempt to find and evict aged out entries unless the
* hit rate in the previous epoch exceeded the supplied threshold.</p><p>This field must lie in the
* interval [0.0, 1.0].</p><p>For \c H5C_incr__threshold, .9995 or .99995 is a good place to
* start.</p><p>For \c H5C_decr__age_out_with_threshold, .999 might be more useful.</p></td>
* </tr>
* <tr>
* <td><em>double</em> <code>decrement</code></td>
* <td>IN: In the hit rate threshold cache size decrease algorithm, this parameter contains the factor by
* which the current max cache size is multiplied to produce a tentative new cache size.<p>The actual
* cache size decrease will be clipped to satisfy the min_size specified in the general configuration, and
* possibly max_decrement below.</p><p>The parameter must be be in the interval [0.0, 1.0].</p><p>If you set
* it to 1.0, you will effectively disable cache size decreases. 0.9 is a reasonable starting point.</p></td>
* cache size decrease will be clipped to satisfy the min_size specified in the general configuration,
* and possibly max_decrement below.</p><p>The parameter must be be in the interval
* [0.0, 1.0].</p><p>If you set it to 1.0, you will effectively disable cache size decreases. 0.9 is a
* reasonable starting point.</p></td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>apply_max_decrement</code></td>
@ -1378,7 +1384,7 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>int</em> <code>epochs_before_eviction</code></td>
* <td>IN: In the ageout based cache size reduction algorithms, this field contains the minimum number of
* epochs an entry must remain unaccessed in cache before the cache size reduction algorithm tries to
* evict it. 3 is a reasonable value.</td>
* evict it. 3 is a reasonable value.</td>
* </tr>
* <tr>
* <td><em>hbool_t</em> <code>apply_empty_reserve</code></td>
@ -1388,9 +1394,9 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <tr>
* <td><em>double</em> <code>empty_reserve</code></td>
* <td>IN: Empty reserve as a fraction of maximum cache size if applicable.<p>When so directed, the
* ageout based algorithms will not decrease the maximum cache size unless the empty reserve can be
* met.</p><p>The parameter must lie in the interval [0.0, 1.0]. 0.1 or 0.05 is a good place to
* start.</p></td>
* ageout based algorithms will not decrease the maximum cache size unless the empty reserve can be
* met.</p><p>The parameter must lie in the interval [0.0, 1.0]. 0.1 or 0.05 is a good place to
* start.</p></td>
* </tr>
* </table>
*
@ -1400,11 +1406,11 @@ H5_DLL herr_t H5Fget_mdc_config(hid_t file_id, H5AC_cache_config_t *config_ptr);
* <td><em>int</em> <code>dirty_bytes_threshold</code></td>
* <td>IN: Threshold number of bytes of dirty metadata generation for triggering synchronizations of the
* metadata caches serving the target file in the parallel case.<p>Synchronization occurs whenever the
* number of bytes of dirty metadata created since the last synchronization exceeds this limit.</p><p>This
* field only applies to the parallel case. While it is ignored elsewhere, it can still draw a value out of
* bounds error.</p><p>It must be consistant across all caches on any given file.</p><p>By default, this field
* is set to 256 KB. It shouldn't be more than half the current maximum cache size times the minimum clean
* fraction.</p></td>
* number of bytes of dirty metadata created since the last synchronization exceeds this
* limit.</p><p>This field only applies to the parallel case. While it is ignored elsewhere, it can
* still draw a value out of bounds error.</p><p>It must be consistant across all caches on any given
* file.</p><p>By default, this field is set to 256 KB. It shouldn't be more than half the current
* maximum cache size times the minimum clean fraction.</p></td>
* </tr>
* </table>
*
@ -1647,7 +1653,7 @@ H5_DLL herr_t H5Fget_info2(hid_t obj_id, H5F_info2_t *file_info);
* <tr><td>19</td><td>Fixed array data block page</td></tr>
* <tr><td>20</td><td>File's superblock (version 2)</td></tr>
* <tr><td colspan=2><sup>*</sup> All entries are of version 0 (zero) unless indicated
* otherwise.</td></tr>
* otherwise.</td></tr>
* </table>
*
* \note On a system that is not atomic, the library might possibly read inconsistent

6
src/H5Spkg.h
View File

@ -138,10 +138,10 @@ struct H5S_pnt_list_t {
H5S_pnt_node_t *head; /* Pointer to head of point list */
H5S_pnt_node_t *tail; /* Pointer to tail of point list */
hsize_t last_idx; /* Index of the point after the last returned from H5S__get_select_elem_pointlist() */
hsize_t last_idx; /* Index of the point after the last returned from H5S__get_select_elem_pointlist() */
H5S_pnt_node_t *last_idx_pnt; /* Point after the last returned from H5S__get_select_elem_pointlist().
* If we ever add a way to remove points or add points in the middle of
* the pointlist we will need to invalidate these fields. */
* If we ever add a way to remove points or add points in the middle of
* the pointlist we will need to invalidate these fields. */
};
/* Information about hyperslab spans */

16
src/H5Spoint.c
View File

@ -844,7 +844,7 @@ H5S__copy_pnt_list(const H5S_pnt_list_t *src, unsigned rank)
H5MM_memcpy(dst->low_bounds, src->low_bounds, (rank * sizeof(hsize_t)));
/* Clear cached iteration point */
dst->last_idx = 0;
dst->last_idx = 0;
dst->last_idx_pnt = NULL;
/* Set return value */
@ -1516,8 +1516,8 @@ static herr_t
H5S__get_select_elem_pointlist(const H5S_t *space, hsize_t startpoint, hsize_t numpoints, hsize_t *buf)
{
const hsize_t endpoint = startpoint + numpoints; /* Index of last point in iteration */
H5S_pnt_node_t *node; /* Point node */
unsigned rank; /* Dataspace rank */
H5S_pnt_node_t *node; /* Point node */
unsigned rank; /* Dataspace rank */
FUNC_ENTER_STATIC_NOERR
@ -1528,8 +1528,8 @@ H5S__get_select_elem_pointlist(const H5S_t *space, hsize_t startpoint, hsize_t n
rank = space->extent.rank;
/* Check for cached point at the correct index */
if(space->select.sel_info.pnt_lst->last_idx_pnt
&& startpoint == space->select.sel_info.pnt_lst->last_idx)
if (space->select.sel_info.pnt_lst->last_idx_pnt &&
startpoint == space->select.sel_info.pnt_lst->last_idx)
node = space->select.sel_info.pnt_lst->last_idx_pnt;
else {
/* Get the head of the point list */
@ -1540,7 +1540,7 @@ H5S__get_select_elem_pointlist(const H5S_t *space, hsize_t startpoint, hsize_t n
startpoint--;
node = node->next;
} /* end while */
} /* end else */
} /* end else */
/* Iterate through the node, copying each point's information */
while (node != NULL && numpoints > 0) {
@ -1551,7 +1551,7 @@ H5S__get_select_elem_pointlist(const H5S_t *space, hsize_t startpoint, hsize_t n
} /* end while */
/* Cached next point in iteration */
space->select.sel_info.pnt_lst->last_idx = endpoint;
space->select.sel_info.pnt_lst->last_idx = endpoint;
space->select.sel_info.pnt_lst->last_idx_pnt = node;
FUNC_LEAVE_NOAPI(SUCCEED)
@ -2347,7 +2347,7 @@ H5S__point_project_simple(const H5S_t *base_space, H5S_t *new_space, hsize_t *of
} /* end else */
/* Clear cached iteration point */
new_space->select.sel_info.pnt_lst->last_idx = 0;
new_space->select.sel_info.pnt_lst->last_idx = 0;
new_space->select.sel_info.pnt_lst->last_idx_pnt = NULL;
/* Number of elements selected will be the same */

2
src/H5T.c
View File

@ -3498,7 +3498,7 @@ H5T__initiate_copy(const H5T_t *old_dt)
(void)H5VL_object_inc_rc(new_dt->shared->owned_vol_obj);
/* Reset vol_obj field */
new_dt->vol_obj = NULL;
new_dt->vol_obj = NULL;
/* Set return value */
ret_value = new_dt;

3
src/H5TS.c
View File

@ -405,8 +405,7 @@ H5TS__mutex_acquire(H5TS_mutex_t *mutex, unsigned int lock_count, hbool_t *acqui
*--------------------------------------------------------------------------
*/
herr_t
H5TSmutex_acquire(unsigned int lock_count, hbool_t *acquired)
{
H5TSmutex_acquire(unsigned int lock_count, hbool_t *acquired){
FUNC_ENTER_API_NAMECHECK_ONLY
/*NO TRACE*/

2
src/H5Tprivate.h
View File

@ -41,7 +41,7 @@ typedef struct H5T_t H5T_t;
#define H5T_GET_SHARED(T) ((T)->shared)
#define H5T_GET_MEMBER_OFFSET(T, I) ((T)->u.compnd.memb[I].offset)
#define H5T_GET_MEMBER_SIZE(T, I) ((T)->u.compnd.memb[I].shared->size)
#define H5T_GET_FORCE_CONV(T) ((T)>shared->force_conv)
#define H5T_GET_FORCE_CONV(T) ((T)->shared->force_conv)
#else /* H5T_MODULE */
#define H5T_GET_SIZE(T) (H5T_get_size(T))
#define H5T_GET_SHARED(T) (H5T_get_shared(T))

2
src/H5Tref.c
View File

@ -182,7 +182,7 @@ H5T__ref_set_loc(H5T_t *dt, H5VL_object_t *file, H5T_loc_t loc)
/* Release owned file */
if (dt->shared->owned_vol_obj) {
if(H5VL_free_object(dt->shared->owned_vol_obj) < 0)
if (H5VL_free_object(dt->shared->owned_vol_obj) < 0)
HGOTO_ERROR(H5E_REFERENCE, H5E_CANTCLOSEOBJ, FAIL, "unable to close owned VOL object")
dt->shared->owned_vol_obj = NULL;
} /* end if */

2
src/H5Tvlen.c
View File

@ -284,7 +284,7 @@ H5T__vlen_set_loc(H5T_t *dt, H5VL_object_t *file, H5T_loc_t loc)
/* Release owned file */
if (dt->shared->owned_vol_obj) {
if(H5VL_free_object(dt->shared->owned_vol_obj) < 0)
if (H5VL_free_object(dt->shared->owned_vol_obj) < 0)
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTCLOSEOBJ, FAIL, "unable to close owned VOL object")
dt->shared->owned_vol_obj = NULL;
} /* end if */

3
src/H5VL.c
View File

@ -685,7 +685,8 @@ H5VLget_file_type(void *file_obj, hid_t connector_id, hid_t dtype_id)
/* Create VOL object for file if necessary (force_conv will be TRUE if and
* only if file needs to be passed to H5T_set_loc) */
if (H5T_GET_FORCE_CONV(dtype) && (NULL == (file_vol_obj = H5VL_create_object_using_vol_id(H5I_FILE, file_obj, connector_id))))
if (H5T_GET_FORCE_CONV(dtype) &&
(NULL == (file_vol_obj = H5VL_create_object_using_vol_id(H5I_FILE, file_obj, connector_id))))
HGOTO_ERROR(H5E_VOL, H5E_CANTCREATE, FAIL, "can't create VOL object")
/* Copy the datatype */

2
src/H5VLint.c
View File

@ -1023,7 +1023,7 @@ H5VL_free_object(H5VL_object_t *vol_obj)
/* Check arguments */
HDassert(vol_obj);
if(--vol_obj->rc == 0) {
if (--vol_obj->rc == 0) {
/* Decrement refcount on connector */
if (H5VL_conn_dec_rc(vol_obj->connector) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "unable to decrement ref count on VOL connector")

2
src/H5VLprivate.h
View File

@ -37,7 +37,7 @@ typedef struct H5VL_t {
typedef struct H5VL_object_t {
void * data; /* Pointer to connector-managed data for this object */
H5VL_t *connector; /* Pointer to VOL connector struct */
size_t rc; /* Reference count */
size_t rc; /* Reference count */
} H5VL_object_t;
/* Internal structure to hold the connector ID & info for FAPLs */