SHMEM_IPUT32(3)

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

πŸ’– SHMEM_IPUT32(3) β€” it's giving "strided data, but make it remote" ✨

okay bestie, listen. this is the Open MPI page for SHMEM_IPUT32(3) and its entire little iput family, and it's genuinely one of those pages where the whole squad shows up. let's get into it 🫢

🌸 NAME 🌸

shmem_complex_iput(3), shmem_double_iput(3), shmem_float_iput(3), shmem_int_iput(3), shmem_integer_iput(3), shmem_iput4(3), shmem_iput8(3), shmem_iput32(3), shmem_iput64(3), shmem_iput128(3), shmem_logical_iput(3), shmem_long_iput(3), shmem_longdouble_iput(3), shmem_longlong_iput(3), shmem_real_iput(3), shmem_short_iput(3) β€” Transfer strided data to a specified processing element (PE).

like. that's the whole job. strided data. to a PE you picked. 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 πŸ’œ

so the shmem_iput routines read the elements of a local array (source) and write them into a remote array (target) living on the PE you named in pe. iconic behaviour honestly.

and here's the little timing tea you need to know β˜• β€” 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, it's out the door, doesn't mean it's arrived at the function. iykyk.

🌈 the arguments 🌈

  • target β€” the array getting updated on the remote PE. bestie, this data object must be remotely accessible. non-negotiable πŸ’€
  • source β€” the array holding the data that's getting copied.
  • 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 (aka no gaps, clean, slay). tst must be of type integer. if you're in Fortran, it must be a default integer value.
  • sst β€” the stride between consecutive elements of the source array. scaled by the element size of the source array. 1 again means contiguous. sst must be of type integer. 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: must be a constant, variable, or array element of default integer type.

🧚 typing constraints 🧚

the target and source data objects have to conform to typing constraints, and they go a little 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 each show up twice in that list. that's just how the page is, we don't question the queen's choices πŸ‘‘)

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).


πŸ“ NOTES πŸ“

go read intro_shmem(3) for the definition of the term remotely accessible, because that word is doing a LOT of heavy lifting on this page πŸ’…


πŸ”₯ EXAMPLES πŸ”₯

ok so imagine the simplest shmem_long_iput example for C/C++ programs. here's the moment:

#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 */
}
ok the shmem_udcflush() line? it's not required on IRIX systems, so don't come for me 🫢

πŸ‘€ See also:


2003-2026, The Open MPI Community


and that's the whole page, bestie!! you understood it, you ate, no crumbs left πŸ“βœ¨ this was the Open MPI edition of SHMEM_IPUT32(3) and it's dated Sep 10, 2026 β€” mwah, go write some strided data to a PE, ilysm πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from