SHMEM_LONGDOUBLE_MAX_TO_ALL(3)
π SHMEM_LONGDOUBLE_MAX_TO_ALL(3) π
okay bestie, this is an Open MPI manual page, section 3, and it's literally the whole max-to-all reduction family in one place π Like, the longdouble one is the marquee name but the page covers a whole squad of siblings. Sit down, grab a snack, we're doing collective comms π
β¨ NAME β¨
So this page is about the maximum-function reduction routines, and here's the entire friend group β every single one of them:
shmem_double_max_to_all(3)shmem_float_max_to_all(3)shmem_int_max_to_all(3)shmem_int4_max_to_all(3)shmem_int8_max_to_all(3)shmem_long_max_to_all(3)shmem_longdouble_max_to_all(3)shmem_longlong_max_to_all(3)shmem_real4_max_to_all(3)shmem_real8_max_to_all(3)shmem_real16_max_to_all(3)shmem_short_max_to_all(3)
And what do they do? They perform a maximum function reduction across a set of processing elements (PEs). That's it, that's the whole vibe π
πΈ SYNOPSIS πΈ
C or C++
#include <mpp/shmem.h>
void shmem_double_max_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_max_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_max_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_max_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_max_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_max_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_max_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_MAX_TO_ALL(target, source, nreduce,
& PE_start, logPE_stride, PE_size, pWrk, pSync)
CALL SHMEM_INT8_MAX_TO_ALL(target, source, nreduce,
& PE_start, logPE_stride, PE_size, pWrk, pSync)
CALL SHMEM_REAL4_MAX_TO_ALL(target, source, nreduce,
& PE_start, logPE_stride, PE_size, pWrk, pSync)
CALL SHMEM_REAL8_MAX_TO_ALL(target, source, nreduce,
& PE_start, logPE_stride, PE_size, pWrk, pSync)
CALL SHMEM_REAL16_MAX_TO_ALL(target, source, nreduce,
& PE_start, logPE_stride, PE_size, pWrk, pSync)
π DESCRIPTION π
The shared memory (SHMEM) reduction routines compute one or more reductions across symmetric arrays on multiple virtual PEs. A reduction performs an associative binary operation across a set of values. Wanna see the other SHMEM reduction routines? They're all listed over in intro_shmem(3).
Same deal as every SHMEM collective routine: each of these routines assumes that only PEs in the active set call the routine. And if a PE that is not in the active set calls a SHMEM collective routine?
π¨ Undefined behavior results. Not cute. Not a slay. Just don't. π
The nreduce argument decides how many separate reductions we're doing. The source array on every PE in the active set hands over one element for each reduction. The results land in the target array on every PE in the active set. And the active set itself? That's defined by the PE_start, logPE_stride, PE_size triplet, periodt.
source and target arrays may be the same array, but they may not be overlapping arrays. iykyk π
The arguments are as follows:
targetβ A symmetric array of lengthnreduceelements to receive the results of the reduction operations. The data type oftargetvaries with the version of the reduction routine being called. When calling from C, refer to the SYNOPSIS section for data type information.
When calling from Fortran, the target data types are as follows:
shmem_comp8_max_to_all: Complex, with an element size equal to two 8-byte real values.shmem_int4_max_to_all: Integer, with an element size of 4 bytes.shmem_int8_max_to_all: Integer, with an element size of 8 bytes.shmem_real4_max_to_all: Real, with an element size of 4 bytes.shmem_real16_max_to_all: Real, with an element size of 16 bytes.
sourceβ A symmetric array of lengthnreduceelements that contains one element for each separate reduction operation. Thesourceargument must have the same data type astarget.nreduceβ The number of elements in thetargetandsourcearrays.nreducemust be of type integer. If you are using Fortran, it must be a default integer value.PE_startβ The lowest virtual PE number of the active set of PEs.PE_startmust be of type integer. If you are 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_stridemust be of type integer. If you are using Fortran, it must be a default integer value.PE_sizeβ The number of PEs in the active set.PE_sizemust be of type integer. If you are using Fortran, it must be a default integer value.pWrkβ A symmetric work array. ThepWrkargument must have the same data type astarget. In C/C++, this containsmax(nreduce/2 + 1, _SHMEM_REDUCE_MIN_WRKDATA_SIZE)elements. In Fortran, this containsmax(nreduce/2 + 1, SHMEM_REDUCE_MIN_WRKDATA_SIZE)elements.pSyncβ A symmetric work array. In C/C++,pSyncis of typelongand size_SHMEM_REDUCE_SYNC_SIZE. In Fortran,pSyncis of type integer and sizeSHMEM_REDUCE_SYNC_SIZE. If you are using Fortran, it must be a default integer value. Every element of this array must be initialized with the value_SHMEM_SYNC_VALUE(in C/C++) orSHMEM_SYNC_VALUE(in Fortran) before any of the PEs in the active set enter the reduction routine. π
The values of arguments nreduce, PE_start, logPE_stride, and PE_size must be equal on all PEs in the active set. The same target and source arrays, and the same pWrk and pSync work arrays, must be passed to all PEs in the active set. No solo acts, bestie β this is a group performance π«Ά
Before any PE calls a reduction routine, you must make sure the following conditions exist (synchronization via a barrier or some other method is often needed to guarantee this):
- The
pWrkandpSyncarrays on all PEs in the active set are not still in use from a prior call to a collective SHMEM routine. - The
targetarray 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
targetarray is updated. β¨ - The values in the
pSyncarray are restored to the original values.
π NOTES π
The terms collective, symmetric, and cache aligned are defined in intro_shmem(3). All SHMEM reduction routines reset the values in pSync before they return, so a particular pSync buffer need only be initialized the first time it is used. One and done, iconic behavior π
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. Be careful of the following situations:
- If the
pSyncarray is initialized at run time, some type of synchronization is needed to ensure that all PEs in the working set have initializedpSyncbefore any of them enter a SHMEM routine called with thepSyncsynchronization array. - A
pSyncorpWrkarray 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 samepSyncorpWrkarrays.
In general, this can be assured only by doing some type of synchronization. But β 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. Two-array rotation, main character energy π₯
π EXAMPLES π
Example 1
This Fortran example statically initializes the pSync array and finds the maximum value of real variable FOO across all 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, FOOMAX, PWRK(MAX(NR/2+1,SHMEM_REDUCE_MIN_WRKDATA_SIZE))
COMMON /COM/ FOO, FOOMAX, PWRK
INTRINSIC MY_PE
IF ( MOD(MY_PE(),2) .EQ. 0) THEN
CALL SHMEM_REAL8_MAX_TO_ALL(FOOMAX, FOO, NR, 0, 1, N$PES/2,
& PWRK, PSYNC)
PRINT *, 'Result on PE ', MY_PE(), ' is ', FOOMAX
ENDIF
Example 2
Consider the following C/C++ call:
shmem_int_max_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_max_to_all(&(target[0]), &(source[0]), 1, 0, 0, 8,
pwrk1, psync1);
shmem_int_max_to_all(&(target[1]), &(source[1]), 1, 0, 0, 8,
pwrk2, psync2);
shmem_int_max_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. Double-booking them like that? Lowkey genius π§
π SEE ALSO π
π COPYRIGHT π
2003-2026, The Open MPI Community
and that's a wrap, bestie π This page is from Open MPI, and the version down at the bottom is dated Sep 10, 2026 β which is also when SHMEM_LONGDOUBLE_MAX_TO_ALL(3) got its lil timestamp. Go forth and reduce, you absolute icon πβ¨
π¦ where this page comes from
- ubuntu stonking: openmpi-doc 5.0.10-6 Β· other
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms