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