SHMEM_IPUT128(3)

📦
version 26.9 · 7 versions
, in arch rolling

💖 SHMEM_IPUT128(3) 💖

okay so this is the Open MPI manual page for the whole shmem_*_iput family — yes, the header says SHMEM_IPUT128(3) but it's a package deal, bestie 🫶

✨ NAME ✨

The whole girl squad, all in one place:

…and what do they all do? Transfer strided data to a specified processing element (PE). periodt 💅

🌸 SYNOPSIS 🌸

C or C++ 🎀

#include <mpp/shmem.h>

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

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

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

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

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

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

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

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

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

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

Fortran 🦋

INCLUDE "mpp/shmem.fh"

INTEGER tst, sst, len, pe

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

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

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

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

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

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

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

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

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

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

🦋 DESCRIPTION 🦋

okay so picture this: the shmem_iput routines read the elements of a local array (source) and write them to a remote array (target) on the PE indicated by pe. that's the whole vibe ✨

real talk though — these routines return when the data has been copied out of the source array on the local PE, but not necessarily before the data has actually been delivered to the remote data object. so like… the local part is done, the remote part is on its way. don't @ me 😭

the arguments 🎀

  • target — the array that gets updated on the remote PE. this data object must be remotely accessible. non-negotiable bestie.
  • source — the array holding the data to be copied. it's giving "the origin of the whole situation."
  • 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 means contiguous data. tst must be of type integer. if you're doing Fortran, it has to be a default integer value.
  • 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 means contiguous data. sst must be of type integer. and again, Fortran girlies: default integer value, please.
  • len — number of elements in the target and source arrays. len must be of type integer. Fortran: it must be a constant, variable, or array element of default integer type. 💅
  • pe — the PE number of the remote PE. pe must be of type integer. Fortran: constant, variable, or array element of default integer type. same energy as above, no cap.

typing constraints (the vibe check) 🌈

the target and source data objects must conform to these, or it's not happening:

  • shmem_iput32, shmem_iput4 — any noncharacter type that has a storage size equal to 32 bits.
  • shmem_iput64, shmem_iput8 — any noncharacter type that has a storage size equal to 64 bits.
  • shmem_iput128 — any noncharacter type that has a storage size equal to 128 bits.
  • shmem_short_iput — elements of type short.
  • shmem_int_iput — elements of type int.
  • shmem_long_iput — elements of type long.
  • shmem_longlong_iput — elements of type long long.
  • shmem_float_iput — elements of type float.
  • shmem_double_iput — elements of type double.
  • shmem_longdouble_iput — elements of type long double.
  • SHMEM_COMPLEX_IPUT — elements of type complex of default size.
  • SHMEM_DOUBLE_IPUT — (Fortran) elements of type double precision.
  • SHMEM_INTEGER_IPUT — elements of type integer.
  • SHMEM_LOGICAL_IPUT — elements of type logical.
  • SHMEM_REAL_IPUT — elements of type real.
  • SHMEM_LOGICAL_IPUT — elements of type logical. (yes bestie, it's listed twice in the original. we do not make the rules, we just report them 💀)
  • SHMEM_REAL_IPUT — elements of type real. (and this one too 😭)

If you're 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). no fancy extended-precision shenanigans, iykyk.

🎀 NOTES 🎀

need the actual definition of what "remotely accessible" means? go read intro_shmem(3). it's the lore ✨

🌸 EXAMPLES 🌸

okay consider this simple shmem_long_iput example for C/C++ programs — except the code in it is short-typed, so, like, look at the code, not the sentence 💜

#include <mpp/shmem.h>

main()
{
  short source[10] = { 1, 2, 3, 4, 5,
  6, 7, 8, 9, 10 };
  static short target[10];

  shmem_init();
  if (shmem_my_pe() == 0) {
    /* put 10 words into target on PE 1 */
    shmem_short_iput(target, source, 1, 2, 5, 1);
  }
  shmem_barrier_all(); /* sync sender and receiver */
  if (shmem_my_pe() == 1) {
    shmem_udcflush(); /* not required on IRIX systems */
    printf("target on PE %d is %d %d %d %d %d0, shmem_my_pe(),
    (int)target[0], (int)target[1], (int)target[2],
    (int)target[3], (int)target[4] );
  }
  shmem_barrier_all(); /* sync before exiting */
}

lowkey iconic: PE 0 puts 5 elements with sst of 2 into a target with tst of 1, then everybody barrier-syncs, then PE 1 prints its target. shmem_udcflush() is not required on IRIX systems, bestie, noted 🫶

SEE ALSO:

2003-2026, The Open MPI Community

and that's the whole page, bestie 💖 this was SHMEM_IPUT128(3) from the Open MPI manual, dated May 14, 2026 — slay, go transfer some strided data responsibly ✨🎀🦋

📦 where this page comes from