communications_array.h

/****************************************************************************
* Copyright (c) 2025, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
 
#ifndef communications_array_included
#define communications_array_included
 
#include <type_traits>
#include <Comm_Group.h>
#include <PE_Groups.h>
#include <arch.h>
 
// These methods are intentionally separated from communications.h as they are more dangerous to use.
// The arrays passed as parameters must have at least n elements, and n must be
// identical on all processors communicating with each other.
 
// Warning: the template only works for simple types (not Objet_U!)
// We do not go through an Entree/Sortie buffer but send the array directly in binary form.
// A single message is sent, except in check() mode where the size is also sent for verification.
template<typename _TYPE_> std::enable_if_t<std::is_arithmetic<_TYPE_>::value,bool >
inline envoyer_array(const _TYPE_ *objet, int n, int source, int cible, int canal)
{
  const Comm_Group& grp = PE_Groups::current_group();
  const int moi = grp.rank();
  if (moi == cible)
    return false;
 
  if (source != moi && source != -1)
    return false;
 
  const char *data = (const char*) objet;
  const int sz = (int)sizeof(_TYPE_) * n;
  if (cible < 0)
    {
      const int nbproc = grp.nproc();
      for (int i = 0; i < nbproc; i++)
        {
          if (i != moi)
            {
              // In check mode, we verify that n is the same on both sender and receiver
              if (grp.check_enabled())
                grp.send(i, &sz, (int)sizeof(int), canal);
              if (sz > 0)
                grp.send(i, data, sz, canal);
            }
        }
    }
  else
    {
      if (grp.check_enabled())
        grp.send(cible, &sz, (int)sizeof(int), canal);
      if (sz > 0)
        grp.send(cible, data, sz, canal);
    }
  return true;
}
 
#ifndef INT_is_64_
inline bool envoyer_array(const long *t, int n, int source, int cible, int canal)
{
  return envoyer_array<long>(t,n,source,cible,canal);
}
#endif
 
template<typename _TYPE_> std::enable_if_t<std::is_arithmetic<_TYPE_>::value,bool >
inline recevoir_array(const _TYPE_ *objet, int n, int source, int cible, int canal)
{
  const Comm_Group& grp = PE_Groups::current_group();
  const int moi = grp.rank();
  if (moi == source)
    return false;
 
  if (cible != moi && cible != -1)
    return false;
 
  const int sz = (int)sizeof(_TYPE_) * n;
  if (grp.check_enabled())
    {
      int sz_check;
      grp.recv(source, &sz_check, (int)sizeof(int), canal);
      if (sz_check != sz)
        {
          Cerr << "Fatal error in template<typename _TYPE_> int recevoir_array : incorrect size\n" << " sent=" << sz_check << " expected=" << sz << finl;
          Process::exit();
        }
    }
  char *data = (char*) objet;
  if (sz > 0)
    grp.recv(source, data, sz, canal);
  return true;
}
 
#ifndef INT_is_64_
inline bool recevoir_array(const long *t, int n, int source, int cible, int canal)
{
  return recevoir_array<long>(t, n, source, cible, canal);
}
#endif
 
template<typename _TYPE_> std::enable_if_t<std::is_arithmetic<_TYPE_>::value,bool >
inline envoyer_broadcast_array(_TYPE_ *objet, int n, int source)
{
  const Comm_Group& grp = PE_Groups::current_group();
  if (grp.check_enabled())
    {
      int copie_n = n;
      grp.broadcast(&copie_n, (int)sizeof(int), source);
      if (copie_n != n)
        {
          Cerr << "Error in template<typename _TYPE_> envoyer_broadcast_array !" << finl;
          Process::exit();
        }
    }
  grp.broadcast(objet, (int)sizeof(_TYPE_) * n, source);
  return true;
}
 
#ifndef INT_is_64_
inline bool envoyer_broadcast_array(long *t, int n, int source)
{
  return envoyer_broadcast_array<long>(t, n, source);
}
#endif
 
#endif /* communications_array_included */