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