5#ifndef DUNE_COMMON_PARALLEL_VARIABLESIZECOMMUNICATOR_HH
6#define DUNE_COMMON_PARALLEL_VARIABLESIZECOMMUNICATOR_HH
44 template <
typename H>
auto require(H &&h) ->
decltype(h.fixedSize());
53constexpr bool callFixedSize(H &&handle) {
54 return handle.fixedSize();
65template<
class T,
class Allocator=std::allocator<T> >
73 explicit MessageBuffer(
int size)
74 : buffer_(new T[
size]), size_(
size), position_(0)
80 explicit MessageBuffer(
const MessageBuffer& o)
81 : buffer_(new T[o.size_]), size_(o.size_), position_(o.position_)
93 void write(
const T& data)
95 buffer_[position_++]=
data;
104 data=buffer_[position_++];
123 return position_==size_;
131 bool hasSpaceForItems(
int noItems)
133 return position_+noItems<=size_;
170class InterfaceTracker
178 InterfaceTracker(
int rank, InterfaceInformation info,
std::size_t fixedsize=0,
179 bool allocateSizes=
false)
180 :
fixedSize(fixedsize),rank_(rank), index_(), interface_(info), sizes_()
184 sizes_.resize(info.size());
191 void moveToNextIndex()
194 assert(index_<=interface_.size());
204 assert(index_<=interface_.size());
210 bool finished()
const
212 return index_==interface_.size();
215 void skipZeroIndices()
218 while(sizes_.size() && index_!=interface_.size() &&!
size())
228 return interface_[index_];
235 assert(sizes_.size());
236 return sizes_[index_];
251 return !interface_.size();
260 return interface_.size()-index_;
286 InterfaceInformation interface_;
330template<
class Allocator=std::allocator<std::pair<InterfaceInformation,InterfaceInformation> > >
342#ifndef DUNE_PARALLEL_MAX_COMMUNICATION_BUFFER_SIZE
350 : maxBufferSize_(32768), interface_(&inf)
352 MPI_Comm_dup(comm, &communicator_);
359 : maxBufferSize_(32768), interface_(&inf.interfaces())
371 : maxBufferSize_(DUNE_PARALLEL_MAX_COMMUNICATION_BUFFER_SIZE),
374 MPI_Comm_dup(comm, &communicator_);
380 VariableSizeCommunicator(
const Interface& inf)
381 : maxBufferSize_(DUNE_PARALLEL_MAX_COMMUNICATION_BUFFER_SIZE),
382 interface_(&inf.interfaces())
384 MPI_Comm_dup(inf.communicator(), &communicator_);
394 : maxBufferSize_(max_buffer_size), interface_(&inf)
396 MPI_Comm_dup(comm, &communicator_);
405 : maxBufferSize_(max_buffer_size), interface_(&inf.interfaces())
412 MPI_Comm_free(&communicator_);
420 maxBufferSize_ = other.maxBufferSize_;
421 interface_ = other.interface_;
422 MPI_Comm_dup(other.communicator_, &communicator_);
433 maxBufferSize_ = other.maxBufferSize_;
434 interface_ = other.interface_;
435 MPI_Comm_free(&communicator_);
436 MPI_Comm_dup(other.communicator_, &communicator_);
460 template<
class DataHandle>
463 communicate<true>(handle);
485 template<
class DataHandle>
488 communicate<false>(handle);
492 template<
bool FORWARD,
class DataHandle>
493 void communicateSizes(DataHandle& handle,
502 template<
bool forward,
class DataHandle>
503 void communicate(DataHandle& handle);
513 template<
bool FORWARD,
class DataHandle>
514 void setupInterfaceTrackers(DataHandle& handle,
524 template<
bool FORWARD,
class DataHandle>
525 void communicateFixedSize(DataHandle& handle);
533 template<
bool FORWARD,
class DataHandle>
534 void communicateVariableSize(DataHandle& handle);
555 MPI_Comm communicator_;
564template<
class DataHandle>
570 SizeDataHandle(DataHandle& data,
572 : data_(data), trackers_(trackers), index_()
583 void gather(B& buf,
int i)
585 buf.write(data_.size(i));
593 return trackers_[index_].getSizesPointer();
603void setReceivingIndex(T&,
int)
607void setReceivingIndex(SizeDataHandle<T>& t,
int i)
609 t.setReceivingIndex(i);
618template<
bool FORWARD>
619struct InterfaceInformationChooser
624 static const InterfaceInformation&
633 static const InterfaceInformation&
641struct InterfaceInformationChooser<false>
643 static const InterfaceInformation&
649 static const InterfaceInformation&
661template<
class DataHandle>
665 int operator()(DataHandle& handle, InterfaceTracker& tracker,
666 MessageBuffer<typename DataHandle::DataType>& buffer,
667 [[maybe_unused]]
int i)
const
669 return operator()(handle,tracker,buffer);
679 int operator()(DataHandle& handle, InterfaceTracker& tracker,
680 MessageBuffer<typename DataHandle::DataType>& buffer)
const
682 if(tracker.fixedSize)
688 handle.gather(buffer, tracker.index());
689 tracker.moveToNextIndex();
691 return noIndices*tracker.fixedSize;
696 tracker.skipZeroIndices();
697 while(!tracker.finished())
698 if(buffer.hasSpaceForItems(handle.size(tracker.index())))
700 handle.gather(buffer, tracker.index());
701 packed+=handle.size(tracker.index());
702 tracker.moveToNextIndex();
716template<
class DataHandle>
726 bool operator()(DataHandle& handle, InterfaceTracker& tracker,
727 MessageBuffer<typename DataHandle::DataType>& buffer,
730 if(tracker.fixedSize)
736 handle.scatter(buffer, tracker.index(), tracker.fixedSize);
737 tracker.moveToNextIndex();
739 return tracker.finished();
744 for(
int unpacked=0;unpacked<
count;)
746 assert(!tracker.finished());
747 assert(buffer.hasSpaceForItems(tracker.size()));
748 handle.scatter(buffer, tracker.index(), tracker.size());
749 unpacked+=tracker.size();
750 tracker.moveToNextIndex();
752 return tracker.finished();
761template<
class DataHandle>
762struct UnpackSizeEntries{
771 bool operator()(SizeDataHandle<DataHandle>& handle, InterfaceTracker& tracker,
772 MessageBuffer<
typename SizeDataHandle<DataHandle>::DataType>& buffer)
const
776 handle.getSizesPointer()+tracker.offset());
777 tracker.increment(noIndices);
780 bool operator()(SizeDataHandle<DataHandle>& handle, InterfaceTracker& tracker,
781 MessageBuffer<
typename SizeDataHandle<DataHandle>::DataType>& buffer,
int)
const
783 return operator()(handle,tracker,buffer);
798 MPI_Comm communicator)
803 for(TIter iter=recv_trackers.
begin(), end=recv_trackers.
end(); iter!=
end;
807 iter->rank(), 933881, communicator, &(*mIter));
812 for(TIter iter=send_trackers.
begin(), end=send_trackers.
end();
817 iter->rank(), 933881, communicator, &(*mIter1));
826template<
class DataHandle>
827struct SetupSendRequest{
828 void operator()(DataHandle& handle,
829 InterfaceTracker& tracker,
830 MessageBuffer<typename DataHandle::DataType>& buffer,
831 MPI_Request& request,
835 int size=PackEntries<DataHandle>()(handle, tracker, buffer);
837 while(!tracker.finished() && !handle.size(tracker.index()))
838 tracker.moveToNextIndex();
841 tracker.rank(), 933399, comm, &request);
850template<
class DataHandle>
851struct SetupRecvRequest{
852 void operator()(DataHandle& ,
853 InterfaceTracker& tracker,
854 MessageBuffer<typename DataHandle::DataType>& buffer,
855 MPI_Request& request,
859 if(tracker.indicesLeft())
861 tracker.rank(), 933399, comm, &request);
868template<
class DataHandle>
869struct NullPackUnpackFunctor
871 int operator()(DataHandle&, InterfaceTracker&,
872 MessageBuffer<typename DataHandle::DataType>&,
int)
876 int operator()(DataHandle&, InterfaceTracker&,
877 MessageBuffer<typename DataHandle::DataType>&)
897template<
class DataHandle,
class BufferFunctor,
class CommunicationFunctor>
902 std::vector<MessageBuffer<typename DataHandle::DataType> >& buffers,
904 BufferFunctor buffer_func,
905 CommunicationFunctor comm_func,
914 MPI_Testsome(size, &(requests[0]), &no_completed, &(indices[0]), &(statuses[0]));
915 indices.resize(no_completed);
919 InterfaceTracker& tracker=trackers[*index];
920 setReceivingIndex(handle, *index);
925 MPI_Get_count(&(statuses[index-indices.begin()]),
929 buffer_func(handle, tracker, buffers[*index], count);
931 buffer_func(handle, tracker, buffers[*index]);
932 tracker.skipZeroIndices();
933 if(!tracker.finished()){
935 comm_func(handle, tracker, buffers[*index], requests2[*index], comm);
936 tracker.skipZeroIndices();
954template<
class DataHandle>
955std::size_t receiveSizeAndSetupReceive(DataHandle& handle,
959 std::vector<MessageBuffer<typename DataHandle::DataType> >& buffers,
962 return checkAndContinue(handle, trackers, size_requests, data_requests, buffers, comm,
963 NullPackUnpackFunctor<DataHandle>(), SetupRecvRequest<DataHandle>(),
false);
974template<
class DataHandle>
975std::size_t checkSendAndContinueSending(DataHandle& handle,
978 std::vector<MessageBuffer<typename DataHandle::DataType> >& buffers,
981 return checkAndContinue(handle, trackers, requests, requests, buffers, comm,
982 NullPackUnpackFunctor<DataHandle>(), SetupSendRequest<DataHandle>());
993template<
class DataHandle>
994std::size_t checkReceiveAndContinueReceiving(DataHandle& handle,
997 std::vector<MessageBuffer<typename DataHandle::DataType> >& buffers,
1000 return checkAndContinue(handle, trackers, requests, requests, buffers, comm,
1001 UnpackEntries<DataHandle>(), SetupRecvRequest<DataHandle>(),
1002 true, !Impl::callFixedSize(handle));
1010 if(*i!=MPI_REQUEST_NULL)
1025template<
class DataHandle,
class Functor>
1028 std::vector<MessageBuffer<typename DataHandle::DataType> >& buffers,
1030 const Functor& setupFunctor,
1031 MPI_Comm communicator)
1035 biter=buffers.
begin();
1038 for(TIter titer=trackers.
begin(), end=trackers.
end(); titer!=
end; ++titer, ++biter, ++riter)
1040 setupFunctor(handle, *titer, *biter, *riter, communicator);
1041 complete+=titer->finished();
1047template<
class Allocator>
1048template<
bool FORWARD,
class DataHandle>
1049void VariableSizeCommunicator<Allocator>::setupInterfaceTrackers(DataHandle& handle,
1053 if(interface_->
size()==0)
1059 if(Impl::callFixedSize(handle))
1063 typedef typename InterfaceMap::const_iterator IIter;
1064 for(IIter inf=interface_->begin(), end=interface_->end(); inf!=
end; ++inf)
1067 if(Impl::callFixedSize(handle) && InterfaceInformationChooser<FORWARD>::getSend(inf->second).size())
1068 fixedsize=handle.size(InterfaceInformationChooser<FORWARD>::getSend(inf->second)[0]);
1069 assert(!Impl::callFixedSize(handle)||fixedsize>0);
1070 send_trackers.
push_back(InterfaceTracker(inf->first,
1071 InterfaceInformationChooser<FORWARD>::getSend(inf->second), fixedsize));
1072 recv_trackers.
push_back(InterfaceTracker(inf->first,
1073 InterfaceInformationChooser<FORWARD>::getReceive(inf->second), fixedsize, fixedsize==0));
1077template<
class Allocator>
1078template<
bool FORWARD,
class DataHandle>
1079void VariableSizeCommunicator<Allocator>::communicateFixedSize(DataHandle& handle)
1086 setupInterfaceTrackers<FORWARD>(handle,send_trackers, recv_trackers);
1087 sendFixedSize(send_trackers, size_send_req, recv_trackers, size_recv_req, communicator_);
1091 typedef typename DataHandle::DataType DataType;
1093 recv_buffers(interface_->
size(), MessageBuffer<DataType>(maxBufferSize_));
1096 setupRequests(handle, send_trackers, send_buffers, data_send_req,
1097 SetupSendRequest<DataHandle>(), communicator_);
1099 std::size_t no_size_to_recv, no_to_send, no_to_recv, old_size;
1100 no_size_to_recv = no_to_send = no_to_recv = old_size = interface_->
size();
1104 for(Iter i=recv_trackers.
begin(), end=recv_trackers.
end(); i!=
end; ++i)
1107 for(Iter i=send_trackers.
begin(),
end=send_trackers.
end(); i!=
end; ++i)
1111 while(no_size_to_recv+no_to_send+no_to_recv)
1115 no_size_to_recv -= receiveSizeAndSetupReceive(handle,recv_trackers, size_recv_req,
1116 data_recv_req, recv_buffers,
1121 no_to_send -= checkSendAndContinueSending(handle, send_trackers, data_send_req,
1122 send_buffers, communicator_);
1123 if(validRecvRequests(data_recv_req))
1125 no_to_recv -= checkReceiveAndContinueReceiving(handle, recv_trackers, data_recv_req,
1126 recv_buffers, communicator_);
1131 MPI_Waitall(size_send_req.size(), &(size_send_req[0]), MPI_STATUSES_IGNORE);
1135template<
class Allocator>
1136template<
bool FORWARD,
class DataHandle>
1137void VariableSizeCommunicator<Allocator>::communicateSizes(DataHandle& handle,
1146 send_buffers(size, MessageBuffer<std::size_t>(maxBufferSize_)),
1147 recv_buffers(size, MessageBuffer<std::size_t>(maxBufferSize_));
1148 SizeDataHandle<DataHandle> size_handle(handle,data_recv_trackers);
1149 setupInterfaceTrackers<FORWARD>(size_handle,send_trackers, recv_trackers);
1150 setupRequests(size_handle, send_trackers, send_buffers, send_requests,
1151 SetupSendRequest<SizeDataHandle<DataHandle> >(), communicator_);
1152 setupRequests(size_handle, recv_trackers, recv_buffers, recv_requests,
1153 SetupRecvRequest<SizeDataHandle<DataHandle> >(), communicator_);
1156 auto valid_req_func =
1157 [](
const MPI_Request& req) {
return req != MPI_REQUEST_NULL; };
1164 while(size_to_send+size_to_recv)
1168 checkSendAndContinueSending(size_handle, send_trackers, send_requests,
1169 send_buffers, communicator_);
1175 checkAndContinue(size_handle, recv_trackers, recv_requests, recv_requests,
1176 recv_buffers, communicator_, UnpackSizeEntries<DataHandle>(),
1177 SetupRecvRequest<SizeDataHandle<DataHandle> >());
1181template<
class Allocator>
1182template<
bool FORWARD,
class DataHandle>
1183void VariableSizeCommunicator<Allocator>::communicateVariableSize(DataHandle& handle)
1188 setupInterfaceTrackers<FORWARD>(handle, send_trackers, recv_trackers);
1192 typedef typename DataHandle::DataType DataType;
1194 send_buffers(interface_->
size(), MessageBuffer<DataType>(maxBufferSize_)),
1195 recv_buffers(interface_->
size(), MessageBuffer<DataType>(maxBufferSize_));
1197 communicateSizes<FORWARD>(handle, recv_trackers);
1199 setupRequests(handle, send_trackers, send_buffers, send_requests,
1200 SetupSendRequest<DataHandle>(), communicator_);
1201 setupRequests(handle, recv_trackers, recv_buffers, recv_requests,
1202 SetupRecvRequest<DataHandle>(), communicator_);
1205 auto valid_req_func =
1206 [](
const MPI_Request& req) {
return req != MPI_REQUEST_NULL;};
1212 while(no_to_send+no_to_recv)
1216 no_to_send -= checkSendAndContinueSending(handle, send_trackers, send_requests,
1217 send_buffers, communicator_);
1220 no_to_recv -= checkReceiveAndContinueReceiving(handle, recv_trackers, recv_requests,
1221 recv_buffers, communicator_);
1225template<
class Allocator>
1226template<
bool FORWARD,
class DataHandle>
1227void VariableSizeCommunicator<Allocator>::communicate(DataHandle& handle)
1229 if( interface_->
size() == 0)
1234 if(Impl::callFixedSize(handle))
1235 communicateFixedSize<FORWARD>(handle);
1237 communicateVariableSize<FORWARD>(handle);
Traits classes for mapping types onto MPI_Datatype.
std::size_t fixedSize
The number of data items per index if it is fixed, 0 otherwise.
Definition variablesizecommunicator.hh:265
Infrastructure for concepts.
MPI_Comm communicator() const
Get the MPI Communicator.
Definition parallel/interface.hh:417
Dune namespace.
Definition alignedallocator.hh:13
static MPI_Datatype getType()
Definition mpitraits.hh:48
size_t size() const
Get the number of entries in the interface.
Definition parallel/interface.hh:108
Communication interface between remote and local indices.
Definition parallel/interface.hh:209
Definition variablesizecommunicator.hh:43
auto require(H &&h) -> decltype(h.fixedSize())
A buffered communicator where the amount of data sent does not have to be known a priori.
Definition variablesizecommunicator.hh:332
VariableSizeCommunicator(const Interface &inf, std::size_t max_buffer_size)
Creates a communicator with a specific maximum buffer size.
Definition variablesizecommunicator.hh:404
void backward(DataHandle &handle)
Communicate backwards.
Definition variablesizecommunicator.hh:486
~VariableSizeCommunicator()
Definition variablesizecommunicator.hh:410
VariableSizeCommunicator(MPI_Comm comm, const InterfaceMap &inf, std::size_t max_buffer_size)
Creates a communicator with a specific maximum buffer size.
Definition variablesizecommunicator.hh:393
VariableSizeCommunicator(const VariableSizeCommunicator &other)
Copy-constructs a communicator.
Definition variablesizecommunicator.hh:419
void forward(DataHandle &handle)
Communicate forward.
Definition variablesizecommunicator.hh:461
VariableSizeCommunicator & operator=(const VariableSizeCommunicator &other)
Copy-assignes a communicator.
Definition variablesizecommunicator.hh:429
std::map< int, std::pair< InterfaceInformation, InterfaceInformation >, std::less< int >, typename std::allocator_traits< Allocator >::template rebind_alloc< std::pair< const int, std::pair< InterfaceInformation, InterfaceInformation > > > > InterfaceMap
The type of the map from process number to InterfaceInformation for sending and receiving to and from...
Definition variablesizecommunicator.hh:340
VariableSizeCommunicator(MPI_Comm comm, const InterfaceMap &inf)
Creates a communicator with the default maximum buffer size.
Definition variablesizecommunicator.hh:349
VariableSizeCommunicator(const Interface &inf)
Creates a communicator with the default maximum buffer size.
Definition variablesizecommunicator.hh:358
Provides classes for building the communication interface between remote indices.