src/smpi/smpi_global.cpp

   1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "mc/mc.h"
   7 #include "private.h"
   8 #include "private.hpp"
   9 #include "simgrid/s4u/Mailbox.hpp"
  10 #include "simgrid/sg_config.h"
  11 #include "src/kernel/activity/SynchroComm.hpp"
  12 #include "src/mc/mc_record.h"
  13 #include "src/mc/mc_replay.h"
  14 #include "src/msg/msg_private.h"
  15 #include "src/simix/smx_private.h"
  16 #include "surf/surf.h"
  17 #include "xbt/replay.hpp"
  18 #include <xbt/config.hpp>
  19
  20 #include <float.h> /* DBL_MAX */
  21 #include <fstream>
  22 #include <map>
  23 #include <stdint.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string>
  27 #include <vector>
  28
  29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_kernel, smpi, "Logging specific to SMPI (kernel)");
  30 #include <boost/tokenizer.hpp>
  31 #include <boost/algorithm/string.hpp> /* trim_right / trim_left */
  32
  33 #if HAVE_PAPI
  34 #include "papi.h"
  35 const char* papi_default_config_name = "default";
  36
  37 struct papi_process_data {
  38   papi_counter_t counter_data;
  39   int event_set;
  40 };
  41
  42 #endif
  43 std::unordered_map<std::string, double> location2speedup;
  44
  45 simgrid::smpi::Process **process_data = nullptr;
  46 int process_count = 0;
  47 int smpi_universe_size = 0;
  48 int* index_to_process_data = nullptr;
  49 extern double smpi_total_benched_time;
  50 xbt_os_timer_t global_timer;
  51 MPI_Comm MPI_COMM_WORLD = MPI_COMM_UNINITIALIZED;
  52 MPI_Errhandler *MPI_ERRORS_RETURN = nullptr;
  53 MPI_Errhandler *MPI_ERRORS_ARE_FATAL = nullptr;
  54 MPI_Errhandler *MPI_ERRHANDLER_NULL = nullptr;
  55 static simgrid::config::Flag<double> smpi_wtime_sleep(
  56   "smpi/wtime", "Minimum time to inject inside a call to MPI_Wtime", 0.0);
  57 static simgrid::config::Flag<double> smpi_init_sleep(
  58   "smpi/init", "Time to inject inside a call to MPI_Init", 0.0);
  59
  60 void (*smpi_comm_copy_data_callback) (smx_activity_t, void*, size_t) = &smpi_comm_copy_buffer_callback;
  61
  62
  63
  64 int smpi_process_count()
  65 {
  66   return process_count;
  67 }
  68
  69 simgrid::smpi::Process* smpi_process()
  70 {
  71   simgrid::MsgActorExt* msgExt = static_cast<simgrid::MsgActorExt*>(SIMIX_process_self()->data);
  72   return static_cast<simgrid::smpi::Process*>(msgExt->data);
  73 }
  74
  75 simgrid::smpi::Process* smpi_process_remote(int index)
  76 {
  77   return process_data[index_to_process_data[index]];
  78 }
  79
  80 MPI_Comm smpi_process_comm_self(){
  81   return smpi_process()->comm_self();
  82 }
  83
  84 void smpi_process_init(int *argc, char ***argv){
  85   simgrid::smpi::Process::init(argc, argv);
  86 }
  87
  88 int smpi_process_index(){
  89   return smpi_process()->index();
  90 }
  91
  92
  93 int smpi_global_size()
  94 {
  95   char *value = getenv("SMPI_GLOBAL_SIZE");
  96   xbt_assert(value,"Please set env var SMPI_GLOBAL_SIZE to the expected number of processes.");
  97
  98   return xbt_str_parse_int(value, "SMPI_GLOBAL_SIZE contains a non-numerical value: %s");
  99 }
 100
 101 void smpi_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t))
 102 {
 103   smpi_comm_copy_data_callback = callback;
 104 }
 105
 106 void smpi_comm_copy_buffer_callback(smx_activity_t synchro, void *buff, size_t buff_size)
 107 {
 108   XBT_DEBUG("Copy the data over");
 109   void* tmpbuff=buff;
 110   simgrid::kernel::activity::Comm *comm = dynamic_cast<simgrid::kernel::activity::Comm*>(synchro);
 111
 112   if((smpi_privatize_global_variables) && (static_cast<char*>(buff) >= smpi_start_data_exe)
 113       && (static_cast<char*>(buff) < smpi_start_data_exe + smpi_size_data_exe )
 114     ){
 115        XBT_DEBUG("Privatization : We are copying from a zone inside global memory... Saving data to temp buffer !");
 116
 117        smpi_switch_data_segment(
 118            (static_cast<simgrid::smpi::Process*>((static_cast<simgrid::MsgActorExt*>(comm->src_proc->data)->data))->index()));
 119        tmpbuff = static_cast<void*>(xbt_malloc(buff_size));
 120        memcpy(tmpbuff, buff, buff_size);
 121   }
 122
 123   if((smpi_privatize_global_variables) && ((char*)comm->dst_buff >= smpi_start_data_exe)
 124       && ((char*)comm->dst_buff < smpi_start_data_exe + smpi_size_data_exe )){
 125        XBT_DEBUG("Privatization : We are copying to a zone inside global memory - Switch data segment");
 126        smpi_switch_data_segment(
 127            (static_cast<simgrid::smpi::Process*>((static_cast<simgrid::MsgActorExt*>(comm->dst_proc->data)->data))->index()));
 128   }
 129
 130   XBT_DEBUG("Copying %zu bytes from %p to %p", buff_size, tmpbuff,comm->dst_buff);
 131   memcpy(comm->dst_buff, tmpbuff, buff_size);
 132   if (comm->detached) {
 133     // if this is a detached send, the source buffer was duplicated by SMPI
 134     // sender to make the original buffer available to the application ASAP
 135     xbt_free(buff);
 136     //It seems that the request is used after the call there this should be free somewhere else but where???
 137     //xbt_free(comm->comm.src_data);// inside SMPI the request is kept inside the user data and should be free
 138     comm->src_buff = nullptr;
 139   }
 140
 141   if(tmpbuff!=buff)xbt_free(tmpbuff);
 142 }
 143
 144 void smpi_comm_null_copy_buffer_callback(smx_activity_t comm, void *buff, size_t buff_size)
 145 {
 146   /* nothing done in this version */
 147 }
 148
 149 static void smpi_check_options(){
 150   //check correctness of MPI parameters
 151
 152    xbt_assert(xbt_cfg_get_int("smpi/async-small-thresh") <= xbt_cfg_get_int("smpi/send-is-detached-thresh"));
 153
 154    if (xbt_cfg_is_default_value("smpi/host-speed")) {
 155      XBT_INFO("You did not set the power of the host running the simulation.  "
 156               "The timings will certainly not be accurate.  "
 157               "Use the option \"--cfg=smpi/host-speed:<flops>\" to set its value."
 158               "Check http://simgrid.org/simgrid/latest/doc/options.html#options_smpi_bench for more information.");
 159    }
 160
 161    xbt_assert(xbt_cfg_get_double("smpi/cpu-threshold") >=0,
 162        "The 'smpi/cpu-threshold' option cannot have negative values [anymore]. If you want to discard "
 163        "the simulation of any computation, please use 'smpi/simulate-computation:no' instead.");
 164 }
 165
 166 int smpi_enabled() {
 167   return process_data != nullptr;
 168 }
 169
 170 void smpi_global_init()
 171 {
 172   int i;
 173   MPI_Group group;
 174   int smpirun=0;
 175
 176   if (!MC_is_active()) {
 177     global_timer = xbt_os_timer_new();
 178     xbt_os_walltimer_start(global_timer);
 179   }
 180
 181   if (xbt_cfg_get_string("smpi/comp-adjustment-file")[0] != '\0') {
 182     std::string filename {xbt_cfg_get_string("smpi/comp-adjustment-file")};
 183     std::ifstream fstream(filename);
 184     if (!fstream.is_open()) {
 185       xbt_die("Could not open file %s. Does it exist?", filename.c_str());
 186     }
 187
 188     std::string line;
 189     typedef boost::tokenizer< boost::escaped_list_separator<char>> Tokenizer;
 190     std::getline(fstream, line); // Skip the header line
 191     while (std::getline(fstream, line)) {
 192       Tokenizer tok(line);
 193       Tokenizer::iterator it  = tok.begin();
 194       Tokenizer::iterator end = std::next(tok.begin());
 195
 196       std::string location = *it;
 197       boost::trim(location);
 198       location2speedup.insert(std::pair<std::string, double>(location, std::stod(*end)));
 199     }
 200   }
 201
 202 #if HAVE_PAPI
 203   // This map holds for each computation unit (such as "default" or "process1" etc.)
 204   // the configuration as given by the user (counter data as a pair of (counter_name, counter_counter))
 205   // and the (computed) event_set.
 206   std::map</* computation unit name */ std::string, papi_process_data> units2papi_setup;
 207
 208   if (xbt_cfg_get_string("smpi/papi-events")[0] != '\0') {
 209     if (PAPI_library_init(PAPI_VER_CURRENT) != PAPI_VER_CURRENT)
 210       XBT_ERROR("Could not initialize PAPI library; is it correctly installed and linked?"
 211                 " Expected version is %i",
 212                 PAPI_VER_CURRENT);
 213
 214     typedef boost::tokenizer<boost::char_separator<char>> Tokenizer;
 215     boost::char_separator<char> separator_units(";");
 216     std::string str = std::string(xbt_cfg_get_string("smpi/papi-events"));
 217     Tokenizer tokens(str, separator_units);
 218
 219     // Iterate over all the computational units. This could be
 220     // processes, hosts, threads, ranks... You name it. I'm not exactly
 221     // sure what we will support eventually, so I'll leave it at the
 222     // general term "units".
 223     for (auto& unit_it : tokens) {
 224       boost::char_separator<char> separator_events(":");
 225       Tokenizer event_tokens(unit_it, separator_events);
 226
 227       int event_set = PAPI_NULL;
 228       if (PAPI_create_eventset(&event_set) != PAPI_OK) {
 229         // TODO: Should this let the whole simulation die?
 230         XBT_CRITICAL("Could not create PAPI event set during init.");
 231       }
 232
 233       // NOTE: We cannot use a map here, as we must obey the order of the counters
 234       // This is important for PAPI: We need to map the values of counters back
 235       // to the event_names (so, when PAPI_read() has finished)!
 236       papi_counter_t counters2values;
 237
 238       // Iterate over all counters that were specified for this specific
 239       // unit.
 240       // Note that we need to remove the name of the unit
 241       // (that could also be the "default" value), which always comes first.
 242       // Hence, we start at ++(events.begin())!
 243       for (Tokenizer::iterator events_it = ++(event_tokens.begin()); events_it != event_tokens.end(); events_it++) {
 244
 245         int event_code   = PAPI_NULL;
 246         char* event_name = const_cast<char*>((*events_it).c_str());
 247         if (PAPI_event_name_to_code(event_name, &event_code) == PAPI_OK) {
 248           if (PAPI_add_event(event_set, event_code) != PAPI_OK) {
 249             XBT_ERROR("Could not add PAPI event '%s'. Skipping.", event_name);
 250             continue;
 251           } else {
 252             XBT_DEBUG("Successfully added PAPI event '%s' to the event set.", event_name);
 253           }
 254         } else {
 255           XBT_CRITICAL("Could not find PAPI event '%s'. Skipping.", event_name);
 256           continue;
 257         }
 258
 259         counters2values.push_back(
 260             // We cannot just pass *events_it, as this is of type const basic_string
 261             std::make_pair<std::string, long long>(std::string(*events_it), 0));
 262       }
 263
 264       std::string unit_name    = *(event_tokens.begin());
 265       papi_process_data config = {.counter_data = std::move(counters2values), .event_set = event_set};
 266
 267       units2papi_setup.insert(std::make_pair(unit_name, std::move(config)));
 268     }
 269   }
 270 #endif
 271   if (process_count == 0){
 272     process_count = SIMIX_process_count();
 273     smpirun=1;
 274   }
 275   smpi_universe_size = process_count;
 276   process_data       = new simgrid::smpi::Process*[process_count];
 277   for (i = 0; i < process_count; i++) {
 278     process_data[i]                       = new simgrid::smpi::Process(i);
 279   }
 280   //if the process was launched through smpirun script we generate a global mpi_comm_world
 281   //if not, we let MPI_COMM_NULL, and the comm world will be private to each mpi instance
 282   if(smpirun){
 283     group = new  simgrid::smpi::Group(process_count);
 284     MPI_COMM_WORLD = new  simgrid::smpi::Comm(group, nullptr);
 285     MPI_Attr_put(MPI_COMM_WORLD, MPI_UNIVERSE_SIZE, reinterpret_cast<void *>(process_count));
 286     msg_bar_t bar = MSG_barrier_init(process_count);
 287
 288     for (i = 0; i < process_count; i++) {
 289       group->set_mapping(i, i);
 290       process_data[i]->set_finalization_barrier(bar);
 291     }
 292   }
 293 }
 294
 295 void smpi_global_destroy()
 296 {
 297   int count = smpi_process_count();
 298
 299   smpi_bench_destroy();
 300   if (MPI_COMM_WORLD != MPI_COMM_UNINITIALIZED){
 301       delete MPI_COMM_WORLD->group();
 302       MSG_barrier_destroy(process_data[0]->finalization_barrier());
 303   }else{
 304       smpi_deployment_cleanup_instances();
 305   }
 306   for (int i = 0; i < count; i++) {
 307     if(process_data[i]->comm_self()!=MPI_COMM_NULL){
 308       simgrid::smpi::Comm::destroy(process_data[i]->comm_self());
 309     }
 310     if(process_data[i]->comm_intra()!=MPI_COMM_NULL){
 311       simgrid::smpi::Comm::destroy(process_data[i]->comm_intra());
 312     }
 313     xbt_os_timer_free(process_data[i]->timer());
 314     xbt_mutex_destroy(process_data[i]->mailboxes_mutex());
 315     delete process_data[i];
 316   }
 317   delete[] process_data;
 318   process_data = nullptr;
 319
 320   if (MPI_COMM_WORLD != MPI_COMM_UNINITIALIZED){
 321     MPI_COMM_WORLD->cleanup_smp();
 322     MPI_COMM_WORLD->cleanup_attr<simgrid::smpi::Comm>();
 323     if(simgrid::smpi::Colls::smpi_coll_cleanup_callback!=nullptr)
 324       simgrid::smpi::Colls::smpi_coll_cleanup_callback();
 325     delete MPI_COMM_WORLD;
 326   }
 327
 328   MPI_COMM_WORLD = MPI_COMM_NULL;
 329
 330   if (!MC_is_active()) {
 331     xbt_os_timer_free(global_timer);
 332   }
 333
 334   xbt_free(index_to_process_data);
 335   if(smpi_privatize_global_variables)
 336     smpi_destroy_global_memory_segments();
 337   smpi_free_static();
 338 }
 339
 340 extern "C" {
 341
 342 #ifndef WIN32
 343
 344 void __attribute__ ((weak)) user_main_()
 345 {
 346   xbt_die("Should not be in this smpi_simulated_main");
 347 }
 348
 349 int __attribute__ ((weak)) smpi_simulated_main_(int argc, char **argv)
 350 {
 351   simgrid::smpi::Process::init(&argc, &argv);
 352   user_main_();
 353   return 0;
 354 }
 355
 356 inline static int smpi_main_wrapper(int argc, char **argv){
 357   int ret = smpi_simulated_main_(argc,argv);
 358   if(ret !=0){
 359     XBT_WARN("SMPI process did not return 0. Return value : %d", ret);
 360     smpi_process()->set_return_value(ret);
 361   }
 362   return 0;
 363 }
 364
 365 int __attribute__ ((weak)) main(int argc, char **argv)
 366 {
 367   return smpi_main(smpi_main_wrapper, argc, argv);
 368 }
 369
 370 #endif
 371
 372 static void smpi_init_logs(){
 373
 374   /* Connect log categories.  See xbt/log.c */
 375
 376   XBT_LOG_CONNECT(smpi);  /* Keep this line as soon as possible in this function: xbt_log_appender_file.c depends on it
 377                              DO NOT connect this in XBT or so, or it will be useless to xbt_log_appender_file.c */
 378   XBT_LOG_CONNECT(instr_smpi);
 379   XBT_LOG_CONNECT(smpi_bench);
 380   XBT_LOG_CONNECT(smpi_coll);
 381   XBT_LOG_CONNECT(smpi_colls);
 382   XBT_LOG_CONNECT(smpi_comm);
 383   XBT_LOG_CONNECT(smpi_datatype);
 384   XBT_LOG_CONNECT(smpi_dvfs);
 385   XBT_LOG_CONNECT(smpi_group);
 386   XBT_LOG_CONNECT(smpi_kernel);
 387   XBT_LOG_CONNECT(smpi_mpi);
 388   XBT_LOG_CONNECT(smpi_memory);
 389   XBT_LOG_CONNECT(smpi_op);
 390   XBT_LOG_CONNECT(smpi_pmpi);
 391   XBT_LOG_CONNECT(smpi_request);
 392   XBT_LOG_CONNECT(smpi_replay);
 393   XBT_LOG_CONNECT(smpi_rma);
 394   XBT_LOG_CONNECT(smpi_utils);
 395 }
 396 }
 397
 398 static void smpi_init_options(){
 399
 400     simgrid::smpi::Colls::set_collectives();
 401     simgrid::smpi::Colls::smpi_coll_cleanup_callback=nullptr;
 402     smpi_cpu_threshold = xbt_cfg_get_double("smpi/cpu-threshold");
 403     smpi_host_speed = xbt_cfg_get_double("smpi/host-speed");
 404     smpi_privatize_global_variables = xbt_cfg_get_boolean("smpi/privatize-global-variables");
 405     if (smpi_cpu_threshold < 0)
 406       smpi_cpu_threshold = DBL_MAX;
 407
 408     char* val = xbt_cfg_get_string("smpi/shared-malloc");
 409     if (!strcasecmp(val, "yes") || !strcmp(val, "1") || !strcasecmp(val, "on") || !strcasecmp(val, "global")) {
 410       smpi_cfg_shared_malloc = shmalloc_global;
 411     } else if (!strcasecmp(val, "local")) {
 412       smpi_cfg_shared_malloc = shmalloc_local;
 413     } else if (!strcasecmp(val, "no") || !strcmp(val, "0") || !strcasecmp(val, "off")) {
 414       smpi_cfg_shared_malloc = shmalloc_none;
 415     } else {
 416       xbt_die("Invalid value '%s' for option smpi/shared-malloc. Possible values: 'on' or 'global', 'local', 'off'",
 417               val);
 418     }
 419 }
 420
 421 int smpi_main(int (*realmain) (int argc, char *argv[]), int argc, char *argv[])
 422 {
 423   srand(SMPI_RAND_SEED);
 424
 425   if (getenv("SMPI_PRETEND_CC") != nullptr) {
 426     /* Hack to ensure that smpicc can pretend to be a simple compiler. Particularly handy to pass it to the
 427      * configuration tools */
 428     return 0;
 429   }
 430   smpi_init_logs();
 431
 432   TRACE_global_init(&argc, argv);
 433   TRACE_add_start_function(TRACE_smpi_alloc);
 434   TRACE_add_end_function(TRACE_smpi_release);
 435
 436   SIMIX_global_init(&argc, argv);
 437   MSG_init(&argc,argv);
 438
 439   SMPI_switch_data_segment = &smpi_switch_data_segment;
 440
 441   smpi_init_options();
 442
 443   // parse the platform file: get the host list
 444   SIMIX_create_environment(argv[1]);
 445   SIMIX_comm_set_copy_data_callback(smpi_comm_copy_data_callback);
 446   SIMIX_function_register_default(realmain);
 447   SIMIX_launch_application(argv[2]);
 448
 449   smpi_global_init();
 450
 451   smpi_check_options();
 452
 453   if(smpi_privatize_global_variables)
 454     smpi_initialize_global_memory_segments();
 455
 456   /* Clean IO before the run */
 457   fflush(stdout);
 458   fflush(stderr);
 459
 460   if (MC_is_active()) {
 461     MC_run();
 462   } else {
 463
 464     SIMIX_run();
 465
 466     xbt_os_walltimer_stop(global_timer);
 467     if (xbt_cfg_get_boolean("smpi/display-timing")){
 468       double global_time = xbt_os_timer_elapsed(global_timer);
 469       XBT_INFO("Simulated time: %g seconds. \n\n"
 470           "The simulation took %g seconds (after parsing and platform setup)\n"
 471           "%g seconds were actual computation of the application",
 472           SIMIX_get_clock(), global_time , smpi_total_benched_time);
 473
 474       if (smpi_total_benched_time/global_time>=0.75)
 475       XBT_INFO("More than 75%% of the time was spent inside the application code.\n"
 476       "You may want to use sampling functions or trace replay to reduce this.");
 477     }
 478   }
 479   int count = smpi_process_count();
 480   int i, ret=0;
 481   for (i = 0; i < count; i++) {
 482     if(process_data[i]->return_value()!=0){
 483       ret=process_data[i]->return_value();//return first non 0 value
 484       break;
 485     }
 486   }
 487   smpi_global_destroy();
 488
 489   TRACE_end();
 490
 491   return ret;
 492 }
 493
 494 // This function can be called from extern file, to initialize logs, options, and processes of smpi
 495 // without the need of smpirun
 496 void SMPI_init(){
 497   smpi_init_logs();
 498   smpi_init_options();
 499   smpi_global_init();
 500   smpi_check_options();
 501   if (TRACE_is_enabled() && TRACE_is_configured())
 502     TRACE_smpi_alloc();
 503   if(smpi_privatize_global_variables)
 504     smpi_initialize_global_memory_segments();
 505 }
 506
 507 void SMPI_finalize(){
 508   smpi_global_destroy();
 509 }
 510
 511 void smpi_mpi_init() {
 512   if(smpi_init_sleep > 0)
 513     simcall_process_sleep(smpi_init_sleep);
 514 }
 515
 516 double smpi_mpi_wtime(){
 517   double time;
 518   if (smpi_process()->initialized() != 0 && smpi_process()->finalized() == 0 && smpi_process()->sampling() == 0) {
 519     smpi_bench_end();
 520     time = SIMIX_get_clock();
 521     // to avoid deadlocks if used as a break condition, such as
 522     //     while (MPI_Wtime(...) < time_limit) {
 523     //       ....
 524     //     }
 525     // because the time will not normally advance when only calls to MPI_Wtime
 526     // are made -> deadlock (MPI_Wtime never reaches the time limit)
 527     if(smpi_wtime_sleep > 0)
 528       simcall_process_sleep(smpi_wtime_sleep);
 529     smpi_bench_begin();
 530   } else {
 531     time = SIMIX_get_clock();
 532   }
 533   return time;
 534 }
 535