1 /* Copyright (c) 2007, 2009-2017. 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. */
7 #include "simgrid/host.h"
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.hpp"
13 #include "src/simix/ActorImpl.hpp"
14 #include <unordered_map>
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_bench, smpi, "Logging specific to SMPI (benchmarking)");
27 double smpi_cpu_threshold = -1;
28 double smpi_host_speed;
30 shared_malloc_type smpi_cfg_shared_malloc = shmalloc_global;
31 double smpi_total_benched_time = 0;
33 extern "C" XBT_PUBLIC(void) smpi_execute_flops_(double *flops);
34 void smpi_execute_flops_(double *flops)
36 smpi_execute_flops(*flops);
39 extern "C" XBT_PUBLIC(void) smpi_execute_(double *duration);
40 void smpi_execute_(double *duration)
42 smpi_execute(*duration);
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, smpi_process()->process()->getHost());
48 simcall_set_category (action, TRACE_internal_smpi_get_category());
49 simcall_execution_wait(action);
50 smpi_switch_data_segment(simgrid::s4u::Actor::self()->getPid());
53 void smpi_execute(double duration)
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 = simgrid::s4u::Actor::self()->getPid();
59 TRACE_smpi_computing_in(rank, flops);
61 smpi_execute_flops(flops);
63 TRACE_smpi_computing_out(rank);
66 XBT_DEBUG("Real computation took %g while option smpi/cpu-threshold is set to %g => ignore it", duration,
71 void smpi_execute_benched(double duration)
74 double speed = sg_host_speed(sg_host_self());
75 smpi_execute_flops(duration*speed);
79 void smpi_bench_begin()
81 if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
82 smpi_switch_data_segment(simgrid::s4u::Actor::self()->getPid());
85 if (MC_is_active() || MC_record_replay_is_active())
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");
101 xbt_os_threadtimer_start(smpi_process()->timer());
104 void smpi_bench_end()
106 if (MC_is_active() || MC_record_replay_is_active())
110 xbt_os_timer_t timer = smpi_process()->timer();
111 xbt_os_threadtimer_stop(timer);
115 * An MPI function has been called and now is the right time to update
116 * our PAPI counters for this process.
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());
123 if (PAPI_stop(event_set, &event_values[0]) != PAPI_OK) { // Error
124 XBT_CRITICAL("Could not stop PAPI counters.\n");
127 for (unsigned int i = 0; i < counter_data.size(); i++) {
128 counter_data[i].second += event_values[i];
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.");
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.
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;
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);
158 if (xbt_cfg_get_string("smpi/papi-events")[0] != '\0' && TRACE_smpi_is_enabled()) {
159 container_t container =
160 new simgrid::instr::Container(std::string("rank-") + std::to_string(simgrid::s4u::Actor::self()->getPid()));
161 papi_counter_t& counter_data = smpi_process()->papi_counters();
163 for (auto const& pair : counter_data) {
164 new simgrid::instr::SetVariableEvent(
165 surf_get_clock(), container, PJ_type_get(/* countername */ pair.first.c_str(), container->type), pair.second);
170 smpi_total_benched_time += xbt_os_timer_elapsed(timer);
173 /* Private sleep function used by smpi_sleep() and smpi_usleep() */
174 static unsigned int private_sleep(double secs)
178 XBT_DEBUG("Sleep for: %lf secs", secs);
179 int rank = MPI_COMM_WORLD->rank();
180 TRACE_smpi_sleeping_in(rank, secs);
182 simcall_process_sleep(secs);
184 TRACE_smpi_sleeping_out(rank);
190 unsigned int smpi_sleep(unsigned int secs)
192 return private_sleep(static_cast<double>(secs));
195 int smpi_usleep(useconds_t usecs)
197 return static_cast<int>(private_sleep(static_cast<double>(usecs) / 1000000.0));
200 #if _POSIX_TIMERS > 0
201 int smpi_nanosleep(const struct timespec* tp, struct timespec* /*t*/)
203 return static_cast<int>(private_sleep(static_cast<double>(tp->tv_sec + tp->tv_nsec / 1000000000.0)));
207 int smpi_gettimeofday(struct timeval* tv, void* /*tz*/)
210 double now = SIMIX_get_clock();
212 tv->tv_sec = static_cast<time_t>(now);
214 tv->tv_usec = static_cast<useconds_t>((now - tv->tv_sec) * 1e6);
216 tv->tv_usec = static_cast<suseconds_t>((now - tv->tv_sec) * 1e6);
223 #if _POSIX_TIMERS > 0
224 int smpi_clock_gettime(clockid_t /*clk_id*/, struct timespec* tp)
226 //there is only one time in SMPI, so clk_id is ignored.
228 double now = SIMIX_get_clock();
230 tp->tv_sec = static_cast<time_t>(now);
231 tp->tv_nsec = static_cast<long int>((now - tp->tv_sec) * 1e9);
238 extern double sg_surf_precision;
239 unsigned long long smpi_rastro_resolution ()
242 double resolution = (1/sg_surf_precision);
244 return static_cast<unsigned long long>(resolution);
247 unsigned long long smpi_rastro_timestamp ()
250 double now = SIMIX_get_clock();
252 unsigned long long sec = static_cast<unsigned long long>(now);
253 unsigned long long pre = (now - sec) * smpi_rastro_resolution();
255 return static_cast<unsigned long long>(sec) * smpi_rastro_resolution() + pre;
258 /* ****************************** Functions related to the SMPI_SAMPLE_ macros ************************************/
260 class SampleLocation : public std::string {
262 SampleLocation(bool global, const char* file, int line) : std::string(std::string(file) + ":" + std::to_string(line))
265 this->append(":" + std::to_string(simgrid::s4u::Actor::self()->getPid()));
271 double threshold; /* maximal stderr requested (if positive) */
272 double relstderr; /* observed stderr so far */
273 double mean; /* mean of benched times, to be used if the block is disabled */
274 double sum; /* sum of benched times (to compute the mean and stderr) */
275 double sum_pow2; /* sum of the square of the benched times (to compute the stderr) */
276 int iters; /* amount of requested iterations */
277 int count; /* amount of iterations done so far */
278 bool benching; /* true: we are benchmarking; false: we have enough data, no bench anymore */
280 bool need_more_benchs() const;
284 std::unordered_map<SampleLocation, LocalData, std::hash<std::string>> samples;
286 bool LocalData::need_more_benchs() const
288 bool res = (count < iters) || (threshold > 0.0 && (count < 2 || // not enough data
289 relstderr > threshold // stderr too high yet
291 XBT_DEBUG("%s (count:%d iter:%d stderr:%f thres:%f mean:%fs)",
292 (res ? "need more data" : "enough benchs"), count, iters, relstderr, threshold, mean);
296 void smpi_sample_1(int global, const char *file, int line, int iters, double threshold)
298 SampleLocation loc(global, file, line);
300 smpi_bench_end(); /* Take time from previous, unrelated computation into account */
301 smpi_process()->set_sampling(1);
303 auto insert = samples.emplace(loc, LocalData{
304 threshold, // threshold
311 true // benching (if we have no data, we need at least one)
313 LocalData& data = insert.first->second;
315 XBT_DEBUG("XXXXX First time ever on benched nest %s.", loc.c_str());
316 xbt_assert(threshold > 0 || iters > 0,
317 "You should provide either a positive amount of iterations to bench, or a positive maximal stderr (or both)");
319 if (data.iters != iters || data.threshold != threshold) {
320 XBT_ERROR("Asked to bench block %s with different settings %d, %f is not %d, %f. "
321 "How did you manage to give two numbers at the same line??",
322 loc.c_str(), data.iters, data.threshold, iters, threshold);
326 // if we already have some data, check whether sample_2 should get one more bench or whether it should emulate
327 // the computation instead
328 data.benching = data.need_more_benchs();
329 XBT_DEBUG("XXXX Re-entering the benched nest %s. %s", loc.c_str(),
330 (data.benching ? "more benching needed" : "we have enough data, skip computes"));
334 int smpi_sample_2(int global, const char *file, int line)
336 SampleLocation loc(global, file, line);
339 XBT_DEBUG("sample2 %s", loc.c_str());
340 auto sample = samples.find(loc);
341 if (sample == samples.end())
342 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
343 LocalData& data = sample->second;
346 // we need to run a new bench
347 XBT_DEBUG("benchmarking: count:%d iter:%d stderr:%f thres:%f; mean:%f",
348 data.count, data.iters, data.relstderr, data.threshold, data.mean);
351 // Enough data, no more bench (either we got enough data from previous visits to this benched nest, or we just
352 //ran one bench and need to bail out now that our job is done). Just sleep instead
353 XBT_DEBUG("No benchmark (either no need, or just ran one): count >= iter (%d >= %d) or stderr<thres (%f<=%f)."
354 " apply the %fs delay instead",
355 data.count, data.iters, data.relstderr, data.threshold, data.mean);
356 smpi_execute(data.mean);
357 smpi_process()->set_sampling(0);
358 res = 0; // prepare to capture future, unrelated computations
364 void smpi_sample_3(int global, const char *file, int line)
366 SampleLocation loc(global, file, line);
368 XBT_DEBUG("sample3 %s", loc.c_str());
369 auto sample = samples.find(loc);
370 if (sample == samples.end())
371 xbt_die("Y U NO use SMPI_SAMPLE_* macros? Stop messing directly with smpi_sample_* functions!");
372 LocalData& data = sample->second;
374 if (not data.benching)
377 // ok, benchmarking this loop is over
378 xbt_os_threadtimer_stop(smpi_process()->timer());
382 double period = xbt_os_timer_elapsed(smpi_process()->timer());
384 data.sum_pow2 += period * period;
385 double n = static_cast<double>(data.count);
386 data.mean = data.sum / n;
387 data.relstderr = sqrt((data.sum_pow2 / n - data.mean * data.mean) / n) / data.mean;
388 if (data.need_more_benchs()) {
389 data.mean = period; // Still in benching process; We want sample_2 to simulate the exact time of this loop
390 // occurrence before leaving, not the mean over the history
392 XBT_DEBUG("Average mean after %d steps is %f, relative standard error is %f (sample was %f)",
393 data.count, data.mean, data.relstderr, period);
395 // That's enough for now, prevent sample_2 to run the same code over and over
396 data.benching = false;
399 extern "C" { /** These functions will be called from the user code **/
400 smpi_trace_call_location_t* smpi_trace_get_call_location()
402 return smpi_process()->call_location();
405 void smpi_trace_set_call_location(const char* file, const int line)
407 smpi_trace_call_location_t* loc = smpi_process()->call_location();
409 loc->previous_filename = loc->filename;
410 loc->previous_linenumber = loc->linenumber;
411 loc->filename = file;
412 loc->linenumber = line;
415 /** Required for Fortran bindings */
416 void smpi_trace_set_call_location_(const char* file, int* line)
418 smpi_trace_set_call_location(file, *line);
421 /** Required for Fortran if -fsecond-underscore is activated */
422 void smpi_trace_set_call_location__(const char* file, int* line)
424 smpi_trace_set_call_location(file, *line);
428 void smpi_bench_destroy()