src/smpi/internals/smpi_bench.cpp

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