_gfortran_caf_get_by_ref— Getting data from a remote image using enhanced references
Called to get a scalar, an array section or a whole array from a remote image identified by the image_index.
void _gfortran_caf_get_by_ref (caf_token_t token, int image_index,
caf_reference_t *refs, gfc_descriptor_t *dst, int dst_kind, int src_kind,
bool may_require_tmp, bool dst_reallocatable, int *stat, int src_type)
|token||intent(in) An opaque pointer identifying the coarray.|
|image_index||intent(in) The ID of the remote image; must be a positive number.|
|refs||intent(in) The references to apply to the remote structure to get the data.|
|dst||intent(in) Array descriptor of the local array to store the data transferred from the remote image. May be reallocated where needed and when DST_REALLOCATABLE allows it.|
|dst_kind||intent(in) Kind of the destination argument|
|src_kind||intent(in) Kind of the source argument|
|may_require_tmp||intent(in) The variable is |
|dst_reallocatable||intent(in) Set when DST is of allocatable or pointer type and its refs allow reallocation, i.e., the full array or a component is referenced.|
|stat||intent(out) When non-|
|src_type||intent(in) Give the type of the source. When the source is not an array, than the precise type, e.g. of a component in a derived type, is not known, but provided here.|
It is permitted to have
image_index equal the current image; the memory
of the send-to and the send-from might (partially) overlap in that case. The
implementation has to take care that it handles this case, e.g. using
memmove which handles (partially) overlapping memory. If
may_require_tmp is true, the library might additionally create a
temporary variable, unless additional checks show that this is not required
(e.g. because walking backward is possible or because both arrays are
memmove takes care of overlap issues).
Note that the library has to handle numeric-type conversion and for strings, padding and different character kinds.
Because of the more complicated references possible some operations may be unsupported by certain libraries. The library is expected to issue a precise error message why the operation is not permitted.