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