SHMEM_INT_PUT(3)

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

πŸ’… SHMEM_INT_PUT(3) β€” the put-to-another-PE glow-up πŸ’…

okay bestie, welcome to your new favorite Open MPI manpage. this one is SHMEM_INT_PUT(3), and it's the whole family of put routines, not just the int one. we're talking the full squad:

  • shmem_character_put(3), shmem_complex_put(3), shmem_double_put(3), shmem_float_put(3), shmem_int_put(3), shmem_integer_put(3), shmem_logical_put(3), shmem_long_put(3), shmem_longdouble_put(3), shmem_longlong_put(3)
  • shmem_put4(3), shmem_put8(3), shmem_put32(3), shmem_put64(3), shmem_put128(3), shmem_putmem(3), shmem_real_put(3), shmem_short_put(3)

and what do they all do? Transfers data to a specified processing element (PE). that's it, that's the whole vibe. moving your lil data objects across the cluster like it's nothing. πŸ’–


✨ SYNOPSIS ✨

🩷 C or C++

#include <mpp/shmem.h>

void shmem_double_put(double *target, const double *source,
  size_t len, int pe)

void shmem_float_put(float *target, const float *source,
  size_t len, int pe)

void shmem_int_put(int *target, const int *source, size_t len,
  int pe)

void shmem_long_put(long *target, const long *source,
  size_t len, int pe)

void shmem_longdouble_put(long double *target,
  const long double *source, size_t len, int pe)

void shmem_longlong_put(long long *target,
  const long long *source, size_t len, int pe)

void shmem_put32(void *target, const void *source, size_t len,
  int pe)

void shmem_put64(void *target, const void *source, size_t len,
  int pe)

void shmem_put128(void *target, const void *source, size_t len,
  int pe)

void shmem_putmem(void *target, const void *source, size_t len,
  int pe)

void shmem_short_put(short *target, const short *source,
  size_t len, int pe)

πŸ’œ Fortran

INCLUDE "mpp/shmem.fh"

INTEGER len, pe

CALL SHMEM_CHARACTER_PUT(target, source, len, pe)

CALL SHMEM_COMPLEX_PUT(target, source, len, pe)

CALL SHMEM_DOUBLE_PUT(target, source, len, pe)

CALL SHMEM_INTEGER_PUT(target, source, len, pe)

CALL SHMEM_LOGICAL_PUT(target, source, len, pe)

CALL SHMEM_PUT(target, source, len, pe)

CALL SHMEM_PUT4(target, source, len, pe)

CALL SHMEM_PUT8(target, source, len, pe)

CALL SHMEM_PUT32(target, source, len, pe)

CALL SHMEM_PUT64(target, source, len, pe)

CALL SHMEM_PUT128(target, source, len, pe)

CALL SHMEM_PUTMEM(target, source, len, pe)

CALL SHMEM_REAL_PUT(target, source, len, pe)

🌸 DESCRIPTION 🌸

so here's the tea. these routines transfer nelems elements of the data object sitting at address source on the calling PE, over to the data object at address target on the remote PE pe. πŸ¦‹

and listen β€” these routines start the remote transfer and may return before the data is delivered to the remote PE. so like, not me finishing my sentence before the data even arrives. lowkey asynchronous, highkey iconic.

⚠️ okay so this next part matters, no cap: the delivery of data into the data object on the destination PE from different put calls may occur in any order. because of that, two successive put operations may deliver data out of order unless a call to shmem_fence(3) is introduced between the two calls. so if order matters to you (and bestie, it usually does), fence it. πŸ™ˆ

πŸŽ€ The arguments πŸŽ€

  • target β€” the data object that's getting updated on the remote PE. it must be remotely accessible. non-negotiable, bestie, that's the entry fee. ✨
  • source β€” the data object holding the data you wanna copy. your lil source of truth.
  • len β€” number of elements in the target and source arrays. len must be of type integer. if you're in Fortran land, it has to 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 same Fortran rules: constant, variable, or array element of default integer type.

🧚 Typing constraints (the vibe check) 🧚

the target and source data objects must conform to certain typing constraints, which are as follows:

  • shmem_putmem β€” Fortran: Any noncharacter type. C: Any data type. len is scaled in bytes.
  • shmem_put4, shmem_put32 β€” Any noncharacter type that has a storage size equal to 32 bits.
  • shmem_put8, shmem_put64 β€” Any noncharacter type that has a storage size equal to 64 bits.
  • shmem_put128 β€” Any noncharacter type that has a storage size equal to 128 bits.
  • shmem_short_put β€” Elements of type short.
  • shmem_int_put β€” Elements of type int.
  • shmem_long_put β€” Elements of type long.
  • shmem_longlong_put β€” Elements of type long long.
  • shmem_float_put β€” Elements of type float.
  • shmem_double_put β€” Elements of type double.
  • shmem_longdouble_put β€” Elements of type long double.
  • SHMEM_CHARACTER_PUT β€” Elements of type character. len is the number of characters to transfer. the actual character lengths of the source and target variables are ignored.
  • SHMEM_COMPLEX_PUT β€” Elements of type complex of default size.
  • SHMEM_DOUBLE_PUT β€” (Fortran) Elements of type double precision.
  • SHMEM_INTEGER_PUT β€” Elements of type integer.
  • SHMEM_LOGICAL_PUT β€” Elements of type logical.
  • SHMEM_REAL_PUT β€” 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).

πŸ”₯ EXAMPLES πŸ”₯

the following shmem_put example is for C/C++ programs, and yes it's giving main character energy:

#include <stdio.h>
#include <mpp/shmem.h>

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

  if (shmem_my_pe() == 0) {
    /* put 10 words into target on PE 1 */
    shmem_long_put(target, source, 10, 1);
  }
  shmem_barrier_all();  /* sync sender and receiver */
  if (shmem_my_pe() == 1)
    shmem_udcflush();  /* not required on Altix systems */
  printf("target[0] on PE %d is %d\n", shmem_my_pe(), target[0]);
}

like??? PE 0 puts ten words into PE 1's target, they barrier up so nobody's out here racing, and then PE 1 prints it. chewed. ate. left no crumbs. πŸ“


🌈 SEE ALSO 🌈

go read these next, bestie, iykyk:

  • intro_shmem(3)
  • shmem_iput(3)
  • shmem_quiet(3)

2003-2026, The Open MPI Community


and that's the whole page, periodt. πŸ’–βœ¨ this was SHMEM_INT_PUT(3) from Open MPI, dated Sep 10, 2026 β€” so like, shoutout to the Open MPI Community for keeping the cluster connected since 2003. now go fence your puts and stay iconic. πŸ’…πŸ«Ά

πŸ“¦ where this page comes from