SHMEM_INT_IGET(3)

🌸 SHMEM_INT_IGET(3) 🌸

okay bestie, so this page lives in the Open MPI manual (yes, that manual) and it's basically a whole little friend group of routines, not just one. The crew is: shmem_complex_iget(3), shmem_double_iget(3), shmem_float_iget(3), shmem_iget4(3), shmem_iget8(3), shmem_iget32(3), shmem_iget64(3), shmem_iget128(3), shmem_int_iget(3), shmem_integer_iget(3), shmem_logical_iget(3), shmem_long_iget(3), shmem_longdouble_iget(3), shmem_longlong_iget(3), shmem_real_iget(3), shmem_short_iget(3).

πŸ’– NAME πŸ’–

Transfers strided data from a specified processing element (PE). That's the whole vibe β€” strided data, one PE, no cap. πŸ’…


✨ SYNOPSIS ✨

🩡 C or C++

#include <mpp/shmem.h>

void shmem_iget32(void *target, const void *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_iget64(void *target, const void *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_iget128(void *target, const void *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_int_iget(int *target, const int *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_double_iget(double *target, const double *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_float_iget(float *target, const float *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_long_iget(long *target, const long *source,
  ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_longdouble_iget(long double *target,
  const long double *source, ptrdiff_t tst, ptrdiff_t sst,size_t len, int pe)

void shmem_longlong_iget(long long *target,
  const long long *source, ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)

void shmem_short_iget(short *target,
  const short *source, ptrdiff_t tst, ptrdiff_t sst, size_t len, int pe)
bestie I am begging you, copy those signatures character for character. The sst,size_t with no space in shmem_longdouble_iget? That's literally how it's printed on the page. Not me being messy. πŸ™ˆ

🩡 Fortran

INCLUDE "mpp/shmem.fh"

INTEGER tst, sst, len, pe

CALL SHMEM_COMPLEX_IGET(target, source, tst, sst, len,
& pe)

CALL SHMEM_DOUBLE_IGET(target, source, tst, sst, len,
& pe)

CALL SHMEM_IGET4(target, source, tst, sst, len, pe)

CALL SHMEM_IGET8(target, source, tst, sst, len, pe)

CALL SHMEM_IGET32(target, source, tst, sst, len, pe)

CALL SHMEM_IGET64(target, source, tst, sst, len, pe)

CALL SHMEM_IGET128(target, source, tst, sst, len, pe)

CALL SHMEM_INTEGER_IGET(target, source, tst, sst, len,
& pe)

CALL SHMEM_LOGICAL_IGET(target, source, tst, sst, len,
& pe)

CALL SHMEM_REAL_IGET(target, source, tst, sst, len, pe)

πŸ¦‹ DESCRIPTION πŸ¦‹

So the strided get routines (iconic behavior honestly) retrieve array data that's available at the address source on the remote PE (pe). The elements of the source array are separated by a stride sst. Once the data is received, it gets stored at the local memory address target, separated by stride tst. The routines return when the data has been copied into the local target array. Like, actually returned. Done. Copied. Slay. ✨

πŸŽ€ The arguments, bestie

  • target β€” the array to be updated on the local PE. This is the glow-up destination. πŸ’–
  • source β€” the array containing the data to be copied, sitting on the remote PE. Original flavor.
  • tst β€” the stride between consecutive elements of the target array. The stride is scaled by the element size of the target array. A value of 1 indicates contiguous data. tst must be of type integer. If you are calling from Fortran, it must be a default integer value. Yes, defaults only, no custom-vibe integers, sorry. 🫢
  • sst β€” the stride between consecutive elements of the source array. The stride is scaled by the element size of the source array. A value of 1 indicates contiguous data. sst must be of type integer. If you are calling from Fortran, it must be a default integer value. Same rules, other stride, we don't make them.
  • len β€” number of elements in the target and source arrays. len must be of type integer. If you are using Fortran, it must be a constant, variable, or array element of default integer type.
  • pe β€” PE number of the remote PE. pe must be of type integer. If you are using Fortran, it must be a constant, variable, or array element of default integer type. That's the whole address book, right there.

🌈 Type constraints (the vibe check)

The target and source data objects must conform to typing constraints, which are as follows β€” no exceptions, this is the dress code:

  • shmem_iget32, shmem_iget4 β€” any noncharacter type that has a storage size equal to 32 bits.
  • shmem_iget64, shmem_iget8 β€” any noncharacter type that has a storage size equal to 64 bits.
  • shmem_iget128 β€” any noncharacter type that has a storage size equal to 128 bits.
  • shmem_short_iget β€” elements of type short.
  • shmem_int_iget β€” elements of type int.
  • shmem_long_iget β€” elements of type long.
  • shmem_longlong_iget β€” elements of type long long.
  • shmem_float_iget β€” elements of type float.
  • shmem_double_iget β€” elements of type double.
  • shmem_longdouble_iget β€” elements of type long double.
  • SHMEM_COMPLEX_IGET β€” elements of type complex of default size.
  • SHMEM_DOUBLE_IGET β€” (Fortran) elements of type double precision.
  • SHMEM_INTEGER_IGET β€” elements of type integer.
  • SHMEM_LOGICAL_IGET β€” elements of type logical.
  • SHMEM_REAL_IGET β€” elements of type real.

and then, because the page literally says it a second time, here's the encore β€” not me repeating myself, this is canon:

  • shmem_longdouble_iget β€” elements of type long double.
  • SHMEM_COMPLEX_IGET β€” elements of type complex of default size.
  • SHMEM_DOUBLE_IGET β€” (Fortran) elements of type double precision.
  • SHMEM_INTEGER_IGET β€” elements of type integer.
  • SHMEM_LOGICAL_IGET β€” elements of type logical.
  • SHMEM_REAL_IGET β€” elements of type real.

If you are using Fortran, data types must be of default size. For example, a real variable must be declared as REAL, REAL*4, or REAL(KIND=4). Periodt. 🧚


πŸ’œ NOTES πŸ’œ

See intro_shmem(3) for a definition of the term remotely accessible. Go read it, it's important, iykyk.


πŸ“ EXAMPLES πŸ“

The following simple example uses shmem_logical_iget in a Fortran program. Compile this example with the -lsma compiler option. (Don't forget the flag, bestie, or it's giving ✨nothing✨.)

PROGRAM STRIDELOGICAL
  LOGICAL SOURCE(10), TARGET(5)
  SAVE SOURCE ! SAVE MAKES IT REMOTELY ACCESSIBLE
  DATA SOURCE /.T.,.F.,.T.,.F.,.T.,.F.,.T.,.F.,.T.,.F./
  DATA TARGET / 5*.F. /

  CALL START_PES(2)
  IF (MY_PE() .EQ. 0) THEN
    CALL SHMEM_LOGICAL_IGET(TARGET, SOURCE, 1, 2, 5, 1)
    PRINT*,'TARGET AFTER SHMEM_LOGICAL_IGET:',TARGET
  ENDIF
  CALL SHMEM_BARRIER_ALL
END

πŸ‘€ SEE ALSO πŸ‘€

intro_shmem(3) shmem_get(3) shmem_quiet(3)


2003-2026, The Open MPI Community.


and that's the page, bestie!! 🫢 the copyright says 2003-2026, The Open MPI Community, and this whole thing was dated May 14, 2026 under the title SHMEM_INT_IGET(3) from the Open MPI manual. mwah πŸ’‹ go get those strides. πŸ¦‹β­

πŸ“¦ where this page comes from