MachineShMemWinBase.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MachineShMemWinBase.h                                       (C) 2000-2026 */
/*                                                                           */
/* Class allowing the creation of memory windows for a computing node.       */
/* The segments of these windows are not contiguous in memory and can        */
/* be resized.                                                               */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_MACHINESHMEMWINBASE_H
#define ARCANE_CORE_MACHINESHMEMWINBASE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/utils/Ref.h"
 
#include "arccore/base/Span.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IParallelMng;
class IParallelMngInternal;
namespace MessagePassing
{
  class IMachineShMemWinBaseInternal;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MachineShMemWinBase
{
 
 public:

  MachineShMemWinBase(IParallelMng* pm, Int64 sizeof_segment, Int32 sizeof_elem);
 
 public:

  ConstArrayView<Int32> machineRanks() const;

  void barrier() const;

  Span<std::byte> segmentView();

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

  Span<const std::byte> segmentConstView() const;

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

  void add(Span<const std::byte> elem);
  void add();

  void addToAnotherSegment(Int32 rank, Span<const std::byte> elem);

  void addToAnotherSegment();

  void reserve(Int64 new_nb_elem_segment_capacity);

  void reserve();

  void resize(Int64 new_nb_elem_segment);

  void resize();

  void shrink();
 
 private:
 
  IParallelMngInternal* m_pm_internal;
  Ref<MessagePassing::IMachineShMemWinBaseInternal> m_node_window_base;
  Int32 m_sizeof_elem;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif