src/smpi/internals/smpi_bench.cpp

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