src/smpi/internals/smpi_bench.cpp

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