SHMEM_PUT16_NBI(3)

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

okay bestie πŸ’– you just pulled up SHMEM_PUT16_NBI(3) from the Open MPI manual and honestly? this is the nonblocking put family, it's giving fire-and-forget but make it correct. buckle up, we're going through every single line πŸŽ€


✨ NAME ✨

shmem_putmem_nbi(3), shmem_char_put_nbi(3), shmem_short_put_nbi(3), shmem_int_put_nbi(3), shmem_long_put_nbi(3), shmem_longlong_put_nbi(3), shmem_float_put_nbi(3), shmem_double_put_nbi(3), shmem_longdouble_put_nbi(3), shmem_put8_nbi(3), shmem_put16_nbi(3), shmem_put32_nbi(3), shmem_put64_nbi(3), shmem_put128_nbi(3)

πŸ’« The nonblocking put routines are literally the method for copying data from a contiguous local data object into a data object on a specified PE. that's the whole gig. that's the vibe. 🫢


🌸 SYNOPSIS 🌸

πŸ“ C or C++ πŸ“

#include <mpp/shmem.h>

void shmem_putmem_nbi(void *dest, const void *source,
  size_t nelems, int pe)

void shmem_char_put(char *dest, const char *source,
  size_t nelems, int pe)

void shmem_short_put(short *dest, const short *source,
  size_t nelems, int pe)

void shmem_int_put(int *dest, const int *source,
  size_t nelems, int pe)

void shmem_long_put(long *dest, const long *source,
  size_t nelems, int pe)

void shmem_longlong_put(long long *dest, const long long *source,
  size_t nelems, int pe)

void shmem_float_put(float *dest, const float *source,
  size_t nelems, int pe)

void shmem_double_put(double *dest, const double *source,
  size_t nelems, int pe)

void shmem_longdouble_put(long double *dest, const long double *source,
  size_t nelems, int pe)

void shmem_put8(void *dest, const void *source,
  size_t nelems, int pe)

void shmem_put16(void *dest, const void *source,
  size_t nelems, int pe)

void shmem_put32(void *dest, const void *source,
  size_t nelems, int pe)

void shmem_put64(void *dest, const void *source,
  size_t nelems, int pe)

void shmem_put128(void *dest, const void *source,
  size_t nelems, int pe)

πŸ¦‹ Fortran πŸ¦‹

INCLUDE "mpp/shmem.fh"

INTEGER nelems, pe

CALL SHMEM_PUTMEM_NBI(dest, source, nelems, pe)

CALL SHMEM_CHARACTER_PUT_NBI(dest, source, nelems, pe)

CALL SHMEM_COMPLEX_PUT_NBI(dest, source, nelems, pe)

CALL SHMEM_DOUBLE_PUT_NBI(dest, source, nelems, pe)

CALL SHMEM_INTEGER_PUT_NBI(dest, source, nelems, pe)

CALL SHMEM_LOGICAL_PUT_NBI(dest, source, nelems, pe)

CALL SHMEM_REAL_PUT_NBI(dest, source, nelems, pe)

CALL SHMEM_PUT4_NBI(dest, source, nelems, pe)

CALL SHMEM_PUT8_NBI(dest, source, nelems, pe)

CALL SHMEM_PUT32_NBI(dest, source, nelems, pe)

CALL SHMEM_PUT64_NBI(dest, source, nelems, pe)

CALL SHMEM_PUT128_NBI(dest, source, nelems, pe)

πŸ’œ DESCRIPTION πŸ’œ

okay so the tea β˜•: these routines return right after posting the operation β€” like, they just drop off the package and leave, no waiting around at the door. πŸ™ˆ

The operation is considered complete only after a subsequent call to shmem_quiet. At the completion of shmem_quiet, the data has been copied into the dest array on the destination PE. βœ…

🚨 bestie this is the part that matters: the delivery of data words into the data object on the destination PE may occur in any order. and like, it gets spicier β€” two successive put routines may deliver data out of order unless a call to shmem_fence is introduced between the two calls. no shmem_fence between them = chaos. periodt. πŸ’€

The arguments are as follows:

  • dest β€” the data object to be updated on the remote PE. ngl this one has requirements: it must be remotely accessible. πŸ’…
  • source β€” the data object containing the data to be copied. the source of truth, the origin story, the moment. ✨
  • nelems β€” the number of elements in the dest and source arrays. For C it must be of type size_t. Fortran girlies: it has to 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 girlies again: constant, variable, or array element of default integer type. πŸ“

If you are using Fortran, data types must be of default size. like, for example, a real variable must be declared as REAL, REAL*4, or REAL(KIND=4). don't be out here declaring random sizes, it's not the move 🧚


🌈 NOTES 🌈

See intro_shmem(3) for a definition of the term remotely accessible. iykyk but if you don't, the lore is right there πŸ“–


⭐ EXAMPLES ⭐

Consider this simple example for C. it's cute, it's classic, it eats 🍽️

#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_nbi(target, source, 10, 1);
    shmem_quiet();
  }
  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]);
}

See also:

  • intro_shmem(3)
  • shmem_quiet(3)

2003-2026, The Open MPI Community


and that's the whole page bestie, we got to the very last line πŸ₯Ή source: the Open MPI manual, dated Sep 10, 2026. go forth and shmem_quiet() responsibly πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from