DataSynchronizeInfo.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* DataSynchronizeInfo.h                                       (C) 2000-2025 */
/*                                                                           */
/* Information for synchronizing data.                                       */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_IMPL_DATASYNCHRONIZERINFO_H
#define ARCANE_IMPL_DATASYNCHRONIZERINFO_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ReferenceCounterImpl.h"
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/Parallel.h"
#include "arcane/core/VariableCollection.h"
 
#include <array>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class DataSynchronizeInfo;

enum class eDataSynchronizeCompareStatus
{
  Unknown,
  Same,
  Different
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class DataSynchronizeResult
{
 public:
 
  eDataSynchronizeCompareStatus compareStatus() const { return m_compare_status; }
  void setCompareStatus(eDataSynchronizeCompareStatus v) { m_compare_status = v; }
 
 private:
 
  eDataSynchronizeCompareStatus m_compare_status = eDataSynchronizeCompareStatus::Unknown;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_IMPL_EXPORT VariableSyncInfo
{
 public:
 
  VariableSyncInfo(Int32ConstArrayView share_ids, Int32ConstArrayView ghost_ids, Int32 rank);
  VariableSyncInfo(const VariableSyncInfo& rhs);
  VariableSyncInfo();
 
 public:

  Int32 targetRank() const { return m_target_rank; }

  ConstArrayView<Int32> shareIds() const { return m_share_ids; }
  ConstArrayView<Int32> ghostIds() const { return m_ghost_ids; }

  Int32 nbShare() const { return m_share_ids.size(); }
  Int32 nbGhost() const { return m_ghost_ids.size(); }

  void changeLocalIds(Int32ConstArrayView old_to_new_ids);
 
 private:

  UniqueArray<Int32> m_share_ids;
  UniqueArray<Int32> m_ghost_ids;
  Int32 m_target_rank = A_NULL_RANK;
 
 private:
 
  void _changeIds(Array<Int32>& ids, Int32ConstArrayView old_to_new_ids);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class DataSynchronizeBufferInfoList
{
  friend DataSynchronizeInfo;
 
 private:
 
  DataSynchronizeBufferInfoList(const DataSynchronizeInfo* sync_info, bool is_share)
  : m_sync_info(sync_info)
  , m_is_share(is_share)
  {
  }
 
 public:
 
  Int32 nbRank() const { return m_displacements_base.size(); }
  Int64 totalNbItem() const { return m_total_nb_item; }
  Int64 bufferDisplacement(Int32 index) const { return m_displacements_base[index]; }
  ConstArrayView<Int32> localIds(Int32 index) const;
  Int32 nbItem(Int32 index) const;
 
 private:

  UniqueArray<Int64> m_displacements_base;
  Int64 m_total_nb_item = 0;
  const DataSynchronizeInfo* m_sync_info = nullptr;
  bool m_is_share = false;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_IMPL_EXPORT DataSynchronizeInfo
: private ReferenceCounterImpl
{
  friend class DataSynchronizeBufferInfoList;
 
 private:
 
  static constexpr int SEND = 0;
  static constexpr int RECEIVE = 1;
 
 private:
 
  DataSynchronizeInfo() = default;
 
 public:
 
  DataSynchronizeInfo(const DataSynchronizeInfo&) = delete;
  DataSynchronizeInfo operator=(const DataSynchronizeInfo&) = delete;
  DataSynchronizeInfo(DataSynchronizeInfo&&) = delete;
  DataSynchronizeInfo operator=(DataSynchronizeInfo&&) = delete;
 
 public:
 
  static Ref<DataSynchronizeInfo> create()
  {
    return makeRef(new DataSynchronizeInfo());
  }
 
 public:
 
  void clear()
  {
    m_ranks_info.clear();
    m_communicating_ranks.clear();
  }
  Int32 size() const { return m_ranks_info.size(); }
  void add(const VariableSyncInfo& s);

  const DataSynchronizeBufferInfoList& sendInfo() const { return m_buffer_infos[SEND]; }
  const DataSynchronizeBufferInfoList& receiveInfo() const { return m_buffer_infos[RECEIVE]; }

  Int32 targetRank(Int32 index) const { return m_ranks_info[index].targetRank(); }

  ConstArrayView<Int32> communicatingRanks() const { return m_communicating_ranks; }

  void changeLocalIds(ConstArrayView<Int32> old_to_new_ids);

  void recompute();
 
 public:
 
  void addReference() { ReferenceCounterImpl::addReference(); }
  void removeReference() { ReferenceCounterImpl::removeReference(); }
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2023: do not use")
  ConstArrayView<VariableSyncInfo> infos() const { return m_ranks_info; }
 
  ARCANE_DEPRECATED_REASON("Y2023: do not use")
  ArrayView<VariableSyncInfo> infos() { return m_ranks_info; }
 
  ARCANE_DEPRECATED_REASON("Y2023: do not use")
  VariableSyncInfo& operator[](Int32 i) { return m_ranks_info[i]; }
  ARCANE_DEPRECATED_REASON("Y2023: do not use")
  const VariableSyncInfo& operator[](Int32 i) const { return m_ranks_info[i]; }
 
  ARCANE_DEPRECATED_REASON("Y2023: do not use")
  VariableSyncInfo& rankInfo(Int32 i) { return m_ranks_info[i]; }
  ARCANE_DEPRECATED_REASON("Y2023: do not use")
  const VariableSyncInfo& rankInfo(Int32 i) const { return m_ranks_info[i]; }
 
 private:
 
  UniqueArray<Int32> m_communicating_ranks;
  UniqueArray<VariableSyncInfo> m_ranks_info;
  std::array<DataSynchronizeBufferInfoList, 2> m_buffer_infos = { { { this, true }, { this, false } } };
 
 private:
 
  DataSynchronizeBufferInfoList& _sendInfo() { return m_buffer_infos[SEND]; }
  DataSynchronizeBufferInfoList& _receiveInfo() { return m_buffer_infos[RECEIVE]; }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif