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 %gs (host time) 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 void 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   simgrid::s4u::this_actor::sleep_for(secs);
 173   TRACE_smpi_sleeping_out(pid);
 174 }
 175
 176 unsigned int smpi_sleep(unsigned int secs)
 177 {
 178   if (not smpi_process())
 179     return sleep(secs);
 180   private_sleep(secs);
 181   return 0;
 182 }
 183
 184 int smpi_usleep(useconds_t usecs)
 185 {
 186   if (not smpi_process())
 187     return usleep(usecs);
 188   private_sleep(static_cast<double>(usecs) / 1e6);
 189   return 0;
 190 }
 191
 192 #if _POSIX_TIMERS > 0
 193 int smpi_nanosleep(const struct timespec* tp, struct timespec* t)
 194 {
 195   if (not smpi_process())
 196     return nanosleep(tp,t);
 197   private_sleep(static_cast<double>(tp->tv_sec) + static_cast<double>(tp->tv_nsec) / 1e9);
 198   return 0;
 199 }
 200 #endif
 201
 202 int smpi_gettimeofday(struct timeval* tv, struct timezone* tz)
 203 {
 204   if (not smpi_process()->initialized() || smpi_process()->finalized() || smpi_process()->sampling())
 205     return gettimeofday(tv, tz);
 206
 207   const SmpiBenchGuard suspend_bench;
 208   if (tv) {
 209     double now   = simgrid::s4u::Engine::get_clock();
 210     double secs  = trunc(now);
 211     double usecs = (now - secs) * 1e6;
 212     tv->tv_sec   = static_cast<time_t>(secs);
 213     tv->tv_usec  = static_cast<decltype(tv->tv_usec)>(usecs); // suseconds_t (or useconds_t on WIN32)
 214   }
 215   if (smpi_wtime_sleep > 0)
 216     simgrid::s4u::this_actor::sleep_for(smpi_wtime_sleep);
 217   return 0;
 218 }
 219
 220 #if _POSIX_TIMERS > 0
 221 int smpi_clock_gettime(clockid_t clk_id, struct timespec* tp)
 222 {
 223   if (not tp) {
 224     errno = EFAULT;
 225     return -1;
 226   }
 227   if (not smpi_process()->initialized() || smpi_process()->finalized() || smpi_process()->sampling())
 228     return clock_gettime(clk_id, tp);
 229   //there is only one time in SMPI, so clk_id is ignored.
 230   const SmpiBenchGuard suspend_bench;
 231   double now   = simgrid::s4u::Engine::get_clock();
 232   double secs  = trunc(now);
 233   double nsecs = (now - secs) * 1e9;
 234   tp->tv_sec   = static_cast<time_t>(secs);
 235   tp->tv_nsec  = static_cast<long int>(nsecs);
 236   if (smpi_wtime_sleep > 0)
 237     simgrid::s4u::this_actor::sleep_for(smpi_wtime_sleep);
 238   return 0;
 239 }
 240 #endif
 241
 242 double smpi_mpi_wtime()
 243 {
 244   double time;
 245   if (smpi_process()->initialized() && not smpi_process()->finalized() && not smpi_process()->sampling()) {
 246     const SmpiBenchGuard suspend_bench;
 247     time = simgrid::s4u::Engine::get_clock();
 248     if (smpi_wtime_sleep > 0)
 249       simgrid::s4u::this_actor::sleep_for(smpi_wtime_sleep);
 250   } else {
 251     time = simgrid::s4u::Engine::get_clock();
 252   }
 253   return time;
 254 }
 255
 256 extern double sg_surf_precision;
 257 unsigned long long smpi_rastro_resolution ()
 258 {
 259   const SmpiBenchGuard suspend_bench;
 260   double resolution = (1/sg_surf_precision);
 261   return static_cast<unsigned long long>(resolution);
 262 }
 263
 264 unsigned long long smpi_rastro_timestamp ()
 265 {
 266   const SmpiBenchGuard suspend_bench;
 267   double now = simgrid::s4u::Engine::get_clock();
 268
 269   auto sec               = static_cast<unsigned long long>(now);
 270   unsigned long long pre = (now - sec) * smpi_rastro_resolution();
 271   return sec * smpi_rastro_resolution() + pre;
 272 }
 273
 274 /* ****************************** Functions related to the SMPI_SAMPLE_ macros ************************************/
 275 namespace {
 276 class SampleLocation : public std::string {
 277 public:
 278   SampleLocation(bool global, const char* file, const char* tag) : std::string(std::string(file) + ":" + std::string(tag))
 279   {
 280     if (not global)
 281       this->append(":" + std::to_string(simgrid::s4u::this_actor::get_pid()));
 282   }
 283 };
 284
 285 class LocalData {
 286 public:
 287   double threshold; /* maximal stderr requested (if positive) */
 288   double relstderr; /* observed stderr so far */
 289   double mean;      /* mean of benched times, to be used if the block is disabled */
 290   double sum;       /* sum of benched times (to compute the mean and stderr) */
 291   double sum_pow2;  /* sum of the square of the benched times (to compute the stderr) */
 292   int iters;        /* amount of requested iterations */
 293   int count;        /* amount of iterations done so far */
 294   bool benching;    /* true: we are benchmarking; false: we have enough data, no bench anymore */
 295
 296   bool need_more_benchs() const;
 297 };
 298
 299 bool LocalData::need_more_benchs() const
 300 {
 301   bool res = (count < iters) && (threshold < 0.0 || count < 2 ||          // not enough data
 302                                                   relstderr >= threshold); // stderr too high yet
 303   XBT_DEBUG("%s (count:%d iter:%d stderr:%f thres:%f mean:%fs)",
 304             (res ? "need more data" : "enough benchs"), count, iters, relstderr, threshold, mean);
 305   return res;
 306 }
 307
 308 std::unordered_map<SampleLocation, LocalData, std::hash<std::string>> samples;
 309 }
 310
 311 void smpi_sample_1(int global, const char *file, const char *tag, int iters, double threshold)
 312 {
 313   SampleLocation loc(global, file, tag);
 314   if (not smpi_process()->sampling()) { /* Only at first call when benchmarking, skip for next ones */
 315     smpi_bench_end();     /* Take time from previous, unrelated computation into account */
 316     smpi_process()->set_sampling(1);
 317   }
 318
 319   auto insert = samples.emplace(loc, LocalData{
 320                                          threshold, // threshold
 321                                          0.0,       // relstderr
 322                                          0.0,       // mean
 323                                          0.0,       // sum
 324                                          0.0,       // sum_pow2
 325                                          iters,     // iters
 326                                          0,         // count
 327                                          true       // benching (if we have no data, we need at least one)
 328                                      });
 329   if (insert.second) {
 330     XBT_DEBUG("XXXXX First time ever on benched nest %s.", loc.c_str());
 331     xbt_assert(threshold > 0 || iters > 0,
 332         "You should provide either a positive amount of iterations to bench, or a positive maximal stderr (or both)");
 333   } else {
 334     LocalData& data = insert.first->second;
 335     if (data.iters != iters || data.threshold != threshold) {
 336       XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
 337                 "How did you manage to give two numbers at the same line??",
 338                 loc.c_str(), data.iters, data.threshold, iters, threshold);
 339       THROW_IMPOSSIBLE;
 340     }
 341
 342     // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
 343     // the computation instead
 344     data.benching = data.need_more_benchs();
 345     XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
 346               (data.benching ? "more benching needed" : "we have enough data, skip computes"));
 347   }
 348 }
 349
 350 int smpi_sample_2(int global, const char *file,const char *tag, int iter_count)
 351 {
 352   SampleLocation loc(global, file, tag);
 353
 354   XBT_DEBUG("sample2 %s %d", loc.c_str(), iter_count);
 355   auto sample = samples.find(loc);
 356   xbt_assert(sample != samples.end(),
 357              "Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 358   const LocalData& data = sample->second;
 359
 360   if (data.benching) {
 361     // we need to run a new bench
 362     XBT_DEBUG("benchmarking: count:%d iter:%d stderr:%f thres:%f; mean:%f; total:%f",
 363               data.count, data.iters, data.relstderr, data.threshold, data.mean, data.sum);
 364     smpi_bench_begin();
 365   } else {
 366     // Enough data, no more bench (either we got enough data from previous visits to this benched nest, or we just
 367     //ran one bench and need to bail out now that our job is done). Just sleep instead
 368     if (not data.need_more_benchs()){
 369       XBT_DEBUG("No benchmark (either no need, or just ran one): count (%d) >= iter (%d) (or <2) or stderr (%f) < thres (%f), or thresh is negative and ignored. "
 370               "Mean is %f, will be injected %d times",
 371               data.count, data.iters, data.relstderr, data.threshold, data.mean, iter_count);
 372
 373       //we ended benchmarking, let's inject all the time, now, and fast forward out of the loop.
 374       smpi_process()->set_sampling(0);
 375       smpi_execute(data.mean*iter_count);
 376       smpi_bench_begin();
 377       return 0;
 378     } else {
 379       XBT_DEBUG("Skipping - Benchmark already performed - accumulating time");
 380       xbt_os_threadtimer_start(smpi_process()->timer());
 381     }
 382   }
 383   return 1;
 384 }
 385
 386 void smpi_sample_3(int global, const char *file, const char* tag)
 387 {
 388   SampleLocation loc(global, file, tag);
 389
 390   XBT_DEBUG("sample3 %s", loc.c_str());
 391   auto sample = samples.find(loc);
 392   xbt_assert(sample != samples.end(),
 393              "Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 394   LocalData& data = sample->second;
 395
 396   if (not data.benching)
 397     THROW_IMPOSSIBLE;
 398
 399   // ok, benchmarking this loop is over
 400   xbt_os_threadtimer_stop(smpi_process()->timer());
 401
 402   // update the stats
 403   data.count++;
 404   double period  = xbt_os_timer_elapsed(smpi_process()->timer());
 405   data.sum      += period;
 406   data.sum_pow2 += period * period;
 407   double n       = data.count;
 408   data.mean      = data.sum / n;
 409   data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
 410
 411   XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
 412             data.count, data.mean, data.relstderr, period);
 413
 414   // That's enough for now, prevent sample_2 to run the same code over and over
 415   data.benching = false;
 416 }
 417
 418 int smpi_sample_exit(int global, const char *file, const char* tag, int iter_count){
 419   if (smpi_process()->sampling()){
 420     SampleLocation loc(global, file, tag);
 421
 422     XBT_DEBUG("sample exit %s", loc.c_str());
 423     auto sample = samples.find(loc);
 424     xbt_assert(sample != samples.end(),
 425                "Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 426
 427     if (smpi_process()->sampling()){//end of loop, but still sampling needed
 428       const LocalData& data = sample->second;
 429       smpi_process()->set_sampling(0);
 430       smpi_execute(data.mean * iter_count);
 431       smpi_bench_begin();
 432     }
 433   }
 434   return 0;
 435 }
 436
 437 smpi_trace_call_location_t* smpi_trace_get_call_location()
 438 {
 439   return smpi_process()->call_location();
 440 }
 441
 442 void smpi_trace_set_call_location(const char* file, const int line)
 443 {
 444   smpi_trace_call_location_t* loc = smpi_process()->call_location();
 445
 446   loc->previous_filename   = loc->filename;
 447   loc->previous_linenumber = loc->linenumber;
 448   if(not smpi_cfg_trace_call_use_absolute_path())
 449     loc->filename = simgrid::xbt::Path(file).get_base_name();
 450   else
 451     loc->filename = file;
 452   loc->linenumber = line;
 453 }
 454
 455 /** Required for Fortran bindings */
 456 void smpi_trace_set_call_location_(const char* file, const int* line)
 457 {
 458   smpi_trace_set_call_location(file, *line);
 459 }
 460
 461 /** Required for Fortran if -fsecond-underscore is activated */
 462 void smpi_trace_set_call_location__(const char* file, const int* line)
 463 {
 464   smpi_trace_set_call_location(file, *line);
 465 }
 466
 467 void smpi_bench_destroy()
 468 {
 469   samples.clear();
 470 }
 471
 472 int smpi_getopt_long_only (int argc,  char *const *argv,  const char *options,
 473                       const struct option * long_options, int *opt_index)
 474 {
 475   if (smpi_process())
 476     optind = smpi_process()->get_optind();
 477   int ret = getopt_long_only (argc,  argv,  options, long_options, opt_index);
 478   if (smpi_process())
 479     smpi_process()->set_optind(optind);
 480   return ret;
 481 }
 482
 483 int smpi_getopt_long (int argc,  char *const *argv,  const char *options,
 484                       const struct option * long_options, int *opt_index)
 485 {
 486   if (smpi_process())
 487     optind = smpi_process()->get_optind();
 488   int ret = getopt_long (argc,  argv,  options, long_options, opt_index);
 489   if (smpi_process())
 490     smpi_process()->set_optind(optind);
 491   return ret;
 492 }
 493
 494 int smpi_getopt (int argc,  char *const *argv,  const char *options)
 495 {
 496   if (smpi_process())
 497     optind = smpi_process()->get_optind();
 498   int ret = getopt (argc,  argv,  options);
 499   if (smpi_process())
 500     smpi_process()->set_optind(optind);
 501   return ret;
 502 }