Logo AND Algorithmique Numérique Distribuée

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