MessagePassingGlobal.h

Aller à la documentation de ce fichier.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2025 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-2025 */
/*                                                                           */
/* Définitions globales de la composante 'MessagePassing' de '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 Arccore
{
class ISerializer;
class ITimeMetricCollector;
}
 
namespace Arccore::MessagePassing
{
/*!
 * \brief Numéro correspondant à un rang nul.
 *
 * La signification du rang nul dépend de la situation.
 *
 * \sa MessageRank.
 */
static const Int32 A_NULL_RANK = static_cast<Int32>(-1);
 
//! Numéro correspondant à un rang nul
static const Int32 A_NULL_TAG_VALUE = static_cast<Int32>(-1);
 
//! Numéro correspondant à MPI_ANY_SOURCE
static const Int32 A_ANY_SOURCE_RANK = static_cast<Int32>(-2);
 
//! Numéro correspondant à 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 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;
 
/*!
 * \brief Types des réductions supportées.
 */
enum eReduceType
{
  ReduceMin, //!< Minimum des valeurs
  ReduceMax, //!< Maximum des valeurs
  ReduceSum  //!< Somme des valeurs
};
 
/*!
 * \brief Type d'attente.
 */
enum eWaitType
{
  WaitAll = 0, //! Attend que tous les messages de la liste soient traités
  WaitSome = 1, //! Attend que au moins un message de la liste soit traité
  TestSome = 2, //! Traite uniquement les messages qui peuvent l'être sans attendre.
  //! \deprecated Utiliser TestSome à la place
  WaitSomeNonBlocking = 2
};
/*!
 * \brief Type indiquant si un message est bloquant ou non.
 */
enum eBlockingType
{
  Blocking = 0,
  NonBlocking
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Type de message point à point.
 */
enum ePointToPointMessageType
{
  MsgSend = 0,
  MsgReceive
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arccore::MessagePassing
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore::MessagePassing::internal
{
class BasicSerializeMessage;
}
 
namespace Arcane::MessagePassing::internal
{
using Arccore::MessagePassing::internal::BasicSerializeMessage;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ARCCORE_DECLARE_REFERENCE_COUNTED_CLASS(Arccore::MessagePassing::IMessagePassingMng)
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
using Arccore::MessagePassing::IControlDispatcher;
using Arccore::MessagePassing::IMessagePassingMng;
using Arccore::MessagePassing::ISerializeMessage;
using Arccore::MessagePassing::ISerializeMessageList;
using Arccore::MessagePassing::ITypeDispatcher;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::MessagePassing
{
using Arccore::MessagePassing::eReduceType;
using Arccore::MessagePassing::ReduceMax;
using Arccore::MessagePassing::ReduceMin;
using Arccore::MessagePassing::ReduceSum;
 
using Arccore::MessagePassing::eWaitType;
using Arccore::MessagePassing::TestSome;
using Arccore::MessagePassing::WaitAll;
using Arccore::MessagePassing::WaitSome;
using Arccore::MessagePassing::WaitSomeNonBlocking;
 
using Arccore::MessagePassing::Blocking;
using Arccore::MessagePassing::eBlockingType;
using Arccore::MessagePassing::NonBlocking;
 
using Arccore::MessagePassing::ePointToPointMessageType;
using Arccore::MessagePassing::MsgReceive;
using Arccore::MessagePassing::MsgSend;
 
using Arccore::MessagePassing::IRequestCreator;
using Arccore::MessagePassing::IRequestList;
using Arccore::MessagePassing::ISubRequest;
using Arccore::MessagePassing::MessageId;
using Arccore::MessagePassing::MessageRank;
using Arccore::MessagePassing::MessageSourceInfo;
using Arccore::MessagePassing::MessageTag;
using Arccore::MessagePassing::PointToPointMessageInfo;
using Arccore::MessagePassing::Request;
using Arccore::MessagePassing::MessagePassingMng;
using Arccore::MessagePassing::SubRequestCompletionInfo;
 
using Arccore::MessagePassing::Communicator;
using Arccore::MessagePassing::IProfiler;
using Arccore::MessagePassing::IStat;
using Arccore::MessagePassing::Stat;
using Arccore::MessagePassing::ISerializeDispatcher;
using Arccore::MessagePassing::IDispatchers;
using Arccore::MessagePassing::Dispatchers;
 
using Arccore::MessagePassing::A_NULL_RANK;
using Arccore::MessagePassing::A_NULL_TAG_VALUE;
using Arccore::MessagePassing::A_ANY_SOURCE_RANK;
using Arccore::MessagePassing::A_PROC_NULL_RANK;
 
using Arccore::MessagePassing::GatherMessageInfoBase;
using Arccore::MessagePassing::GatherMessageInfo;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// TODO: rendre obsolète et utiliser Arcane::MessagePassing à la place
namespace Arcane::Parallel
{
using Arccore::MessagePassing::eReduceType;
using Arccore::MessagePassing::ReduceMax;
using Arccore::MessagePassing::ReduceMin;
using Arccore::MessagePassing::ReduceSum;
 
using Arccore::MessagePassing::eWaitType;
using Arccore::MessagePassing::TestSome;
using Arccore::MessagePassing::WaitAll;
using Arccore::MessagePassing::WaitSome;
using Arccore::MessagePassing::WaitSomeNonBlocking;
 
using Arccore::MessagePassing::Blocking;
using Arccore::MessagePassing::eBlockingType;
using Arccore::MessagePassing::NonBlocking;
 
using Arccore::MessagePassing::ePointToPointMessageType;
using Arccore::MessagePassing::MsgReceive;
using Arccore::MessagePassing::MsgSend;
 
using Arccore::MessagePassing::IRequestCreator;
using Arccore::MessagePassing::IRequestList;
using Arccore::MessagePassing::ISubRequest;
using Arccore::MessagePassing::MessageId;
using Arccore::MessagePassing::MessageRank;
using Arccore::MessagePassing::MessageSourceInfo;
using Arccore::MessagePassing::MessageTag;
using Arccore::MessagePassing::PointToPointMessageInfo;
using Arccore::MessagePassing::Request;
 
using Arccore::MessagePassing::Communicator;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif