xref: /petsc/src/sys/utils/mpits.c (revision c4762a1b19cd2af06abeed90e8f9d34fb975dd94)
1 #include <petscsys.h>        /*I  "petscsys.h"  I*/
2 #include <petsc/private/petscimpl.h>
3 
4 PetscLogEvent PETSC_BuildTwoSided;
5 PetscLogEvent PETSC_BuildTwoSidedF;
6 
7 const char *const PetscBuildTwoSidedTypes[] = {
8   "ALLREDUCE",
9   "IBARRIER",
10   "REDSCATTER",
11   "PetscBuildTwoSidedType",
12   "PETSC_BUILDTWOSIDED_",
13   NULL
14 };
15 
16 static PetscBuildTwoSidedType _twosided_type = PETSC_BUILDTWOSIDED_NOTSET;
17 
18 /*@
19    PetscCommBuildTwoSidedSetType - set algorithm to use when building two-sided communication
20 
21    Logically Collective
22 
23    Input Arguments:
24 +  comm - PETSC_COMM_WORLD
25 -  twosided - algorithm to use in subsequent calls to PetscCommBuildTwoSided()
26 
27    Level: developer
28 
29    Note:
30    This option is currently global, but could be made per-communicator.
31 
32 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedGetType()
33 @*/
34 PetscErrorCode PetscCommBuildTwoSidedSetType(MPI_Comm comm,PetscBuildTwoSidedType twosided)
35 {
36   PetscFunctionBegin;
37 #if defined(PETSC_USE_DEBUG)
38   {                             /* We don't have a PetscObject so can't use PetscValidLogicalCollectiveEnum */
39     PetscMPIInt ierr;
40     PetscMPIInt b1[2],b2[2];
41     b1[0] = -(PetscMPIInt)twosided;
42     b1[1] = (PetscMPIInt)twosided;
43     ierr  = MPIU_Allreduce(b1,b2,2,MPI_INT,MPI_MAX,comm);CHKERRQ(ierr);
44     if (-b2[0] != b2[1]) SETERRQ(comm,PETSC_ERR_ARG_WRONG,"Enum value must be same on all processes");
45   }
46 #endif
47   _twosided_type = twosided;
48   PetscFunctionReturn(0);
49 }
50 
51 /*@
52    PetscCommBuildTwoSidedGetType - set algorithm to use when building two-sided communication
53 
54    Logically Collective
55 
56    Output Arguments:
57 +  comm - communicator on which to query algorithm
58 -  twosided - algorithm to use for PetscCommBuildTwoSided()
59 
60    Level: developer
61 
62 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedSetType()
63 @*/
64 PetscErrorCode PetscCommBuildTwoSidedGetType(MPI_Comm comm,PetscBuildTwoSidedType *twosided)
65 {
66   PetscErrorCode ierr;
67 
68   PetscFunctionBegin;
69   *twosided = PETSC_BUILDTWOSIDED_NOTSET;
70   if (_twosided_type == PETSC_BUILDTWOSIDED_NOTSET) {
71 #if defined(PETSC_HAVE_MPI_IBARRIER)
72 #  if defined(PETSC_HAVE_MPICH_CH3_SOCK) && !defined(PETSC_HAVE_MPICH_CH3_SOCK_FIXED_NBC_PROGRESS)
73     /* Deadlock in Ibarrier: http://trac.mpich.org/projects/mpich/ticket/1785 */
74     _twosided_type = PETSC_BUILDTWOSIDED_ALLREDUCE;
75 #  else
76     _twosided_type = PETSC_BUILDTWOSIDED_IBARRIER;
77 #  endif
78 #else
79     _twosided_type = PETSC_BUILDTWOSIDED_ALLREDUCE;
80 #endif
81     ierr = PetscOptionsGetEnum(NULL,NULL,"-build_twosided",PetscBuildTwoSidedTypes,(PetscEnum*)&_twosided_type,NULL);CHKERRQ(ierr);
82   }
83   *twosided = _twosided_type;
84   PetscFunctionReturn(0);
85 }
86 
87 #if defined(PETSC_HAVE_MPI_IBARRIER) || defined(PETSC_HAVE_MPIX_IBARRIER)
88 
89 static PetscErrorCode PetscCommBuildTwoSided_Ibarrier(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata)
90 {
91   PetscErrorCode ierr;
92   PetscMPIInt    nrecvs,tag,done,i;
93   MPI_Aint       lb,unitbytes;
94   char           *tdata;
95   MPI_Request    *sendreqs,barrier;
96   PetscSegBuffer segrank,segdata;
97   PetscBool      barrier_started;
98 
99   PetscFunctionBegin;
100   ierr = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr);
101   ierr = MPI_Type_get_extent(dtype,&lb,&unitbytes);CHKERRQ(ierr);
102   if (lb != 0) SETERRQ1(comm,PETSC_ERR_SUP,"Datatype with nonzero lower bound %ld\n",(long)lb);
103   tdata = (char*)todata;
104   ierr  = PetscMalloc1(nto,&sendreqs);CHKERRQ(ierr);
105   for (i=0; i<nto; i++) {
106     ierr = MPI_Issend((void*)(tdata+count*unitbytes*i),count,dtype,toranks[i],tag,comm,sendreqs+i);CHKERRQ(ierr);
107   }
108   ierr = PetscSegBufferCreate(sizeof(PetscMPIInt),4,&segrank);CHKERRQ(ierr);
109   ierr = PetscSegBufferCreate(unitbytes,4*count,&segdata);CHKERRQ(ierr);
110 
111   nrecvs  = 0;
112   barrier = MPI_REQUEST_NULL;
113   /* MPICH-3.2 sometimes does not create a request in some "optimized" cases.  This is arguably a standard violation,
114    * but we need to work around it. */
115   barrier_started = PETSC_FALSE;
116   for (done=0; !done; ) {
117     PetscMPIInt flag;
118     MPI_Status  status;
119     ierr = MPI_Iprobe(MPI_ANY_SOURCE,tag,comm,&flag,&status);CHKERRQ(ierr);
120     if (flag) {                 /* incoming message */
121       PetscMPIInt *recvrank;
122       void        *buf;
123       ierr      = PetscSegBufferGet(segrank,1,&recvrank);CHKERRQ(ierr);
124       ierr      = PetscSegBufferGet(segdata,count,&buf);CHKERRQ(ierr);
125       *recvrank = status.MPI_SOURCE;
126       ierr      = MPI_Recv(buf,count,dtype,status.MPI_SOURCE,tag,comm,MPI_STATUS_IGNORE);CHKERRQ(ierr);
127       nrecvs++;
128     }
129     if (!barrier_started) {
130       PetscMPIInt sent,nsends;
131       ierr = PetscMPIIntCast(nto,&nsends);CHKERRQ(ierr);
132       ierr = MPI_Testall(nsends,sendreqs,&sent,MPI_STATUSES_IGNORE);CHKERRQ(ierr);
133       if (sent) {
134 #if defined(PETSC_HAVE_MPI_IBARRIER)
135         ierr = MPI_Ibarrier(comm,&barrier);CHKERRQ(ierr);
136 #elif defined(PETSC_HAVE_MPIX_IBARRIER)
137         ierr = MPIX_Ibarrier(comm,&barrier);CHKERRQ(ierr);
138 #endif
139         barrier_started = PETSC_TRUE;
140         ierr = PetscFree(sendreqs);CHKERRQ(ierr);
141       }
142     } else {
143       ierr = MPI_Test(&barrier,&done,MPI_STATUS_IGNORE);CHKERRQ(ierr);
144     }
145   }
146   *nfrom = nrecvs;
147   ierr   = PetscSegBufferExtractAlloc(segrank,fromranks);CHKERRQ(ierr);
148   ierr   = PetscSegBufferDestroy(&segrank);CHKERRQ(ierr);
149   ierr   = PetscSegBufferExtractAlloc(segdata,fromdata);CHKERRQ(ierr);
150   ierr   = PetscSegBufferDestroy(&segdata);CHKERRQ(ierr);
151   ierr   = PetscCommDestroy(&comm);CHKERRQ(ierr);
152   PetscFunctionReturn(0);
153 }
154 #endif
155 
156 static PetscErrorCode PetscCommBuildTwoSided_Allreduce(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata)
157 {
158   PetscErrorCode ierr;
159   PetscMPIInt    size,*iflags,nrecvs,tag,*franks,i;
160   MPI_Aint       lb,unitbytes;
161   char           *tdata,*fdata;
162   MPI_Request    *reqs,*sendreqs;
163   MPI_Status     *statuses;
164 
165   PetscFunctionBegin;
166   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
167   ierr = PetscCalloc1(size,&iflags);CHKERRQ(ierr);
168   for (i=0; i<nto; i++) iflags[toranks[i]] = 1;
169   ierr = PetscGatherNumberOfMessages(comm,iflags,NULL,&nrecvs);CHKERRQ(ierr);
170   ierr = PetscFree(iflags);CHKERRQ(ierr);
171 
172   ierr     = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr);
173   ierr     = MPI_Type_get_extent(dtype,&lb,&unitbytes);CHKERRQ(ierr);
174   if (lb != 0) SETERRQ1(comm,PETSC_ERR_SUP,"Datatype with nonzero lower bound %ld\n",(long)lb);
175   ierr     = PetscMalloc(nrecvs*count*unitbytes,&fdata);CHKERRQ(ierr);
176   tdata    = (char*)todata;
177   ierr     = PetscMalloc2(nto+nrecvs,&reqs,nto+nrecvs,&statuses);CHKERRQ(ierr);
178   sendreqs = reqs + nrecvs;
179   for (i=0; i<nrecvs; i++) {
180     ierr = MPI_Irecv((void*)(fdata+count*unitbytes*i),count,dtype,MPI_ANY_SOURCE,tag,comm,reqs+i);CHKERRQ(ierr);
181   }
182   for (i=0; i<nto; i++) {
183     ierr = MPI_Isend((void*)(tdata+count*unitbytes*i),count,dtype,toranks[i],tag,comm,sendreqs+i);CHKERRQ(ierr);
184   }
185   ierr = MPI_Waitall(nto+nrecvs,reqs,statuses);CHKERRQ(ierr);
186   ierr = PetscMalloc1(nrecvs,&franks);CHKERRQ(ierr);
187   for (i=0; i<nrecvs; i++) franks[i] = statuses[i].MPI_SOURCE;
188   ierr = PetscFree2(reqs,statuses);CHKERRQ(ierr);
189   ierr = PetscCommDestroy(&comm);CHKERRQ(ierr);
190 
191   *nfrom            = nrecvs;
192   *fromranks        = franks;
193   *(void**)fromdata = fdata;
194   PetscFunctionReturn(0);
195 }
196 
197 #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
198 static PetscErrorCode PetscCommBuildTwoSided_RedScatter(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata)
199 {
200   PetscErrorCode ierr;
201   PetscMPIInt    size,*iflags,nrecvs,tag,*franks,i;
202   MPI_Aint       lb,unitbytes;
203   char           *tdata,*fdata;
204   MPI_Request    *reqs,*sendreqs;
205   MPI_Status     *statuses;
206 
207   PetscFunctionBegin;
208   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
209   ierr = PetscMalloc1(size,&iflags);CHKERRQ(ierr);
210   ierr = PetscArrayzero(iflags,size);CHKERRQ(ierr);
211   for (i=0; i<nto; i++) iflags[toranks[i]] = 1;
212   ierr = MPI_Reduce_scatter_block(iflags,&nrecvs,1,MPI_INT,MPI_SUM,comm);CHKERRQ(ierr);
213   ierr = PetscFree(iflags);CHKERRQ(ierr);
214 
215   ierr     = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr);
216   ierr     = MPI_Type_get_extent(dtype,&lb,&unitbytes);CHKERRQ(ierr);
217   if (lb != 0) SETERRQ1(comm,PETSC_ERR_SUP,"Datatype with nonzero lower bound %ld\n",(long)lb);
218   ierr     = PetscMalloc(nrecvs*count*unitbytes,&fdata);CHKERRQ(ierr);
219   tdata    = (char*)todata;
220   ierr     = PetscMalloc2(nto+nrecvs,&reqs,nto+nrecvs,&statuses);CHKERRQ(ierr);
221   sendreqs = reqs + nrecvs;
222   for (i=0; i<nrecvs; i++) {
223     ierr = MPI_Irecv((void*)(fdata+count*unitbytes*i),count,dtype,MPI_ANY_SOURCE,tag,comm,reqs+i);CHKERRQ(ierr);
224   }
225   for (i=0; i<nto; i++) {
226     ierr = MPI_Isend((void*)(tdata+count*unitbytes*i),count,dtype,toranks[i],tag,comm,sendreqs+i);CHKERRQ(ierr);
227   }
228   ierr = MPI_Waitall(nto+nrecvs,reqs,statuses);CHKERRQ(ierr);
229   ierr = PetscMalloc1(nrecvs,&franks);CHKERRQ(ierr);
230   for (i=0; i<nrecvs; i++) franks[i] = statuses[i].MPI_SOURCE;
231   ierr = PetscFree2(reqs,statuses);CHKERRQ(ierr);
232   ierr = PetscCommDestroy(&comm);CHKERRQ(ierr);
233 
234   *nfrom            = nrecvs;
235   *fromranks        = franks;
236   *(void**)fromdata = fdata;
237   PetscFunctionReturn(0);
238 }
239 #endif
240 
241 /*@C
242    PetscCommBuildTwoSided - discovers communicating ranks given one-sided information, moving constant-sized data in the process (often message lengths)
243 
244    Collective
245 
246    Input Arguments:
247 +  comm - communicator
248 .  count - number of entries to send/receive (must match on all ranks)
249 .  dtype - datatype to send/receive from each rank (must match on all ranks)
250 .  nto - number of ranks to send data to
251 .  toranks - ranks to send to (array of length nto)
252 -  todata - data to send to each rank (packed)
253 
254    Output Arguments:
255 +  nfrom - number of ranks receiving messages from
256 .  fromranks - ranks receiving messages from (length nfrom; caller should PetscFree())
257 -  fromdata - packed data from each rank, each with count entries of type dtype (length nfrom, caller responsible for PetscFree())
258 
259    Level: developer
260 
261    Options Database Keys:
262 .  -build_twosided <allreduce|ibarrier|redscatter> - algorithm to set up two-sided communication
263 
264    Notes:
265    This memory-scalable interface is an alternative to calling PetscGatherNumberOfMessages() and
266    PetscGatherMessageLengths(), possibly with a subsequent round of communication to send other constant-size data.
267 
268    Basic data types as well as contiguous types are supported, but non-contiguous (e.g., strided) types are not.
269 
270    References:
271 .  1. - Hoefler, Siebert and Lumsdaine, The MPI_Ibarrier implementation uses the algorithm in
272    Scalable communication protocols for dynamic sparse data exchange, 2010.
273 
274 .seealso: PetscGatherNumberOfMessages(), PetscGatherMessageLengths()
275 @*/
276 PetscErrorCode PetscCommBuildTwoSided(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata)
277 {
278   PetscErrorCode         ierr;
279   PetscBuildTwoSidedType buildtype = PETSC_BUILDTWOSIDED_NOTSET;
280 
281   PetscFunctionBegin;
282   ierr = PetscSysInitializePackage();CHKERRQ(ierr);
283   ierr = PetscLogEventSync(PETSC_BuildTwoSided,comm);CHKERRQ(ierr);
284   ierr = PetscLogEventBegin(PETSC_BuildTwoSided,0,0,0,0);CHKERRQ(ierr);
285   ierr = PetscCommBuildTwoSidedGetType(comm,&buildtype);CHKERRQ(ierr);
286   switch (buildtype) {
287   case PETSC_BUILDTWOSIDED_IBARRIER:
288 #if defined(PETSC_HAVE_MPI_IBARRIER) || defined(PETSC_HAVE_MPIX_IBARRIER)
289     ierr = PetscCommBuildTwoSided_Ibarrier(comm,count,dtype,nto,toranks,todata,nfrom,fromranks,fromdata);CHKERRQ(ierr);
290 #else
291     SETERRQ(comm,PETSC_ERR_PLIB,"MPI implementation does not provide MPI_Ibarrier (part of MPI-3)");
292 #endif
293     break;
294   case PETSC_BUILDTWOSIDED_ALLREDUCE:
295     ierr = PetscCommBuildTwoSided_Allreduce(comm,count,dtype,nto,toranks,todata,nfrom,fromranks,fromdata);CHKERRQ(ierr);
296     break;
297   case PETSC_BUILDTWOSIDED_REDSCATTER:
298 #if defined(PETSC_HAVE_MPI_REDUCE_SCATTER_BLOCK)
299     ierr = PetscCommBuildTwoSided_RedScatter(comm,count,dtype,nto,toranks,todata,nfrom,fromranks,fromdata);CHKERRQ(ierr);
300 #else
301     SETERRQ(comm,PETSC_ERR_PLIB,"MPI implementation does not provide MPI_Reduce_scatter_block (part of MPI-2.2)");
302 #endif
303     break;
304   default: SETERRQ(comm,PETSC_ERR_PLIB,"Unknown method for building two-sided communication");
305   }
306   ierr = PetscLogEventEnd(PETSC_BuildTwoSided,0,0,0,0);CHKERRQ(ierr);
307   PetscFunctionReturn(0);
308 }
309 
310 static PetscErrorCode PetscCommBuildTwoSidedFReq_Reference(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,
311                                                            PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata,PetscMPIInt ntags,MPI_Request **toreqs,MPI_Request **fromreqs,
312                                                            PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
313                                                            PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
314 {
315   PetscErrorCode ierr;
316   PetscMPIInt i,*tag;
317   MPI_Aint    lb,unitbytes;
318   MPI_Request *sendreq,*recvreq;
319 
320   PetscFunctionBegin;
321   ierr = PetscMalloc1(ntags,&tag);CHKERRQ(ierr);
322   if (ntags > 0) {
323     ierr = PetscCommDuplicate(comm,&comm,&tag[0]);CHKERRQ(ierr);
324   }
325   for (i=1; i<ntags; i++) {
326     ierr = PetscCommGetNewTag(comm,&tag[i]);CHKERRQ(ierr);
327   }
328 
329   /* Perform complete initial rendezvous */
330   ierr = PetscCommBuildTwoSided(comm,count,dtype,nto,toranks,todata,nfrom,fromranks,fromdata);CHKERRQ(ierr);
331 
332   ierr = PetscMalloc1(nto*ntags,&sendreq);CHKERRQ(ierr);
333   ierr = PetscMalloc1(*nfrom*ntags,&recvreq);CHKERRQ(ierr);
334 
335   ierr = MPI_Type_get_extent(dtype,&lb,&unitbytes);CHKERRQ(ierr);
336   if (lb != 0) SETERRQ1(comm,PETSC_ERR_SUP,"Datatype with nonzero lower bound %ld\n",(long)lb);
337   for (i=0; i<nto; i++) {
338     PetscMPIInt k;
339     for (k=0; k<ntags; k++) sendreq[i*ntags+k] = MPI_REQUEST_NULL;
340     ierr = (*send)(comm,tag,i,toranks[i],((char*)todata)+count*unitbytes*i,sendreq+i*ntags,ctx);CHKERRQ(ierr);
341   }
342   for (i=0; i<*nfrom; i++) {
343     void *header = (*(char**)fromdata) + count*unitbytes*i;
344     PetscMPIInt k;
345     for (k=0; k<ntags; k++) recvreq[i*ntags+k] = MPI_REQUEST_NULL;
346     ierr = (*recv)(comm,tag,(*fromranks)[i],header,recvreq+i*ntags,ctx);CHKERRQ(ierr);
347   }
348   ierr = PetscFree(tag);CHKERRQ(ierr);
349   ierr = PetscCommDestroy(&comm);CHKERRQ(ierr);
350   *toreqs = sendreq;
351   *fromreqs = recvreq;
352   PetscFunctionReturn(0);
353 }
354 
355 #if defined(PETSC_HAVE_MPI_IBARRIER) || defined(PETSC_HAVE_MPIX_IBARRIER)
356 
357 static PetscErrorCode PetscCommBuildTwoSidedFReq_Ibarrier(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,
358                                                           PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata,PetscMPIInt ntags,MPI_Request **toreqs,MPI_Request **fromreqs,
359                                                           PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
360                                                           PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
361 {
362   PetscErrorCode ierr;
363   PetscMPIInt    nrecvs,tag,*tags,done,i;
364   MPI_Aint       lb,unitbytes;
365   char           *tdata;
366   MPI_Request    *sendreqs,*usendreqs,*req,barrier;
367   PetscSegBuffer segrank,segdata,segreq;
368   PetscBool      barrier_started;
369 
370   PetscFunctionBegin;
371   ierr = PetscCommDuplicate(comm,&comm,&tag);CHKERRQ(ierr);
372   ierr = PetscMalloc1(ntags,&tags);CHKERRQ(ierr);
373   for (i=0; i<ntags; i++) {
374     ierr = PetscCommGetNewTag(comm,&tags[i]);CHKERRQ(ierr);
375   }
376   ierr = MPI_Type_get_extent(dtype,&lb,&unitbytes);CHKERRQ(ierr);
377   if (lb != 0) SETERRQ1(comm,PETSC_ERR_SUP,"Datatype with nonzero lower bound %ld\n",(long)lb);
378   tdata = (char*)todata;
379   ierr = PetscMalloc1(nto,&sendreqs);CHKERRQ(ierr);
380   ierr = PetscMalloc1(nto*ntags,&usendreqs);CHKERRQ(ierr);
381   /* Post synchronous sends */
382   for (i=0; i<nto; i++) {
383     ierr = MPI_Issend((void*)(tdata+count*unitbytes*i),count,dtype,toranks[i],tag,comm,sendreqs+i);CHKERRQ(ierr);
384   }
385   /* Post actual payloads.  These are typically larger messages.  Hopefully sending these later does not slow down the
386    * synchronous messages above. */
387   for (i=0; i<nto; i++) {
388     PetscMPIInt k;
389     for (k=0; k<ntags; k++) usendreqs[i*ntags+k] = MPI_REQUEST_NULL;
390     ierr = (*send)(comm,tags,i,toranks[i],tdata+count*unitbytes*i,usendreqs+i*ntags,ctx);CHKERRQ(ierr);
391   }
392 
393   ierr = PetscSegBufferCreate(sizeof(PetscMPIInt),4,&segrank);CHKERRQ(ierr);
394   ierr = PetscSegBufferCreate(unitbytes,4*count,&segdata);CHKERRQ(ierr);
395   ierr = PetscSegBufferCreate(sizeof(MPI_Request),4,&segreq);CHKERRQ(ierr);
396 
397   nrecvs  = 0;
398   barrier = MPI_REQUEST_NULL;
399   /* MPICH-3.2 sometimes does not create a request in some "optimized" cases.  This is arguably a standard violation,
400    * but we need to work around it. */
401   barrier_started = PETSC_FALSE;
402   for (done=0; !done; ) {
403     PetscMPIInt flag;
404     MPI_Status  status;
405     ierr = MPI_Iprobe(MPI_ANY_SOURCE,tag,comm,&flag,&status);CHKERRQ(ierr);
406     if (flag) {                 /* incoming message */
407       PetscMPIInt *recvrank,k;
408       void        *buf;
409       ierr = PetscSegBufferGet(segrank,1,&recvrank);CHKERRQ(ierr);
410       ierr = PetscSegBufferGet(segdata,count,&buf);CHKERRQ(ierr);
411       *recvrank = status.MPI_SOURCE;
412       ierr = MPI_Recv(buf,count,dtype,status.MPI_SOURCE,tag,comm,MPI_STATUS_IGNORE);CHKERRQ(ierr);
413       ierr = PetscSegBufferGet(segreq,ntags,&req);CHKERRQ(ierr);
414       for (k=0; k<ntags; k++) req[k] = MPI_REQUEST_NULL;
415       ierr = (*recv)(comm,tags,status.MPI_SOURCE,buf,req,ctx);CHKERRQ(ierr);
416       nrecvs++;
417     }
418     if (!barrier_started) {
419       PetscMPIInt sent,nsends;
420       ierr = PetscMPIIntCast(nto,&nsends);CHKERRQ(ierr);
421       ierr = MPI_Testall(nsends,sendreqs,&sent,MPI_STATUSES_IGNORE);CHKERRQ(ierr);
422       if (sent) {
423 #if defined(PETSC_HAVE_MPI_IBARRIER)
424         ierr = MPI_Ibarrier(comm,&barrier);CHKERRQ(ierr);
425 #elif defined(PETSC_HAVE_MPIX_IBARRIER)
426         ierr = MPIX_Ibarrier(comm,&barrier);CHKERRQ(ierr);
427 #endif
428         barrier_started = PETSC_TRUE;
429       }
430     } else {
431       ierr = MPI_Test(&barrier,&done,MPI_STATUS_IGNORE);CHKERRQ(ierr);
432     }
433   }
434   *nfrom = nrecvs;
435   ierr = PetscSegBufferExtractAlloc(segrank,fromranks);CHKERRQ(ierr);
436   ierr = PetscSegBufferDestroy(&segrank);CHKERRQ(ierr);
437   ierr = PetscSegBufferExtractAlloc(segdata,fromdata);CHKERRQ(ierr);
438   ierr = PetscSegBufferDestroy(&segdata);CHKERRQ(ierr);
439   *toreqs = usendreqs;
440   ierr = PetscSegBufferExtractAlloc(segreq,fromreqs);CHKERRQ(ierr);
441   ierr = PetscSegBufferDestroy(&segreq);CHKERRQ(ierr);
442   ierr = PetscFree(sendreqs);CHKERRQ(ierr);
443   ierr = PetscFree(tags);CHKERRQ(ierr);
444   ierr = PetscCommDestroy(&comm);CHKERRQ(ierr);
445   PetscFunctionReturn(0);
446 }
447 #endif
448 
449 /*@C
450    PetscCommBuildTwoSidedF - discovers communicating ranks given one-sided information, calling user-defined functions during rendezvous
451 
452    Collective
453 
454    Input Arguments:
455 +  comm - communicator
456 .  count - number of entries to send/receive in initial rendezvous (must match on all ranks)
457 .  dtype - datatype to send/receive from each rank (must match on all ranks)
458 .  nto - number of ranks to send data to
459 .  toranks - ranks to send to (array of length nto)
460 .  todata - data to send to each rank (packed)
461 .  ntags - number of tags needed by send/recv callbacks
462 .  send - callback invoked on sending process when ready to send primary payload
463 .  recv - callback invoked on receiving process after delivery of rendezvous message
464 -  ctx - context for callbacks
465 
466    Output Arguments:
467 +  nfrom - number of ranks receiving messages from
468 .  fromranks - ranks receiving messages from (length nfrom; caller should PetscFree())
469 -  fromdata - packed data from each rank, each with count entries of type dtype (length nfrom, caller responsible for PetscFree())
470 
471    Level: developer
472 
473    Notes:
474    This memory-scalable interface is an alternative to calling PetscGatherNumberOfMessages() and
475    PetscGatherMessageLengths(), possibly with a subsequent round of communication to send other data.
476 
477    Basic data types as well as contiguous types are supported, but non-contiguous (e.g., strided) types are not.
478 
479    References:
480 .  1. - Hoefler, Siebert and Lumsdaine, The MPI_Ibarrier implementation uses the algorithm in
481    Scalable communication protocols for dynamic sparse data exchange, 2010.
482 
483 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedFReq(), PetscGatherNumberOfMessages(), PetscGatherMessageLengths()
484 @*/
485 PetscErrorCode PetscCommBuildTwoSidedF(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata,PetscMPIInt ntags,
486                                        PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
487                                        PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
488 {
489   PetscErrorCode ierr;
490   MPI_Request    *toreqs,*fromreqs;
491 
492   PetscFunctionBegin;
493   ierr = PetscCommBuildTwoSidedFReq(comm,count,dtype,nto,toranks,todata,nfrom,fromranks,fromdata,ntags,&toreqs,&fromreqs,send,recv,ctx);CHKERRQ(ierr);
494   ierr = MPI_Waitall(nto*ntags,toreqs,MPI_STATUSES_IGNORE);CHKERRQ(ierr);
495   ierr = MPI_Waitall(*nfrom*ntags,fromreqs,MPI_STATUSES_IGNORE);CHKERRQ(ierr);
496   ierr = PetscFree(toreqs);CHKERRQ(ierr);
497   ierr = PetscFree(fromreqs);CHKERRQ(ierr);
498   PetscFunctionReturn(0);
499 }
500 
501 /*@C
502    PetscCommBuildTwoSidedFReq - discovers communicating ranks given one-sided information, calling user-defined functions during rendezvous, returns requests
503 
504    Collective
505 
506    Input Arguments:
507 +  comm - communicator
508 .  count - number of entries to send/receive in initial rendezvous (must match on all ranks)
509 .  dtype - datatype to send/receive from each rank (must match on all ranks)
510 .  nto - number of ranks to send data to
511 .  toranks - ranks to send to (array of length nto)
512 .  todata - data to send to each rank (packed)
513 .  ntags - number of tags needed by send/recv callbacks
514 .  send - callback invoked on sending process when ready to send primary payload
515 .  recv - callback invoked on receiving process after delivery of rendezvous message
516 -  ctx - context for callbacks
517 
518    Output Arguments:
519 +  nfrom - number of ranks receiving messages from
520 .  fromranks - ranks receiving messages from (length nfrom; caller should PetscFree())
521 .  fromdata - packed data from each rank, each with count entries of type dtype (length nfrom, caller responsible for PetscFree())
522 .  toreqs - array of nto*ntags sender requests (caller must wait on these, then PetscFree())
523 -  fromreqs - array of nfrom*ntags receiver requests (caller must wait on these, then PetscFree())
524 
525    Level: developer
526 
527    Notes:
528    This memory-scalable interface is an alternative to calling PetscGatherNumberOfMessages() and
529    PetscGatherMessageLengths(), possibly with a subsequent round of communication to send other data.
530 
531    Basic data types as well as contiguous types are supported, but non-contiguous (e.g., strided) types are not.
532 
533    References:
534 .  1. - Hoefler, Siebert and Lumsdaine, The MPI_Ibarrier implementation uses the algorithm in
535    Scalable communication protocols for dynamic sparse data exchange, 2010.
536 
537 .seealso: PetscCommBuildTwoSided(), PetscCommBuildTwoSidedF(), PetscGatherNumberOfMessages(), PetscGatherMessageLengths()
538 @*/
539 PetscErrorCode PetscCommBuildTwoSidedFReq(MPI_Comm comm,PetscMPIInt count,MPI_Datatype dtype,PetscMPIInt nto,const PetscMPIInt *toranks,const void *todata,
540                                           PetscMPIInt *nfrom,PetscMPIInt **fromranks,void *fromdata,PetscMPIInt ntags,MPI_Request **toreqs,MPI_Request **fromreqs,
541                                           PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
542                                           PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx)
543 {
544   PetscErrorCode         ierr,(*f)(MPI_Comm,PetscMPIInt,MPI_Datatype,PetscMPIInt,const PetscMPIInt[],const void*,
545                                    PetscMPIInt*,PetscMPIInt**,void*,PetscMPIInt,MPI_Request**,MPI_Request**,
546                                    PetscErrorCode (*send)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,PetscMPIInt,void*,MPI_Request[],void*),
547                                    PetscErrorCode (*recv)(MPI_Comm,const PetscMPIInt[],PetscMPIInt,void*,MPI_Request[],void*),void *ctx);
548   PetscBuildTwoSidedType buildtype = PETSC_BUILDTWOSIDED_NOTSET;
549   PetscMPIInt i,size;
550 
551   PetscFunctionBegin;
552   ierr = PetscSysInitializePackage();CHKERRQ(ierr);
553   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
554   for (i=0; i<nto; i++) {
555     if (toranks[i] < 0 || size <= toranks[i]) SETERRQ3(comm,PETSC_ERR_ARG_OUTOFRANGE,"toranks[%d] %d not in comm size %d",i,toranks[i],size);
556   }
557   ierr = PetscLogEventSync(PETSC_BuildTwoSidedF,comm);CHKERRQ(ierr);
558   ierr = PetscLogEventBegin(PETSC_BuildTwoSidedF,0,0,0,0);CHKERRQ(ierr);
559   ierr = PetscCommBuildTwoSidedGetType(comm,&buildtype);CHKERRQ(ierr);
560   switch (buildtype) {
561   case PETSC_BUILDTWOSIDED_IBARRIER:
562 #if defined(PETSC_HAVE_MPI_IBARRIER) || defined(PETSC_HAVE_MPIX_IBARRIER)
563     f = PetscCommBuildTwoSidedFReq_Ibarrier;
564 #else
565     SETERRQ(comm,PETSC_ERR_PLIB,"MPI implementation does not provide MPI_Ibarrier (part of MPI-3)");
566 #endif
567     break;
568   case PETSC_BUILDTWOSIDED_ALLREDUCE:
569   case PETSC_BUILDTWOSIDED_REDSCATTER:
570     f = PetscCommBuildTwoSidedFReq_Reference;
571     break;
572   default: SETERRQ(comm,PETSC_ERR_PLIB,"Unknown method for building two-sided communication");
573   }
574   ierr = (*f)(comm,count,dtype,nto,toranks,todata,nfrom,fromranks,fromdata,ntags,toreqs,fromreqs,send,recv,ctx);CHKERRQ(ierr);
575   ierr = PetscLogEventEnd(PETSC_BuildTwoSidedF,0,0,0,0);CHKERRQ(ierr);
576   PetscFunctionReturn(0);
577 }
578