1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */
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. */
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"
17 #include "src/smpi/include/smpi_actor.hpp"
18 #include <unordered_map>
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_bench, smpi, "Logging specific to SMPI (benchmarking)");
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-8 /* Documented to be 10 ns */);
36 double smpi_cpu_threshold = -1;
37 double smpi_host_speed;
39 SharedMallocType smpi_cfg_shared_malloc = SharedMallocType::GLOBAL;
40 double smpi_total_benched_time = 0;
42 extern "C" XBT_PUBLIC void smpi_execute_flops_(double* flops);
44 void smpi_execute_flops_(double *flops)
46 smpi_execute_flops(*flops);
49 extern "C" XBT_PUBLIC void smpi_execute_(double* duration);
50 void smpi_execute_(double *duration)
52 smpi_execute(*duration);
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())
63 smpi_switch_data_segment(simgrid::s4u::Actor::self());
66 void smpi_execute(double duration)
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);
74 smpi_execute_flops(flops);
76 TRACE_smpi_computing_out(rank);
79 XBT_DEBUG("Real computation took %g while option smpi/cpu-threshold is set to %g => ignore it", duration,
84 void smpi_execute_benched(double duration)
87 double speed = sg_host_speed(sg_host_self());
88 smpi_execute_flops(duration*speed);
92 void smpi_bench_begin()
94 if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
95 smpi_switch_data_segment(simgrid::s4u::Actor::self());
98 if (MC_is_active() || MC_record_replay_is_active())
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() && PAPI_start(event_set) != PAPI_OK) {
106 // TODO This needs some proper handling.
107 XBT_CRITICAL("Could not start PAPI counters.\n");
112 xbt_os_threadtimer_start(smpi_process()->timer());
115 void smpi_bench_end()
117 if (MC_is_active() || MC_record_replay_is_active())
121 xbt_os_timer_t timer = smpi_process()->timer();
122 xbt_os_threadtimer_stop(timer);
126 * An MPI function has been called and now is the right time to update
127 * our PAPI counters for this process.
129 if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty()) {
130 papi_counter_t& counter_data = smpi_process()->papi_counters();
131 int event_set = smpi_process()->papi_event_set();
132 std::vector<long long> event_values = std::vector<long long>(counter_data.size());
134 if (PAPI_stop(event_set, &event_values[0]) != PAPI_OK) { // Error
135 XBT_CRITICAL("Could not stop PAPI counters.\n");
138 for (unsigned int i = 0; i < counter_data.size(); i++) {
139 counter_data[i].second += event_values[i];
145 if (smpi_process()->sampling()) {
146 XBT_CRITICAL("Cannot do recursive benchmarks.");
147 XBT_CRITICAL("Are you trying to make a call to MPI within a SMPI_SAMPLE_ block?");
148 xbt_backtrace_display_current();
149 xbt_die("Aborting.");
152 // Maybe we need to artificially speed up or slow down our computation based on our statistical analysis.
153 if (simgrid::config::get_value<std::string>("smpi/comp-adjustment-file")[0] != '\0') {
155 smpi_trace_call_location_t* loc = smpi_process()->call_location();
156 std::string key = loc->get_composed_key();
157 std::unordered_map<std::string, double>::const_iterator it = location2speedup.find(key);
158 if (it != location2speedup.end()) {
159 speedup = it->second;
163 // Simulate the benchmarked computation unless disabled via command-line argument
164 if (simgrid::config::get_value<bool>("smpi/simulate-computation")) {
165 smpi_execute(xbt_os_timer_elapsed(timer)/speedup);
169 if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty() && TRACE_smpi_is_enabled()) {
170 container_t container =
171 simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(simgrid::s4u::this_actor::get_pid()));
172 papi_counter_t& counter_data = smpi_process()->papi_counters();
174 for (auto const& pair : counter_data) {
175 simgrid::instr::VariableType* variable = static_cast<simgrid::instr::VariableType*>(container->type_->by_name(pair.first));
176 variable->set_event(SIMIX_get_clock(), pair.second);
181 smpi_total_benched_time += xbt_os_timer_elapsed(timer);
184 /* Private sleep function used by smpi_sleep(), smpi_usleep() and friends */
185 static unsigned int private_sleep(double secs)
189 XBT_DEBUG("Sleep for: %lf secs", secs);
190 int rank = simgrid::s4u::this_actor::get_pid();
191 TRACE_smpi_sleeping_in(rank, secs);
193 simcall_process_sleep(secs);
195 TRACE_smpi_sleeping_out(rank);
201 unsigned int smpi_sleep(unsigned int secs)
203 if (not smpi_process())
205 return private_sleep(static_cast<double>(secs));
208 int smpi_usleep(useconds_t usecs)
210 if (not smpi_process())
211 return usleep(usecs);
212 return static_cast<int>(private_sleep(static_cast<double>(usecs) / 1000000.0));
215 #if _POSIX_TIMERS > 0
216 int smpi_nanosleep(const struct timespec* tp, struct timespec* t)
218 if (not smpi_process())
219 return nanosleep(tp,t);
220 return static_cast<int>(private_sleep(static_cast<double>(tp->tv_sec + tp->tv_nsec / 1000000000.0)));
224 int smpi_gettimeofday(struct timeval* tv, struct timezone* tz)
226 if (not smpi_process())
227 return gettimeofday(tv, tz);
230 double now = SIMIX_get_clock();
232 tv->tv_sec = static_cast<time_t>(now);
234 tv->tv_usec = static_cast<useconds_t>((now - tv->tv_sec) * 1e6);
236 tv->tv_usec = static_cast<suseconds_t>((now - tv->tv_sec) * 1e6);
239 if (smpi_wtime_sleep > 0)
240 simcall_process_sleep(smpi_wtime_sleep);
245 #if _POSIX_TIMERS > 0
246 int smpi_clock_gettime(clockid_t clk_id, struct timespec* tp)
248 if (not smpi_process())
249 return clock_gettime(clk_id, tp);
250 //there is only one time in SMPI, so clk_id is ignored.
252 double now = SIMIX_get_clock();
254 tp->tv_sec = static_cast<time_t>(now);
255 tp->tv_nsec = static_cast<long int>((now - tp->tv_sec) * 1e9);
257 if (smpi_wtime_sleep > 0)
258 simcall_process_sleep(smpi_wtime_sleep);
264 double smpi_mpi_wtime()
267 if (smpi_process()->initialized() && not smpi_process()->finalized() && not smpi_process()->sampling()) {
269 time = SIMIX_get_clock();
270 if (smpi_wtime_sleep > 0)
271 simcall_process_sleep(smpi_wtime_sleep);
274 time = SIMIX_get_clock();
279 extern double sg_surf_precision;
280 unsigned long long smpi_rastro_resolution ()
283 double resolution = (1/sg_surf_precision);
285 return static_cast<unsigned long long>(resolution);
288 unsigned long long smpi_rastro_timestamp ()
291 double now = SIMIX_get_clock();
293 unsigned long long sec = static_cast<unsigned long long>(now);
294 unsigned long long pre = (now - sec) * smpi_rastro_resolution();
296 return static_cast<unsigned long long>(sec) * smpi_rastro_resolution() + pre;
299 /* ****************************** Functions related to the SMPI_SAMPLE_ macros ************************************/
301 class SampleLocation : public std::string {
303 SampleLocation(bool global, const char* file, int line) : std::string(std::string(file) + ":" + std::to_string(line))
306 this->append(":" + std::to_string(simgrid::s4u::this_actor::get_pid()));
312 double threshold; /* maximal stderr requested (if positive) */
313 double relstderr; /* observed stderr so far */
314 double mean; /* mean of benched times, to be used if the block is disabled */
315 double sum; /* sum of benched times (to compute the mean and stderr) */
316 double sum_pow2; /* sum of the square of the benched times (to compute the stderr) */
317 int iters; /* amount of requested iterations */
318 int count; /* amount of iterations done so far */
319 bool benching; /* true: we are benchmarking; false: we have enough data, no bench anymore */
321 bool need_more_benchs() const;
324 bool LocalData::need_more_benchs() const
326 bool res = (count < iters) || (threshold > 0.0 && (count < 2 || // not enough data
327 relstderr > threshold // stderr too high yet
329 XBT_DEBUG("%s (count:%d iter:%d stderr:%f thres:%f mean:%fs)",
330 (res ? "need more data" : "enough benchs"), count, iters, relstderr, threshold, mean);
334 std::unordered_map<SampleLocation, LocalData, std::hash<std::string>> samples;
337 void smpi_sample_1(int global, const char *file, int line, int iters, double threshold)
339 SampleLocation loc(global, file, line);
341 smpi_bench_end(); /* Take time from previous, unrelated computation into account */
342 smpi_process()->set_sampling(1);
344 auto insert = samples.emplace(loc, LocalData{
345 threshold, // threshold
352 true // benching (if we have no data, we need at least one)
354 LocalData& data = insert.first->second;
356 XBT_DEBUG("XXXXX First time ever on benched nest %s.", loc.c_str());
357 xbt_assert(threshold > 0 || iters > 0,
358 "You should provide either a positive amount of iterations to bench, or a positive maximal stderr (or both)");
360 if (data.iters != iters || data.threshold != threshold) {
361 XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
362 "How did you manage to give two numbers at the same line??",
363 loc.c_str(), data.iters, data.threshold, iters, threshold);
367 // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
368 // the computation instead
369 data.benching = data.need_more_benchs();
370 XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
371 (data.benching ? "more benching needed" : "we have enough data, skip computes"));
375 int smpi_sample_2(int global, const char *file, int line)
377 SampleLocation loc(global, file, line);
380 XBT_DEBUG("sample2 %s", loc.c_str());
381 auto sample = samples.find(loc);
382 if (sample == samples.end())
383 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
384 LocalData& data = sample->second;
387 // we need to run a new bench
388 XBT_DEBUG("benchmarking: count:%d iter:%d stderr:%f thres:%f; mean:%f",
389 data.count, data.iters, data.relstderr, data.threshold, data.mean);
392 // Enough data, no more bench (either we got enough data from previous visits to this benched nest, or we just
393 //ran one bench and need to bail out now that our job is done). Just sleep instead
394 XBT_DEBUG("No benchmark (either no need, or just ran one): count >= iter (%d >= %d) or stderr<thres (%f<=%f)."
395 " apply the %fs delay instead",
396 data.count, data.iters, data.relstderr, data.threshold, data.mean);
397 smpi_execute(data.mean);
398 smpi_process()->set_sampling(0);
399 res = 0; // prepare to capture future, unrelated computations
405 void smpi_sample_3(int global, const char *file, int line)
407 SampleLocation loc(global, file, line);
409 XBT_DEBUG("sample3 %s", loc.c_str());
410 auto sample = samples.find(loc);
411 if (sample == samples.end())
412 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
413 LocalData& data = sample->second;
415 if (not data.benching)
418 // ok, benchmarking this loop is over
419 xbt_os_threadtimer_stop(smpi_process()->timer());
423 double period = xbt_os_timer_elapsed(smpi_process()->timer());
425 data.sum_pow2 += period * period;
426 double n = static_cast<double>(data.count);
427 data.mean = data.sum / n;
428 data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
429 if (data.need_more_benchs()) {
430 data.mean = period; // Still in benching process; We want sample_2 to simulate the exact time of this loop
431 // occurrence before leaving, not the mean over the history
433 XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
434 data.count, data.mean, data.relstderr, period);
436 // That's enough for now, prevent sample_2 to run the same code over and over
437 data.benching = false;
440 smpi_trace_call_location_t* smpi_trace_get_call_location()
442 return smpi_process()->call_location();
445 void smpi_trace_set_call_location(const char* file, const int line)
447 smpi_trace_call_location_t* loc = smpi_process()->call_location();
449 loc->previous_filename = loc->filename;
450 loc->previous_linenumber = loc->linenumber;
451 loc->filename = file;
452 loc->linenumber = line;
455 /** Required for Fortran bindings */
456 void smpi_trace_set_call_location_(const char* file, int* line)
458 smpi_trace_set_call_location(file, *line);
461 /** Required for Fortran if -fsecond-underscore is activated */
462 void smpi_trace_set_call_location__(const char* file, int* line)
464 smpi_trace_set_call_location(file, *line);
467 void smpi_bench_destroy()
472 int smpi_getopt_long_only (int argc, char *const *argv, const char *options,
473 const struct option * long_options, int *opt_index)
476 optind = smpi_process()->get_optind();
477 int ret = getopt_long_only (argc, argv, options, long_options, opt_index);
479 smpi_process()->set_optind(optind);
483 int smpi_getopt_long (int argc, char *const *argv, const char *options,
484 const struct option * long_options, int *opt_index)
487 optind = smpi_process()->get_optind();
488 int ret = getopt_long (argc, argv, options, long_options, opt_index);
490 smpi_process()->set_optind(optind);
494 int smpi_getopt (int argc, char *const *argv, const char *options)
497 optind = smpi_process()->get_optind();
498 int ret = getopt (argc, argv, options);
500 smpi_process()->set_optind(optind);