Arcane  4.2.3.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Messages.h
Aller à la documentation de ce fichier.
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* Messages.h (C) 2000-2026 */
9/* */
10/* Interface du gestionnaire des échanges de messages. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCCORE_MESSAGEPASSING_MESSAGES_H
13#define ARCCORE_MESSAGEPASSING_MESSAGES_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arccore/message_passing/IMessagePassingMng.h"
18#include "arccore/message_passing/IDispatchers.h"
19#include "arccore/message_passing/ITypeDispatcher.h"
20#include "arccore/message_passing/Request.h"
21
22#include "arccore/base/RefDeclarations.h"
23#include "arccore/base/Span.h"
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28namespace Arcane::MessagePassing
29{
30
31/*---------------------------------------------------------------------------*/
32/*---------------------------------------------------------------------------*/
33
34#define ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(type) \
35 \
36 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
37 mpAllGather(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf); \
38 \
39 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
40 mpGather(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf, Int32 rank); \
41 \
42 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
43 mpNonBlockingAllGather(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf); \
44 \
45 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
46 mpNonBlockingGather(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf, Int32 rank); \
47 \
48 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
49 mpAllGatherVariable(IMessagePassingMng* pm, Span<const type> send_buf, Array<type>& recv_buf); \
50 \
51 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
52 mpGatherVariable(IMessagePassingMng* pm, Span<const type> send_buf, Array<type>& recv_buf, Int32 rank); \
53 \
54 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
55 mpGather(IMessagePassingMng* pm, GatherMessageInfo<type>& gather_info); \
56 \
57 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
58 mpScatterVariable(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf, Int32 root); \
59 \
60 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT type \
61 mpAllReduce(IMessagePassingMng* pm, eReduceType rt, type v); \
62 \
63 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
64 mpAllReduce(IMessagePassingMng* pm, eReduceType rt, Span<type> buf); \
65 \
66 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
67 mpAllReduce(IMessagePassingMng* pm, eReduceType rt, Span<const type> send_buf, Span<type> receive_buf); \
68 \
69 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
70 mpScanExclusive(IMessagePassingMng* pm, eReduceType rt, Span<const type> send_buf, Span<type> receive_buf); \
71 \
72 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
73 mpNonBlockingAllReduce(IMessagePassingMng* pm, eReduceType rt, Span<const type> send_buf, Span<type> recv_buf); \
74 \
75 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
76 mpBroadcast(IMessagePassingMng* pm, Span<type> send_buf, Int32 rank); \
77 \
78 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
79 mpNonBlockingBroadcast(IMessagePassingMng* pm, Span<type> send_buf, Int32 rank); \
80 \
81 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
82 mpSend(IMessagePassingMng* pm, Span<const type> values, Int32 rank); \
83 \
84 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
85 mpReceive(IMessagePassingMng* pm, Span<type> values, Int32 rank); \
86 \
87 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
88 mpSend(IMessagePassingMng* pm, Span<const type> values, Int32 rank, bool is_blocked); \
89 \
90 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
91 mpSend(IMessagePassingMng* pm, Span<const type> values, const PointToPointMessageInfo& message); \
92 \
93 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
94 mpReceive(IMessagePassingMng* pm, Span<type> values, Int32 rank, bool is_blocked); \
95 \
96 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
97 mpReceive(IMessagePassingMng* pm, Span<type> values, const PointToPointMessageInfo& message); \
98 \
99 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
100 mpAllToAll(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf, Int32 count); \
101 \
102 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
103 mpNonBlockingAllToAll(IMessagePassingMng* pm, Span<const type> send_buf, Span<type> recv_buf, Int32 count); \
104 \
105 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT void \
106 mpAllToAllVariable(IMessagePassingMng* pm, Span<const type> send_buf, ConstArrayView<Int32> send_count, \
107 ConstArrayView<Int32> send_index, Span<type> recv_buf, \
108 ConstArrayView<Int32> recv_count, ConstArrayView<Int32> recv_index); \
109 \
110 extern "C++" ARCCORE_MESSAGEPASSING_EXPORT Request \
111 mpNonBlockingAllToAllVariable(IMessagePassingMng* pm, Span<const type> send_buf, ConstArrayView<Int32> send_count, \
112 ConstArrayView<Int32> send_index, Span<type> recv_buf, \
113 ConstArrayView<Int32> recv_count, ConstArrayView<Int32> recv_index);
114
115/*---------------------------------------------------------------------------*/
116/*---------------------------------------------------------------------------*/
122ARCCORE_MESSAGEPASSING_EXPORT Ref<IRequestList>
123mpCreateRequestListRef(IMessagePassingMng* pm);
124
125/*---------------------------------------------------------------------------*/
126/*---------------------------------------------------------------------------*/
130ARCCORE_MESSAGEPASSING_EXPORT void
131mpWaitAll(IMessagePassingMng* pm, ArrayView<Request> requests);
132
133/*---------------------------------------------------------------------------*/
134/*---------------------------------------------------------------------------*/
138ARCCORE_MESSAGEPASSING_EXPORT void
139mpWait(IMessagePassingMng* pm, Request request);
140
141/*---------------------------------------------------------------------------*/
142/*---------------------------------------------------------------------------*/
149ARCCORE_MESSAGEPASSING_EXPORT void
150mpWaitSome(IMessagePassingMng* pm, ArrayView<Request> requests, ArrayView<bool> indexes);
151
152/*---------------------------------------------------------------------------*/
153/*---------------------------------------------------------------------------*/
160ARCCORE_MESSAGEPASSING_EXPORT void
161mpTestSome(IMessagePassingMng* pm, ArrayView<Request> requests, ArrayView<bool> indexes);
162
163/*---------------------------------------------------------------------------*/
164/*---------------------------------------------------------------------------*/
171ARCCORE_MESSAGEPASSING_EXPORT void
172mpWait(IMessagePassingMng* pm, ArrayView<Request> requests,
173 ArrayView<bool> indexes, eWaitType wait_type);
174
175/*---------------------------------------------------------------------------*/
176/*---------------------------------------------------------------------------*/
194ARCCORE_MESSAGEPASSING_EXPORT MessageId
195mpProbe(IMessagePassingMng* pm, const PointToPointMessageInfo& message);
196
197/*---------------------------------------------------------------------------*/
198/*---------------------------------------------------------------------------*/
216ARCCORE_MESSAGEPASSING_EXPORT MessageSourceInfo
217mpLegacyProbe(IMessagePassingMng* pm, const PointToPointMessageInfo& message);
218
219/*---------------------------------------------------------------------------*/
220/*---------------------------------------------------------------------------*/
232ARCCORE_DEPRECATED_REASON("Y2026: Use mpSplitCommunicator() instead.")
233ARCCORE_MESSAGEPASSING_EXPORT IMessagePassingMng*
234mpSplit(IMessagePassingMng* pm, bool keep);
235
236/*---------------------------------------------------------------------------*/
237/*---------------------------------------------------------------------------*/
245ARCCORE_MESSAGEPASSING_EXPORT Ref<IMessagePassingMng>
246mpSplitCommunicator(IMessagePassingMng* pm, bool keep);
247
248/*---------------------------------------------------------------------------*/
249/*---------------------------------------------------------------------------*/
250
256ARCCORE_MESSAGEPASSING_EXPORT void
257mpBarrier(IMessagePassingMng* pm);
258
259/*---------------------------------------------------------------------------*/
260/*---------------------------------------------------------------------------*/
264ARCCORE_MESSAGEPASSING_EXPORT Request
265mpNonBlockingBarrier(IMessagePassingMng* pm);
266
267/*---------------------------------------------------------------------------*/
268/*---------------------------------------------------------------------------*/
274ARCCORE_MESSAGEPASSING_EXPORT Ref<ISerializeMessageList>
275mpCreateSerializeMessageListRef(IMessagePassingMng* pm);
276
278ARCCORE_MESSAGEPASSING_EXPORT Request
279mpSend(IMessagePassingMng* pm, const ISerializer* values, const PointToPointMessageInfo& message);
280
282ARCCORE_MESSAGEPASSING_EXPORT Request
283mpReceive(IMessagePassingMng* pm, ISerializer* values, const PointToPointMessageInfo& message);
284
286ARCCORE_MESSAGEPASSING_EXPORT void
287mpAllGather(IMessagePassingMng* pm, const ISerializer* send_serializer, ISerializer* recv_serializer);
288
289/*---------------------------------------------------------------------------*/
290/*---------------------------------------------------------------------------*/
300ARCCORE_MESSAGEPASSING_EXPORT Ref<ISerializeMessage>
301mpCreateSerializeMessage(IMessagePassingMng* pm, MessageRank target, ePointToPointMessageType type);
302
308ARCCORE_MESSAGEPASSING_EXPORT Ref<ISerializeMessage>
309mpCreateSerializeMessage(IMessagePassingMng* pm, MessageId id);
310
319ARCCORE_MESSAGEPASSING_EXPORT Ref<ISerializeMessage>
320mpCreateSendSerializeMessage(IMessagePassingMng* pm, MessageRank destination);
321
330ARCCORE_MESSAGEPASSING_EXPORT Ref<ISerializeMessage>
331mpCreateReceiveSerializeMessage(IMessagePassingMng* pm, MessageRank source);
332
333/*---------------------------------------------------------------------------*/
334/*---------------------------------------------------------------------------*/
335
336ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(char)
337ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(signed char)
338ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(unsigned char)
339
340ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(short)
341ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(unsigned short)
342ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(int)
343ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(unsigned int)
344ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(long)
345ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(unsigned long)
346ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(long long)
347ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(unsigned long long)
348
349ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(float)
350ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(double)
351ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(long double)
352
353ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(BFloat16)
354ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE(Float16)
355
356#undef ARCCORE_GENERATE_MESSAGEPASSING_PROTOTYPE
357
358/*---------------------------------------------------------------------------*/
359/*---------------------------------------------------------------------------*/
360
361} // namespace Arcane::MessagePassing
362
363/*---------------------------------------------------------------------------*/
364/*---------------------------------------------------------------------------*/
365
366namespace Arccore::MessagePassing
367{
368using Arcane::MessagePassing::mpAllGather;
369using Arcane::MessagePassing::mpAllGatherVariable;
370using Arcane::MessagePassing::mpAllReduce;
371using Arcane::MessagePassing::mpAllToAll;
372using Arcane::MessagePassing::mpAllToAllVariable;
373using Arcane::MessagePassing::mpBarrier;
374using Arcane::MessagePassing::mpBroadcast;
375using Arcane::MessagePassing::mpCreateReceiveSerializeMessage;
376using Arcane::MessagePassing::mpCreateRequestListRef;
377using Arcane::MessagePassing::mpCreateSendSerializeMessage;
378using Arcane::MessagePassing::mpCreateSerializeMessage;
379using Arcane::MessagePassing::mpCreateSerializeMessageListRef;
380using Arcane::MessagePassing::mpGather;
381using Arcane::MessagePassing::mpGatherVariable;
382using Arcane::MessagePassing::mpLegacyProbe;
383using Arcane::MessagePassing::mpNonBlockingAllGather;
384using Arcane::MessagePassing::mpNonBlockingAllReduce;
385using Arcane::MessagePassing::mpNonBlockingAllToAll;
386using Arcane::MessagePassing::mpNonBlockingAllToAllVariable;
387using Arcane::MessagePassing::mpNonBlockingBarrier;
388using Arcane::MessagePassing::mpNonBlockingBroadcast;
389using Arcane::MessagePassing::mpNonBlockingGather;
390using Arcane::MessagePassing::mpProbe;
391using Arcane::MessagePassing::mpReceive;
392using Arcane::MessagePassing::mpScatterVariable;
393using Arcane::MessagePassing::mpSend;
394using Arcane::MessagePassing::mpSplit;
395using Arcane::MessagePassing::mpTestSome;
396using Arcane::MessagePassing::mpWait;
397using Arcane::MessagePassing::mpWaitAll;
398using Arcane::MessagePassing::mpWaitSome;
399}
400
401/*---------------------------------------------------------------------------*/
402/*---------------------------------------------------------------------------*/
403
404#endif
Span.h
Types et fonctions associés aux classes SpanImpl, SmallSpan et Span.
Arcane::Float16
Type flottant demi-précision.
Definition arccore/src/base/arccore/base/Float16.h:33
Arcane::MessagePassing::IMessagePassingMng
Interface du gestionnaire des échanges de messages.
Definition IMessagePassingMng.h:55
Arcane::MessagePassing::ISerializeMessage
Interface d'un message de sérialisation entre IMessagePassingMng.
Definition arccore/src/message_passing/arccore/message_passing/ISerializeMessage.h:45
Arcane::MessagePassing::MessageSourceInfo
Informations sur la source d'un message.
Definition MessageSourceInfo.h:36
Arcane::MessagePassing::PointToPointMessageInfo
Informations pour envoyer/recevoir un message point à point.
Definition PointToPointMessageInfo.h:52
Arcane::MessagePassing::Request
Requête d'un message.
Definition Request.h:77
Arcane::MessagePassing
Déclarations des types et méthodes utilisés par les mécanismes d'échange de messages.
Definition ContigMachineShMemWinBase.h:37
Arcane::MessagePassing::mpGather
C void mpGather(IMessagePassingMng *pm, Span< const char > send_buf, Span< char > recv_buf, Int32 rank)
Arcane::MessagePassing::mpCreateSerializeMessage
Ref< ISerializeMessage > mpCreateSerializeMessage(IMessagePassingMng *pm, MessageRank target, ePointToPointMessageType type)
Créé un message de sérialisation.
Definition Messages.cc:334
Arcane::MessagePassing::mpScatterVariable
C void mpScatterVariable(IMessagePassingMng *pm, Span< const char > send_buf, Span< char > recv_buf, Int32 root)
Arcane::MessagePassing::mpNonBlockingAllGather
C Request mpNonBlockingAllGather(IMessagePassingMng *pm, Span< const char > send_buf, Span< char > recv_buf)
Arcane::MessagePassing::mpBroadcast
C void mpBroadcast(IMessagePassingMng *pm, Span< char > send_buf, Int32 rank)
Arcane::MessagePassing::mpTestSome
void mpTestSome(IMessagePassingMng *pm, ArrayView< Request > requests, ArrayView< bool > indexes)
Teste si des requêtes de request sont terminées.
Definition Messages.cc:189
Arcane::MessagePassing::mpCreateSerializeMessageListRef
Ref< ISerializeMessageList > mpCreateSerializeMessageListRef(IMessagePassingMng *pm)
Créé une liste de messages de sérialisation.
Definition Messages.cc:278
Arcane::MessagePassing::mpCreateSendSerializeMessage
Ref< ISerializeMessage > mpCreateSendSerializeMessage(IMessagePassingMng *pm, MessageRank destination)
Créé un message de sérialisation en envoi.
Definition Messages.cc:346
Arcane::MessagePassing::mpLegacyProbe
MessageSourceInfo mpLegacyProbe(IMessagePassingMng *pm, const PointToPointMessageInfo &message)
Teste si un message est disponible.
Definition Messages.cc:229
Arcane::MessagePassing::mpSplitCommunicator
Ref< IMessagePassingMng > mpSplitCommunicator(IMessagePassingMng *pm, bool keep)
Créé un sous-communicateur.
Definition Messages.cc:249
Arcane::MessagePassing::mpCreateReceiveSerializeMessage
Ref< ISerializeMessage > mpCreateReceiveSerializeMessage(IMessagePassingMng *pm, MessageRank source)
Créé un message de sérialisation en envoi.
Definition Messages.cc:352
Arcane::MessagePassing::mpProbe
MessageId mpProbe(IMessagePassingMng *pm, const PointToPointMessageInfo &message)
Teste si un message est disponible.
Definition Messages.cc:219
Arcane::MessagePassing::mpAllToAll
C void mpAllToAll(IMessagePassingMng *pm, Span< const char > send_buf, Span< char > recv_buf, Int32 count)
Arcane::MessagePassing::mpNonBlockingAllToAll
C Request mpNonBlockingAllToAll(IMessagePassingMng *pm, Span< const char > send_buf, Span< char > recv_buf, Int32 count)
Arcane::MessagePassing::mpAllToAllVariable
C void mpAllToAllVariable(IMessagePassingMng *pm, Span< const char > send_buf, ConstArrayView< Int32 > send_count, ConstArrayView< Int32 > send_index, Span< char > recv_buf, ConstArrayView< Int32 > recv_count, ConstArrayView< Int32 > recv_index)
Arcane::MessagePassing::mpGatherVariable
C void mpGatherVariable(IMessagePassingMng *pm, Span< const char > send_buf, Array< char > &recv_buf, Int32 rank)
Arcane::MessagePassing::mpAllReduce
C char mpAllReduce(IMessagePassingMng *pm, eReduceType rt, char v)
Arcane::MessagePassing::mpCreateRequestListRef
Ref< IRequestList > mpCreateRequestListRef(IMessagePassingMng *pm)
Créé une liste de requêtes.
Definition Messages.cc:154
Arcane::MessagePassing::mpAllGatherVariable
C void mpAllGatherVariable(IMessagePassingMng *pm, Span< const char > send_buf, Array< char > &recv_buf)
Arcane::MessagePassing::mpBarrier
void mpBarrier(IMessagePassingMng *pm)
Effectue une barrière.
Definition Messages.cc:258
Arcane::MessagePassing::mpNonBlockingBarrier
Request mpNonBlockingBarrier(IMessagePassingMng *pm)
Effectue une barrière non bloquante.
Definition Messages.cc:268
Arcane::MessagePassing::mpWait
void mpWait(IMessagePassingMng *pm, Request request)
Bloque jusqu'à ce que la requête request soit terminée.
Definition Messages.cc:172
Arcane::MessagePassing::mpAllGather
void mpAllGather(IMessagePassingMng *pm, const ISerializer *send_serializer, ISerializer *receive_serialize)
Message allGather() pour une sérialisation.
Definition Messages.cc:318
Arcane::MessagePassing::mpWaitAll
void mpWaitAll(IMessagePassingMng *pm, ArrayView< Request > requests)
Bloque tant que les requêtes de requests ne sont pas terminées.
Definition Messages.cc:163
Arcane::MessagePassing::mpSplit
IMessagePassingMng * mpSplit(IMessagePassingMng *pm, bool keep)
Créé un sous-communicateur.
Definition Messages.cc:239
Arcane::MessagePassing::mpNonBlockingAllToAllVariable
C Request mpNonBlockingAllToAllVariable(IMessagePassingMng *pm, Span< const char > send_buf, ConstArrayView< Int32 > send_count, ConstArrayView< Int32 > send_index, Span< char > recv_buf, ConstArrayView< Int32 > recv_count, ConstArrayView< Int32 > recv_index)
Arcane::MessagePassing::ePointToPointMessageType
ePointToPointMessageType
Type de message point à point.
Definition MessagePassingGlobal.h:132
Arcane::MessagePassing::mpNonBlockingGather
C Request mpNonBlockingGather(IMessagePassingMng *pm, Span< const char > send_buf, Span< char > recv_buf, Int32 rank)
Arcane::MessagePassing::mpReceive
Request mpReceive(IMessagePassingMng *pm, ISerializer *values, const PointToPointMessageInfo &message)
Message de réception utilisant un ISerializer.
Definition Messages.cc:299
Arcane::MessagePassing::mpWaitSome
void mpWaitSome(IMessagePassingMng *pm, ArrayView< Request > requests, ArrayView< bool > indexes)
Bloque jusqu'à ce qu'au moins une des requêtes de request soit terminée.
Definition Messages.cc:180
Arcane::MessagePassing::mpNonBlockingBroadcast
C Request mpNonBlockingBroadcast(IMessagePassingMng *pm, Span< char > send_buf, Int32 rank)
Arcane::MessagePassing::mpSend
Request mpSend(IMessagePassingMng *pm, const ISerializer *values, const PointToPointMessageInfo &message)
Message d'envoi utilisant un ISerializer.
Definition Messages.cc:288
Arcane::MessagePassing::mpNonBlockingAllReduce
C Request mpNonBlockingAllReduce(IMessagePassingMng *pm, eReduceType rt, Span< const char > send_buf, Span< char > recv_buf)
Arccore::MessagePassing
Espace de nommage contenant les types et déclarations qui gèrent le mécanisme de parallélisme par éch...
Definition MessagePassingGlobal.cc:43