Skip to content

Commit ba1f925

Browse files
committed
data_mgmt: Clarify pack/unpack error detection in hetero envs
It is possible that an implementation could detect heterogenous packing issues if, for example, the destination process (and arch) is known ahead of time. Soften this language from "cannot be detected" to "may not be detected". Fixes #507 Signed-off-by: Ken Raffenetti <[email protected]>
1 parent 46c63a5 commit ba1f925

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Chap_API_Data_Mgmt.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ \subsection{\code{PMIx_Data_pack}}
210210
with heterogeneity issues between the packer and unpacker in such
211211
cases. Sending a value outside the range of values that can be handled by the recipient
212212
will return an error code (generated upon unpacking) ---
213-
the error cannot be detected during packing.
213+
the error may not be detected during packing.
214214

215215
The namespace of the intended recipient of the packed buffer (i.e., the
216216
process that will be unpacking it) is used solely to resolve any data type
@@ -271,7 +271,7 @@ \subsection{\code{PMIx_Data_unpack}}
271271

272272
Warning: The caller is responsible for providing adequate memory storage for the requested data. The user must provide a parameter indicating the maximum number of values that can be unpacked into the allocated memory. If more values exist in the buffer than can fit into the memory storage, then the function will unpack what it can fit into that location and return an error code indicating that the buffer was only partially unpacked.
273273

274-
Note that any data that is packed using a type that does not explicitly specify its size may lose precision when unpacked by a non-homogeneous recipient. \ac{PMIx} will do its best to deal with heterogeneity issues between the packer and unpacker in such cases. Sending a value outside the range of values that can be handled by the recipient will return an error code generated upon unpacking --- these errors cannot be detected during packing.
274+
Note that any data that is packed using a type that does not explicitly specify its size may lose precision when unpacked by a non-homogeneous recipient. \ac{PMIx} will do its best to deal with heterogeneity issues between the packer and unpacker in such cases. Sending a value outside the range of values that can be handled by the recipient will return an error code generated upon unpacking --- these errors may not be detected during packing.
275275

276276
The namespace of the process that packed the buffer is used solely to resolve any data type
277277
differences between \ac{PMIx} versions. The packer must, therefore, be

0 commit comments

Comments
 (0)