src/smpi/smpi_coll.cpp

   1 /* smpi_coll.c -- various optimized routing for collectives                   */
   2
   3 /* Copyright (c) 2009-2015. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <assert.h>
  12
  13 #include "private.h"
  14 #include "colls/colls.h"
  15 #include "simgrid/sg_config.h"
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_coll, smpi, "Logging specific to SMPI (coll)");
  18
  19 s_mpi_coll_description_t mpi_coll_gather_description[] = {
  20   {"default", "gather default collective", (void*)smpi_mpi_gather},
  21    COLL_GATHERS(COLL_DESCRIPTION, COLL_COMMA), {NULL, NULL, NULL}      /* this array must be NULL terminated */
  22 };
  23
  24
  25 s_mpi_coll_description_t mpi_coll_allgather_description[] = {
  26   {"default",
  27    "allgather default collective",
  28    (void*)smpi_mpi_allgather},
  29 COLL_ALLGATHERS(COLL_DESCRIPTION, COLL_COMMA),
  30   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  31 };
  32
  33 s_mpi_coll_description_t mpi_coll_allgatherv_description[] = {
  34   {"default",
  35    "allgatherv default collective",
  36    (void*)smpi_mpi_allgatherv},
  37 COLL_ALLGATHERVS(COLL_DESCRIPTION, COLL_COMMA),
  38   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  39 };
  40
  41 s_mpi_coll_description_t mpi_coll_allreduce_description[] = {
  42   {"default",
  43    "allreduce default collective",
  44    (void*)smpi_mpi_allreduce},
  45 COLL_ALLREDUCES(COLL_DESCRIPTION, COLL_COMMA),
  46   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  47 };
  48
  49 s_mpi_coll_description_t mpi_coll_reduce_scatter_description[] = {
  50   {"default",
  51    "reduce_scatter default collective",
  52    (void*)smpi_mpi_reduce_scatter},
  53 COLL_REDUCE_SCATTERS(COLL_DESCRIPTION, COLL_COMMA),
  54   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  55 };
  56
  57 s_mpi_coll_description_t mpi_coll_scatter_description[] = {
  58   {"default",
  59    "scatter default collective",
  60    (void*)smpi_mpi_scatter},
  61 COLL_SCATTERS(COLL_DESCRIPTION, COLL_COMMA),
  62   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  63 };
  64
  65 s_mpi_coll_description_t mpi_coll_barrier_description[] = {
  66   {"default",
  67    "barrier default collective",
  68    (void*)smpi_mpi_barrier},
  69 COLL_BARRIERS(COLL_DESCRIPTION, COLL_COMMA),
  70   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  71 };
  72 s_mpi_coll_description_t mpi_coll_alltoall_description[] = {
  73   {"default",
  74    "Ompi alltoall default collective",
  75    (void*)smpi_coll_tuned_alltoall_ompi2},
  76 COLL_ALLTOALLS(COLL_DESCRIPTION, COLL_COMMA),
  77   {"bruck",
  78    "Alltoall Bruck (SG) collective",
  79    (void*)smpi_coll_tuned_alltoall_bruck},
  80   {"basic_linear",
  81    "Alltoall basic linear (SG) collective",
  82    (void*)smpi_coll_tuned_alltoall_basic_linear},
  83   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  84 };
  85
  86 s_mpi_coll_description_t mpi_coll_alltoallv_description[] = {
  87   {"default",
  88    "Ompi alltoallv default collective",
  89    (void*)smpi_coll_basic_alltoallv},
  90 COLL_ALLTOALLVS(COLL_DESCRIPTION, COLL_COMMA),
  91   {NULL, NULL, NULL}      /* this array must be NULL terminated */
  92 };
  93
  94 s_mpi_coll_description_t mpi_coll_bcast_description[] = {
  95   {"default",
  96    "bcast default collective ",
  97    (void*)smpi_mpi_bcast},
  98 COLL_BCASTS(COLL_DESCRIPTION, COLL_COMMA),
  99   {NULL, NULL, NULL}      /* this array must be NULL terminated */
 100 };
 101
 102 s_mpi_coll_description_t mpi_coll_reduce_description[] = {
 103   {"default",
 104    "reduce default collective",
 105    (void*)smpi_mpi_reduce},
 106 COLL_REDUCES(COLL_DESCRIPTION, COLL_COMMA),
 107   {NULL, NULL, NULL}      /* this array must be NULL terminated */
 108 };
 109
 110
 111
 112 /** Displays the long description of all registered models, and quit */
 113 void coll_help(const char *category, s_mpi_coll_description_t * table)
 114 {
 115   int i;
 116   printf("Long description of the %s models accepted by this simulator:\n",
 117          category);
 118   for (i = 0; table[i].name; i++)
 119     printf("  %s: %s\n", table[i].name, table[i].description);
 120 }
 121
 122 int find_coll_description(s_mpi_coll_description_t * table,
 123                            char *name, const char *desc)
 124 {
 125   char *name_list = NULL;
 126   int selector_on=0;
 127   if (name==NULL || name[0] == '\0') {
 128     //no argument provided, use active selector's algorithm
 129     name=(char*)xbt_cfg_get_string("smpi/coll-selector");
 130     selector_on=1;
 131   }
 132   for (int i = 0; table[i].name; i++)
 133     if (!strcmp(name, table[i].name)) {
 134       if (strcmp(table[i].name,"default"))
 135         XBT_INFO("Switch to algorithm %s for collective %s",table[i].name,desc);
 136       return i;
 137     }
 138
 139   if(selector_on){
 140     // collective seems not handled by the active selector, try with default one
 141     name=(char*)"default";
 142     for (int i = 0; table[i].name; i++)
 143       if (!strcmp(name, table[i].name)) {
 144         return i;
 145     }
 146   }
 147   if (!table[0].name)
 148     xbt_die("No collective is valid for '%s'! This is a bug.",name);
 149   name_list = xbt_strdup(table[0].name);
 150   for (int i = 1; table[i].name; i++) {
 151     name_list = static_cast<char*>(xbt_realloc(name_list,
 152                     strlen(name_list) + strlen(table[i].name) + 3));
 153     strcat(name_list, ", ");
 154     strcat(name_list, table[i].name);
 155   }
 156   xbt_die("Collective '%s' is invalid! Valid collectives are: %s.", name, name_list);
 157   return -1;
 158 }
 159
 160 int (*mpi_coll_gather_fun)(void *, int, MPI_Datatype, void*, int, MPI_Datatype, int root, MPI_Comm);
 161 int (*mpi_coll_allgather_fun)(void *, int, MPI_Datatype, void*, int, MPI_Datatype, MPI_Comm);
 162 int (*mpi_coll_allgatherv_fun)(void *, int, MPI_Datatype, void*, int*, int*, MPI_Datatype, MPI_Comm);
 163 int (*mpi_coll_allreduce_fun)(void *sbuf, void *rbuf, int rcount, MPI_Datatype dtype, MPI_Op op, MPI_Comm comm);
 164 int (*mpi_coll_alltoall_fun)(void *, int, MPI_Datatype, void*, int, MPI_Datatype, MPI_Comm);
 165 int (*mpi_coll_alltoallv_fun)(void *, int*, int*, MPI_Datatype, void*, int*, int*, MPI_Datatype, MPI_Comm);
 166 int (*mpi_coll_bcast_fun)(void *buf, int count, MPI_Datatype datatype, int root, MPI_Comm com);
 167 int (*mpi_coll_reduce_fun)(void *buf, void *rbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPI_Comm comm);
 168 int (*mpi_coll_reduce_scatter_fun)(void *sbuf, void *rbuf, int *rcounts,MPI_Datatype dtype,MPI_Op  op,MPI_Comm  comm);
 169 int (*mpi_coll_scatter_fun)(void *sendbuf, int sendcount, MPI_Datatype sendtype,void *recvbuf, int recvcount, MPI_Datatype recvtype,int root, MPI_Comm comm);
 170 int (*mpi_coll_barrier_fun)(MPI_Comm comm);
 171 void (*smpi_coll_cleanup_callback)(void);
 172
 173
 174 int smpi_coll_tuned_alltoall_ompi2(void *sendbuf, int sendcount,
 175                                    MPI_Datatype sendtype, void *recvbuf,
 176                                    int recvcount, MPI_Datatype recvtype,
 177                                    MPI_Comm comm)
 178 {
 179   int size, sendsize;
 180   size = smpi_comm_size(comm);
 181   sendsize = smpi_datatype_size(sendtype) * sendcount;
 182   if (sendsize < 200 && size > 12) {
 183     return
 184         smpi_coll_tuned_alltoall_bruck(sendbuf, sendcount, sendtype,
 185                                        recvbuf, recvcount, recvtype,
 186                                        comm);
 187   } else if (sendsize < 3000) {
 188     return
 189         smpi_coll_tuned_alltoall_basic_linear(sendbuf, sendcount,
 190                                               sendtype, recvbuf,
 191                                               recvcount, recvtype, comm);
 192   } else {
 193     return
 194         smpi_coll_tuned_alltoall_ring(sendbuf, sendcount, sendtype,
 195                                       recvbuf, recvcount, recvtype,
 196                                       comm);
 197   }
 198 }
 199
 200 /**
 201  * Alltoall Bruck
 202  *
 203  * Openmpi calls this routine when the message size sent to each rank < 2000 bytes and size < 12
 204  * FIXME: uh, check smpi_pmpi again, but this routine is called for > 12, not
 205  * less...
 206  **/
 207 int smpi_coll_tuned_alltoall_bruck(void *sendbuf, int sendcount,
 208                                    MPI_Datatype sendtype, void *recvbuf,
 209                                    int recvcount, MPI_Datatype recvtype,
 210                                    MPI_Comm comm)
 211 {
 212   int system_tag = 777;
 213   int i, rank, size, err, count;
 214   MPI_Aint lb;
 215   MPI_Aint sendext = 0;
 216   MPI_Aint recvext = 0;
 217   MPI_Request *requests;
 218
 219   // FIXME: check implementation
 220   rank = smpi_comm_rank(comm);
 221   size = smpi_comm_size(comm);
 222   XBT_DEBUG("<%d> algorithm alltoall_bruck() called.", rank);
 223   smpi_datatype_extent(sendtype, &lb, &sendext);
 224   smpi_datatype_extent(recvtype, &lb, &recvext);
 225   /* Local copy from self */
 226   err =
 227       smpi_datatype_copy((char *)sendbuf + rank * sendcount * sendext,
 228                          sendcount, sendtype,
 229                          (char *)recvbuf + rank * recvcount * recvext,
 230                          recvcount, recvtype);
 231   if (err == MPI_SUCCESS && size > 1) {
 232     /* Initiate all send/recv to/from others. */
 233     requests = xbt_new(MPI_Request, 2 * (size - 1));
 234     count = 0;
 235     /* Create all receives that will be posted first */
 236     for (i = 0; i < size; ++i) {
 237       if (i == rank) {
 238         XBT_DEBUG("<%d> skip request creation [src = %d, recvcount = %d]",
 239                rank, i, recvcount);
 240         continue;
 241       }
 242       requests[count] =
 243           smpi_irecv_init((char *)recvbuf + i * recvcount * recvext, recvcount,
 244                           recvtype, i, system_tag, comm);
 245       count++;
 246     }
 247     /* Now create all sends  */
 248     for (i = 0; i < size; ++i) {
 249       if (i == rank) {
 250         XBT_DEBUG("<%d> skip request creation [dst = %d, sendcount = %d]",
 251                rank, i, sendcount);
 252         continue;
 253       }
 254       requests[count] =
 255           smpi_isend_init((char *)sendbuf + i * sendcount * sendext, sendcount,
 256                           sendtype, i, system_tag, comm);
 257       count++;
 258     }
 259     /* Wait for them all. */
 260     smpi_mpi_startall(count, requests);
 261     XBT_DEBUG("<%d> wait for %d requests", rank, count);
 262     smpi_mpi_waitall(count, requests, MPI_STATUS_IGNORE);
 263     for(i = 0; i < count; i++) {
 264       if(requests[i]!=MPI_REQUEST_NULL) smpi_mpi_request_free(&requests[i]);
 265     }
 266     xbt_free(requests);
 267   }
 268   return MPI_SUCCESS;
 269 }
 270
 271 /**
 272  * Alltoall basic_linear (STARMPI:alltoall-simple)
 273  **/
 274 int smpi_coll_tuned_alltoall_basic_linear(void *sendbuf, int sendcount,
 275                                           MPI_Datatype sendtype,
 276                                           void *recvbuf, int recvcount,
 277                                           MPI_Datatype recvtype,
 278                                           MPI_Comm comm)
 279 {
 280   int system_tag = 888;
 281   int i, rank, size, err, count;
 282   MPI_Aint lb = 0, sendext = 0, recvext = 0;
 283   MPI_Request *requests;
 284
 285   /* Initialize. */
 286   rank = smpi_comm_rank(comm);
 287   size = smpi_comm_size(comm);
 288   XBT_DEBUG("<%d> algorithm alltoall_basic_linear() called.", rank);
 289   smpi_datatype_extent(sendtype, &lb, &sendext);
 290   smpi_datatype_extent(recvtype, &lb, &recvext);
 291   /* simple optimization */
 292   err = smpi_datatype_copy((char *)sendbuf + rank * sendcount * sendext,
 293                            sendcount, sendtype,
 294                            (char *)recvbuf + rank * recvcount * recvext,
 295                            recvcount, recvtype);
 296   if (err == MPI_SUCCESS && size > 1) {
 297     /* Initiate all send/recv to/from others. */
 298     requests = xbt_new(MPI_Request, 2 * (size - 1));
 299     /* Post all receives first -- a simple optimization */
 300     count = 0;
 301     for (i = (rank + 1) % size; i != rank; i = (i + 1) % size) {
 302       requests[count] =
 303           smpi_irecv_init((char *)recvbuf + i * recvcount * recvext, recvcount,
 304                           recvtype, i, system_tag, comm);
 305       count++;
 306     }
 307     /* Now post all sends in reverse order
 308      *   - We would like to minimize the search time through message queue
 309      *     when messages actually arrive in the order in which they were posted.
 310      * TODO: check the previous assertion
 311      */
 312     for (i = (rank + size - 1) % size; i != rank; i = (i + size - 1) % size) {
 313       requests[count] =
 314           smpi_isend_init((char *)sendbuf + i * sendcount * sendext, sendcount,
 315                           sendtype, i, system_tag, comm);
 316       count++;
 317     }
 318     /* Wait for them all. */
 319     smpi_mpi_startall(count, requests);
 320     XBT_DEBUG("<%d> wait for %d requests", rank, count);
 321     smpi_mpi_waitall(count, requests, MPI_STATUS_IGNORE);
 322     for(i = 0; i < count; i++) {
 323       if(requests[i]!=MPI_REQUEST_NULL) smpi_mpi_request_free(&requests[i]);
 324     }
 325     xbt_free(requests);
 326   }
 327   return err;
 328 }
 329
 330 int smpi_coll_basic_alltoallv(void *sendbuf, int *sendcounts,
 331                               int *senddisps, MPI_Datatype sendtype,
 332                               void *recvbuf, int *recvcounts,
 333                               int *recvdisps, MPI_Datatype recvtype,
 334                               MPI_Comm comm)
 335 {
 336   int system_tag = 889;
 337   int i, rank, size, err, count;
 338   MPI_Aint lb = 0, sendext = 0, recvext = 0;
 339   MPI_Request *requests;
 340
 341   /* Initialize. */
 342   rank = smpi_comm_rank(comm);
 343   size = smpi_comm_size(comm);
 344   XBT_DEBUG("<%d> algorithm basic_alltoallv() called.", rank);
 345   smpi_datatype_extent(sendtype, &lb, &sendext);
 346   smpi_datatype_extent(recvtype, &lb, &recvext);
 347   /* Local copy from self */
 348   err =
 349       smpi_datatype_copy((char *)sendbuf + senddisps[rank] * sendext,
 350                          sendcounts[rank], sendtype,
 351                          (char *)recvbuf + recvdisps[rank] * recvext,
 352                          recvcounts[rank], recvtype);
 353   if (err == MPI_SUCCESS && size > 1) {
 354     /* Initiate all send/recv to/from others. */
 355     requests = xbt_new(MPI_Request, 2 * (size - 1));
 356     count = 0;
 357     /* Create all receives that will be posted first */
 358     for (i = 0; i < size; ++i) {
 359       if (i == rank || recvcounts[i] == 0) {
 360         XBT_DEBUG
 361             ("<%d> skip request creation [src = %d, recvcounts[src] = %d]",
 362              rank, i, recvcounts[i]);
 363         continue;
 364       }
 365       requests[count] =
 366           smpi_irecv_init((char *)recvbuf + recvdisps[i] * recvext,
 367                           recvcounts[i], recvtype, i, system_tag, comm);
 368       count++;
 369     }
 370     /* Now create all sends  */
 371     for (i = 0; i < size; ++i) {
 372       if (i == rank || sendcounts[i] == 0) {
 373         XBT_DEBUG
 374             ("<%d> skip request creation [dst = %d, sendcounts[dst] = %d]",
 375              rank, i, sendcounts[i]);
 376         continue;
 377       }
 378       requests[count] =
 379           smpi_isend_init((char *)sendbuf + senddisps[i] * sendext,
 380                           sendcounts[i], sendtype, i, system_tag, comm);
 381       count++;
 382     }
 383     /* Wait for them all. */
 384     smpi_mpi_startall(count, requests);
 385     XBT_DEBUG("<%d> wait for %d requests", rank, count);
 386     smpi_mpi_waitall(count, requests, MPI_STATUS_IGNORE);
 387     for(i = 0; i < count; i++) {
 388       if(requests[i]!=MPI_REQUEST_NULL) smpi_mpi_request_free(&requests[i]);
 389     }
 390     xbt_free(requests);
 391   }
 392   return err;
 393 }