src/smpi/colls/colls.h

   1 /* Copyright (c) 2013-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SMPI_COLLS_H
   8 #define SMPI_COLLS_H
   9
  10 #include <math.h>
  11 #include "smpi/mpi.h"
  12 #include "smpi/private.h"
  13 #include "xbt/ex.h"
  14 #include "xbt.h"
  15
  16 #define COLL_DESCRIPTION(cat, ret, args, name) \
  17   {# name,\
  18    # cat " " # name " collective",\
  19    smpi_coll_tuned_ ## cat ## _ ## name}
  20
  21 #define COLL_PROTO(cat, ret, args, name) \
  22   ret smpi_coll_tuned_ ## cat ## _ ## name(COLL_UNPAREN args);
  23 #define COLL_UNPAREN(...)  __VA_ARGS__
  24
  25 #define COLL_APPLY(action, sig, name) action(sig, name)
  26 #define COLL_COMMA ,
  27 #define COLL_NOsep
  28 #define COLL_NOTHING(...)
  29
  30 /*************
  31  * GATHER *
  32  *************/
  33 #define COLL_GATHER_SIG gather, int, \
  34                           (void *send_buff, int send_count, MPI_Datatype send_type, \
  35                            void *recv_buff, int recv_count, MPI_Datatype recv_type, \
  36                            int root, MPI_Comm comm)
  37
  38 #define COLL_GATHERS(action, COLL_sep) \
  39 COLL_APPLY(action, COLL_GATHER_SIG, ompi) COLL_sep \
  40 COLL_APPLY(action, COLL_GATHER_SIG, ompi_basic_linear) COLL_sep \
  41 COLL_APPLY(action, COLL_GATHER_SIG, ompi_binomial) COLL_sep \
  42 COLL_APPLY(action, COLL_GATHER_SIG, ompi_linear_sync) COLL_sep \
  43 COLL_APPLY(action, COLL_GATHER_SIG, mpich) COLL_sep \
  44 COLL_APPLY(action, COLL_GATHER_SIG, mvapich2) COLL_sep \
  45 COLL_APPLY(action, COLL_GATHER_SIG, impi) COLL_sep \
  46 COLL_APPLY(action, COLL_GATHER_SIG, automatic)
  47
  48
  49
  50 COLL_GATHERS(COLL_PROTO, COLL_NOsep)
  51
  52 /*************
  53  * ALLGATHER *
  54  *************/
  55 #define COLL_ALLGATHER_SIG allgather, int, \
  56                           (void *send_buff, int send_count, MPI_Datatype send_type, \
  57                            void *recv_buff, int recv_count, MPI_Datatype recv_type, \
  58                            MPI_Comm comm)
  59
  60 #define COLL_ALLGATHERS(action, COLL_sep) \
  61 COLL_APPLY(action, COLL_ALLGATHER_SIG, 2dmesh) COLL_sep \
  62 COLL_APPLY(action, COLL_ALLGATHER_SIG, 3dmesh) COLL_sep \
  63 COLL_APPLY(action, COLL_ALLGATHER_SIG, bruck) COLL_sep \
  64 COLL_APPLY(action, COLL_ALLGATHER_SIG, GB) COLL_sep \
  65 COLL_APPLY(action, COLL_ALLGATHER_SIG, loosely_lr) COLL_sep \
  66 COLL_APPLY(action, COLL_ALLGATHER_SIG, NTSLR) COLL_sep \
  67 COLL_APPLY(action, COLL_ALLGATHER_SIG, NTSLR_NB) COLL_sep \
  68 COLL_APPLY(action, COLL_ALLGATHER_SIG, pair) COLL_sep \
  69 COLL_APPLY(action, COLL_ALLGATHER_SIG, rdb) COLL_sep \
  70 COLL_APPLY(action, COLL_ALLGATHER_SIG, rhv) COLL_sep \
  71 COLL_APPLY(action, COLL_ALLGATHER_SIG, ring) COLL_sep \
  72 COLL_APPLY(action, COLL_ALLGATHER_SIG, SMP_NTS) COLL_sep \
  73 COLL_APPLY(action, COLL_ALLGATHER_SIG, smp_simple) COLL_sep \
  74 COLL_APPLY(action, COLL_ALLGATHER_SIG, spreading_simple) COLL_sep \
  75 COLL_APPLY(action, COLL_ALLGATHER_SIG, ompi) COLL_sep \
  76 COLL_APPLY(action, COLL_ALLGATHER_SIG, ompi_neighborexchange) COLL_sep \
  77 COLL_APPLY(action, COLL_ALLGATHER_SIG, mvapich2) COLL_sep \
  78 COLL_APPLY(action, COLL_ALLGATHER_SIG, mpich) COLL_sep \
  79 COLL_APPLY(action, COLL_ALLGATHER_SIG, impi) COLL_sep \
  80 COLL_APPLY(action, COLL_ALLGATHER_SIG, automatic)
  81
  82
  83 COLL_ALLGATHERS(COLL_PROTO, COLL_NOsep)
  84
  85 /**************
  86  * ALLGATHERV *
  87  **************/
  88 #define COLL_ALLGATHERV_SIG allgatherv, int, \
  89                           (void *send_buff, int send_count, MPI_Datatype send_type, \
  90                            void *recv_buff, int *recv_count, int *recv_disps, \
  91                            MPI_Datatype recv_type, MPI_Comm comm)
  92
  93 #define COLL_ALLGATHERVS(action, COLL_sep) \
  94 COLL_APPLY(action, COLL_ALLGATHERV_SIG, GB) COLL_sep \
  95 COLL_APPLY(action, COLL_ALLGATHERV_SIG, pair) COLL_sep \
  96 COLL_APPLY(action, COLL_ALLGATHERV_SIG, ring) COLL_sep \
  97 COLL_APPLY(action, COLL_ALLGATHERV_SIG, ompi) COLL_sep \
  98 COLL_APPLY(action, COLL_ALLGATHERV_SIG, ompi_neighborexchange) COLL_sep \
  99 COLL_APPLY(action, COLL_ALLGATHERV_SIG, ompi_bruck) COLL_sep \
 100 COLL_APPLY(action, COLL_ALLGATHERV_SIG, mpich) COLL_sep \
 101 COLL_APPLY(action, COLL_ALLGATHERV_SIG, mpich_rdb) COLL_sep \
 102 COLL_APPLY(action, COLL_ALLGATHERV_SIG, mpich_ring) COLL_sep \
 103 COLL_APPLY(action, COLL_ALLGATHERV_SIG, mvapich2) COLL_sep \
 104 COLL_APPLY(action, COLL_ALLGATHERV_SIG, impi) COLL_sep \
 105 COLL_APPLY(action, COLL_ALLGATHERV_SIG, automatic)
 106
 107 COLL_ALLGATHERVS(COLL_PROTO, COLL_NOsep)
 108
 109 /*************
 110  * ALLREDUCE *
 111  *************/
 112 #define COLL_ALLREDUCE_SIG allreduce, int, \
 113                           (void *sbuf, void *rbuf, int rcount, \
 114                            MPI_Datatype dtype, MPI_Op op, MPI_Comm comm)
 115
 116 #define COLL_ALLREDUCES(action, COLL_sep) \
 117 COLL_APPLY(action, COLL_ALLREDUCE_SIG, lr) COLL_sep \
 118 COLL_APPLY(action, COLL_ALLREDUCE_SIG, rab1) COLL_sep \
 119 COLL_APPLY(action, COLL_ALLREDUCE_SIG, rab2) COLL_sep \
 120 COLL_APPLY(action, COLL_ALLREDUCE_SIG, rab_rdb) COLL_sep \
 121 COLL_APPLY(action, COLL_ALLREDUCE_SIG, rdb) COLL_sep \
 122 COLL_APPLY(action, COLL_ALLREDUCE_SIG, smp_binomial) COLL_sep \
 123 COLL_APPLY(action, COLL_ALLREDUCE_SIG, smp_binomial_pipeline) COLL_sep \
 124 COLL_APPLY(action, COLL_ALLREDUCE_SIG, smp_rdb) COLL_sep \
 125 COLL_APPLY(action, COLL_ALLREDUCE_SIG, smp_rsag) COLL_sep \
 126 COLL_APPLY(action, COLL_ALLREDUCE_SIG, smp_rsag_lr) COLL_sep \
 127 COLL_APPLY(action, COLL_ALLREDUCE_SIG, smp_rsag_rab) COLL_sep \
 128 COLL_APPLY(action, COLL_ALLREDUCE_SIG, redbcast) COLL_sep \
 129 COLL_APPLY(action, COLL_ALLREDUCE_SIG, ompi) COLL_sep \
 130 COLL_APPLY(action, COLL_ALLREDUCE_SIG, ompi_ring_segmented) COLL_sep \
 131 COLL_APPLY(action, COLL_ALLREDUCE_SIG, mpich) COLL_sep \
 132 COLL_APPLY(action, COLL_ALLREDUCE_SIG, mvapich2) COLL_sep \
 133 COLL_APPLY(action, COLL_ALLREDUCE_SIG, mvapich2_rs) COLL_sep \
 134 COLL_APPLY(action, COLL_ALLREDUCE_SIG, impi) COLL_sep \
 135 COLL_APPLY(action, COLL_ALLREDUCE_SIG, rab) COLL_sep \
 136 COLL_APPLY(action, COLL_ALLREDUCE_SIG, automatic)
 137
 138 COLL_ALLREDUCES(COLL_PROTO, COLL_NOsep)
 139
 140
 141 /************
 142  * ALLTOALL *
 143  ************/
 144 #define COLL_ALLTOALL_SIG alltoall, int, \
 145                          (void *send_buff, int send_count, MPI_Datatype send_type, \
 146                           void *recv_buff, int recv_count, MPI_Datatype recv_type, \
 147                           MPI_Comm comm)
 148
 149 #define COLL_ALLTOALLS(action, COLL_sep) \
 150 COLL_APPLY(action, COLL_ALLTOALL_SIG, 2dmesh) COLL_sep \
 151 COLL_APPLY(action, COLL_ALLTOALL_SIG, 3dmesh) COLL_sep \
 152 COLL_APPLY(action, COLL_ALLTOALL_SIG, bruck) COLL_sep \
 153 COLL_APPLY(action, COLL_ALLTOALL_SIG, pair) COLL_sep \
 154 COLL_APPLY(action, COLL_ALLTOALL_SIG, pair_rma) COLL_sep \
 155 COLL_APPLY(action, COLL_ALLTOALL_SIG, pair_light_barrier) COLL_sep \
 156 COLL_APPLY(action, COLL_ALLTOALL_SIG, pair_mpi_barrier) COLL_sep \
 157 COLL_APPLY(action, COLL_ALLTOALL_SIG, pair_one_barrier) COLL_sep \
 158 COLL_APPLY(action, COLL_ALLTOALL_SIG, rdb) COLL_sep \
 159 COLL_APPLY(action, COLL_ALLTOALL_SIG, ring) COLL_sep \
 160 COLL_APPLY(action, COLL_ALLTOALL_SIG, ring_light_barrier) COLL_sep \
 161 COLL_APPLY(action, COLL_ALLTOALL_SIG, ring_mpi_barrier) COLL_sep \
 162 COLL_APPLY(action, COLL_ALLTOALL_SIG, ring_one_barrier) COLL_sep \
 163 COLL_APPLY(action, COLL_ALLTOALL_SIG, mvapich2) COLL_sep \
 164 COLL_APPLY(action, COLL_ALLTOALL_SIG, mvapich2_scatter_dest) COLL_sep \
 165 COLL_APPLY(action, COLL_ALLTOALL_SIG, ompi) COLL_sep \
 166 COLL_APPLY(action, COLL_ALLTOALL_SIG, mpich) COLL_sep \
 167 COLL_APPLY(action, COLL_ALLTOALL_SIG, impi) COLL_sep \
 168 COLL_APPLY(action, COLL_ALLTOALL_SIG, automatic)
 169
 170 COLL_ALLTOALLS(COLL_PROTO, COLL_NOsep)
 171
 172 /*************
 173  * ALLTOALLV *
 174  *************/
 175 #define COLL_ALLTOALLV_SIG alltoallv, int, \
 176                          (void *send_buff, int *send_counts, int *send_disps, MPI_Datatype send_type, \
 177                           void *recv_buff, int *recv_counts, int *recv_disps, MPI_Datatype recv_type, \
 178                           MPI_Comm comm)
 179
 180 #define COLL_ALLTOALLVS(action, COLL_sep) \
 181 COLL_APPLY(action, COLL_ALLTOALLV_SIG, bruck) COLL_sep \
 182 COLL_APPLY(action, COLL_ALLTOALLV_SIG, pair) COLL_sep \
 183 COLL_APPLY(action, COLL_ALLTOALLV_SIG, pair_light_barrier) COLL_sep \
 184 COLL_APPLY(action, COLL_ALLTOALLV_SIG, pair_mpi_barrier) COLL_sep \
 185 COLL_APPLY(action, COLL_ALLTOALLV_SIG, pair_one_barrier) COLL_sep \
 186 COLL_APPLY(action, COLL_ALLTOALLV_SIG, ring) COLL_sep \
 187 COLL_APPLY(action, COLL_ALLTOALLV_SIG, ring_light_barrier) COLL_sep \
 188 COLL_APPLY(action, COLL_ALLTOALLV_SIG, ring_mpi_barrier) COLL_sep \
 189 COLL_APPLY(action, COLL_ALLTOALLV_SIG, ring_one_barrier) COLL_sep \
 190 COLL_APPLY(action, COLL_ALLTOALLV_SIG, ompi) COLL_sep \
 191 COLL_APPLY(action, COLL_ALLTOALLV_SIG, mpich) COLL_sep \
 192 COLL_APPLY(action, COLL_ALLTOALLV_SIG, ompi_basic_linear) COLL_sep \
 193 COLL_APPLY(action, COLL_ALLTOALLV_SIG, mvapich2) COLL_sep \
 194 COLL_APPLY(action, COLL_ALLTOALLV_SIG, impi) COLL_sep \
 195 COLL_APPLY(action, COLL_ALLTOALLV_SIG, automatic)
 196
 197 COLL_ALLTOALLVS(COLL_PROTO, COLL_NOsep)
 198
 199 /*********
 200  * BCAST *
 201  *********/
 202 #define COLL_BCAST_SIG bcast, int, \
 203                       (void *buf, int count, MPI_Datatype datatype, \
 204                        int root, MPI_Comm comm)
 205
 206 #define COLL_BCASTS(action, COLL_sep) \
 207 COLL_APPLY(action, COLL_BCAST_SIG, arrival_pattern_aware) COLL_sep \
 208 COLL_APPLY(action, COLL_BCAST_SIG, arrival_pattern_aware_wait) COLL_sep \
 209 COLL_APPLY(action, COLL_BCAST_SIG, arrival_scatter) COLL_sep \
 210 COLL_APPLY(action, COLL_BCAST_SIG, binomial_tree) COLL_sep \
 211 COLL_APPLY(action, COLL_BCAST_SIG, flattree) COLL_sep \
 212 COLL_APPLY(action, COLL_BCAST_SIG, flattree_pipeline) COLL_sep \
 213 COLL_APPLY(action, COLL_BCAST_SIG, NTSB) COLL_sep \
 214 COLL_APPLY(action, COLL_BCAST_SIG, NTSL) COLL_sep \
 215 COLL_APPLY(action, COLL_BCAST_SIG, NTSL_Isend) COLL_sep \
 216 COLL_APPLY(action, COLL_BCAST_SIG, scatter_LR_allgather) COLL_sep \
 217 COLL_APPLY(action, COLL_BCAST_SIG, scatter_rdb_allgather) COLL_sep \
 218 COLL_APPLY(action, COLL_BCAST_SIG, SMP_binary) COLL_sep \
 219 COLL_APPLY(action, COLL_BCAST_SIG, SMP_binomial) COLL_sep \
 220 COLL_APPLY(action, COLL_BCAST_SIG, SMP_linear) COLL_sep \
 221 COLL_APPLY(action, COLL_BCAST_SIG, ompi) COLL_sep \
 222 COLL_APPLY(action, COLL_BCAST_SIG, ompi_split_bintree) COLL_sep \
 223 COLL_APPLY(action, COLL_BCAST_SIG, ompi_pipeline) COLL_sep \
 224 COLL_APPLY(action, COLL_BCAST_SIG, mpich) COLL_sep \
 225 COLL_APPLY(action, COLL_BCAST_SIG, mvapich2)   COLL_sep \
 226 COLL_APPLY(action, COLL_BCAST_SIG, impi)   COLL_sep \
 227 COLL_APPLY(action, COLL_BCAST_SIG, automatic)
 228
 229 COLL_BCASTS(COLL_PROTO, COLL_NOsep)
 230
 231
 232 /**********
 233  * REDUCE *
 234  **********/
 235 #define COLL_REDUCE_SIG reduce, int, \
 236                        (void *buf, void *rbuf, int count, MPI_Datatype datatype, \
 237                         MPI_Op op, int root, MPI_Comm comm)
 238
 239 #define COLL_REDUCES(action, COLL_sep) \
 240 COLL_APPLY(action, COLL_REDUCE_SIG, arrival_pattern_aware) COLL_sep \
 241 COLL_APPLY(action, COLL_REDUCE_SIG, binomial) COLL_sep \
 242 COLL_APPLY(action, COLL_REDUCE_SIG, flat_tree) COLL_sep \
 243 COLL_APPLY(action, COLL_REDUCE_SIG, NTSL) COLL_sep \
 244 COLL_APPLY(action, COLL_REDUCE_SIG, scatter_gather) COLL_sep \
 245 COLL_APPLY(action, COLL_REDUCE_SIG, ompi) COLL_sep \
 246 COLL_APPLY(action, COLL_REDUCE_SIG, ompi_chain) COLL_sep \
 247 COLL_APPLY(action, COLL_REDUCE_SIG, ompi_pipeline) COLL_sep \
 248 COLL_APPLY(action, COLL_REDUCE_SIG, ompi_basic_linear) COLL_sep \
 249 COLL_APPLY(action, COLL_REDUCE_SIG, ompi_in_order_binary) COLL_sep \
 250 COLL_APPLY(action, COLL_REDUCE_SIG, ompi_binary) COLL_sep \
 251 COLL_APPLY(action, COLL_REDUCE_SIG, ompi_binomial) COLL_sep \
 252 COLL_APPLY(action, COLL_REDUCE_SIG, mpich) COLL_sep \
 253 COLL_APPLY(action, COLL_REDUCE_SIG, mvapich2) COLL_sep \
 254 COLL_APPLY(action, COLL_REDUCE_SIG, mvapich2_knomial) COLL_sep \
 255 COLL_APPLY(action, COLL_REDUCE_SIG, impi) COLL_sep \
 256 COLL_APPLY(action, COLL_REDUCE_SIG, rab) COLL_sep \
 257 COLL_APPLY(action, COLL_REDUCE_SIG, automatic)
 258
 259 COLL_REDUCES(COLL_PROTO, COLL_NOsep)
 260
 261 /*************
 262  * REDUCE_SCATTER *
 263  *************/
 264 #define COLL_REDUCE_SCATTER_SIG reduce_scatter, int, \
 265                           (void *sbuf, void *rbuf, int *rcounts,\
 266                     MPI_Datatype dtype,MPI_Op  op,MPI_Comm  comm)
 267
 268 #define COLL_REDUCE_SCATTERS(action, COLL_sep) \
 269 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, ompi) COLL_sep \
 270 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, ompi_basic_recursivehalving) COLL_sep \
 271 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, ompi_ring)  COLL_sep \
 272 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, mpich) COLL_sep \
 273 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, mpich_pair) COLL_sep \
 274 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, mpich_rdb) COLL_sep \
 275 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, mpich_noncomm) COLL_sep \
 276 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, mvapich2) COLL_sep \
 277 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, impi) COLL_sep \
 278 COLL_APPLY(action, COLL_REDUCE_SCATTER_SIG, automatic)
 279
 280
 281
 282 COLL_REDUCE_SCATTERS(COLL_PROTO, COLL_NOsep)
 283
 284
 285 /*************
 286  * SCATTER *
 287  *************/
 288 #define COLL_SCATTER_SIG scatter, int, \
 289                 (void *sendbuf, int sendcount, MPI_Datatype sendtype,\
 290                 void *recvbuf, int recvcount, MPI_Datatype recvtype,\
 291                 int root, MPI_Comm comm)
 292
 293 #define COLL_SCATTERS(action, COLL_sep) \
 294 COLL_APPLY(action, COLL_SCATTER_SIG, ompi) COLL_sep \
 295 COLL_APPLY(action, COLL_SCATTER_SIG, ompi_basic_linear) COLL_sep \
 296 COLL_APPLY(action, COLL_SCATTER_SIG, ompi_binomial)  COLL_sep \
 297 COLL_APPLY(action, COLL_SCATTER_SIG, mpich)   COLL_sep \
 298 COLL_APPLY(action, COLL_SCATTER_SIG, mvapich2)   COLL_sep \
 299 COLL_APPLY(action, COLL_SCATTER_SIG, impi)   COLL_sep \
 300 COLL_APPLY(action, COLL_SCATTER_SIG, automatic)
 301
 302 COLL_SCATTERS(COLL_PROTO, COLL_NOsep)
 303
 304 /*************
 305  * SCATTER *
 306  *************/
 307 #define COLL_BARRIER_SIG barrier, int, \
 308                 (MPI_Comm comm)
 309
 310 #define COLL_BARRIERS(action, COLL_sep) \
 311 COLL_APPLY(action, COLL_BARRIER_SIG, ompi) COLL_sep \
 312 COLL_APPLY(action, COLL_BARRIER_SIG, ompi_basic_linear) COLL_sep \
 313 COLL_APPLY(action, COLL_BARRIER_SIG, ompi_two_procs)  COLL_sep \
 314 COLL_APPLY(action, COLL_BARRIER_SIG, ompi_tree)  COLL_sep \
 315 COLL_APPLY(action, COLL_BARRIER_SIG, ompi_bruck)  COLL_sep \
 316 COLL_APPLY(action, COLL_BARRIER_SIG, ompi_recursivedoubling) COLL_sep \
 317 COLL_APPLY(action, COLL_BARRIER_SIG, ompi_doublering) COLL_sep \
 318 COLL_APPLY(action, COLL_BARRIER_SIG, mpich)   COLL_sep \
 319 COLL_APPLY(action, COLL_BARRIER_SIG, mvapich2_pair)   COLL_sep \
 320 COLL_APPLY(action, COLL_BARRIER_SIG, mvapich2)   COLL_sep \
 321 COLL_APPLY(action, COLL_BARRIER_SIG, impi)   COLL_sep \
 322 COLL_APPLY(action, COLL_BARRIER_SIG, automatic)
 323
 324 COLL_BARRIERS(COLL_PROTO, COLL_NOsep)
 325
 326
 327 #endif