Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for H5Pset_dxpl_mpio_collective_opt() #3594

Merged
merged 2 commits into from
Sep 25, 2023
Merged

Fix docs for H5Pset_dxpl_mpio_collective_opt() #3594

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d91183
Fix docs for H5Pset_dxpl_mpio_collective_opt()
jhendersonHDF Sep 25, 2023
58999c3
Update H5FDmpio.c
brtnfld Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/H5FDmpio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,13 +559,13 @@ H5Pget_dxpl_mpio(hid_t dxpl_id, H5FD_mpio_xfer_t *xfer_mode /*out*/)
/*-------------------------------------------------------------------------
* Function: H5Pset_dxpl_mpio_collective_opt
*
* Purpose: To set a flag to choose linked chunk I/O or multi-chunk I/O
* without involving decision-making inside HDF5
*
* Note: The library will do linked chunk I/O or multi-chunk I/O without
* involving communications for decision-making process.
* The library won't behave as it asks for only when we find
* that the low-level MPI-IO package doesn't support this.
* Purpose: Set the data transfer property list DXPL_ID to use transfer
* mode OPT_MODE during I/O. This allows the application to
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is OPT_MODE defined somewhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OPT_MODE is just referring to the parameter

* specify collective I/O at the HDF5 interface level (with
* the H5Pset_dxpl_mpio routine), while controlling whether
* the actual I/O is performed collectively (e.g., via
* MPI_File_write_at_all) or independently (e.g., via
* MPI_File_write_at).
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down
20 changes: 13 additions & 7 deletions src/H5FDmpio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,18 +164,24 @@ H5_DLL herr_t H5Pget_dxpl_mpio(hid_t dxpl_id, H5FD_mpio_xfer_t *xfer_mode /*out*
/**
* \ingroup DXPL
*
* \brief Sets data transfer mode
* \brief Sets low-level data transfer mode
*
* \dxpl_id
* \param[in] opt_mode Transfer mode
* \returns \herr_t
*
* \details H5Pset_dxpl_mpio() sets the data transfer property list \p dxpl_id
* to use transfer mode xfer_mode. The property list can then be used
* to control the I/O transfer mode during data I/O operations.
*
* Valid transfer modes are #H5FD_MPIO_INDEPENDENT (default) and
* #H5FD_MPIO_COLLECTIVE.
* \details H5Pset_dxpl_mpio_collective_opt() sets the data transfer property
* list \p dxpl_id to use transfer mode \p opt_mode when performing
* I/O. This allows the application to specify collective I/O at the
* HDF5 interface level (with the H5Pset_dxpl_mpio() API routine),
* while controlling whether the actual I/O is performed collectively
* (e.g., via MPI_File_write_at_all) or independently (e.g., via
* MPI_File_write_at). If the collectivity setting at the HDF5
* interface level (set via H5Pset_dxpl_mpio()) is not set to
* H5FD_MPIO_COLLECTIVE, this setting will be ignored.
*
* Valid transfer modes are #H5FD_MPIO_COLLECTIVE_IO (default) and
* #H5FD_MPIO_INDIVIDUAL_IO.
*
* \since 1.4.0
*
Expand Down