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