SHMEM_SHORT_PUT_NBI(3)

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

πŸ’– SHMEM_SHORT_PUT_NBI β€” the nonblocking put girlies πŸ’–

okay bestie, gather round, because this is the Open MPI man page for shmem_short_put_nbi(3) and its whole enormous friend group. it's giving "one function, sixteen glow-ups." ✨

here's the full squad, all documented together:

and what do they all do? The nonblocking put routines provide a method for copying data from a contiguous local data object to a data object on a specified PE. no cap, that's the whole job. copying local stuff β†’ someone else's PE, but make it nonblocking. πŸ’…


✨ 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 here's the tea. β˜• these routines return after posting the operation. they do NOT wait around. they said "sent βœ‰οΈ" and dipped. 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. 🫢

but like β€” and this is the important bit β€” the delivery of data words into the data object on the destination PE may occur in any order. any order!! chaos energy, honestly. furthermore, two successive put routines may deliver data out of order unless a call to shmem_fence is introduced between the two calls. so if you need them in order, insert that shmem_fence like a responsible main character. πŸ”₯

πŸŽ€ the arguments (a breakdown)

  • dest β€” the data object to be updated on the remote PE. this one must be remotely accessible. non-negotiable bestie.
  • source β€” the data object containing the data to be copied. your little origin story.
  • nelems β€” the number of elements in the dest and source arrays. for C, nelems must be of type size_t. if you're in Fortran land, 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. if you're doing Fortran, again: constant, variable, or array element of default integer type.
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). no custom sizing, we're keeping it default, periodt.

πŸ“ NOTES πŸ“

you want to know what "remotely accessible" actually means? go read intro_shmem(3), it's got the definition. that's the homework. πŸ“š


πŸ‘‘ EXAMPLES πŸ‘‘

here's a cute little C example, no cap:

#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 πŸ¦‹


2003-2026, The Open MPI Community


okay that's the whole page bestie, you ate it up, go forth and shmem_quiet() responsibly πŸ“βœ¨ this was brought to you by Open MPI, dated Sep 10, 2026 β€” mwah, stan. πŸ’…πŸŽ€

πŸ“¦ where this page comes from