MessagePassingGlobal.h

Go to the documentation of this file.

// -*- 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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MessagePassingGlobal.h                                      (C) 2000-2026 */
/*                                                                           */
/* Global definitions for the 'MessagePassing' component of 'Arccore'.       */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_MESSAGEPASSING_MESSAGEPASSINGGLOBAL_H
#define ARCCORE_MESSAGEPASSING_MESSAGEPASSINGGLOBAL_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/RefDeclarations.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#if defined(ARCCORE_COMPONENT_arccore_message_passing)
#define ARCCORE_MESSAGEPASSING_EXPORT ARCCORE_EXPORT
#define ARCCORE_MESSAGEPASSING_EXTERN_TPL
#else
#define ARCCORE_MESSAGEPASSING_EXPORT ARCCORE_IMPORT
#define ARCCORE_MESSAGEPASSING_EXTERN_TPL extern
#endif
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class ISerializer;
class ITimeMetricCollector;
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore
{
using Arcane::ISerializer;
using Arcane::ITimeMetricCollector;
} // namespace Arccore
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::MessagePassing
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \brief Number corresponding to a null rank.
 *
 * The meaning of the null rank depends on the situation.
 *
 * \sa MessageRank.
 */
static const Int32 A_NULL_RANK = static_cast<Int32>(-1);
 
//! Number corresponding to a null rank
static const Int32 A_NULL_TAG_VALUE = static_cast<Int32>(-1);
 
//! Number corresponding to MPI_ANY_SOURCE
static const Int32 A_ANY_SOURCE_RANK = static_cast<Int32>(-2);
 
//! Number corresponding to MPI_PROC_NULL
static const Int32 A_PROC_NULL_RANK = static_cast<Int32>(-3);
 
class Communicator;
class SubRequestCompletionInfo;
class IRequestCreator;
class IRequestList;
class ISerializeMessage;
class ISerializeMessageList;
class ISerializeDispatcher;
class Request;
class MessageId;
class MessageTag;
class MessageRank;
class MessageSourceInfo;
class PointToPointMessageInfo;
class IStat;
class Stat;
class OneStat;
class StatData;
class IMessagePassingMng;
class MessagePassingMng;
class IDispatchers;
class Dispatchers;
class IProfiler;
class ISubRequest;
class IControlDispatcher;
template <typename DataType> class ITypeDispatcher;
class GatherMessageInfoBase;
template <typename DataType> class GatherMessageInfo;
class PointToPointSerializerMng;
class ISerializeMessage;
class ISerializeMessageList;
class IContigMachineShMemWinBaseInternal;
 
/*!
 * \brief Supported reduction types.
 */
enum eReduceType
{
  ReduceMin, //!< Minimum of values
  ReduceMax, //!< Maximum of values
  ReduceSum //!< Sum of values
};
 
/*!
 * \brief Wait type.
 */
enum eWaitType
{
  WaitAll = 0, //! Wait until all messages in the list are processed
  WaitSome = 1, //! Wait until at least one message in the list is processed
  TestSome = 2, //! Process only messages that can be processed without waiting.
  //! \deprecated Use TestSome instead
  WaitSomeNonBlocking = 2
};
 
/*!
 * \brief Type indicating whether a message is blocking or not.
 */
enum eBlockingType
{
  Blocking = 0,
  NonBlocking
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \brief Point-to-point message type.
 */
enum ePointToPointMessageType
{
  MsgSend = 0,
  MsgReceive
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::MessagePassing
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::MessagePassing::internal
{
class BasicSerializeMessage;
class SerializeMessageList;
} // namespace Arcane::MessagePassing::internal
 
namespace Arccore::MessagePassing::internal
{
using Arcane::MessagePassing::internal::BasicSerializeMessage;
using Arcane::MessagePassing::internal::SerializeMessageList;
} // namespace Arccore::MessagePassing::internal
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arcane::MessagePassing::IMessagePassingMng)
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
using Arcane::MessagePassing::IControlDispatcher;
using Arcane::MessagePassing::IMessagePassingMng;
using Arcane::MessagePassing::ISerializeMessage;
using Arcane::MessagePassing::ISerializeMessageList;
using Arcane::MessagePassing::ITypeDispatcher;
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore::MessagePassing
{
using Arcane::MessagePassing::eReduceType;
using Arcane::MessagePassing::ReduceMax;
using Arcane::MessagePassing::ReduceMin;
using Arcane::MessagePassing::ReduceSum;
 
using Arcane::MessagePassing::eWaitType;
using Arcane::MessagePassing::TestSome;
using Arcane::MessagePassing::WaitAll;
using Arcane::MessagePassing::WaitSome;
using Arcane::MessagePassing::WaitSomeNonBlocking;
 
using Arcane::MessagePassing::Blocking;
using Arcane::MessagePassing::eBlockingType;
using Arcane::MessagePassing::NonBlocking;
 
using Arcane::MessagePassing::ePointToPointMessageType;
using Arcane::MessagePassing::MsgReceive;
using Arcane::MessagePassing::MsgSend;
 
using Arcane::MessagePassing::IRequestCreator;
using Arcane::MessagePassing::IRequestList;
using Arcane::MessagePassing::ISubRequest;
using Arcane::MessagePassing::MessageId;
using Arcane::MessagePassing::MessagePassingMng;
using Arcane::MessagePassing::MessageRank;
using Arcane::MessagePassing::MessageSourceInfo;
using Arcane::MessagePassing::MessageTag;
using Arcane::MessagePassing::PointToPointMessageInfo;
using Arcane::MessagePassing::Request;
using Arcane::MessagePassing::SubRequestCompletionInfo;
 
using Arcane::MessagePassing::Communicator;
using Arcane::MessagePassing::Dispatchers;
using Arcane::MessagePassing::IDispatchers;
using Arcane::MessagePassing::IProfiler;
using Arcane::MessagePassing::ISerializeDispatcher;
using Arcane::MessagePassing::IStat;
using Arcane::MessagePassing::Stat;
 
using Arcane::MessagePassing::A_ANY_SOURCE_RANK;
using Arcane::MessagePassing::A_NULL_RANK;
using Arcane::MessagePassing::A_NULL_TAG_VALUE;
using Arcane::MessagePassing::A_PROC_NULL_RANK;
 
using Arcane::MessagePassing::GatherMessageInfo;
using Arcane::MessagePassing::GatherMessageInfoBase;
 
using Arcane::MessagePassing::IControlDispatcher;
using Arcane::MessagePassing::IMessagePassingMng;
using Arcane::MessagePassing::ISerializeMessage;
using Arcane::MessagePassing::ISerializeMessageList;
using Arcane::MessagePassing::OneStat;
using Arcane::MessagePassing::PointToPointSerializerMng;
using Arcane::MessagePassing::StatData;
} // namespace Arccore::MessagePassing
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// TODO: deprecate and use Arcane::MessagePassing instead
namespace Arcane::Parallel
{
using Arcane::MessagePassing::eReduceType;
using Arcane::MessagePassing::ReduceMax;
using Arcane::MessagePassing::ReduceMin;
using Arcane::MessagePassing::ReduceSum;
 
using Arcane::MessagePassing::eWaitType;
using Arcane::MessagePassing::TestSome;
using Arcane::MessagePassing::WaitAll;
using Arcane::MessagePassing::WaitSome;
using Arcane::MessagePassing::WaitSomeNonBlocking;
 
using Arcane::MessagePassing::Blocking;
using Arcane::MessagePassing::eBlockingType;
using Arcane::MessagePassing::NonBlocking;
 
using Arcane::MessagePassing::ePointToPointMessageType;
using Arcane::MessagePassing::MsgReceive;
using Arcane::MessagePassing::MsgSend;
 
using Arcane::MessagePassing::IRequestCreator;
using Arcane::MessagePassing::IRequestList;
using Arcane::MessagePassing::ISubRequest;
using Arcane::MessagePassing::MessageId;
using Arcane::MessagePassing::MessageRank;
using Arcane::MessagePassing::MessageSourceInfo;
using Arcane::MessagePassing::MessageTag;
using Arcane::MessagePassing::PointToPointMessageInfo;
using Arcane::MessagePassing::Request;
 
using Arcane::MessagePassing::Communicator;
} // namespace Arcane::Parallel
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif