src/smpi/internals/smpi_bench.cpp

   1 /* Copyright (c) 2007-2019. 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 "getopt.h"
   7 #include "private.hpp"
   8 #include "simgrid/host.h"
   9 #include "simgrid/modelchecker.h"
  10 #include "simgrid/s4u/Exec.hpp"
  11 #include "smpi_comm.hpp"
  12 #include "src/internal_config.h"
  13 #include "src/mc/mc_replay.hpp"
  14 #include "xbt/config.hpp"
  15 #include "xbt/file.hpp"
  16
  17 #include "src/smpi/include/smpi_actor.hpp"
  18 #include <unordered_map>
  19
  20 #ifndef WIN32
  21 #include <sys/mman.h>
  22 #endif
  23 #include <cmath>
  24
  25 #if HAVE_PAPI
  26 #include <papi.h>
  27 #endif
  28
  29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_bench, smpi, "Logging specific to SMPI (benchmarking)");
  30
  31 static simgrid::config::Flag<double>
  32     smpi_wtime_sleep("smpi/wtime",
  33                      "Minimum time to inject inside a call to MPI_Wtime(), gettimeofday() and clock_gettime()",
  34                      1e-8 /* Documented to be 10 ns */);
  35
  36 double smpi_total_benched_time = 0;
  37
  38 // Private execute_flops used by smpi_execute and smpi_execute_benched
  39 void private_execute_flops(double flops) {
  40   xbt_assert(flops >= 0, "You're trying to execute a negative amount of flops (%f)!", flops);
  41   XBT_DEBUG("Handle real computation time: %f flops", flops);
  42   simgrid::s4u::this_actor::exec_init(flops)
  43       ->set_name("computation")
  44       ->set_tracing_category(smpi_process()->get_tracing_category())
  45       ->start()
  46       ->wait();
  47   smpi_switch_data_segment(simgrid::s4u::Actor::self());
  48 }
  49
  50 void smpi_execute_flops(double flops) {
  51   int rank     = simgrid::s4u::this_actor::get_pid();
  52   TRACE_smpi_computing_in(rank, flops);
  53
  54   private_execute_flops(flops);
  55
  56   TRACE_smpi_computing_out(rank);
  57 }
  58
  59 void smpi_execute(double duration)
  60 {
  61   if (duration >= smpi_cfg_cpu_thresh()) {
  62     XBT_DEBUG("Sleep for %g to handle real computation time", duration);
  63     double flops = duration * smpi_cfg_host_speed();
  64     int rank     = simgrid::s4u::this_actor::get_pid();
  65     TRACE_smpi_computing_in(rank, flops);
  66
  67     private_execute_flops(flops);
  68
  69     TRACE_smpi_computing_out(rank);
  70
  71   } else {
  72     XBT_DEBUG("Real computation took %g while option smpi/cpu-threshold is set to %g => ignore it", duration,
  73               smpi_cfg_cpu_thresh());
  74   }
  75 }
  76
  77 void smpi_execute_benched(double duration)
  78 {
  79   smpi_bench_end();
  80   double speed = sg_host_speed(sg_host_self());
  81   smpi_execute_flops(duration*speed);
  82   smpi_bench_begin();
  83 }
  84
  85 void smpi_bench_begin()
  86 {
  87   if (smpi_cfg_privatization() == SmpiPrivStrategies::MMAP) {
  88     smpi_switch_data_segment(simgrid::s4u::Actor::self());
  89   }
  90
  91   if (MC_is_active() || MC_record_replay_is_active())
  92     return;
  93
  94 #if HAVE_PAPI
  95   if (not smpi_cfg_papi_events_file().empty()) {
  96     int event_set = smpi_process()->papi_event_set();
  97     // PAPI_start sets everything to 0! See man(3) PAPI_start
  98     if (PAPI_LOW_LEVEL_INITED == PAPI_is_initialized() && PAPI_start(event_set) != PAPI_OK) {
  99       // TODO This needs some proper handling.
 100       XBT_CRITICAL("Could not start PAPI counters.\n");
 101       xbt_die("Error.");
 102     }
 103   }
 104 #endif
 105   xbt_os_threadtimer_start(smpi_process()->timer());
 106 }
 107
 108 double smpi_adjust_comp_speed(){
 109   double speedup=1;
 110   if (smpi_cfg_comp_adjustment_file()[0] != '\0') {
 111     smpi_trace_call_location_t* loc                            = smpi_process()->call_location();
 112     std::string key                                            = loc->get_composed_key();
 113     std::unordered_map<std::string, double>::const_iterator it = location2speedup.find(key);
 114     if (it != location2speedup.end()) {
 115       speedup = it->second;
 116     }
 117   }
 118   return speedup;
 119 }
 120
 121 void smpi_bench_end()
 122 {
 123   if (MC_is_active() || MC_record_replay_is_active())
 124     return;
 125
 126   xbt_os_timer_t timer = smpi_process()->timer();
 127   xbt_os_threadtimer_stop(timer);
 128
 129 #if HAVE_PAPI
 130   /**
 131    * An MPI function has been called and now is the right time to update
 132    * our PAPI counters for this process.
 133    */
 134   if (not smpi_cfg_papi_events_file().empty()) {
 135     papi_counter_t& counter_data        = smpi_process()->papi_counters();
 136     int event_set                       = smpi_process()->papi_event_set();
 137     std::vector<long long> event_values = std::vector<long long>(counter_data.size());
 138
 139     if (PAPI_stop(event_set, &event_values[0]) != PAPI_OK) { // Error
 140       XBT_CRITICAL("Could not stop PAPI counters.\n");
 141       xbt_die("Error.");
 142     } else {
 143       for (unsigned int i = 0; i < counter_data.size(); i++) {
 144         counter_data[i].second += event_values[i];
 145       }
 146     }
 147   }
 148 #endif
 149
 150   if (smpi_process()->sampling()) {
 151     XBT_CRITICAL("Cannot do recursive benchmarks.");
 152     XBT_CRITICAL("Are you trying to make a call to MPI within a SMPI_SAMPLE_ block?");
 153     xbt_backtrace_display_current();
 154     xbt_die("Aborting.");
 155   }
 156
 157   // Maybe we need to artificially speed up or slow down our computation based on our statistical analysis.
 158   // Simulate the benchmarked computation unless disabled via command-line argument
 159   if (smpi_cfg_simulate_computation()) {
 160     smpi_execute(xbt_os_timer_elapsed(timer)/smpi_adjust_comp_speed());
 161   }
 162
 163 #if HAVE_PAPI
 164   if (not smpi_cfg_papi_events_file().empty() && TRACE_smpi_is_enabled()) {
 165     const simgrid::instr::Container* container =
 166         simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(simgrid::s4u::this_actor::get_pid()));
 167     const papi_counter_t& counter_data = smpi_process()->papi_counters();
 168
 169     for (auto const& pair : counter_data) {
 170       simgrid::instr::VariableType* variable = static_cast<simgrid::instr::VariableType*>(container->type_->by_name(pair.first));
 171       variable->set_event(SIMIX_get_clock(), pair.second);
 172     }
 173   }
 174 #endif
 175
 176   smpi_total_benched_time += xbt_os_timer_elapsed(timer);
 177 }
 178
 179 /* Private sleep function used by smpi_sleep(), smpi_usleep() and friends */
 180 static unsigned int private_sleep(double secs)
 181 {
 182   smpi_bench_end();
 183
 184   XBT_DEBUG("Sleep for: %lf secs", secs);
 185   int rank = simgrid::s4u::this_actor::get_pid();
 186   TRACE_smpi_sleeping_in(rank, secs);
 187
 188   simgrid::s4u::this_actor::sleep_for(secs);
 189
 190   TRACE_smpi_sleeping_out(rank);
 191
 192   smpi_bench_begin();
 193   return 0;
 194 }
 195
 196 unsigned int smpi_sleep(unsigned int secs)
 197 {
 198   if (not smpi_process())
 199     return sleep(secs);
 200   return private_sleep(secs);
 201 }
 202
 203 int smpi_usleep(useconds_t usecs)
 204 {
 205   if (not smpi_process())
 206     return usleep(usecs);
 207   return static_cast<int>(private_sleep(usecs / 1000000.0));
 208 }
 209
 210 #if _POSIX_TIMERS > 0
 211 int smpi_nanosleep(const struct timespec* tp, struct timespec* t)
 212 {
 213   if (not smpi_process())
 214     return nanosleep(tp,t);
 215   return static_cast<int>(private_sleep(tp->tv_sec + tp->tv_nsec / 1000000000.0));
 216 }
 217 #endif
 218
 219 int smpi_gettimeofday(struct timeval* tv, struct timezone* tz)
 220 {
 221   if (not smpi_process())
 222     return gettimeofday(tv, tz);
 223
 224   smpi_bench_end();
 225   double now = SIMIX_get_clock();
 226   if (tv) {
 227     tv->tv_sec = static_cast<time_t>(now);
 228 #ifdef WIN32
 229     tv->tv_usec = static_cast<useconds_t>((now - tv->tv_sec) * 1e6);
 230 #else
 231     tv->tv_usec = static_cast<suseconds_t>((now - tv->tv_sec) * 1e6);
 232 #endif
 233   }
 234   if (smpi_wtime_sleep > 0)
 235     simgrid::s4u::this_actor::sleep_for(smpi_wtime_sleep);
 236   smpi_bench_begin();
 237   return 0;
 238 }
 239
 240 #if _POSIX_TIMERS > 0
 241 int smpi_clock_gettime(clockid_t clk_id, struct timespec* tp)
 242 {
 243   if (not smpi_process())
 244     return clock_gettime(clk_id, tp);
 245   //there is only one time in SMPI, so clk_id is ignored.
 246   smpi_bench_end();
 247   double now = SIMIX_get_clock();
 248   if (tp) {
 249     tp->tv_sec = static_cast<time_t>(now);
 250     tp->tv_nsec = static_cast<long int>((now - tp->tv_sec) * 1e9);
 251   }
 252   if (smpi_wtime_sleep > 0)
 253     simgrid::s4u::this_actor::sleep_for(smpi_wtime_sleep);
 254   smpi_bench_begin();
 255   return 0;
 256 }
 257 #endif
 258
 259 double smpi_mpi_wtime()
 260 {
 261   double time;
 262   if (smpi_process()->initialized() && not smpi_process()->finalized() && not smpi_process()->sampling()) {
 263     smpi_bench_end();
 264     time = SIMIX_get_clock();
 265     if (smpi_wtime_sleep > 0)
 266       simgrid::s4u::this_actor::sleep_for(smpi_wtime_sleep);
 267     smpi_bench_begin();
 268   } else {
 269     time = SIMIX_get_clock();
 270   }
 271   return time;
 272 }
 273
 274 extern double sg_surf_precision;
 275 unsigned long long smpi_rastro_resolution ()
 276 {
 277   smpi_bench_end();
 278   double resolution = (1/sg_surf_precision);
 279   smpi_bench_begin();
 280   return static_cast<unsigned long long>(resolution);
 281 }
 282
 283 unsigned long long smpi_rastro_timestamp ()
 284 {
 285   smpi_bench_end();
 286   double now = SIMIX_get_clock();
 287
 288   unsigned long long sec = static_cast<unsigned long long>(now);
 289   unsigned long long pre = (now - sec) * smpi_rastro_resolution();
 290   smpi_bench_begin();
 291   return static_cast<unsigned long long>(sec) * smpi_rastro_resolution() + pre;
 292 }
 293
 294 /* ****************************** Functions related to the SMPI_SAMPLE_ macros ************************************/
 295 namespace {
 296 class SampleLocation : public std::string {
 297 public:
 298   SampleLocation(bool global, const char* file, int line) : std::string(std::string(file) + ":" + std::to_string(line))
 299   {
 300     if (not global)
 301       this->append(":" + std::to_string(simgrid::s4u::this_actor::get_pid()));
 302   }
 303 };
 304
 305 class LocalData {
 306 public:
 307   double threshold; /* maximal stderr requested (if positive) */
 308   double relstderr; /* observed stderr so far */
 309   double mean;      /* mean of benched times, to be used if the block is disabled */
 310   double sum;       /* sum of benched times (to compute the mean and stderr) */
 311   double sum_pow2;  /* sum of the square of the benched times (to compute the stderr) */
 312   int iters;        /* amount of requested iterations */
 313   int count;        /* amount of iterations done so far */
 314   bool benching;    /* true: we are benchmarking; false: we have enough data, no bench anymore */
 315
 316   bool need_more_benchs() const;
 317 };
 318
 319 bool LocalData::need_more_benchs() const
 320 {
 321   bool res = (count < iters) || (threshold > 0.0 && (count < 2 ||          // not enough data
 322                                                      relstderr > threshold // stderr too high yet
 323                                                      ));
 324   XBT_DEBUG("%s (count:%d iter:%d stderr:%f thres:%f mean:%fs)",
 325             (res ? "need more data" : "enough benchs"), count, iters, relstderr, threshold, mean);
 326   return res;
 327 }
 328
 329 std::unordered_map<SampleLocation, LocalData, std::hash<std::string>> samples;
 330 }
 331
 332 void smpi_sample_1(int global, const char *file, int line, int iters, double threshold)
 333 {
 334   SampleLocation loc(global, file, line);
 335   if (not smpi_process()->sampling()) { /* Only at first call when benchmarking, skip for next ones */
 336     smpi_bench_end();     /* Take time from previous, unrelated computation into account */
 337     smpi_process()->set_sampling(1);
 338   }
 339
 340   auto insert = samples.emplace(loc, LocalData{
 341                                          threshold, // threshold
 342                                          0.0,       // relstderr
 343                                          0.0,       // mean
 344                                          0.0,       // sum
 345                                          0.0,       // sum_pow2
 346                                          iters,     // iters
 347                                          0,         // count
 348                                          true       // benching (if we have no data, we need at least one)
 349                                      });
 350   if (insert.second) {
 351     XBT_DEBUG("XXXXX First time ever on benched nest %s.", loc.c_str());
 352     xbt_assert(threshold > 0 || iters > 0,
 353         "You should provide either a positive amount of iterations to bench, or a positive maximal stderr (or both)");
 354   } else {
 355     LocalData& data = insert.first->second;
 356     if (data.iters != iters || data.threshold != threshold) {
 357       XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
 358                 "How did you manage to give two numbers at the same line??",
 359                 loc.c_str(), data.iters, data.threshold, iters, threshold);
 360       THROW_IMPOSSIBLE;
 361     }
 362
 363     // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
 364     // the computation instead
 365     data.benching = data.need_more_benchs();
 366     XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
 367               (data.benching ? "more benching needed" : "we have enough data, skip computes"));
 368   }
 369 }
 370
 371 int smpi_sample_2(int global, const char *file, int line, int iter_count)
 372 {
 373   SampleLocation loc(global, file, line);
 374
 375   XBT_DEBUG("sample2 %s %d", loc.c_str(), iter_count);
 376   auto sample = samples.find(loc);
 377   if (sample == samples.end())
 378     xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 379   const LocalData& data = sample->second;
 380
 381   if (data.benching) {
 382     // we need to run a new bench
 383     XBT_DEBUG("benchmarking: count:%d iter:%d stderr:%f thres:%f; mean:%f; total:%f",
 384               data.count, data.iters, data.relstderr, data.threshold, data.mean, data.sum);
 385     smpi_bench_begin();
 386   } else {
 387     // Enough data, no more bench (either we got enough data from previous visits to this benched nest, or we just
 388     //ran one bench and need to bail out now that our job is done). Just sleep instead
 389     if (not data.need_more_benchs()){
 390       XBT_DEBUG("No benchmark (either no need, or just ran one): count >= iter (%d >= %d) or stderr<thres (%f<=%f). "
 391               "Mean is %f, will be injected %d times",
 392               data.count, data.iters, data.relstderr, data.threshold, data.mean, iter_count);
 393
 394       //we ended benchmarking, let's inject all the time, now, and fast forward out of the loop.
 395       smpi_process()->set_sampling(0);
 396       smpi_execute(data.mean*iter_count);
 397       smpi_bench_begin();
 398       return 0;
 399     } else {
 400       XBT_DEBUG("Skipping - Benchmark already performed - accumulating time");
 401       xbt_os_threadtimer_start(smpi_process()->timer());
 402     }
 403   }
 404   return 1;
 405 }
 406
 407 void smpi_sample_3(int global, const char *file, int line)
 408 {
 409   SampleLocation loc(global, file, line);
 410
 411   XBT_DEBUG("sample3 %s", loc.c_str());
 412   auto sample = samples.find(loc);
 413   if (sample == samples.end())
 414     xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 415   LocalData& data = sample->second;
 416
 417   if (not data.benching)
 418     THROW_IMPOSSIBLE;
 419
 420   // ok, benchmarking this loop is over
 421   xbt_os_threadtimer_stop(smpi_process()->timer());
 422
 423   // update the stats
 424   data.count++;
 425   double period  = xbt_os_timer_elapsed(smpi_process()->timer());
 426   data.sum      += period;
 427   data.sum_pow2 += period * period;
 428   double n       = data.count;
 429   data.mean      = data.sum / n;
 430   data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
 431
 432   XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
 433             data.count, data.mean, data.relstderr, period);
 434
 435   // That's enough for now, prevent sample_2 to run the same code over and over
 436   data.benching = false;
 437 }
 438
 439 int smpi_sample_exit(int global, const char *file, int line, int iter_count){
 440   if (smpi_process()->sampling()){
 441     SampleLocation loc(global, file, line);
 442
 443     XBT_DEBUG("sample exit %s", loc.c_str());
 444     auto sample = samples.find(loc);
 445     if (sample == samples.end())
 446       xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 447
 448     if (smpi_process()->sampling()){//end of loop, but still sampling needed
 449       const LocalData& data = sample->second;
 450       smpi_process()->set_sampling(0);
 451       smpi_execute(data.mean * iter_count);
 452       smpi_bench_begin();
 453     }
 454   }
 455   return 0;
 456 }
 457
 458 smpi_trace_call_location_t* smpi_trace_get_call_location()
 459 {
 460   return smpi_process()->call_location();
 461 }
 462
 463 void smpi_trace_set_call_location(const char* file, const int line)
 464 {
 465   smpi_trace_call_location_t* loc = smpi_process()->call_location();
 466
 467   loc->previous_filename   = loc->filename;
 468   loc->previous_linenumber = loc->linenumber;
 469   if(not smpi_cfg_trace_call_use_absolute_path())
 470     loc->filename = simgrid::xbt::Path(file).get_base_name();
 471   else
 472     loc->filename = file;
 473   loc->linenumber = line;
 474 }
 475
 476 /** Required for Fortran bindings */
 477 void smpi_trace_set_call_location_(const char* file, const int* line)
 478 {
 479   smpi_trace_set_call_location(file, *line);
 480 }
 481
 482 /** Required for Fortran if -fsecond-underscore is activated */
 483 void smpi_trace_set_call_location__(const char* file, const int* line)
 484 {
 485   smpi_trace_set_call_location(file, *line);
 486 }
 487
 488 void smpi_bench_destroy()
 489 {
 490   samples.clear();
 491 }
 492
 493 int smpi_getopt_long_only (int argc,  char *const *argv,  const char *options,
 494                       const struct option * long_options, int *opt_index)
 495 {
 496   if (smpi_process())
 497     optind = smpi_process()->get_optind();
 498   int ret = getopt_long_only (argc,  argv,  options, long_options, opt_index);
 499   if (smpi_process())
 500     smpi_process()->set_optind(optind);
 501   return ret;
 502 }
 503
 504 int smpi_getopt_long (int argc,  char *const *argv,  const char *options,
 505                       const struct option * long_options, int *opt_index)
 506 {
 507   if (smpi_process())
 508     optind = smpi_process()->get_optind();
 509   int ret = getopt_long (argc,  argv,  options, long_options, opt_index);
 510   if (smpi_process())
 511     smpi_process()->set_optind(optind);
 512   return ret;
 513 }
 514
 515 int smpi_getopt (int argc,  char *const *argv,  const char *options)
 516 {
 517   if (smpi_process())
 518     optind = smpi_process()->get_optind();
 519   int ret = getopt (argc,  argv,  options);
 520   if (smpi_process())
 521     smpi_process()->set_optind(optind);
 522   return ret;
 523 }