SHMEM_FLOAT_GET(3)

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

πŸ’– SHMEM_FLOAT_GET(3) β€” the Open MPI glow-up ✨

okay bestie, so you're here for the get family and honestly? iconic. this whole girlies-and-they-dies crew transfers data from a specified processing element (PE), and the squad is stacked:

they all do the same thing, just for different lil data types. no cap. transfers data from a specified processing element (PE) πŸ’…


✨ SYNOPSIS ✨

C or C++:

#include <mpp/shmem.h>

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

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

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

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

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

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

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

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

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

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

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

Fortran:

INCLUDE "mpp/shmem.fh"

INTEGER len, pe

CALL SHMEM_CHARACTER_GET(target, source, len, pe)

CALL SHMEM_COMPLEX_GET(target, source, len, pe)

CALL SHMEM_DOUBLE_GET(target, source, len, pe)

CALL SHMEM_GET4(target, source, len, pe)

CALL SHMEM_GET8(target, source, len, pe)

CALL SHMEM_GET32(target, source, len, pe)

CALL SHMEM_GET64(target, source, len, pe)

CALL SHMEM_GET128(target, source, len, pe)

CALL SHMEM_GETMEM(target, source, len, pe)

CALL SHMEM_INTEGER_GET(target, source, len, pe)

CALL SHMEM_LOGICAL_GET(target, source, len, pe)

CALL SHMEM_REAL_GET(target, source, len, pe)

πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the tea β˜•: the shmem_get routines transfer nelems elements of the data object at address source on the remote PE pe, over to the data object at address target on the local PE. and the way that they return after the data has been copied to address target on the local PE? yeah. synchronous behavior, main character energy, no lingering. periodt. πŸ’…

the arguments, bestie β€” let's go one by one:

  • target β€” the local data object that's getting updated. she's receiving. 🫢
  • source β€” the data object on the PE identified by pe that contains the data to be copied. this one must be remotely accessible. don't forget that part, it's giving important.
  • 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. no sneaking in your fancy custom types, bestie. πŸ™ˆ
  • pe β€” PE number of the remote PE. pe must be of type integer. and again, in Fortran it must be a constant, variable, or array element of default integer type.
lowkey the whole vibe check here: target and source data objects must conform to typing constraints. so let's get into those, because messing them up is a whole πŸ’€ situation.

🌸 typing constraints, aka who's allowed where 🌸

  • shmem_getmem β€” Fortran: any noncharacter type. C: any data type. len is scaled in bytes.
  • shmem_get4, shmem_get32 β€” any noncharacter type that has a storage size equal to 32 bits.
  • {shmem_get8, shmem_get64} β€” any noncharacter type that has a storage size equal to 64 bits.
  • shmem_get128 β€” any noncharacter type that has a storage size equal to 128 bits.
  • shmem_short_get β€” elements of type short.
  • shmem_int_get β€” elements of type int.
  • shmem_long_get β€” elements of type long.
  • shmem_longlong_get β€” elements of type long long.
  • shmem_float_get β€” elements of type float.
  • shmem_double_get β€” elements of type double.
  • shmem_longdouble_get β€” elements of type long double.
  • SHMEM_CHARACTER_GET β€” elements of type character. len is the number of characters to transfer. the actual character lengths of the source and target variables are ignored β€” not me pointing that out, it's just facts. πŸŽ€
  • SHMEM_COMPLEX_GET β€” elements of type complex of default size.
  • SHMEM_DOUBLE_GET β€” (Fortran) elements of type double precision.
  • SHMEM_INTEGER_GET β€” elements of type integer.
  • SHMEM_LOGICAL_GET β€” elements of type logical.
  • SHMEM_REAL_GET β€” elements of type real.
πŸ’– Fortran besties: your data types must be of default size. for example, a real variable must be declared as REAL, REAL*4, or REAL(KIND=4). no deviation, i don't make the rules (okay well, the spec does).

πŸ“ NOTES πŸ“

need the definition of "remotely accessible"? slay, go read intro_shmem(3). she explains it. 🌈


πŸ”₯ EXAMPLES πŸ”₯

okay so consider this simple example for Fortran β€” she's cute, she's a reduction, she ate:

PROGRAM REDUCTION
  REAL VALUES, SUM
  COMMON /C/ VALUES
  REAL WORK

  CALL START_PES(0) ! ALLOW ANY NUMBER OF PES
  VALUES = MY_PE() ! INITIALIZE IT TO SOMETHING
  CALL SHMEM_BARRIER_ALL
  SUM = 0.0
  DO I = 0,NUM_PES()-1
    CALL SHMEM_REAL_GET(WORK, VALUES, 1, I)
    SUM = SUM + WORK
  ENDDO
  PRINT *, 'PE ', MY_PE(), ' COMPUTED SUM=', SUM
  CALL SHMEM_BARRIER_ALL
END

See also:

intro_shmem(3) shmem_put(3) shmem_iget(3) shmem_quiet(3)


2003-2026, The Open MPI Community


and that's the whole page, bestie! πŸŽ€ this was Open MPI's SHMEM_FLOAT_GET(3), dated Sep 10, 2026, and it lives in the SHMEM_FLOAT_GET(3) era forever. go forth, call those get routines, stay remotely accessible. mwah πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from