src/smpi/smpi_global.c

   1 /* Copyright (c) 2007-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 #include "private.h"
   8 #include "smpi_mpi_dt_private.h"
   9 #include "mc/mc.h"
  10 #include "xbt/replay.h"
  11 #include "surf/surf.h"
  12 #include "simix/smx_private.h"
  13 #include "simgrid/sg_config.h"
  14
  15 #include <float.h>              /* DBL_MAX */
  16 #include <stdint.h>
  17 #include <stdio.h>
  18 #include <stdlib.h>
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_kernel, smpi,
  21                                 "Logging specific to SMPI (kernel)");
  22
  23 typedef struct s_smpi_process_data {
  24   double simulated;
  25   int *argc;
  26   char ***argv;
  27   smx_rdv_t mailbox;
  28   smx_rdv_t mailbox_small;
  29   xbt_os_timer_t timer;
  30   MPI_Comm comm_self;
  31   void *data;                   /* user data */
  32   int index;
  33   char state;
  34   int sampling;                 /* inside an SMPI_SAMPLE_ block? */
  35 } s_smpi_process_data_t;
  36
  37 static smpi_process_data_t *process_data = NULL;
  38 static int process_count = 0;
  39
  40 MPI_Comm MPI_COMM_WORLD = MPI_COMM_NULL;
  41 int MPI_UNIVERSE_SIZE;
  42
  43 MPI_Errhandler *MPI_ERRORS_RETURN = NULL;
  44 MPI_Errhandler *MPI_ERRORS_ARE_FATAL = NULL;
  45 MPI_Errhandler *MPI_ERRHANDLER_NULL = NULL;
  46
  47 #define MAILBOX_NAME_MAXLEN (5 + sizeof(int) * 2 + 1)
  48
  49 static char *get_mailbox_name(char *str, int index)
  50 {
  51   snprintf(str, MAILBOX_NAME_MAXLEN, "SMPI-%0*x", (int) (sizeof(int) * 2),
  52            index);
  53   return str;
  54 }
  55
  56 static char *get_mailbox_name_small(char *str, int index)
  57 {
  58   snprintf(str, MAILBOX_NAME_MAXLEN, "small%0*x", (int) (sizeof(int) * 2),
  59            index);
  60   return str;
  61 }
  62
  63 void smpi_process_init(int *argc, char ***argv)
  64 {
  65   int index;
  66   smpi_process_data_t data;
  67   smx_process_t proc;
  68
  69   if (argc && argv) {
  70     proc = SIMIX_process_self();
  71     index = atoi((*argv)[1]);
  72 #ifdef SMPI_F2C
  73     smpi_current_rank = index;
  74 #endif
  75     data = smpi_process_remote_data(index);
  76     simcall_process_set_data(proc, data);
  77     if (*argc > 2) {
  78       free((*argv)[1]);
  79       memmove(&(*argv)[1], &(*argv)[2], sizeof(char *) * (*argc - 2));
  80       (*argv)[(*argc) - 1] = NULL;
  81     }
  82     (*argc)--;
  83     data->argc = argc;
  84     data->argv = argv;
  85     // set the process attached to the mailbox
  86     simcall_rdv_set_receiver(data->mailbox_small, proc);
  87     XBT_DEBUG("<%d> New process in the game: %p", index, proc);
  88   }
  89   if (smpi_process_data() == NULL)
  90     xbt_die("smpi_process_data() returned NULL. You probably gave a NULL parameter to MPI_Init. Although it's required by MPI-2, this is currently not supported by SMPI.");
  91 }
  92
  93 void smpi_process_destroy(void)
  94 {
  95   int index = smpi_process_index();
  96   process_data[index]->state = SMPI_FINALIZED;
  97   XBT_DEBUG("<%d> Process left the game", index);
  98 }
  99
 100 /**
 101  * @brief Prepares the current process for termination.
 102  */
 103 void smpi_process_finalize(void)
 104 {
 105 #if 0
 106   // wait for all pending asynchronous comms to finish
 107   while (SIMIX_process_has_pending_comms(SIMIX_process_self())) {
 108     simcall_process_sleep(0.01);
 109   }
 110 #else
 111   int i;
 112   int size = smpi_comm_size(MPI_COMM_WORLD);
 113   int rank = smpi_comm_rank(MPI_COMM_WORLD);
 114   /* All non-root send & receive zero-length message. */
 115   if (rank > 0) {
 116     smpi_mpi_ssend (NULL, 0, MPI_BYTE, 0,
 117                     COLL_TAG_BARRIER,
 118                     MPI_COMM_WORLD);
 119     smpi_mpi_recv (NULL, 0, MPI_BYTE, 0,
 120                     COLL_TAG_BARRIER,
 121                     MPI_COMM_WORLD, MPI_STATUS_IGNORE);
 122   }
 123   /* The root collects and broadcasts the messages. */
 124   else {
 125     MPI_Request* requests;
 126     requests = (MPI_Request*)malloc( size * sizeof(MPI_Request) );
 127     for (i = 1; i < size; ++i) {
 128       requests[i] = smpi_mpi_irecv(NULL, 0, MPI_BYTE, MPI_ANY_SOURCE,
 129                                    COLL_TAG_BARRIER, MPI_COMM_WORLD
 130                                    );
 131     }
 132     smpi_mpi_waitall( size-1, requests+1, MPI_STATUSES_IGNORE );
 133     for (i = 1; i < size; ++i) {
 134       requests[i] = smpi_mpi_issend(NULL, 0, MPI_BYTE, i,
 135                                    COLL_TAG_BARRIER,
 136                                    MPI_COMM_WORLD
 137                                    );
 138     }
 139     smpi_mpi_waitall( size-1, requests+1, MPI_STATUSES_IGNORE );
 140     free( requests );
 141   }
 142 #endif
 143 }
 144
 145 /**
 146  * @brief Check if a process is finalized
 147  */
 148 int smpi_process_finalized()
 149 {
 150   int index = smpi_process_index();
 151     if (index != MPI_UNDEFINED)
 152       return (process_data[index]->state == SMPI_FINALIZED);
 153     else
 154       return 0;
 155 }
 156
 157 /**
 158  * @brief Check if a process is initialized
 159  */
 160 int smpi_process_initialized(void)
 161 {
 162   int index = smpi_process_index();
 163   return ( (index != MPI_UNDEFINED)
 164           && (process_data[index]->state == SMPI_INITIALIZED));
 165 }
 166
 167 /**
 168  * @brief Mark a process as initialized (=MPI_Init called)
 169  */
 170 void smpi_process_mark_as_initialized(void)
 171 {
 172   int index = smpi_process_index();
 173   if ((index != MPI_UNDEFINED) && (!process_data[index]->state != SMPI_FINALIZED))
 174     process_data[index]->state = SMPI_INITIALIZED;
 175 }
 176
 177
 178 #ifdef SMPI_F2C
 179 int smpi_process_argc(void)
 180 {
 181   smpi_process_data_t data = smpi_process_data();
 182   return data->argc ? *(data->argc) - 1 : 0;
 183 }
 184
 185 int smpi_process_getarg(integer * index, char *dst, ftnlen len)
 186 {
 187   smpi_process_data_t data = smpi_process_data();
 188   char *arg;
 189   ftnlen i;
 190
 191   if (!data->argc || !data->argv || *index < 1 || *index >= *(data->argc)) {
 192     return -1;
 193   }
 194   arg = (*data->argv)[*index];
 195   for (i = 0; i < len && arg[i] != '\0'; i++) {
 196     dst[i] = arg[i];
 197   }
 198   for (; i < len; i++) {
 199     dst[i] = ' ';
 200   }
 201   return 0;
 202 }
 203 #endif
 204
 205 int smpi_global_size(void)
 206 {
 207   char *value = getenv("SMPI_GLOBAL_SIZE");
 208
 209   if (!value) {
 210     fprintf(stderr,
 211             "Please set env var SMPI_GLOBAL_SIZE to expected number of processes.\n");
 212     xbt_abort();
 213   }
 214   return atoi(value);
 215 }
 216
 217 smpi_process_data_t smpi_process_data(void)
 218 {
 219   return SIMIX_process_self_get_data(SIMIX_process_self());
 220 }
 221
 222 smpi_process_data_t smpi_process_remote_data(int index)
 223 {
 224   return process_data[index];
 225 }
 226
 227 void smpi_process_set_user_data(void *data)
 228 {
 229   smpi_process_data_t process_data = smpi_process_data();
 230   process_data->data = data;
 231 }
 232
 233 void *smpi_process_get_user_data()
 234 {
 235   smpi_process_data_t process_data = smpi_process_data();
 236   return process_data->data;
 237 }
 238
 239 int smpi_process_count(void)
 240 {
 241   return process_count;
 242 }
 243
 244 int smpi_process_index(void)
 245 {
 246   smpi_process_data_t data = smpi_process_data();
 247   //return -1 if not initialized
 248   return data ? data->index : MPI_UNDEFINED;
 249 }
 250
 251 smx_rdv_t smpi_process_mailbox(void)
 252 {
 253   smpi_process_data_t data = smpi_process_data();
 254   return data->mailbox;
 255 }
 256
 257 smx_rdv_t smpi_process_mailbox_small(void)
 258 {
 259   smpi_process_data_t data = smpi_process_data();
 260   return data->mailbox_small;
 261 }
 262
 263 smx_rdv_t smpi_process_remote_mailbox(int index)
 264 {
 265   smpi_process_data_t data = smpi_process_remote_data(index);
 266   return data->mailbox;
 267 }
 268
 269
 270 smx_rdv_t smpi_process_remote_mailbox_small(int index)
 271 {
 272   smpi_process_data_t data = smpi_process_remote_data(index);
 273   return data->mailbox_small;
 274 }
 275
 276 xbt_os_timer_t smpi_process_timer(void)
 277 {
 278   smpi_process_data_t data = smpi_process_data();
 279   return data->timer;
 280 }
 281
 282 void smpi_process_simulated_start(void)
 283 {
 284   smpi_process_data_t data = smpi_process_data();
 285   data->simulated = SIMIX_get_clock();
 286 }
 287
 288 double smpi_process_simulated_elapsed(void)
 289 {
 290   smpi_process_data_t data = smpi_process_data();
 291   return SIMIX_get_clock() - data->simulated;
 292 }
 293
 294 MPI_Comm smpi_process_comm_self(void)
 295 {
 296   smpi_process_data_t data = smpi_process_data();
 297   if(data->comm_self==MPI_COMM_NULL){
 298     MPI_Group group = smpi_group_new(1);
 299     data->comm_self = smpi_comm_new(group);
 300     smpi_group_set_mapping(group, smpi_process_index(), 0);
 301   }
 302
 303   return data->comm_self;
 304 }
 305
 306 void smpi_process_set_sampling(int s)
 307 {
 308   smpi_process_data_t data = smpi_process_data();
 309   data->sampling = s;
 310 }
 311
 312 int smpi_process_get_sampling(void)
 313 {
 314   smpi_process_data_t data = smpi_process_data();
 315   return data->sampling;
 316 }
 317
 318 void print_request(const char *message, MPI_Request request)
 319 {
 320   XBT_DEBUG
 321       ("%s  request %p  [buf = %p, size = %zu, src = %d, dst = %d, tag = %d, flags = %x]",
 322        message, request, request->buf, request->size, request->src,
 323        request->dst, request->tag, request->flags);
 324 }
 325
 326 static void smpi_comm_copy_buffer_callback(smx_action_t comm,
 327                                            void *buff, size_t buff_size)
 328 {
 329   XBT_DEBUG("Copy the data over");
 330   if(_xbt_replay_is_active()) return;
 331   memcpy(comm->comm.dst_buff, buff, buff_size);
 332   if (comm->comm.detached) {
 333     // if this is a detached send, the source buffer was duplicated by SMPI
 334     // sender to make the original buffer available to the application ASAP
 335     xbt_free(buff);
 336     //It seems that the request is used after the call there this should
 337     //be free somewhereelse  but where???
 338     //xbt_free(comm->comm.src_data);// inside SMPI the request is keep
 339     //inside the user data and should be free
 340     comm->comm.src_buff = NULL;
 341   }
 342 }
 343
 344 void smpi_global_init(void)
 345 {
 346   int i;
 347   MPI_Group group;
 348   char name[MAILBOX_NAME_MAXLEN];
 349
 350   SIMIX_comm_set_copy_data_callback(&smpi_comm_copy_buffer_callback);
 351   process_count = SIMIX_process_count();
 352   process_data = xbt_new(smpi_process_data_t, process_count);
 353   for (i = 0; i < process_count; i++) {
 354     process_data[i] = xbt_new(s_smpi_process_data_t, 1);
 355     process_data[i]->index = i;
 356     process_data[i]->argc = NULL;
 357     process_data[i]->argv = NULL;
 358     process_data[i]->mailbox = simcall_rdv_create(get_mailbox_name(name, i));
 359     process_data[i]->mailbox_small =
 360         simcall_rdv_create(get_mailbox_name_small(name, i));
 361     process_data[i]->timer = xbt_os_timer_new();
 362     if (MC_is_active())
 363       MC_ignore_heap(process_data[i]->timer, xbt_os_timer_size());
 364     process_data[i]->comm_self = MPI_COMM_NULL;
 365     process_data[i]->state = SMPI_UNINITIALIZED;
 366     process_data[i]->sampling = 0;
 367   }
 368   group = smpi_group_new(process_count);
 369   MPI_COMM_WORLD = smpi_comm_new(group);
 370   MPI_UNIVERSE_SIZE = smpi_comm_size(MPI_COMM_WORLD);
 371   for (i = 0; i < process_count; i++) {
 372     smpi_group_set_mapping(group, i, i);
 373   }
 374
 375   //check correctness of MPI parameters
 376
 377   xbt_assert(sg_cfg_get_int("smpi/async_small_thres") <=
 378              sg_cfg_get_int("smpi/send_is_detached_thres"));
 379
 380   if (sg_cfg_is_default_value("smpi/running_power")) {
 381     XBT_INFO("You did not set the power of the host running the simulation.  "
 382              "The timings will certainly not be accurate.  "
 383              "Use the option \"--cfg=smpi/running_power:<flops>\" to set its value."
 384              "Check http://simgrid.org/simgrid/latest/doc/options.html#options_smpi_bench for more information. ");
 385   }
 386 }
 387
 388 void smpi_global_destroy(void)
 389 {
 390   int count = smpi_process_count();
 391   int i;
 392
 393   smpi_bench_destroy();
 394   while (smpi_group_unuse(smpi_comm_group(MPI_COMM_WORLD)) > 0);
 395   xbt_free(MPI_COMM_WORLD);
 396   MPI_COMM_WORLD = MPI_COMM_NULL;
 397   for (i = 0; i < count; i++) {
 398     if(process_data[i]->comm_self!=MPI_COMM_NULL){
 399       smpi_group_unuse(smpi_comm_group(process_data[i]->comm_self));
 400       smpi_comm_destroy(process_data[i]->comm_self);
 401     }
 402     xbt_os_timer_free(process_data[i]->timer);
 403     simcall_rdv_destroy(process_data[i]->mailbox);
 404     simcall_rdv_destroy(process_data[i]->mailbox_small);
 405     xbt_free(process_data[i]);
 406   }
 407   xbt_free(process_data);
 408   process_data = NULL;
 409
 410   smpi_free_static();
 411 }
 412
 413 /* Fortran specific stuff */
 414 /* With smpicc, the following weak symbols are used */
 415 /* With smpiff, the following weak symbols are replaced by those in libf2c */
 416 int __attribute__ ((weak)) xargc;
 417 char ** __attribute__ ((weak)) xargv;
 418
 419 #ifndef WIN32
 420 void __attribute__ ((weak)) user_main_()
 421 {
 422   xbt_die("Should not be in this smpi_simulated_main");
 423   return;
 424 }
 425
 426 int __attribute__ ((weak)) smpi_simulated_main_(int argc, char **argv)
 427 {
 428   smpi_process_init(&argc, &argv);
 429   user_main_();
 430   return 0;
 431 }
 432
 433 int __attribute__ ((weak)) main(int argc, char **argv)
 434 {
 435   return smpi_main(smpi_simulated_main_, argc, argv);
 436 }
 437
 438 int __attribute__ ((weak)) MAIN__()
 439 {
 440   return smpi_main(smpi_simulated_main_, xargc, xargv);
 441 };
 442 #endif
 443
 444 int smpi_main(int (*realmain) (int argc, char *argv[]), int argc, char *argv[])
 445 {
 446   srand(SMPI_RAND_SEED);
 447
 448   if (getenv("SMPI_PRETEND_CC") != NULL) {
 449     /* Hack to ensure that smpicc can pretend to be a simple
 450      * compiler. Particularly handy to pass it to the configuration tools */
 451     return 0;
 452   }
 453
 454   /* Connect log categories.  See xbt/log.c */
 455   XBT_LOG_CONNECT(smpi);        /* Keep this line as soon as possible in this
 456                                    function: xbt_log_appender_file.c depends on it
 457                                    DO NOT connect this in XBT or so, or it will be
 458                                    useless to xbt_log_appender_file.c */
 459 #ifdef HAVE_TRACING
 460   XBT_LOG_CONNECT(instr_smpi);
 461 #endif
 462   XBT_LOG_CONNECT(smpi_base);
 463   XBT_LOG_CONNECT(smpi_bench);
 464   XBT_LOG_CONNECT(smpi_coll);
 465   XBT_LOG_CONNECT(smpi_colls);
 466   XBT_LOG_CONNECT(smpi_comm);
 467   XBT_LOG_CONNECT(smpi_dvfs);
 468   XBT_LOG_CONNECT(smpi_group);
 469   XBT_LOG_CONNECT(smpi_kernel);
 470   XBT_LOG_CONNECT(smpi_mpi);
 471   XBT_LOG_CONNECT(smpi_mpi_dt);
 472   XBT_LOG_CONNECT(smpi_pmpi);
 473   XBT_LOG_CONNECT(smpi_replay);
 474
 475 #ifdef HAVE_TRACING
 476   TRACE_global_init(&argc, argv);
 477
 478   TRACE_add_start_function(TRACE_smpi_alloc);
 479   TRACE_add_end_function(TRACE_smpi_release);
 480 #endif
 481
 482   SIMIX_global_init(&argc, argv);
 483
 484 #ifdef HAVE_TRACING
 485   TRACE_start();
 486 #endif
 487
 488   // parse the platform file: get the host list
 489   SIMIX_create_environment(argv[1]);
 490
 491   SIMIX_function_register_default(realmain);
 492   SIMIX_launch_application(argv[2]);
 493
 494   int gather_id = find_coll_description(mpi_coll_gather_description,
 495                                         sg_cfg_get_string("smpi/gather"));
 496   mpi_coll_gather_fun = (int (*)(void *, int, MPI_Datatype,
 497                                  void *, int, MPI_Datatype, int, MPI_Comm))
 498       mpi_coll_gather_description[gather_id].coll;
 499
 500   int allgather_id = find_coll_description(mpi_coll_allgather_description,
 501                                            sg_cfg_get_string("smpi/allgather"));
 502   mpi_coll_allgather_fun = (int (*)(void *, int, MPI_Datatype,
 503                                     void *, int, MPI_Datatype, MPI_Comm))
 504       mpi_coll_allgather_description[allgather_id].coll;
 505
 506   int allgatherv_id = find_coll_description(mpi_coll_allgatherv_description,
 507                                             sg_cfg_get_string("smpi/allgatherv"));
 508   mpi_coll_allgatherv_fun = (int (*)(void *, int, MPI_Datatype, void *, int *,
 509                                      int *, MPI_Datatype, MPI_Comm))
 510       mpi_coll_allgatherv_description[allgatherv_id].coll;
 511
 512   int allreduce_id = find_coll_description(mpi_coll_allreduce_description,
 513                                            sg_cfg_get_string("smpi/allreduce"));
 514   mpi_coll_allreduce_fun = (int (*)(void *sbuf, void *rbuf, int rcount,
 515                                     MPI_Datatype dtype, MPI_Op op,
 516                                     MPI_Comm comm))
 517       mpi_coll_allreduce_description[allreduce_id].coll;
 518
 519   int alltoall_id = find_coll_description(mpi_coll_alltoall_description,
 520                                           sg_cfg_get_string("smpi/alltoall"));
 521   mpi_coll_alltoall_fun = (int (*)(void *, int, MPI_Datatype,
 522                                    void *, int, MPI_Datatype, MPI_Comm))
 523       mpi_coll_alltoall_description[alltoall_id].coll;
 524
 525   int alltoallv_id = find_coll_description(mpi_coll_alltoallv_description,
 526                                            sg_cfg_get_string("smpi/alltoallv"));
 527   mpi_coll_alltoallv_fun = (int (*)(void *, int *, int *, MPI_Datatype,
 528                                     void *, int *, int *, MPI_Datatype,
 529                                     MPI_Comm))
 530       mpi_coll_alltoallv_description[alltoallv_id].coll;
 531
 532   int bcast_id = find_coll_description(mpi_coll_bcast_description,
 533                                        sg_cfg_get_string("smpi/bcast"));
 534   mpi_coll_bcast_fun = (int (*)(void *buf, int count, MPI_Datatype datatype,
 535                                 int root, MPI_Comm com))
 536       mpi_coll_bcast_description[bcast_id].coll;
 537
 538   int reduce_id = find_coll_description(mpi_coll_reduce_description,
 539                                         sg_cfg_get_string("smpi/reduce"));
 540   mpi_coll_reduce_fun = (int (*)(void *buf, void *rbuf, int count,
 541                                  MPI_Datatype datatype, MPI_Op op,
 542                                  int root, MPI_Comm comm))
 543       mpi_coll_reduce_description[reduce_id].coll;
 544
 545   int reduce_scatter_id =
 546       find_coll_description(mpi_coll_reduce_scatter_description,
 547                             sg_cfg_get_string("smpi/reduce_scatter"));
 548   mpi_coll_reduce_scatter_fun = (int (*)(void *sbuf, void *rbuf, int *rcounts,
 549                                          MPI_Datatype dtype, MPI_Op op,
 550                                          MPI_Comm comm))
 551       mpi_coll_reduce_scatter_description[reduce_scatter_id].coll;
 552
 553   int scatter_id = find_coll_description(mpi_coll_scatter_description,
 554                                          sg_cfg_get_string("smpi/scatter"));
 555   mpi_coll_scatter_fun = (int (*)(void *sendbuf, int sendcount,
 556                                   MPI_Datatype sendtype, void *recvbuf,
 557                                   int recvcount, MPI_Datatype recvtype,
 558                                   int root, MPI_Comm comm))
 559       mpi_coll_scatter_description[scatter_id].coll;
 560
 561   int barrier_id = find_coll_description(mpi_coll_barrier_description,
 562                                          sg_cfg_get_string("smpi/barrier"));
 563   mpi_coll_barrier_fun = (int (*)(MPI_Comm comm))
 564       mpi_coll_barrier_description[barrier_id].coll;
 565
 566   smpi_cpu_threshold = sg_cfg_get_double("smpi/cpu_threshold");
 567   smpi_running_power = sg_cfg_get_double("smpi/running_power");
 568   if (smpi_cpu_threshold < 0)
 569     smpi_cpu_threshold = DBL_MAX;
 570
 571   smpi_global_init();
 572
 573   /* Clean IO before the run */
 574   fflush(stdout);
 575   fflush(stderr);
 576
 577   if (MC_is_active())
 578     MC_do_the_modelcheck_for_real();
 579   else
 580     SIMIX_run();
 581
 582   if (sg_cfg_get_boolean("smpi/display_timing"))
 583     XBT_INFO("Simulation time: %g seconds.", SIMIX_get_clock());
 584
 585   smpi_global_destroy();
 586
 587 #ifdef HAVE_TRACING
 588   TRACE_end();
 589 #endif
 590
 591   return 0;
 592 }