src/smpi/internals/smpi_bench.cpp

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