SHMEM_LONGLONG_XOR_TO_ALL(3)

πŸ’… shmem_longlong_xor_to_all(3) πŸ’…

ok so this is the Open MPI manual page for shmem_longlong_xor_to_all(3) and her whole reduce-to-all bestie family β€” come get y'all's bitwise XOR πŸ¦‹

Also repping the whole squad in this page: shmem_comp4_xor_to_all(3), shmem_int_xor_to_all(3), shmem_int4_xor_to_all(3), shmem_int8_xor_to_all(3), shmem_long_xor_to_all(3), shmem_longlong_xor_to_all(3), shmem_short_xor_to_all(3) β€” these do a bitwise XOR operation on symmetric arrays over the active set of PEs. no cap. ✨


✨ SYNOPSIS ✨

C or C++ besties, include this:

#include <mpp/shmem.h>

then here's the whole lineup, verbatim, don't @ me:

void shmem_int_xor_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_xor_to_all(long *target, const long *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  long *pWrk, long *pSync)

void shmem_longlong_xor_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_xor_to_all(short *target, const short *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  short *pWrk, long *pSync)

Fortran girlies, y'all do:

INCLUDE "mpp/shmem.fh"

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

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

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

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

🌸 DESCRIPTION 🌸

okay so the shared memory (SHMEM) reduction routines compute one or more reductions across symmetric arrays on multiple virtual PEs. A reduction does an associative binary operation across a set of values. Want the full roster of other SHMEM reduction routines? it's giving intro_shmem(3), go look πŸ‘‘

Same deal as literally every SHMEM collective routine: each of these assumes that only PEs in the active set call the routine. If a PE that's not in the active set calls a SHMEM collective routine β†’ undefined behavior. and we do not stan undefined behavior πŸ™ˆ

The nreduce argument decides how many separate reductions you're doing. The source array on all PEs in the active set hands over one element per reduction. Results land in the target array on all PEs in the active set. The active set is defined by the PE_start, logPE_stride, PE_size trio β€” that's the whole vibe check πŸ’…

The source and target arrays may be the same array, but they may not be overlapping arrays. (same β‰  overlapping, bestie, keep that straight 🫢)

The arguments, one by one:

  • 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 and the language used. From C/C++, check the SYNOPSIS section for data type info. From Fortran, the target data types are:
    • shmem_comp8_xor_to_all:** Complex, with an element size equal to two 8-byte real values
    • shmem_comp4_xor_to_all:** Complex, with an element size equal to two 4-byte real values
    • shmem_int8_xor_to_all:** Integer, with an element size of 8 bytes
    • shmem_int4_xor_to_all:** Integer, with an element size of 4 bytes
    • shmem_real8_xor_to_all:** Real, with an element size of 8 bytes
    • shmem_real4_xor_to_all:** Real, with an element size of 4 bytes
  • source β€” a symmetric array, of length nreduce elements, containing one element for each separate reduction operation. source must have the same data type as target. matching sets only πŸ’–
  • nreduce β€” the number of elements in the target and source arrays. nreduce must be of type integer. In 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. In 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. In 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. In Fortran, it must be a default integer value.
  • pWrk β€” a symmetric work array. pWrk 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. In Fortran, it must be a default integer value. Every element of this array must be initialized with the value _SHMEM_SYNC_VALUE (C/C++) or SHMEM_SYNC_VALUE (Fortran) before any of the PEs in the active set enter the reduction routine. all of them. every single one. πŸ”₯

The values of the 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. everyone in sync or nothing works, periodt ✨

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

  • 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.

Once a reduction routine returns, 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 defined in intro_shmem(3). 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 are participating in processing of a SHMEM reduction routine. Be careful of the following 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. two little buffers taking turns, we love to see it πŸ¦‹

🌈 EXAMPLES 🌈

Example 1

This Fortran example statically initializes the pSync array and computes the exclusive OR of 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, FOOXOR, PWRK(MAX(NR/2+1,SHMEM_REDUCE_MIN_WRKDATA_SIZE))
COMMON /COM/ FOO, FOOXOR, PWRK
INTRINSIC MY_PE

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

Example 2

Consider the following C/C++ call:

shmem_short_xor_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_short_xor_to_all(&(target[0]), &(source[0]), 1, 0, 0, 8,
  pwrk1, psync1);
shmem_short_xor_to_all(&(target[1]), &(source[1]), 1, 0, 0, 8,
  pwrk2, psync2);
shmem_short_xor_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? told you alternating was the move 😌)


πŸ‘‘ SEE ALSO πŸ‘‘

intro_shmem(3)


2003-2026, The Open MPI Community


ok that's the whole page, mwah πŸ’– this was SHMEM_LONGLONG_XOR_TO_ALL(3) from the Open MPI manual, dated May 14, 2026 β€” go XOR something symmetric and stay hydrated, bestie πŸ“πŸ§šπŸ’œ

πŸ“¦ where this page comes from