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