SHMEM_LONG_MIN_TO_ALL(3)

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

🌸 NAME 🌸

okay bestie, so this is the <hotpink>SHMEM_LONG_MIN_TO_ALL(3)</hotpink> page, and it comes to you straight from your friends at Open MPI πŸ’–. It's the girlies that do one specific job: performs a minimum function reduction across a set of processing elements (PEs). ✨

And like, she doesn't roll alone β€” she's part of a whole squad:

  • shmem_double_min_to_all(3)
  • shmem_float_min_to_all(3)
  • shmem_int_min_to_all(3)
  • shmem_int4_min_to_all(3)
  • shmem_int8_min_to_all(3)
  • shmem_long_min_to_all(3)
  • shmem_longdouble_min_to_all(3)
  • shmem_longlong_min_to_all(3)
  • shmem_real4_min_to_all(3)
  • shmem_real8_min_to_all(3)
  • shmem_real16_min_to_all(3)
  • shmem_short_min_to_all(3)

✨ SYNOPSIS ✨

🫢 C or C++

#include <mpp/shmem.h>

void shmem_double_min_to_all(double *target, const double *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  double *pWrk, long *pSync)

void shmem_float_min_to_all(float *target, const float *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  float *pWrk, long *pSync)

void shmem_int_min_to_all(int *target, const int *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  int *pWrk, long *pSync)

void shmem_long_min_to_all(long *target, const long *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  long *pWrk, long *pSync)

void shmem_longdouble_min_to_all(long double *target,
  const long double *source, int nreduce, int PE_start,
  int logPE_stride, int PE_size, long double *pWrk,
  long *pSync)

void shmem_longlong_min_to_all(long long *target,
  const long long *source, int nreduce, int PE_start, int logPE_stride,
  int PE_size, long long *pWrk, long *pSync)

void shmem_short_min_to_all(short *target, const short *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  short *pWrk, long *pSync)

πŸ’œ Fortran

INCLUDE "mpp/shmem.fh"

INTEGER pSync(SHMEM_REDUCE_SYNC_SIZE)
INTEGER nreduce, PE_start, logPE_stride, PE_size

CALL SHMEM_INT4_MIN_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_INT8_MIN_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_REAL4_MIN_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_REAL8_MIN_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_REAL16_MIN_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

πŸ¦‹ DESCRIPTION πŸ¦‹

So the shared memory (SHMEM) reduction routines compute one or more reductions across symmetric arrays on multiple virtual PEs, okay? And a reduction is literally just an associative binary operation happening across a set of values. If you wanna see the whole reduction-fam lineup, go peek at intro_shmem(3). πŸ‘‘

Same as every SHMEM collective routine ever, each of these assumes that only PEs in the active set call the routine. And bestie, listen: if a PE that is not in the active set calls a SHMEM collective routine, that's undefined behavior. Not cute. Don't do it. πŸ’€

The nreduce argument tells you how many separate reductions are happening. The source array on all PEs in the active set provides one element for each reduction. The results land in the target array on all PEs in the active set. And the active set? That's defined by the PE_start, logPE_stride, PE_size triplet. Slay. ✨

The source and target arrays may be the same array, but they may not be overlapping arrays. Rules are rules. πŸ™ˆ

The arguments are as follows:

  • target β€” A symmetric array of length nreduce elements to receive the results of the reduction operations. The data type of target varies with the version of the reduction routine being called. When calling from C/C++, refer to the SYNOPSIS section for data type info. When calling from Fortran, the target data types are as follows:
    • shmem_int4_min_to_all: Integer, with an element size of 4 bytes
    • shmem_int8_min_to_all: Integer, with an element size of 8 bytes
    • shmem_real4_min_to_all: Real, with an element size of 4 bytes
    • shmem_real8_min_to_all: Real, with an element size of 8 bytes
    • shmem_real16_min_to_all: Real, with an element size of 16 bytes
  • source β€” A symmetric array, of length nreduce elements, that contains one element for each separate reduction operation. The source argument must have the same data type as target.
  • nreduce β€” The number of elements in the target and source arrays. nreduce must be of type integer. If you're using Fortran, it must be a default integer value.
  • PE_start β€” The lowest virtual PE number of the active set of PEs. PE_start must be of type integer. If you're using Fortran, it must be a default integer value.
  • logPE_stride β€” The log (base 2) of the stride between consecutive virtual PE numbers in the active set. logPE_stride must be of type integer. If you're using Fortran, it must be a default integer value.
  • PE_size β€” The number of PEs in the active set. PE_size must be of type integer. If you're using Fortran, it must be a default integer value.
  • pWrk β€” A symmetric work array. The pWrk argument must have the same data type as target. In C/C++, this contains max(nreduce/2 + 1, _SHMEM_REDUCE_MIN_WRKDATA_SIZE) elements. In Fortran, this contains max(nreduce/2 + 1, SHMEM_REDUCE_MIN_WRKDATA_SIZE) elements.
  • pSync β€” A symmetric work array. In C/C++, pSync is of type long and size _SHMEM_REDUCE_SYNC_SIZE. In Fortran, pSync is of type integer and size SHMEM_REDUCE_SYNC_SIZE. If you're using Fortran, it must be a default integer value. Every single element of this array must be initialized with the value _SHMEM_SYNC_VALUE (in C/C++) or SHMEM_SYNC_VALUE (in Fortran) before any of the PEs in the active set enter the reduction routine. No skipping this. πŸ’…

The values of arguments nreduce, PE_start, logPE_stride, and PE_size must be equal on all PEs in the active set. And the same target and source arrays, and the same pWrk and pSync work arrays, must be passed to all PEs in the active set. Everyone matching, everyone on the same page. 🫢

Before any PE calls a reduction routine, you must make sure the following conditions exist (fr fr, synchronization via a barrier or some other method is often needed to ensure this):

  • The pWrk and pSync arrays on all PEs in the active set are not still in use from a prior call to a collective SHMEM routine.
  • The target array on all PEs in the active set is ready to accept the results of the reduction.

Upon return from a reduction routine, the following are true for the local PE:

  • The target array is updated. βœ…
  • The values in the pSync array are restored to the original values. βœ…

🌈 NOTES 🌈

The terms collective, symmetric, and cache aligned are all defined over in intro_shmem(3). And here's a lil gift: all SHMEM reduction routines reset the values in pSync before they return, so a particular pSync buffer only needs to be initialized the first time it's used. Iconic behavior honestly. ✨

You must ensure that the pSync array is not being updated on any PE in the active set while any of the PEs participate in processing of a SHMEM reduction routine. And bestie, be careful of these situations:

  • If the pSync array is initialized at run time, some type of synchronization is needed to ensure that all PEs in the working set have initialized pSync before any of them enter a SHMEM routine called with the pSync synchronization array.
  • A pSync or pWrk array can be reused in a subsequent reduction routine call only if none of the PEs in the active set are still processing a prior reduction routine call that used the same pSync or pWrk arrays.
  • In general, this can be assured only by doing some type of synchronization. However, in the special case of reduction routines being called with the same active set, you can allocate two pSync and pWrk arrays and alternate between them on successive calls. Big brain move. 🧠✨

πŸŽ€ EXAMPLES πŸŽ€

Example 1: This Fortran example statically initializes the pSync array and finds the minimum value of real variable FOO across all the even PEs.

INCLUDE "mpp/shmem.fh"

INTEGER PSYNC(SHMEM_REDUCE_SYNC_SIZE)
DATA PSYNC /SHMEM_REDUCE_SYNC_SIZE*SHMEM_SYNC_VALUE/
PARAMETER (NR=1)
REAL FOO, FOOMIN, PWRK(MAX(NR/2+1,SHMEM_REDUCE_MIN_WRKDATA_SIZE))
COMMON /COM/ FOO, FOOMIN, PWRK
INTRINSIC MY_PE

IF ( MOD(MY_PE(),2) .EQ. 0) THEN
  CALL SHMEM_REAL8_MIN_TO_ALL(FOOMIN, FOO, NR, 0, 1, N$PES/2,
  & PWRK, PSYNC)
  PRINT *, 'Result on PE ', MY_PE(), ' is ', FOOMIN
ENDIF

Example 2: Consider the following C/C++ call:

shmem_int_min_to_all( target, source, 3, 0, 0, 8, pwrk, psync );

The preceding call is more efficient, but semantically equivalent to, the combination of the following calls:

shmem_int_min_to_all(&(target[0]), &(source[0]), 1, 0, 0, 8,
  pwrk1, psync1);
shmem_int_min_to_all(&(target[1]), &(source[1]), 1, 0, 0, 8,
  pwrk2, psync2);
shmem_int_min_to_all(&(target[2]), &(source[2]), 1, 0, 0, 8,
  pwrk1, psync1);

Note that two sets of pWrk and pSync arrays are used alternately, because no synchronization is done between calls. πŸ‘‘

See also:

  • intro_shmem(3)

So that's the whole page, bestie β€” every argument, every array size, every "must be equal on all PEs," all of it. This gem is copyright 2003-2026, The Open MPI Community, and this version was dated Sep 10, 2026 β€” it's literally <rainbow>SHMEM_LONG_MIN_TO_ALL(3)</rainbow> from the Open MPI manual, and she ate. πŸ’…πŸ’– Stay symmetric, initialize your pSync, and go get that minimum. πŸ¦‹βœ¨

πŸ“¦ where this page comes from