SHMEM_FLOAT_IPUT(3)

πŸ“¦
version 5.0.10 Β· 4 versions
, in ubuntu stonking

okay bestie, sit down, hydrate, we're doing SHMEM_FLOAT_IPUT(3) β€” yes that's the Open MPI manual, section 3, and she is everything πŸ’…

This page is basically the group chat for a whole squad of strided-put routines, and every single one of them is invited:

and what do they collectively do?? Transfer strided data to a specified processing element (PE). That's the whole personality. Iconic, honestly. πŸ’–


✨ 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 πŸ’…

so here's the tea: 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 slay. πŸ¦‹

But listen, bestie, the timing is a whole thing: 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 been delivered to the remote data object. So like… your local end is done, but the remote end might still be getting ready. Don't assume otherwise, I'm begging. 😭

🌸 the arguments (aka the lore)

  • target β€” the array that gets updated on the remote PE. This data object must be remotely accessible. Non-negotiable.
  • source β€” the array holding the data being copied. Your local stash.
  • tst β€” the stride between consecutive elements of the target array. It gets scaled by the element size of the target array. A value of 1 means contiguous data. tst must be of type integer, and if you're in Fortran it must be a default integer value.
  • sst β€” the stride between consecutive elements of the source array. It gets scaled by the element size of the source array. A value of 1 means contiguous data. sst must be of type integer, and if you're in Fortran it must be a default integer value.
  • len β€” number of elements in the target and source arrays. len must be of type integer, and if you're in 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, and if you're in Fortran it must be a constant, variable, or array element of default integer type.

πŸŽ€ typing constraints (the vibe check)

The target and source data objects must conform to typing constraints, and they go a lil something like this:

  • 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.
  • SHMEM_REAL_IPUT: elements of type real.

yes, SHMEM_LOGICAL_IPUT and SHMEM_REAL_IPUT show up twice in the source. we're keeping the receipts exactly as written, fr fr 🫢

And 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 custom-sized chaos, bestie. 🚫


🫢 NOTES 🫢

Go read intro_shmem(3) for a definition of the term remotely accessible. That's the homework. It's giving required reading, but make it cute. πŸ“šβœ¨


🌈 EXAMPLES 🌈

okay so picture this β€” a simple shmem_long_iput example for C/C++ programs. (main character energy, let's go) 🌟

#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 */
}

See also:


πŸ’– and that's the whole page, bestie! Copyright 2003-2026, The Open MPI Community β€” go off kings πŸ‘‘ β€” and this edition of the docs is dated Sep 10, 2026. stay remotely accessible, stay iconic, and close your transfers responsibly πŸŽ€πŸ¦‹βœ¨

πŸ“¦ where this page comes from