src/smpi/internals/smpi_bench.cpp

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