MachineShMemWinVariableBase.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MachineShMemWinVariableBase.h                               (C) 2000-2026 */
/*                                                                           */
/* Base classes allowing the exploitation of the MachineShMemWinVariable     */
/* pointed to the shared memory variable zone.                               */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_INTERNAL_MACHINESHMEMWINVARIABLEBASE_H
#define ARCANE_CORE_INTERNAL_MACHINESHMEMWINVARIABLEBASE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
#include "arcane/utils/UniqueArray.h"
#include "arcane/utils/FixedArray.h"
#include "arcane/utils/HashTableMap2.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MachineShMemWinVariableBase
{
 
 public:

  explicit MachineShMemWinVariableBase(IVariable* var);
 
 public:

  ConstArrayView<Int32> machineRanks() const;

  void barrier() const;

  Span<std::byte> segmentView(Int32 rank) const;

  void updateVariable(Int64 nb_elem_dim1, Int64 sizeof_elem);
 
 protected:
 
  IVariable* m_var = nullptr;
  IParallelMng* m_pm = nullptr;
 
  ConstArrayView<Int32> m_machine_ranks;
 
  // <world_rank, size_bytes>
  impl::HashTableMap2<Int32, Int64> m_sizeof_var;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MachineShMemWinVariable2DBase
: public MachineShMemWinVariableBase
{
 
 public:

  explicit MachineShMemWinVariable2DBase(IVariable* var);
 
 public:

  void updateVariable(Int64 nb_elem_dim1, Int64 nb_elem_dim2, Int64 sizeof_elem);
 
  Int64 nbElemDim1(const Int32 rank) const { return m_nb_elem_dim1.at(rank); }
  Int64 nbElemDim2(const Int32 rank) const { return m_nb_elem_dim2.at(rank); }
 
 private:
 
  // <world_rank, size_nb_elems>
  impl::HashTableMap2<Int32, Int64> m_nb_elem_dim1;
  impl::HashTableMap2<Int32, Int64> m_nb_elem_dim2;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MachineShMemWinVariableMDBase
: public MachineShMemWinVariableBase
{
 
 public:

  explicit MachineShMemWinVariableMDBase(IVariable* var);
 
 public:

  void updateVariable(Int64 nb_elem_dim1, Int32 nb_elem_dim2, Int64 sizeof_elem);
 
  Int64 nbElemDim1(const Int32 rank) const { return m_nb_elem_dim1.at(rank); }
  ArrayShape arrayShape() const;
 
 private:
 
  // <world_rank, size_nb_elems>
  impl::HashTableMap2<Int32, Int64> m_nb_elem_dim1;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif