Logo AND Algorithmique Numérique Distribuée

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