_gfortran_caf_sendget_by_ref (The GNU Fortran Compiler)

#### 7.2.17 `_gfortran_caf_sendget_by_ref` — Sending data between remote images using enhanced references on both sides ¶

Synopsis:

  `void _gfortran_caf_sendget_by_ref (caf_token_t dst_token, int dst_image_index, caf_reference_t *dst_refs, caf_token_t src_token, int src_image_index, caf_reference_t *src_refs, int dst_kind, int src_kind, bool may_require_tmp, int *dst_stat, int *src_stat, int dst_type, int src_type)`

Description:

  Called to send a scalar, an array section or a whole array from a remote image identified by the src_image_index to a remote image identified by the dst_image_index.

Arguments:

  dst_token | intent(in) An opaque pointer identifying the destination coarray.
  dst_image_index | intent(in) The ID of the destination remote image; must be a positive number.
  dst_refs | intent(in) The references on the remote array to store the data given by the source. Guaranteed to have at least one entry.
  src_token | intent(in) An opaque pointer identifying the source coarray.
  src_image_index | intent(in) The ID of the source remote image; must be a positive number.
  src_refs | intent(in) The references to apply to the remote structure to get the data.
  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 `false` when it is known at compile time that the dest and src either cannot overlap or overlap (fully or partially) such that walking src and dest in elementwise order (honoring the stride value) does not lead to wrong results. Otherwise, the value is `true`.
  dst_stat | intent(out) when non-`NULL` give the result of the send-operation, i.e., zero on success and nonzero on error. When `NULL` and an error occurs, then an error message is printed and the program is terminated.
  src_stat | intent(out) When non-`NULL` give the result of the get-operation, i.e., zero on success and nonzero on error. When `NULL` and an error occurs, then an error message is printed and the program is terminated.
  dst_type | intent(in) Give the type of the destination. When the destination is not an array, than the precise type, e.g. of a component in a derived type, is not known, but provided here.
  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.

Notes:

  It is permitted to have the same image index for both src_image_index and dst_image_index; 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 contiguous and `memmove` takes care of overlap issues).

  Note that the assignment of a scalar to an array is permitted. In addition, 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.