2 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
3 * University Research and Technology
4 * Corporation. All rights reserved.
5 * Copyright (c) 2004-2009 The University of Tennessee and The University
6 * of Tennessee Research Foundation. All rights
8 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
9 * University of Stuttgart. All rights reserved.
10 * Copyright (c) 2004-2005 The Regents of the University of California.
11 * All rights reserved.
14 * Additional copyrights may follow
19 #include "colls_private.h"
20 #include "coll_tuned_topo.h"
24 int smpi_coll_tuned_ompi_reduce_generic( void* sendbuf, void* recvbuf, int original_count,
25 MPI_Datatype datatype, MPI_Op op,
26 int root, MPI_Comm comm,
27 ompi_coll_tree_t* tree, int count_by_segment,
28 int max_outstanding_reqs );
30 * This is a generic implementation of the reduce protocol. It used the tree
31 * provided as an argument and execute all operations using a segment of
32 * count times a datatype.
33 * For the last communication it will update the count in order to limit
34 * the number of datatype to the original count (original_count)
36 * Note that for non-commutative operations we cannot save memory copy
37 * for the first block: thus we must copy sendbuf to accumbuf on intermediate
38 * to keep the optimized loop happy.
40 int smpi_coll_tuned_ompi_reduce_generic( void* sendbuf, void* recvbuf, int original_count,
41 MPI_Datatype datatype, MPI_Op op,
42 int root, MPI_Comm comm,
43 ompi_coll_tree_t* tree, int count_by_segment,
44 int max_outstanding_reqs )
46 char *inbuf[2] = {NULL, NULL}, *inbuf_free[2] = {NULL, NULL};
47 char *accumbuf = NULL, *accumbuf_free = NULL;
48 char *local_op_buffer = NULL, *sendtmpbuf = NULL;
49 ptrdiff_t extent, lower_bound, segment_increment;
50 MPI_Request reqs[2] = {MPI_REQUEST_NULL, MPI_REQUEST_NULL};
51 int num_segments, line, ret, segindex, i, rank;
52 int recvcount, prevcount, inbi;
55 * Determine number of segments and number of elements
58 smpi_datatype_extent( datatype, &lower_bound, &extent);
59 num_segments = (original_count + count_by_segment - 1) / count_by_segment;
60 segment_increment = count_by_segment * extent;
62 sendtmpbuf = (char*) sendbuf;
63 if( sendbuf == MPI_IN_PLACE ) {
64 sendtmpbuf = (char *)recvbuf;
67 XBT_DEBUG( "coll:tuned:reduce_generic count %d, msg size %ld, segsize %ld, max_requests %d", original_count, (unsigned long)(num_segments * segment_increment), (unsigned long)segment_increment, max_outstanding_reqs);
69 rank = smpi_comm_rank(comm);
71 /* non-leaf nodes - wait for children to send me data & forward up
73 if( tree->tree_nextsize > 0 ) {
74 ptrdiff_t true_extent, real_segment_size;
75 true_extent=smpi_datatype_get_extent( datatype);
77 /* handle non existant recv buffer (i.e. its NULL) and
78 protect the recv buffer on non-root nodes */
79 accumbuf = (char*)recvbuf;
80 if( (NULL == accumbuf) || (root != rank) ) {
81 /* Allocate temporary accumulator buffer. */
82 accumbuf_free = (char*)malloc(true_extent +
83 (original_count - 1) * extent);
84 if (accumbuf_free == NULL) {
85 line = __LINE__; ret = -1; goto error_hndl;
87 accumbuf = accumbuf_free - lower_bound;
90 /* If this is a non-commutative operation we must copy
91 sendbuf to the accumbuf, in order to simplfy the loops */
92 if (!smpi_op_is_commute(op)) {
94 (char*)sendtmpbuf, original_count, datatype,
95 (char*)accumbuf, original_count, datatype);
97 /* Allocate two buffers for incoming segments */
98 real_segment_size = true_extent + (count_by_segment - 1) * extent;
99 inbuf_free[0] = (char*) malloc(real_segment_size);
100 if( inbuf_free[0] == NULL ) {
101 line = __LINE__; ret = -1; goto error_hndl;
103 inbuf[0] = inbuf_free[0] - lower_bound;
104 /* if there is chance to overlap communication -
105 allocate second buffer */
106 if( (num_segments > 1) || (tree->tree_nextsize > 1) ) {
107 inbuf_free[1] = (char*) malloc(real_segment_size);
108 if( inbuf_free[1] == NULL ) {
109 line = __LINE__; ret = -1; goto error_hndl;
111 inbuf[1] = inbuf_free[1] - lower_bound;
114 /* reset input buffer index and receive count */
117 /* for each segment */
118 for( segindex = 0; segindex <= num_segments; segindex++ ) {
119 prevcount = recvcount;
120 /* recvcount - number of elements in current segment */
121 recvcount = count_by_segment;
122 if( segindex == (num_segments-1) )
123 recvcount = original_count - count_by_segment * segindex;
126 for( i = 0; i < tree->tree_nextsize; i++ ) {
128 * We try to overlap communication:
129 * either with next segment or with the next child
131 /* post irecv for current segindex on current child */
132 if( segindex < num_segments ) {
133 void* local_recvbuf = inbuf[inbi];
135 /* for the first step (1st child per segment) and
136 * commutative operations we might be able to irecv
137 * directly into the accumulate buffer so that we can
138 * reduce(op) this with our sendbuf in one step as
139 * ompi_op_reduce only has two buffer pointers,
140 * this avoids an extra memory copy.
142 * BUT if the operation is non-commutative or
143 * we are root and are USING MPI_IN_PLACE this is wrong!
145 if( (smpi_op_is_commute(op)) &&
146 !((MPI_IN_PLACE == sendbuf) && (rank == tree->tree_root)) ) {
147 local_recvbuf = accumbuf + segindex * segment_increment;
151 reqs[inbi]=smpi_mpi_irecv(local_recvbuf, recvcount, datatype,
153 COLL_TAG_REDUCE, comm
156 /* wait for previous req to complete, if any.
157 if there are no requests reqs[inbi ^1] will be
159 /* wait on data from last child for previous segment */
160 smpi_mpi_waitall( 1, &reqs[inbi ^ 1],
161 MPI_STATUSES_IGNORE );
162 local_op_buffer = inbuf[inbi ^ 1];
164 /* our first operation is to combine our own [sendbuf] data
165 * with the data we recvd from down stream (but only
166 * the operation is commutative and if we are not root and
167 * not using MPI_IN_PLACE)
170 if( (smpi_op_is_commute(op)) &&
171 !((MPI_IN_PLACE == sendbuf) && (rank == tree->tree_root)) ) {
172 local_op_buffer = sendtmpbuf + segindex * segment_increment;
175 /* apply operation */
176 smpi_op_apply(op, local_op_buffer,
177 accumbuf + segindex * segment_increment,
178 &recvcount, &datatype );
179 } else if ( segindex > 0 ) {
180 void* accumulator = accumbuf + (segindex-1) * segment_increment;
181 if( tree->tree_nextsize <= 1 ) {
182 if( (smpi_op_is_commute(op)) &&
183 !((MPI_IN_PLACE == sendbuf) && (rank == tree->tree_root)) ) {
184 local_op_buffer = sendtmpbuf + (segindex-1) * segment_increment;
187 smpi_op_apply(op, local_op_buffer, accumulator, &prevcount,
190 /* all reduced on available data this step (i) complete,
191 * pass to the next process unless you are the root.
193 if (rank != tree->tree_root) {
194 /* send combined/accumulated data to parent */
195 smpi_mpi_send( accumulator, prevcount,
196 datatype, tree->tree_prev,
201 /* we stop when segindex = number of segments
202 (i.e. we do num_segment+1 steps for pipelining */
203 if (segindex == num_segments) break;
206 /* update input buffer index */
208 } /* end of for each child */
209 } /* end of for each segment */
212 if( inbuf_free[0] != NULL) free(inbuf_free[0]);
213 if( inbuf_free[1] != NULL) free(inbuf_free[1]);
214 if( accumbuf_free != NULL ) free(accumbuf_free);
218 Depending on the value of max_outstanding_reqs and
219 the number of segments we have two options:
220 - send all segments using blocking send to the parent, or
221 - avoid overflooding the parent nodes by limiting the number of
222 outstanding requests to max_oustanding_reqs.
223 TODO/POSSIBLE IMPROVEMENT: If there is a way to determine the eager size
224 for the current communication, synchronization should be used only
225 when the message/segment size is smaller than the eager size.
229 /* If the number of segments is less than a maximum number of oustanding
230 requests or there is no limit on the maximum number of outstanding
231 requests, we send data to the parent using blocking send */
232 if ((0 == max_outstanding_reqs) ||
233 (num_segments <= max_outstanding_reqs)) {
236 while ( original_count > 0) {
237 if (original_count < count_by_segment) {
238 count_by_segment = original_count;
240 smpi_mpi_send((char*)sendbuf +
241 segindex * segment_increment,
242 count_by_segment, datatype,
247 original_count -= count_by_segment;
251 /* Otherwise, introduce flow control:
252 - post max_outstanding_reqs non-blocking synchronous send,
253 - for remaining segments
254 - wait for a ssend to complete, and post the next one.
255 - wait for all outstanding sends to complete.
260 MPI_Request* sreq = NULL;
262 sreq = (MPI_Request*) calloc( max_outstanding_reqs,
263 sizeof(MPI_Request ) );
264 if (NULL == sreq) { line = __LINE__; ret = -1; goto error_hndl; }
266 /* post first group of requests */
267 for (segindex = 0; segindex < max_outstanding_reqs; segindex++) {
268 sreq[segindex]=smpi_mpi_isend((char*)sendbuf +
269 segindex * segment_increment,
270 count_by_segment, datatype,
274 original_count -= count_by_segment;
278 while ( original_count > 0 ) {
279 /* wait on a posted request to complete */
280 smpi_mpi_wait(&sreq[creq], MPI_STATUS_IGNORE);
281 sreq[creq] = MPI_REQUEST_NULL;
283 if( original_count < count_by_segment ) {
284 count_by_segment = original_count;
286 sreq[creq]=smpi_mpi_isend((char*)sendbuf +
287 segindex * segment_increment,
288 count_by_segment, datatype,
292 creq = (creq + 1) % max_outstanding_reqs;
294 original_count -= count_by_segment;
297 /* Wait on the remaining request to complete */
298 smpi_mpi_waitall( max_outstanding_reqs, sreq,
299 MPI_STATUSES_IGNORE );
307 error_hndl: /* error handler */
308 XBT_DEBUG("ERROR_HNDL: node %d file %s line %d error %d\n",
309 rank, __FILE__, line, ret );
310 if( inbuf_free[0] != NULL ) free(inbuf_free[0]);
311 if( inbuf_free[1] != NULL ) free(inbuf_free[1]);
312 if( accumbuf_free != NULL ) free(accumbuf);
316 /* Attention: this version of the reduce operations does not
318 - non-commutative operations
319 - segment sizes which are not multiplies of the extent of the datatype
320 meaning that at least one datatype must fit in the segment !
323 int smpi_coll_tuned_reduce_ompi_chain( void *sendbuf, void *recvbuf, int count,
324 MPI_Datatype datatype,
329 uint32_t segsize=64*1024;
330 int segcount = count;
332 int fanout = smpi_comm_size(comm)/2;
334 XBT_DEBUG("coll:tuned:reduce_intra_chain rank %d fo %d ss %5d", smpi_comm_rank(comm), fanout, segsize);
337 * Determine number of segments and number of elements
340 typelng = smpi_datatype_size( datatype);
342 COLL_TUNED_COMPUTED_SEGCOUNT( segsize, typelng, segcount );
344 return smpi_coll_tuned_ompi_reduce_generic( sendbuf, recvbuf, count, datatype,
346 ompi_coll_tuned_topo_build_chain(fanout, comm, root),
351 int smpi_coll_tuned_reduce_ompi_pipeline( void *sendbuf, void *recvbuf,
352 int count, MPI_Datatype datatype,
358 int segcount = count;
360 // COLL_TUNED_UPDATE_PIPELINE( comm, tuned_module, root );
363 * Determine number of segments and number of elements
366 const double a2 = 0.0410 / 1024.0; /* [1/B] */
367 const double b2 = 9.7128;
368 const double a4 = 0.0033 / 1024.0; /* [1/B] */
369 const double b4 = 1.6761;
370 typelng= smpi_datatype_size( datatype);
371 int communicator_size = smpi_comm_size(comm);
372 size_t message_size = typelng * count;
374 if (communicator_size > (a2 * message_size + b2)) {
377 }else if (communicator_size > (a4 * message_size + b4)) {
385 XBT_DEBUG("coll:tuned:reduce_intra_pipeline rank %d ss %5d",
386 smpi_comm_rank(comm), segsize);
388 COLL_TUNED_COMPUTED_SEGCOUNT( segsize, typelng, segcount );
390 return smpi_coll_tuned_ompi_reduce_generic( sendbuf, recvbuf, count, datatype,
392 ompi_coll_tuned_topo_build_chain( 1, comm, root),
396 int smpi_coll_tuned_reduce_ompi_binary( void *sendbuf, void *recvbuf,
397 int count, MPI_Datatype datatype,
402 int segcount = count;
408 * Determine number of segments and number of elements
411 typelng=smpi_datatype_size( datatype );
416 XBT_DEBUG("coll:tuned:reduce_intra_binary rank %d ss %5d",
417 smpi_comm_rank(comm), segsize);
419 COLL_TUNED_COMPUTED_SEGCOUNT( segsize, typelng, segcount );
421 return smpi_coll_tuned_ompi_reduce_generic( sendbuf, recvbuf, count, datatype,
423 ompi_coll_tuned_topo_build_tree(2, comm, root),
427 int smpi_coll_tuned_reduce_ompi_binomial( void *sendbuf, void *recvbuf,
428 int count, MPI_Datatype datatype,
434 int segcount = count;
437 const double a1 = 0.6016 / 1024.0; /* [1/B] */
438 const double b1 = 1.3496;
440 // COLL_TUNED_UPDATE_IN_ORDER_BMTREE( comm, tuned_module, root );
443 * Determine number of segments and number of elements
446 typelng= smpi_datatype_size( datatype);
447 int communicator_size = smpi_comm_size(comm);
448 size_t message_size = typelng * count;
449 if (((communicator_size < 8) && (message_size < 20480)) ||
450 (message_size < 2048) || (count <= 1)) {
453 } else if (communicator_size > (a1 * message_size + b1)) {
458 XBT_DEBUG("coll:tuned:reduce_intra_binomial rank %d ss %5d",
459 smpi_comm_rank(comm), segsize);
460 COLL_TUNED_COMPUTED_SEGCOUNT( segsize, typelng, segcount );
462 return smpi_coll_tuned_ompi_reduce_generic( sendbuf, recvbuf, count, datatype,
464 ompi_coll_tuned_topo_build_in_order_bmtree(comm, root),
469 * reduce_intra_in_order_binary
471 * Function: Logarithmic reduce operation for non-commutative operations.
472 * Acecpts: same as MPI_Reduce()
473 * Returns: MPI_SUCCESS or error code
475 int smpi_coll_tuned_reduce_ompi_in_order_binary( void *sendbuf, void *recvbuf,
477 MPI_Datatype datatype,
483 int rank, size, io_root;
484 int segcount = count;
485 void *use_this_sendbuf = NULL, *use_this_recvbuf = NULL;
488 rank = smpi_comm_rank(comm);
489 size = smpi_comm_size(comm);
490 XBT_DEBUG("coll:tuned:reduce_intra_in_order_binary rank %d ss %5d",
494 * Determine number of segments and number of elements
497 typelng=smpi_datatype_size( datatype);
498 COLL_TUNED_COMPUTED_SEGCOUNT( segsize, typelng, segcount );
500 /* An in-order binary tree must use root (size-1) to preserve the order of
501 operations. Thus, if root is not rank (size - 1), then we must handle
502 1. MPI_IN_PLACE option on real root, and
503 2. we must allocate temporary recvbuf on rank (size - 1).
504 Note that generic function must be careful not to switch order of
505 operations for non-commutative ops.
508 use_this_sendbuf = sendbuf;
509 use_this_recvbuf = recvbuf;
510 if (io_root != root) {
514 ext=smpi_datatype_get_extent(datatype);
515 text=smpi_datatype_get_extent(datatype);
517 if ((root == rank) && (MPI_IN_PLACE == sendbuf)) {
518 tmpbuf = (char *) malloc(text + (count - 1) * ext);
519 if (NULL == tmpbuf) {
520 return MPI_ERR_INTERN;
523 (char*)recvbuf, count, datatype,
524 (char*)tmpbuf, count, datatype);
525 use_this_sendbuf = tmpbuf;
526 } else if (io_root == rank) {
527 tmpbuf = (char *) malloc(text + (count - 1) * ext);
528 if (NULL == tmpbuf) {
529 return MPI_ERR_INTERN;
531 use_this_recvbuf = tmpbuf;
535 /* Use generic reduce with in-order binary tree topology and io_root */
536 ret = smpi_coll_tuned_ompi_reduce_generic( use_this_sendbuf, use_this_recvbuf, count, datatype,
538 ompi_coll_tuned_topo_build_in_order_bintree(comm),
540 if (MPI_SUCCESS != ret) { return ret; }
543 if (io_root != root) {
545 /* Receive result from rank io_root to recvbuf */
546 smpi_mpi_recv(recvbuf, count, datatype, io_root,
547 COLL_TAG_REDUCE, comm,
549 if (MPI_IN_PLACE == sendbuf) {
550 free(use_this_sendbuf);
553 } else if (io_root == rank) {
554 /* Send result from use_this_recvbuf to root */
555 smpi_mpi_send(use_this_recvbuf, count, datatype, root,
558 free(use_this_recvbuf);
566 * Linear functions are copied from the BASIC coll module
567 * they do not segment the message and are simple implementations
568 * but for some small number of nodes and/or small data sizes they
569 * are just as fast as tuned/tree based segmenting operations
570 * and as such may be selected by the decision functions
571 * These are copied into this module due to the way we select modules
572 * in V1. i.e. in V2 we will handle this differently and so will not
573 * have to duplicate code.
574 * GEF Oct05 after asking Jeff.
577 /* copied function (with appropriate renaming) starts here */
582 * Function: - reduction using O(N) algorithm
583 * Accepts: - same as MPI_Reduce()
584 * Returns: - MPI_SUCCESS or error code
588 smpi_coll_tuned_reduce_ompi_basic_linear(void *sbuf, void *rbuf, int count,
595 ptrdiff_t true_extent, lb, extent;
596 char *free_buffer = NULL;
597 char *pml_buffer = NULL;
598 char *inplace_temp = NULL;
603 rank = smpi_comm_rank(comm);
604 size = smpi_comm_size(comm);
606 XBT_DEBUG("coll:tuned:reduce_intra_basic_linear rank %d", rank);
608 /* If not root, send data to the root. */
611 smpi_mpi_send(sbuf, count, dtype, root,
617 /* see discussion in ompi_coll_basic_reduce_lin_intra about
618 extent and true extent */
619 /* for reducing buffer allocation lengths.... */
621 smpi_datatype_extent(dtype, &lb, &extent);
622 true_extent = smpi_datatype_get_extent(dtype);
624 if (MPI_IN_PLACE == sbuf) {
626 inplace_temp = (char*)malloc(true_extent + (count - 1) * extent);
627 if (NULL == inplace_temp) {
630 rbuf = inplace_temp - lb;
634 free_buffer = (char*)malloc(true_extent + (count - 1) * extent);
635 pml_buffer = free_buffer - lb;
638 /* Initialize the receive buffer. */
640 if (rank == (size - 1)) {
641 smpi_datatype_copy((char*)sbuf, count, dtype,(char*)rbuf, count, dtype);
643 smpi_mpi_recv(rbuf, count, dtype, size - 1,
644 COLL_TAG_REDUCE, comm,
648 /* Loop receiving and calling reduction function (C or Fortran). */
650 for (i = size - 2; i >= 0; --i) {
654 smpi_mpi_recv(pml_buffer, count, dtype, i,
655 COLL_TAG_REDUCE, comm,
660 /* Perform the reduction */
661 smpi_op_apply(op, inbuf, rbuf, &count, &dtype);
664 if (NULL != inplace_temp) {
665 smpi_datatype_copy(inplace_temp, count, dtype,(char*)sbuf
669 if (NULL != free_buffer) {
677 /* copied function (with appropriate renaming) ends here */