Logo AND Algorithmique Numérique Distribuée

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