Skip to content

Commit de1222f

Browse files
committed
doc: add new hint nc_num_aggrs_per_node
1 parent 213999e commit de1222f

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

doc/c-reference/pnetcdf-c.texi

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11027,6 +11027,21 @@ collective read/write functions performs significantly worse than using
1102711027
contiguous buffers. Note if the size of aggregated user buffers is larger than
1102811028
@t{nc_ibuf_size}, packing/unpacking will be disabled to save memory footprint.
1102911029
The default value is 16 MiB.
11030+
@item nc_num_aggrs_per_node
11031+
(version 1.14.0 and later)
11032+
The intra-node aggregation is a new feature introduced in version 1.14.0, which
11033+
is designed for the I/O patterns that contain many noncontiguous requests
11034+
interleaved among processes, and spreading across a wide range of file space.
11035+
It is particularly useful when the number of MPI processes allocated to a
11036+
compute node is large. Setting this hint to a positive integral value to
11037+
indicate the desired number of processes per compute node to be selected as the
11038+
intra-node I/O aggregators. Each process is assigned a unique aggregator. The
11039+
non-aggregators send their requests to the assigned aggregators, and then the
11040+
aggregators make MPI-IO requests to the file. Such strategy can effectively
11041+
reduce communication congestion due to many pending asynchronous messages
11042+
produced in the collective write inside of MPI-IO. Setting this hint to 0
11043+
disables the aggregation, the default mode.
11044+
1103011045
@end table
1103111046

1103211047
@node Utility programs, Summary of C Interface, Run-time Environment Variables, Top

doc/c-reference/pnetcdf-c/PNETCDF_005fHINTS.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,22 @@ <h3 class="heading">Available PnetCDF hints</h3>
209209
<tt>nc_ibuf_size</tt>, packing/unpacking will be disabled to save memory footprint.
210210
The default value is 16 MiB.
211211
</p></dd>
212+
<dt><code>nc_num_aggrs_per_node</code></dt>
213+
<dd><p>(version 1.14.0 and later)
214+
The intra-node aggregation is a new feature introduced in version 1.14.0, which
215+
is designed for the I/O patterns that contain many noncontiguous requests
216+
interleaved among processes, and spreading across a wide range of file space.
217+
It is particularly useful when the number of MPI processes allocated to a
218+
compute node is large. Setting this hint to a positive integral value to
219+
indicate the desired number of processes per compute node to be selected as the
220+
intra-node I/O aggregators. Each process is assigned a unique aggregator. The
221+
non-aggregators send their requests to the assigned aggregators, and then the
222+
aggregators make MPI-IO requests to the file. Such strategy can effectively
223+
reduce communication congestion due to many pending asynchronous messages
224+
produced in the collective write inside of MPI-IO. Setting this hint to 0
225+
disables the aggregation, the default mode.
226+
</p>
227+
</dd>
212228
</dl>
213229

214230
<hr>

0 commit comments

Comments
 (0)