Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / 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/modelchecker.h"
8 #include "smpi_comm.hpp"
9 #include "smpi_process.hpp"
10 #include "src/internal_config.h"
11 #include "src/mc/mc_replay.h"
12 #include <unordered_map>
13
14 #ifndef WIN32
15 #include <sys/mman.h>
16 #endif
17 #include <cmath>
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 double smpi_cpu_threshold = -1;
26 double smpi_host_speed;
27
28 shared_malloc_type smpi_cfg_shared_malloc = shmalloc_global;
29 double smpi_total_benched_time = 0;
30
31 extern "C" XBT_PUBLIC(void) smpi_execute_flops_(double *flops);
32 void smpi_execute_flops_(double *flops)
33 {
34   smpi_execute_flops(*flops);
35 }
36
37 extern "C" XBT_PUBLIC(void) smpi_execute_(double *duration);
38 void smpi_execute_(double *duration)
39 {
40   smpi_execute(*duration);
41 }
42
43 void smpi_execute_flops(double flops) {
44   XBT_DEBUG("Handle real computation time: %f flops", flops);
45   smx_activity_t action = simcall_execution_start("computation", flops, 1, 0);
46   simcall_set_category (action, TRACE_internal_smpi_get_category());
47   simcall_execution_wait(action);
48   smpi_switch_data_segment(smpi_process()->index());
49 }
50
51 void smpi_execute(double duration)
52 {
53   if (duration >= smpi_cpu_threshold) {
54     XBT_DEBUG("Sleep for %g to handle real computation time", duration);
55     double flops = duration * smpi_host_speed;
56     int rank = smpi_process()->index();
57     instr_extra_data extra = xbt_new0(s_instr_extra_data_t,1);
58     extra->type=TRACING_COMPUTING;
59     extra->comp_size=flops;
60     TRACE_smpi_computing_in(rank, extra);
61
62     smpi_execute_flops(flops);
63
64     TRACE_smpi_computing_out(rank);
65
66   } else {
67     XBT_DEBUG("Real computation took %g while option smpi/cpu-threshold is set to %g => ignore it", duration,
68               smpi_cpu_threshold);
69   }
70 }
71
72 void smpi_execute_benched(double duration)
73 {
74   smpi_bench_end();
75   smpi_execute(duration);
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(smpi_process()->index());
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        = new simgrid::instr::Container(smpi_container(smpi_process()->index()));
160     papi_counter_t& counter_data = smpi_process()->papi_counters();
161
162     for (auto const& pair : counter_data) {
163       new simgrid::instr::SetVariableEvent(
164           surf_get_clock(), container, PJ_type_get(/* countername */ pair.first.c_str(), container->type), pair.second);
165     }
166   }
167 #endif
168
169   smpi_total_benched_time += xbt_os_timer_elapsed(timer);
170 }
171
172 /* Private sleep function used by smpi_sleep() and smpi_usleep() */
173 static unsigned int private_sleep(double secs)
174 {
175   smpi_bench_end();
176
177   XBT_DEBUG("Sleep for: %lf secs", secs);
178   int rank = MPI_COMM_WORLD->rank();
179   instr_extra_data extra = xbt_new0(s_instr_extra_data_t,1);
180   extra->type=TRACING_SLEEPING;
181   extra->sleep_duration=secs;
182   TRACE_smpi_sleeping_in(rank, extra);
183
184   simcall_process_sleep(secs);
185
186   TRACE_smpi_sleeping_out(rank);
187
188   smpi_bench_begin();
189   return 0;
190 }
191
192 unsigned int smpi_sleep(unsigned int secs)
193 {
194   return private_sleep(static_cast<double>(secs));
195 }
196
197 int smpi_usleep(useconds_t usecs)
198 {
199   return static_cast<int>(private_sleep(static_cast<double>(usecs) / 1000000.0));
200 }
201
202 #if _POSIX_TIMERS > 0
203 int smpi_nanosleep(const struct timespec* tp, struct timespec* /*t*/)
204 {
205   return static_cast<int>(private_sleep(static_cast<double>(tp->tv_sec + tp->tv_nsec / 1000000000.0)));
206 }
207 #endif
208
209 int smpi_gettimeofday(struct timeval* tv, void* /*tz*/)
210 {
211   smpi_bench_end();
212   double now = SIMIX_get_clock();
213   if (tv) {
214     tv->tv_sec = static_cast<time_t>(now);
215 #ifdef WIN32
216     tv->tv_usec = static_cast<useconds_t>((now - tv->tv_sec) * 1e6);
217 #else
218     tv->tv_usec = static_cast<suseconds_t>((now - tv->tv_sec) * 1e6);
219 #endif
220   }
221   smpi_bench_begin();
222   return 0;
223 }
224
225 #if _POSIX_TIMERS > 0
226 int smpi_clock_gettime(clockid_t /*clk_id*/, struct timespec* tp)
227 {
228   //there is only one time in SMPI, so clk_id is ignored.
229   smpi_bench_end();
230   double now = SIMIX_get_clock();
231   if (tp) {
232     tp->tv_sec = static_cast<time_t>(now);
233     tp->tv_nsec = static_cast<long int>((now - tp->tv_sec) * 1e9);
234   }
235   smpi_bench_begin();
236   return 0;
237 }
238 #endif
239
240 extern double sg_surf_precision;
241 unsigned long long smpi_rastro_resolution ()
242 {
243   smpi_bench_end();
244   double resolution = (1/sg_surf_precision);
245   smpi_bench_begin();
246   return static_cast<unsigned long long>(resolution);
247 }
248
249 unsigned long long smpi_rastro_timestamp ()
250 {
251   smpi_bench_end();
252   double now = SIMIX_get_clock();
253
254   unsigned long long sec = static_cast<unsigned long long>(now);
255   unsigned long long pre = (now - sec) * smpi_rastro_resolution();
256   smpi_bench_begin();
257   return static_cast<unsigned long long>(sec) * smpi_rastro_resolution() + pre;
258 }
259
260 /* ****************************** Functions related to the SMPI_SAMPLE_ macros ************************************/
261 namespace {
262 class SampleLocation : public std::string {
263 public:
264   SampleLocation(bool global, const char* file, int line) : std::string(std::string(file) + ":" + std::to_string(line))
265   {
266     if (not global)
267       this->append(":" + std::to_string(smpi_process()->index()));
268   }
269 };
270
271 class LocalData {
272 public:
273   double threshold; /* maximal stderr requested (if positive) */
274   double relstderr; /* observed stderr so far */
275   double mean;      /* mean of benched times, to be used if the block is disabled */
276   double sum;       /* sum of benched times (to compute the mean and stderr) */
277   double sum_pow2;  /* sum of the square of the benched times (to compute the stderr) */
278   int iters;        /* amount of requested iterations */
279   int count;        /* amount of iterations done so far */
280   bool benching;    /* true: we are benchmarking; false: we have enough data, no bench anymore */
281
282   bool need_more_benchs() const;
283 };
284 }
285
286 std::unordered_map<SampleLocation, LocalData, std::hash<std::string>> samples;
287
288 bool LocalData::need_more_benchs() const
289 {
290   bool res = (count < iters) || (threshold > 0.0 && (count < 2 ||          // not enough data
291                                                      relstderr > threshold // stderr too high yet
292                                                      ));
293   XBT_DEBUG("%s (count:%d iter:%d stderr:%f thres:%f mean:%fs)",
294             (res ? "need more data" : "enough benchs"), count, iters, relstderr, threshold, mean);
295   return res;
296 }
297
298 void smpi_sample_1(int global, const char *file, int line, int iters, double threshold)
299 {
300   SampleLocation loc(global, file, line);
301
302   smpi_bench_end();     /* Take time from previous, unrelated computation into account */
303   smpi_process()->set_sampling(1);
304
305   auto insert = samples.emplace(loc, LocalData{
306                                          threshold, // threshold
307                                          0.0,       // relstderr
308                                          0.0,       // mean
309                                          0.0,       // sum
310                                          0.0,       // sum_pow2
311                                          iters,     // iters
312                                          0,         // count
313                                          true       // benching (if we have no data, we need at least one)
314                                      });
315   LocalData& data = insert.first->second;
316   if (insert.second) {
317     XBT_DEBUG("XXXXX First time ever on benched nest %s.", loc.c_str());
318     xbt_assert(threshold > 0 || iters > 0,
319         "You should provide either a positive amount of iterations to bench, or a positive maximal stderr (or both)");
320   } else {
321     if (data.iters != iters || data.threshold != threshold) {
322       XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
323                 "How did you manage to give two numbers at the same line??",
324                 loc.c_str(), data.iters, data.threshold, iters, threshold);
325       THROW_IMPOSSIBLE;
326     }
327
328     // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
329     // the computation instead
330     data.benching = data.need_more_benchs();
331     XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
332               (data.benching ? "more benching needed" : "we have enough data, skip computes"));
333   }
334 }
335
336 int smpi_sample_2(int global, const char *file, int line)
337 {
338   SampleLocation loc(global, file, line);
339   int res;
340
341   XBT_DEBUG("sample2 %s", loc.c_str());
342   auto sample = samples.find(loc);
343   if (sample == samples.end())
344     xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
345   LocalData& data = sample->second;
346
347   if (data.benching) {
348     // we need to run a new bench
349     XBT_DEBUG("benchmarking: count:%d iter:%d stderr:%f thres:%f; mean:%f",
350               data.count, data.iters, data.relstderr, data.threshold, data.mean);
351     res = 1;
352   } else {
353     // Enough data, no more bench (either we got enough data from previous visits to this benched nest, or we just
354     //ran one bench and need to bail out now that our job is done). Just sleep instead
355     XBT_DEBUG("No benchmark (either no need, or just ran one): count >= iter (%d >= %d) or stderr<thres (%f<=%f)."
356               " apply the %fs delay instead",
357               data.count, data.iters, data.relstderr, data.threshold, data.mean);
358     smpi_execute(data.mean);
359     smpi_process()->set_sampling(0);
360     res = 0; // prepare to capture future, unrelated computations
361   }
362   smpi_bench_begin();
363   return res;
364 }
365
366 void smpi_sample_3(int global, const char *file, int line)
367 {
368   SampleLocation loc(global, file, line);
369
370   XBT_DEBUG("sample3 %s", loc.c_str());
371   auto sample = samples.find(loc);
372   if (sample == samples.end())
373     xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
374   LocalData& data = sample->second;
375
376   if (not data.benching)
377     THROW_IMPOSSIBLE;
378
379   // ok, benchmarking this loop is over
380   xbt_os_threadtimer_stop(smpi_process()->timer());
381
382   // update the stats
383   data.count++;
384   double period  = xbt_os_timer_elapsed(smpi_process()->timer());
385   data.sum      += period;
386   data.sum_pow2 += period * period;
387   double n       = static_cast<double>(data.count);
388   data.mean      = data.sum / n;
389   data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
390   if (data.need_more_benchs()) {
391     data.mean = period; // Still in benching process; We want sample_2 to simulate the exact time of this loop
392     // occurrence before leaving, not the mean over the history
393   }
394   XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
395             data.count, data.mean, data.relstderr, period);
396
397   // That's enough for now, prevent sample_2 to run the same code over and over
398   data.benching = false;
399 }
400
401 extern "C" { /** These functions will be called from the user code **/
402 smpi_trace_call_location_t* smpi_trace_get_call_location()
403 {
404   return smpi_process()->call_location();
405 }
406
407 void smpi_trace_set_call_location(const char* file, const int line)
408 {
409   smpi_trace_call_location_t* loc = smpi_process()->call_location();
410
411   loc->previous_filename   = loc->filename;
412   loc->previous_linenumber = loc->linenumber;
413   loc->filename            = file;
414   loc->linenumber          = line;
415 }
416
417 /** Required for Fortran bindings */
418 void smpi_trace_set_call_location_(const char* file, int* line)
419 {
420   smpi_trace_set_call_location(file, *line);
421 }
422
423 /** Required for Fortran if -fsecond-underscore is activated */
424 void smpi_trace_set_call_location__(const char* file, int* line)
425 {
426   smpi_trace_set_call_location(file, *line);
427 }
428 }
429
430 void smpi_bench_destroy()
431 {
432   samples.clear();
433 }