src/smpi/internals/smpi_bench.cpp

   1 /* Copyright (c) 2007-2018. 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 "src/simix/ActorImpl.hpp"
  15 #include "xbt/config.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 double smpi_cpu_threshold = -1;
  32 double smpi_host_speed;
  33
  34 SharedMallocType smpi_cfg_shared_malloc = SharedMallocType::GLOBAL;
  35 double smpi_total_benched_time = 0;
  36
  37 extern "C" XBT_PUBLIC void smpi_execute_flops_(double* flops);
  38 void smpi_execute_flops_(double *flops)
  39 {
  40   smpi_execute_flops(*flops);
  41 }
  42
  43 extern "C" XBT_PUBLIC void smpi_execute_(double* duration);
  44 void smpi_execute_(double *duration)
  45 {
  46   smpi_execute(*duration);
  47 }
  48
  49 void smpi_execute_flops(double flops) {
  50   xbt_assert(flops >= 0, "You're trying to execute a negative amount of flops (%f)!", flops);
  51   XBT_DEBUG("Handle real computation time: %f flops", flops);
  52   simgrid::s4u::ExecPtr e = simgrid::s4u::this_actor::exec_init(flops)->set_name("computation");
  53   e->start();
  54   e->set_tracing_category(TRACE_internal_smpi_get_category());
  55   e->wait();
  56   smpi_switch_data_segment(simgrid::s4u::Actor::self());
  57 }
  58
  59 void smpi_execute(double duration)
  60 {
  61   if (duration >= smpi_cpu_threshold) {
  62     XBT_DEBUG("Sleep for %g to handle real computation time", duration);
  63     double flops = duration * smpi_host_speed;
  64     int rank     = simgrid::s4u::this_actor::get_pid();
  65     TRACE_smpi_computing_in(rank, flops);
  66
  67     smpi_execute_flops(flops);
  68
  69     TRACE_smpi_computing_out(rank);
  70
  71   } else {
  72     XBT_DEBUG("Real computation took %g while option smpi/cpu-threshold is set to %g => ignore it", duration,
  73               smpi_cpu_threshold);
  74   }
  75 }
  76
  77 void smpi_execute_benched(double duration)
  78 {
  79   smpi_bench_end();
  80   double speed = sg_host_speed(sg_host_self());
  81   smpi_execute_flops(duration*speed);
  82   smpi_bench_begin();
  83 }
  84
  85 void smpi_bench_begin()
  86 {
  87   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
  88     smpi_switch_data_segment(simgrid::s4u::Actor::self());
  89   }
  90
  91   if (MC_is_active() || MC_record_replay_is_active())
  92     return;
  93
  94 #if HAVE_PAPI
  95   if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty()) {
  96     int event_set = smpi_process()->papi_event_set();
  97     // PAPI_start sets everything to 0! See man(3) PAPI_start
  98     if (PAPI_LOW_LEVEL_INITED == PAPI_is_initialized()) {
  99       if (PAPI_start(event_set) != PAPI_OK) {
 100         // TODO This needs some proper handling.
 101         XBT_CRITICAL("Could not start PAPI counters.\n");
 102         xbt_die("Error.");
 103       }
 104     }
 105   }
 106 #endif
 107   xbt_os_threadtimer_start(smpi_process()->timer());
 108 }
 109
 110 void smpi_bench_end()
 111 {
 112   if (MC_is_active() || MC_record_replay_is_active())
 113     return;
 114
 115   double speedup = 1;
 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 simgrid::config::get_value<std::string>("smpi/papi-events").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 = std::vector<long long>(counter_data.size());
 128
 129     if (PAPI_stop(event_set, &event_values[0]) != PAPI_OK) { // Error
 130       XBT_CRITICAL("Could not stop PAPI counters.\n");
 131       xbt_die("Error.");
 132     } else {
 133       for (unsigned int i = 0; i < counter_data.size(); i++) {
 134         counter_data[i].second += event_values[i];
 135       }
 136     }
 137   }
 138 #endif
 139
 140   if (smpi_process()->sampling()) {
 141     XBT_CRITICAL("Cannot do recursive benchmarks.");
 142     XBT_CRITICAL("Are you trying to make a call to MPI within a SMPI_SAMPLE_ block?");
 143     xbt_backtrace_display_current();
 144     xbt_die("Aborting.");
 145   }
 146
 147   // Maybe we need to artificially speed up or slow down our computation based on our statistical analysis.
 148   if (simgrid::config::get_value<std::string>("smpi/comp-adjustment-file")[0] != '\0') {
 149
 150     smpi_trace_call_location_t* loc                            = smpi_process()->call_location();
 151     std::string key                                            = loc->get_composed_key();
 152     std::unordered_map<std::string, double>::const_iterator it = location2speedup.find(key);
 153     if (it != location2speedup.end()) {
 154       speedup = it->second;
 155     }
 156   }
 157
 158   // Simulate the benchmarked computation unless disabled via command-line argument
 159   if (simgrid::config::get_value<bool>("smpi/simulate-computation")) {
 160     smpi_execute(xbt_os_timer_elapsed(timer)/speedup);
 161   }
 162
 163 #if HAVE_PAPI
 164   if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty() && TRACE_smpi_is_enabled()) {
 165     container_t container =
 166         simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(simgrid::s4u::this_actor::get_pid()));
 167     papi_counter_t& counter_data = smpi_process()->papi_counters();
 168
 169     for (auto const& pair : counter_data) {
 170       simgrid::instr::VariableType* variable = static_cast<simgrid::instr::VariableType*>(container->type_->by_name(pair.first));
 171       variable->set_event(SIMIX_get_clock(), pair.second);
 172     }
 173   }
 174 #endif
 175
 176   smpi_total_benched_time += xbt_os_timer_elapsed(timer);
 177 }
 178
 179 /* Private sleep function used by smpi_sleep() and smpi_usleep() */
 180 static unsigned int private_sleep(double secs)
 181 {
 182   smpi_bench_end();
 183
 184   XBT_DEBUG("Sleep for: %lf secs", secs);
 185   int rank = simgrid::s4u::this_actor::get_pid();
 186   TRACE_smpi_sleeping_in(rank, secs);
 187
 188   simcall_process_sleep(secs);
 189
 190   TRACE_smpi_sleeping_out(rank);
 191
 192   smpi_bench_begin();
 193   return 0;
 194 }
 195
 196 unsigned int smpi_sleep(unsigned int secs)
 197 {
 198   if (not smpi_process())
 199     return sleep(secs);
 200   return private_sleep(static_cast<double>(secs));
 201 }
 202
 203 int smpi_usleep(useconds_t usecs)
 204 {
 205   if (not smpi_process())
 206     return usleep(usecs);
 207   return static_cast<int>(private_sleep(static_cast<double>(usecs) / 1000000.0));
 208 }
 209
 210 #if _POSIX_TIMERS > 0
 211 int smpi_nanosleep(const struct timespec* tp, struct timespec* t)
 212 {
 213   if (not smpi_process())
 214     return nanosleep(tp,t);
 215   return static_cast<int>(private_sleep(static_cast<double>(tp->tv_sec + tp->tv_nsec / 1000000000.0)));
 216 }
 217 #endif
 218
 219 int smpi_gettimeofday(struct timeval* tv, struct timezone* tz)
 220 {
 221   if (not smpi_process())
 222     return gettimeofday(tv, tz);
 223
 224   smpi_bench_end();
 225   double now = SIMIX_get_clock();
 226   if (tv) {
 227     tv->tv_sec = static_cast<time_t>(now);
 228 #ifdef WIN32
 229     tv->tv_usec = static_cast<useconds_t>((now - tv->tv_sec) * 1e6);
 230 #else
 231     tv->tv_usec = static_cast<suseconds_t>((now - tv->tv_sec) * 1e6);
 232 #endif
 233   }
 234   smpi_bench_begin();
 235   return 0;
 236 }
 237
 238 #if _POSIX_TIMERS > 0
 239 int smpi_clock_gettime(clockid_t clk_id, struct timespec* tp)
 240 {
 241   if (not smpi_process())
 242     return clock_gettime(clk_id, tp);
 243   //there is only one time in SMPI, so clk_id is ignored.
 244   smpi_bench_end();
 245   double now = SIMIX_get_clock();
 246   if (tp) {
 247     tp->tv_sec = static_cast<time_t>(now);
 248     tp->tv_nsec = static_cast<long int>((now - tp->tv_sec) * 1e9);
 249   }
 250   smpi_bench_begin();
 251   return 0;
 252 }
 253 #endif
 254
 255 extern double sg_surf_precision;
 256 unsigned long long smpi_rastro_resolution ()
 257 {
 258   smpi_bench_end();
 259   double resolution = (1/sg_surf_precision);
 260   smpi_bench_begin();
 261   return static_cast<unsigned long long>(resolution);
 262 }
 263
 264 unsigned long long smpi_rastro_timestamp ()
 265 {
 266   smpi_bench_end();
 267   double now = SIMIX_get_clock();
 268
 269   unsigned long long sec = static_cast<unsigned long long>(now);
 270   unsigned long long pre = (now - sec) * smpi_rastro_resolution();
 271   smpi_bench_begin();
 272   return static_cast<unsigned long long>(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
 317   smpi_bench_end();     /* Take time from previous, unrelated computation into account */
 318   smpi_process()->set_sampling(1);
 319
 320   auto insert = samples.emplace(loc, LocalData{
 321                                          threshold, // threshold
 322                                          0.0,       // relstderr
 323                                          0.0,       // mean
 324                                          0.0,       // sum
 325                                          0.0,       // sum_pow2
 326                                          iters,     // iters
 327                                          0,         // count
 328                                          true       // benching (if we have no data, we need at least one)
 329                                      });
 330   LocalData& data = insert.first->second;
 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     if (data.iters != iters || data.threshold != threshold) {
 337       XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
 338                 "How did you manage to give two numbers at the same line??",
 339                 loc.c_str(), data.iters, data.threshold, iters, threshold);
 340       THROW_IMPOSSIBLE;
 341     }
 342
 343     // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
 344     // the computation instead
 345     data.benching = data.need_more_benchs();
 346     XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
 347               (data.benching ? "more benching needed" : "we have enough data, skip computes"));
 348   }
 349 }
 350
 351 int smpi_sample_2(int global, const char *file, int line)
 352 {
 353   SampleLocation loc(global, file, line);
 354   int res;
 355
 356   XBT_DEBUG("sample2 %s", loc.c_str());
 357   auto sample = samples.find(loc);
 358   if (sample == samples.end())
 359     xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 360   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",
 365               data.count, data.iters, data.relstderr, data.threshold, data.mean);
 366     res = 1;
 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     XBT_DEBUG("No benchmark (either no need, or just ran one): count >= iter (%d >= %d) or stderr<thres (%f<=%f)."
 371               " apply the %fs delay instead",
 372               data.count, data.iters, data.relstderr, data.threshold, data.mean);
 373     smpi_execute(data.mean);
 374     smpi_process()->set_sampling(0);
 375     res = 0; // prepare to capture future, unrelated computations
 376   }
 377   smpi_bench_begin();
 378   return res;
 379 }
 380
 381 void smpi_sample_3(int global, const char *file, int line)
 382 {
 383   SampleLocation loc(global, file, line);
 384
 385   XBT_DEBUG("sample3 %s", loc.c_str());
 386   auto sample = samples.find(loc);
 387   if (sample == samples.end())
 388     xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
 389   LocalData& data = sample->second;
 390
 391   if (not data.benching)
 392     THROW_IMPOSSIBLE;
 393
 394   // ok, benchmarking this loop is over
 395   xbt_os_threadtimer_stop(smpi_process()->timer());
 396
 397   // update the stats
 398   data.count++;
 399   double period  = xbt_os_timer_elapsed(smpi_process()->timer());
 400   data.sum      += period;
 401   data.sum_pow2 += period * period;
 402   double n       = static_cast<double>(data.count);
 403   data.mean      = data.sum / n;
 404   data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
 405   if (data.need_more_benchs()) {
 406     data.mean = period; // Still in benching process; We want sample_2 to simulate the exact time of this loop
 407     // occurrence before leaving, not the mean over the history
 408   }
 409   XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
 410             data.count, data.mean, data.relstderr, period);
 411
 412   // That's enough for now, prevent sample_2 to run the same code over and over
 413   data.benching = false;
 414 }
 415
 416 smpi_trace_call_location_t* smpi_trace_get_call_location()
 417 {
 418   return smpi_process()->call_location();
 419 }
 420
 421 void smpi_trace_set_call_location(const char* file, const int line)
 422 {
 423   smpi_trace_call_location_t* loc = smpi_process()->call_location();
 424
 425   loc->previous_filename   = loc->filename;
 426   loc->previous_linenumber = loc->linenumber;
 427   loc->filename            = file;
 428   loc->linenumber          = line;
 429 }
 430
 431 /** Required for Fortran bindings */
 432 void smpi_trace_set_call_location_(const char* file, int* line)
 433 {
 434   smpi_trace_set_call_location(file, *line);
 435 }
 436
 437 /** Required for Fortran if -fsecond-underscore is activated */
 438 void smpi_trace_set_call_location__(const char* file, int* line)
 439 {
 440   smpi_trace_set_call_location(file, *line);
 441 }
 442
 443 void smpi_bench_destroy()
 444 {
 445   samples.clear();
 446 }
 447
 448 int smpi_getopt_long_only (int argc,  char *const *argv,  const char *options,
 449                       const struct option * long_options, int *opt_index)
 450 {
 451   if (smpi_process())
 452     optind = smpi_process()->get_optind();
 453   int ret = getopt_long_only (argc,  argv,  options, long_options, opt_index);
 454   if (smpi_process())
 455     smpi_process()->set_optind(optind);
 456   return ret;
 457 }
 458
 459 int smpi_getopt_long (int argc,  char *const *argv,  const char *options,
 460                       const struct option * long_options, int *opt_index)
 461 {
 462   if (smpi_process())
 463     optind = smpi_process()->get_optind();
 464   int ret = getopt_long (argc,  argv,  options, long_options, opt_index);
 465   if (smpi_process())
 466     smpi_process()->set_optind(optind);
 467   return ret;
 468 }
 469
 470 int smpi_getopt (int argc,  char *const *argv,  const char *options)
 471 {
 472   if (smpi_process())
 473     optind = smpi_process()->get_optind();
 474   int ret = getopt (argc,  argv,  options);
 475   if (smpi_process())
 476     smpi_process()->set_optind(optind);
 477   return ret;
 478 }