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