+The Single-Writer / Multiple-Reader (SWMR) feature enables multiple processes to read an HDF5 file while it is being written to (by a single process) without using locks or requiring communication between processes.
+
+
All communication between processes must be performed via the HDF5 file. The HDF5 file under SWMR access must reside on a system that complies with POSIX write() semantics.
+The basic engineering challenge for this to work was to ensure that the readers of an HDF5 file always see a coherent (though possibly not up to date) HDF5 file.
+The issue is that when writing data there is information in the metadata cache in addition to the physical file on disk:
+
+
However, the readers can only see the state contained in the physical file:
+
+
The SWMR solution implements dependencies on when the metadata can be flushed to the file. This ensures that metadata cache flush operations occur in the proper order, so that there will never be internal file pointers in the physical file that point to invalid (unflushed) file addresses.
+A beneficial side effect of using SWMR access is better fault tolerance. It is more difficult to corrupt a file when using SWMR.
+Error while fetching page properties report data:
+Please be aware that the SWMR feature requires that an HDF5 file be created with the latest file format. See H5P_SET_LIBVER_BOUNDS for more information.
+To use SWMR follow the the general programming model for creating and accessing HDF5 files and objects along with the steps described below.
+The SWMR writer either opens an existing file and objects or creates them as follows.
+Open an existing file:
+Call H5Fopen using the H5F_ACC_SWMR_WRITE flag. +Begin writing datasets. +Periodically flush data. +Create a new file:
+Call H5Fcreate using the latest file format. +Create groups, datasets and attributes, and then close the attributes. +Call H5F_START_SWMR_WRITE to start SWMR access to the file. +Periodically flush data.
+Create the file using the latest file format property:
++ fapl = H5Pcreate (H5P_FILE_ACCESS); + status = H5Pset_libver_bounds (fapl, H5F_LIBVER_LATEST, H5F_LIBVER_LATEST); + fid = H5Fcreate (filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl); +[Create objects (files, datasets, ...). Close any attributes and named datatype objects. Groups and datasets may remain open before starting SWMR access to them.]
+Start SWMR access to the file:
+status = H5Fstart_swmr_write (fid); +Reopen the datasets and start writing, periodically flushing data:
+status = H5Dwrite (dset_id, ...); + status = H5Dflush (dset_id);
+The SWMR reader must continually poll for new data:
+Call H5Fopen using the H5F_ACC_SWMR_READ flag. +Poll, checking the size of the dataset to see if there is new data available for reading. +Read new data, if any.
+Open the file using the SWMR read flag:
+fid = H5Fopen (filename, H5F_ACC_RDONLY | H5F_ACC_SWMR_READ, H5P_DEFAULT); +Open the dataset and then repeatedly poll the dataset, by getting the dimensions, reading new data, and refreshing:
+dset_id = H5Dopen (...); + space_id = H5Dget_space (...); + while (...) { + status = H5Dread (dset_id, ...); + status = H5Drefresh (dset_id); + space_id = H5Dget_space (...); + }
+An HDF5 file under SWMR access must reside on a system that complies with POSIX write() semantics. It is also limited in scope as follows:
+The writer process is only allowed to modify raw data of existing datasets by;
+Appending data along any unlimited dimension. +Modifying existing data +The following operations are not allowed (and the corresponding HDF5 files will fail):
+The writer cannot add new objects to the file. +The writer cannot delete objects in the file. +The writer cannot modify or append data with variable length, string or region reference datatypes. +File space recycling is not allowed. As a result the size of a file modified by a SWMR writer may be larger than a file modified by a non-SWMR writer.
+Two new tools, h5watch and h5clear, are available for use with SWMR. The other HDF5 utilities have also been modified to recognize SWMR:
+The h5watch tool allows a user to monitor the growth of a dataset. +The h5clear tool clears the status flags in the superblock of an HDF5 file. +The rest of the HDF5 tools will exit gracefully but not work with SWMR otherwise.
+A good example of using SWMR is included with the HDF5 tests in the source code. You can run it while reading the file it creates. If you then interrupt the application and reader and look at the resulting file, you will see that the file is still valid. Follow these steps:
+Download the HDF5-1.10 source code to a local directory on a filesystem (that complies with POSIX write() semantics). Build the software. No special configuration options are needed to use SWMR.
+Invoke two command terminal windows. In one window go into the bin/ directory of the built binaries. In the other window go into the test/ directory of the HDF5-1.10 source code that was just built.
+In the window in the test/ directory compile and run use_append_chunk.c. The example writes a three dimensional dataset by planes (with chunks of size 1 x 256 x 256).
+In the other window (in the bin/ directory) run h5watch on the file created by use_append_chunk.c (use_append_chunk.h5). It should be run while use_append_chunk is executing and you will see valid data displayed with h5watch.
+Interrupt use_append_chunk while it is running, and stop h5watch.
+Use h5clear to clear the status flags in the superblock of the HDF5 file (use_append_chunk.h5).
+View the file with h5dump. You will see that it is a valid file even though the application did not close properly. It will contain data up to the point that it was interrupted.
+ + diff --git a/doxygen/examples/intro_VDS.html b/doxygen/examples/intro_VDS.html new file mode 100644 index 00000000000..6e573b9b75c --- /dev/null +++ b/doxygen/examples/intro_VDS.html @@ -0,0 +1,72 @@ + + +The HDF5 Virtual Dataset (VDS) feature enables users to access data in a collection of HDF5 files as a single HDF5 dataset and to use the HDF5 APIs to work with that dataset.
+For example, your data may be collected into four files:
+ +
+
+
You can map the datasets in the four files into a single VDS that can be accessed just like any other dataset:
+ +
+
+
The mapping between a VDS and the HDF5 source datasets is persistent and transparent to an application. If a source file is missing the fill value will be displayed.
+See the Virtual (VDS) Documentation for complete details regarding the VDS feature.
+The VDS feature was implemented using hyperslab selection (H5S_SELECT_HYPERSLAB). See the tutorial on Reading From or Writing to a Subset of a Dataset for more information on selecting hyperslabs.
+Programming Model +To create a Virtual Dataset you simply follow the HDF5 programming model and add a few additional API calls to map the source code datasets to the VDS.
+Following are the steps for creating a Virtual Dataset:
+Create the source datasets that will comprise the VDS +Create the VDS: ‐ Define a datatype and dataspace (can be unlimited) +‐ Define the dataset creation property list (including fill value) +‐ (Repeat for each source dataset) Map elements from the source dataset to elements of the VDS: +Select elements in the source dataset (source selection) +Select elements in the virtual dataset (destination selection) +Map destination selections to source selections (see Functions for Working with a VDS)
+‐ Call H5Dcreate using the properties defined above +Access the VDS as a regular HDF5 dataset +Close the VDS when finished
+Functions for Working with a VDS +The H5P_SET_VIRTUAL API sets the mapping between virtual and source datasets. This is a dataset creation property list. Using this API will change the layout of the dataset to H5D_VIRTUAL. As with specifying any dataset creation property list, an instance of the property list is created, modified, passed into the dataset creation call and then closed:
+dcpl = H5Pcreate (H5P_DATASET_CREATE);
+src_space = H5screate_simple ... + status = H5Sselect_hyperslab (space, ... + status = H5Pset_virtual (dcpl, space, SRC_FILE[i], SRC_DATASET[i], src_space);
+dset = H5Dcreate2 (file, DATASET, H5T_NATIVE_INT, space, H5P_DEFAULT, dcpl, H5P_DEFAULT);
+status = H5Pclose (dcpl); +There are several other APIs introduced with Virtual Datasets, including query functions. For details see the complete list of HDF5 library APIs that support Virtual Datasets
+Limitations +This feature requires HDF5-1.10. +The number of source datasets is unlimited. However, there is a limit on the size of each source dataset.
+Programming Examples +Example 1 +This example creates three HDF5 files, each with a one-dimensional dataset of 6 elements. The datasets in these files are the source datasets that are then used to create a 4 x 6 Virtual Dataset with a fill value of -1. The first three rows of the VDS are mapped to the data from the three source datasets as shown below:
+
In this example the three source datasets are mapped to the VDS with this code:
+src\_space = H5Screate\_simple (RANK1, dims, NULL);
+for (i = 0; i < 3; i++) {
+ start[0] = (hsize\_t)i;
+ /* Select i-th row in the virtual dataset; selection in the source datasets is the same. */
+ status = H5Sselect\_hyperslab (space, H5S\_SELECT\_SET, start, NULL, count, block);
+ status = H5Pset\_virtual (dcpl, space, SRC\_FILE[i], SRC\_DATASET[i], src\_space);
+}
+After the VDS is created and closed, it is reopened. The property list is then queried to determine the layout of the dataset and its mappings, and the data in the VDS is read and printed.
+This example is in the HDF5 source code and can be obtained from here:
+C Example
+For details on compiling an HDF5 application: [ Compiling HDF5 Applications ]
+Example 2 +This example shows how to use a C-style printf statement for specifying multiple source datasets as one virtual dataset. Only one mapping is required. In other words only one H5P_SET_VIRTUAL call is needed to map multiple datasets. It creates a 2-dimensional unlimited VDS. Then it re-opens the file, makes queries, and reads the virtual dataset.
+The source datasets are specified as A-0, A-1, A-2, and A-3. These are mapped to the virtual dataset with one call:
+status = H5Pset\_virtual (dcpl, vspace, SRCFILE, "/A-%b", src\_space);
+The %b indicates that the block count of the selection in the dimension should be used.
+C Example
+For details on compiling an HDF5 application: [ Compiling HDF5 Applications ]
+Using h5dump with a VDS +The h5dump utility can be used to view a VDS. The h5dump output for a VDS looks exactly like that for any other dataset. If h5dump cannot find a source dataset then the fill value will be displayed.
+You can determine that a dataset is a VDS by looking at its properties with h5dump -p. It will display each source dataset mapping, beginning with Mapping 0. Below is an excerpt of the output of h5dump -p on the vds.h5 file created in Example 1.You can see that the entire source file a.h5 is mapped to the first row of the /VDS dataset:
+ +
+
+
+
+
+
+
+
+*/
diff --git a/doxygen/img/tutr-swmr1.png b/doxygen/img/tutr-swmr1.png
new file mode 100755
index 00000000000..711241619d6
Binary files /dev/null and b/doxygen/img/tutr-swmr1.png differ
diff --git a/doxygen/img/tutr-swmr2.png b/doxygen/img/tutr-swmr2.png
new file mode 100755
index 00000000000..15c6b453a7f
Binary files /dev/null and b/doxygen/img/tutr-swmr2.png differ
diff --git a/doxygen/img/tutr-swmr3.png b/doxygen/img/tutr-swmr3.png
new file mode 100755
index 00000000000..973be56b759
Binary files /dev/null and b/doxygen/img/tutr-swmr3.png differ
diff --git a/doxygen/img/tutrvds-ex.png b/doxygen/img/tutrvds-ex.png
new file mode 100755
index 00000000000..c9867c9f331
Binary files /dev/null and b/doxygen/img/tutrvds-ex.png differ
diff --git a/doxygen/img/tutrvds-map.png b/doxygen/img/tutrvds-map.png
new file mode 100755
index 00000000000..9fb2013c3d0
Binary files /dev/null and b/doxygen/img/tutrvds-map.png differ
diff --git a/doxygen/img/tutrvds-multimgs.png b/doxygen/img/tutrvds-multimgs.png
new file mode 100755
index 00000000000..68328cd62cb
Binary files /dev/null and b/doxygen/img/tutrvds-multimgs.png differ
diff --git a/doxygen/img/tutrvds-snglimg.png b/doxygen/img/tutrvds-snglimg.png
new file mode 100755
index 00000000000..249e56c8483
Binary files /dev/null and b/doxygen/img/tutrvds-snglimg.png differ
diff --git a/release_docs/INSTALL b/release_docs/INSTALL
index 0fcbcf71b15..9f0b9b6cc07 100644
--- a/release_docs/INSTALL
+++ b/release_docs/INSTALL
@@ -16,11 +16,12 @@ CONTENTS
--------
1. Obtaining HDF5
2. Third-party Software Requirements
- 2.1. Zlib
- 2.2 Szip (optional)
- 2.3. MPI and MPI-IO
-
-
+ 2.1 zlib
+ 2.2 Szip (optional)
+ 2.3 MPI and MPI-IO
+ 3. HDF5 Source Code and Precompiled Binaries
+ 4. Build and Install HDF5 on Unix and Mac OSX Platforms with Autotools
+ 5. Build and Install HDF5 Libraries and Tools with CMake
*****************************************************************************
@@ -29,11 +30,11 @@ CONTENTS
https://github.com/HDFGroup/hdf5.
2. Third-party Software Requirements
-2.1. Zlib
+2.1. zlib
The HDF5 library includes a predefined compression filter that
uses the "deflate" method for chunked datasets. If zlib-1.1.2 or
later is found, HDF5 will use it. Otherwise, HDF5's predefined
- compression method will degenerate to a no-op; the compression
+ compression method will be disabled; the compression
filter will succeed but the data will not be compressed.
2.2. Szip (optional)
@@ -41,7 +42,7 @@ CONTENTS
uses the extended-Rice lossless compression algorithm for chunked
datasets.
- Building instructions are available with the Szip source code.
+ Szip source code includes build instructions.
The HDF Group does not distribute separate Szip precompiled libraries,
but the HDF5 pre-built binaries provided on The HDF Group download page
@@ -65,15 +66,12 @@ CONTENTS
3. HDF5 Source Code and Precompiled Binaries
The HDF Group provides source code and pre-compiled binaries from the
- HDF5 github releases page:
+ HDF5 GitHub releases page:
https://github.com/HDFGroup/hdf5/releases
-4. Build and Install HDF5 on Unix and Mac OSX Platforms with autotools
+4. Build and Install HDF5 on Unix and Mac OSX Platforms with Autotools
see the release_docs/INSTALL_Autotools.txt file.
-5. Build and Install HDF5 Libraries and tools with CMake
+5. Build and Install HDF5 Libraries and Tools with CMake
see the release_docs/INSTALL_CMake.txt file.
-
-
-
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index bc1f1631a58..4a832e7def0 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -169,15 +169,16 @@ New Features
- Incorporated HDF5 examples repository into HDF5 library.
- The HDF5Examples folder is equivalent to the repository hdf5-examples.
- As such it can build and test the examples during library build or after
- the library is installed. Previously, the hdf5-repository archives were
- downloaded for packaging with the library. Now the examples can be built
+ The HDF5Examples folder is equivalent to the hdf5-examples repository.
+ This enables building and testing the examples
+ during the library build process or after the library has been installed.
+ Previously, the hdf5-examples archives were downloaded
+ for packaging with the library. Now the examples can be built
and tested without a packaged install of the library.
- However to maintain the ability to use the HDF5Examples with an installed
- library, it is necessary to translate or synch the option names from those
- used by the library to those used by the examples. The typical pattern is:
+ However, to maintain the ability to use the HDF5Examples with an installed
+ library, it is necessary to map the option names used by the library
+ to those used by the examples. The typical pattern is: