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 "xbt/config.hpp"
16 #include "src/smpi/include/smpi_actor.hpp"
17 #include <unordered_map>
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_bench, smpi, "Logging specific to SMPI (benchmarking)");
30 static simgrid::config::Flag<double>
31 smpi_wtime_sleep("smpi/wtime",
32 "Minimum time to inject inside a call to MPI_Wtime(), gettimeofday() and clock_gettime()",
33 1e-8 /* Documented to be 10 ns */);
35 double smpi_cpu_threshold = -1;
36 double smpi_host_speed;
38 SharedMallocType smpi_cfg_shared_malloc = SharedMallocType::GLOBAL;
39 double smpi_total_benched_time = 0;
41 void smpi_execute_flops(double flops) {
42 xbt_assert(flops >= 0, "You're trying to execute a negative amount of flops (%f)!", flops);
43 XBT_DEBUG("Handle real computation time: %f flops", flops);
44 simgrid::s4u::this_actor::exec_init(flops)
45 ->set_name("computation")
46 ->set_tracing_category(smpi_process()->get_tracing_category())
49 smpi_switch_data_segment(simgrid::s4u::Actor::self());
52 void smpi_execute(double duration)
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 = simgrid::s4u::this_actor::get_pid();
58 TRACE_smpi_computing_in(rank, flops);
60 smpi_execute_flops(flops);
62 TRACE_smpi_computing_out(rank);
65 XBT_DEBUG("Real computation took %g while option smpi/cpu-threshold is set to %g => ignore it", duration,
70 void smpi_execute_benched(double duration)
73 double speed = sg_host_speed(sg_host_self());
74 smpi_execute_flops(duration*speed);
78 void smpi_bench_begin()
80 if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
81 smpi_switch_data_segment(simgrid::s4u::Actor::self());
84 if (MC_is_active() || MC_record_replay_is_active())
88 if (not simgrid::config::get_value<std::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() && PAPI_start(event_set) != PAPI_OK) {
92 // TODO This needs some proper handling.
93 XBT_CRITICAL("Could not start PAPI counters.\n");
98 xbt_os_threadtimer_start(smpi_process()->timer());
101 void smpi_bench_end()
103 if (MC_is_active() || MC_record_replay_is_active())
107 xbt_os_timer_t timer = smpi_process()->timer();
108 xbt_os_threadtimer_stop(timer);
112 * An MPI function has been called and now is the right time to update
113 * our PAPI counters for this process.
115 if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty()) {
116 papi_counter_t& counter_data = smpi_process()->papi_counters();
117 int event_set = smpi_process()->papi_event_set();
118 std::vector<long long> event_values = std::vector<long long>(counter_data.size());
120 if (PAPI_stop(event_set, &event_values[0]) != PAPI_OK) { // Error
121 XBT_CRITICAL("Could not stop PAPI counters.\n");
124 for (unsigned int i = 0; i < counter_data.size(); i++) {
125 counter_data[i].second += event_values[i];
131 if (smpi_process()->sampling()) {
132 XBT_CRITICAL("Cannot do recursive benchmarks.");
133 XBT_CRITICAL("Are you trying to make a call to MPI within a SMPI_SAMPLE_ block?");
134 xbt_backtrace_display_current();
135 xbt_die("Aborting.");
138 // Maybe we need to artificially speed up or slow down our computation based on our statistical analysis.
139 if (simgrid::config::get_value<std::string>("smpi/comp-adjustment-file")[0] != '\0') {
141 smpi_trace_call_location_t* loc = smpi_process()->call_location();
142 std::string key = loc->get_composed_key();
143 std::unordered_map<std::string, double>::const_iterator it = location2speedup.find(key);
144 if (it != location2speedup.end()) {
145 speedup = it->second;
149 // Simulate the benchmarked computation unless disabled via command-line argument
150 if (simgrid::config::get_value<bool>("smpi/simulate-computation")) {
151 smpi_execute(xbt_os_timer_elapsed(timer)/speedup);
155 if (not simgrid::config::get_value<std::string>("smpi/papi-events").empty() && TRACE_smpi_is_enabled()) {
156 container_t container =
157 simgrid::instr::Container::by_name(std::string("rank-") + std::to_string(simgrid::s4u::this_actor::get_pid()));
158 papi_counter_t& counter_data = smpi_process()->papi_counters();
160 for (auto const& pair : counter_data) {
161 simgrid::instr::VariableType* variable = static_cast<simgrid::instr::VariableType*>(container->type_->by_name(pair.first));
162 variable->set_event(SIMIX_get_clock(), pair.second);
167 smpi_total_benched_time += xbt_os_timer_elapsed(timer);
170 /* Private sleep function used by smpi_sleep(), smpi_usleep() and friends */
171 static unsigned int private_sleep(double secs)
175 XBT_DEBUG("Sleep for: %lf secs", secs);
176 int rank = simgrid::s4u::this_actor::get_pid();
177 TRACE_smpi_sleeping_in(rank, secs);
179 simcall_process_sleep(secs);
181 TRACE_smpi_sleeping_out(rank);
187 unsigned int smpi_sleep(unsigned int secs)
189 if (not smpi_process())
191 return private_sleep(secs);
194 int smpi_usleep(useconds_t usecs)
196 if (not smpi_process())
197 return usleep(usecs);
198 return static_cast<int>(private_sleep(usecs / 1000000.0));
201 #if _POSIX_TIMERS > 0
202 int smpi_nanosleep(const struct timespec* tp, struct timespec* t)
204 if (not smpi_process())
205 return nanosleep(tp,t);
206 return static_cast<int>(private_sleep(tp->tv_sec + tp->tv_nsec / 1000000000.0));
210 int smpi_gettimeofday(struct timeval* tv, struct timezone* tz)
212 if (not smpi_process())
213 return gettimeofday(tv, tz);
216 double now = SIMIX_get_clock();
218 tv->tv_sec = static_cast<time_t>(now);
220 tv->tv_usec = static_cast<useconds_t>((now - tv->tv_sec) * 1e6);
222 tv->tv_usec = static_cast<suseconds_t>((now - tv->tv_sec) * 1e6);
225 if (smpi_wtime_sleep > 0)
226 simcall_process_sleep(smpi_wtime_sleep);
231 #if _POSIX_TIMERS > 0
232 int smpi_clock_gettime(clockid_t clk_id, struct timespec* tp)
234 if (not smpi_process())
235 return clock_gettime(clk_id, tp);
236 //there is only one time in SMPI, so clk_id is ignored.
238 double now = SIMIX_get_clock();
240 tp->tv_sec = static_cast<time_t>(now);
241 tp->tv_nsec = static_cast<long int>((now - tp->tv_sec) * 1e9);
243 if (smpi_wtime_sleep > 0)
244 simcall_process_sleep(smpi_wtime_sleep);
250 double smpi_mpi_wtime()
253 if (smpi_process()->initialized() && not smpi_process()->finalized() && not smpi_process()->sampling()) {
255 time = SIMIX_get_clock();
256 if (smpi_wtime_sleep > 0)
257 simcall_process_sleep(smpi_wtime_sleep);
260 time = SIMIX_get_clock();
265 extern double sg_surf_precision;
266 unsigned long long smpi_rastro_resolution ()
269 double resolution = (1/sg_surf_precision);
271 return static_cast<unsigned long long>(resolution);
274 unsigned long long smpi_rastro_timestamp ()
277 double now = SIMIX_get_clock();
279 unsigned long long sec = static_cast<unsigned long long>(now);
280 unsigned long long pre = (now - sec) * smpi_rastro_resolution();
282 return static_cast<unsigned long long>(sec) * smpi_rastro_resolution() + pre;
285 /* ****************************** Functions related to the SMPI_SAMPLE_ macros ************************************/
287 class SampleLocation : public std::string {
289 SampleLocation(bool global, const char* file, int line) : std::string(std::string(file) + ":" + std::to_string(line))
292 this->append(":" + std::to_string(simgrid::s4u::this_actor::get_pid()));
298 double threshold; /* maximal stderr requested (if positive) */
299 double relstderr; /* observed stderr so far */
300 double mean; /* mean of benched times, to be used if the block is disabled */
301 double sum; /* sum of benched times (to compute the mean and stderr) */
302 double sum_pow2; /* sum of the square of the benched times (to compute the stderr) */
303 int iters; /* amount of requested iterations */
304 int count; /* amount of iterations done so far */
305 bool benching; /* true: we are benchmarking; false: we have enough data, no bench anymore */
307 bool need_more_benchs() const;
310 bool LocalData::need_more_benchs() const
312 bool res = (count < iters) || (threshold > 0.0 && (count < 2 || // not enough data
313 relstderr > threshold // stderr too high yet
315 XBT_DEBUG("%s (count:%d iter:%d stderr:%f thres:%f mean:%fs)",
316 (res ? "need more data" : "enough benchs"), count, iters, relstderr, threshold, mean);
320 std::unordered_map<SampleLocation, LocalData, std::hash<std::string>> samples;
323 void smpi_sample_1(int global, const char *file, int line, int iters, double threshold)
325 SampleLocation loc(global, file, line);
326 if (not smpi_process()->sampling()) { /* Only at first call when benchmarking, skip for next ones */
327 smpi_bench_end(); /* Take time from previous, unrelated computation into account */
328 smpi_process()->set_sampling(1);
331 auto insert = samples.emplace(loc, LocalData{
332 threshold, // threshold
339 true // benching (if we have no data, we need at least one)
341 LocalData& data = insert.first->second;
343 XBT_DEBUG("XXXXX First time ever on benched nest %s.", loc.c_str());
344 xbt_assert(threshold > 0 || iters > 0,
345 "You should provide either a positive amount of iterations to bench, or a positive maximal stderr (or both)");
347 if (data.iters != iters || data.threshold != threshold) {
348 XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
349 "How did you manage to give two numbers at the same line??",
350 loc.c_str(), data.iters, data.threshold, iters, threshold);
354 // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
355 // the computation instead
356 data.benching = data.need_more_benchs();
357 XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
358 (data.benching ? "more benching needed" : "we have enough data, skip computes"));
362 int smpi_sample_2(int global, const char *file, int line, int iter_count)
364 SampleLocation loc(global, file, line);
366 XBT_DEBUG("sample2 %s %d", loc.c_str(), iter_count);
367 auto sample = samples.find(loc);
368 if (sample == samples.end())
369 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
370 LocalData& data = sample->second;
373 // we need to run a new bench
374 XBT_DEBUG("benchmarking: count:%d iter:%d stderr:%f thres:%f; mean:%f; total:%f",
375 data.count, data.iters, data.relstderr, data.threshold, data.mean, data.sum);
378 // Enough data, no more bench (either we got enough data from previous visits to this benched nest, or we just
379 //ran one bench and need to bail out now that our job is done). Just sleep instead
380 if (not data.need_more_benchs()){
381 XBT_DEBUG("No benchmark (either no need, or just ran one): count >= iter (%d >= %d) or stderr<thres (%f<=%f). "
382 "Mean is %f, will be injected %d times",
383 data.count, data.iters, data.relstderr, data.threshold, data.mean, iter_count);
385 //we ended benchmarking, let's inject all the time, now, and fast forward out of the loop.
386 smpi_process()->set_sampling(0);
387 smpi_execute(data.mean*iter_count);
391 XBT_DEBUG("Skipping - Benchmark already performed - accumulating time");
392 xbt_os_threadtimer_start(smpi_process()->timer());
398 void smpi_sample_3(int global, const char *file, int line)
400 SampleLocation loc(global, file, line);
402 XBT_DEBUG("sample3 %s", loc.c_str());
403 auto sample = samples.find(loc);
404 if (sample == samples.end())
405 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
406 LocalData& data = sample->second;
408 if (not data.benching)
411 // ok, benchmarking this loop is over
412 xbt_os_threadtimer_stop(smpi_process()->timer());
416 double period = xbt_os_timer_elapsed(smpi_process()->timer());
418 data.sum_pow2 += period * period;
419 double n = data.count;
420 data.mean = data.sum / n;
421 data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
423 XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
424 data.count, data.mean, data.relstderr, period);
426 // That's enough for now, prevent sample_2 to run the same code over and over
427 data.benching = false;
430 int smpi_sample_exit(int global, const char *file, int line, int iter_count){
431 if (smpi_process()->sampling()){
432 SampleLocation loc(global, file, line);
434 XBT_DEBUG("sample exit %s", loc.c_str());
435 auto sample = samples.find(loc);
436 if (sample == samples.end())
437 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
438 LocalData& data = sample->second;
440 if (smpi_process()->sampling()){//end of loop, but still sampling needed
441 smpi_process()->set_sampling(0);
442 smpi_execute(data.mean*iter_count);
449 smpi_trace_call_location_t* smpi_trace_get_call_location()
451 return smpi_process()->call_location();
454 void smpi_trace_set_call_location(const char* file, const int line)
456 smpi_trace_call_location_t* loc = smpi_process()->call_location();
458 loc->previous_filename = loc->filename;
459 loc->previous_linenumber = loc->linenumber;
460 loc->filename = file;
461 loc->linenumber = line;
464 /** Required for Fortran bindings */
465 void smpi_trace_set_call_location_(const char* file, int* line)
467 smpi_trace_set_call_location(file, *line);
470 /** Required for Fortran if -fsecond-underscore is activated */
471 void smpi_trace_set_call_location__(const char* file, int* line)
473 smpi_trace_set_call_location(file, *line);
476 void smpi_bench_destroy()
481 int smpi_getopt_long_only (int argc, char *const *argv, const char *options,
482 const struct option * long_options, int *opt_index)
485 optind = smpi_process()->get_optind();
486 int ret = getopt_long_only (argc, argv, options, long_options, opt_index);
488 smpi_process()->set_optind(optind);
492 int smpi_getopt_long (int argc, char *const *argv, const char *options,
493 const struct option * long_options, int *opt_index)
496 optind = smpi_process()->get_optind();
497 int ret = getopt_long (argc, argv, options, long_options, opt_index);
499 smpi_process()->set_optind(optind);
503 int smpi_getopt (int argc, char *const *argv, const char *options)
506 optind = smpi_process()->get_optind();
507 int ret = getopt (argc, argv, options);
509 smpi_process()->set_optind(optind);