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. */
7 #include "simgrid/s4u/Engine.hpp"
8 #include "simgrid/s4u/Host.hpp"
9 #include "src/smpi/include/smpi_actor.hpp"
11 #include "simgrid/sg_config.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "src/kernel/activity/IoImpl.hpp"
14 #include "src/kernel/activity/MailboxImpl.hpp"
15 #include "src/kernel/activity/SleepImpl.hpp"
16 #include "src/kernel/activity/SynchroRaw.hpp"
17 #include "src/mc/mc_record.hpp"
18 #include "src/mc/mc_replay.hpp"
19 #include "src/simix/smx_private.hpp"
20 #include "src/surf/StorageImpl.hpp"
21 #include "src/surf/xml/platf.hpp"
24 #include "src/mc/remote/Client.hpp"
28 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix, "Logging specific to SIMIX (kernel)");
31 std::unique_ptr<simgrid::simix::Global> simix_global;
33 void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr) = nullptr;
35 bool _sg_do_verbose_exit = true;
36 static void inthandler(int)
38 if ( _sg_do_verbose_exit ) {
39 XBT_INFO("CTRL-C pressed. The current status will be displayed before exit (disable that behavior with option 'verbose-exit').");
40 SIMIX_display_process_status();
43 XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'verbose-exit' is set to false.");
49 static void segvhandler(int signum, siginfo_t* siginfo, void* /*context*/)
51 if (siginfo->si_signo == SIGSEGV && siginfo->si_code == SEGV_ACCERR) {
52 fprintf(stderr, "Access violation detected.\n"
53 "This probably comes from a programming error in your code, or from a stack\n"
54 "overflow. If you are certain of your code, try increasing the stack size\n"
55 " --cfg=contexts/stack-size=XXX (current size is %u KiB).\n"
57 "If it does not help, this may have one of the following causes:\n"
58 "a bug in SimGrid, a bug in the OS or a bug in a third-party libraries.\n"
59 "Failing hardware can sometimes generate such errors too.\n"
61 "If you think you've found a bug in SimGrid, please report it along with a\n"
62 "Minimal Working Example (MWE) reproducing your problem and a full backtrace\n"
63 "of the fault captured with gdb or valgrind.\n",
64 smx_context_stack_size / 1024);
65 } else if (siginfo->si_signo == SIGSEGV) {
66 fprintf(stderr, "Segmentation fault.\n");
68 if (smpi_enabled() && smpi_privatize_global_variables == SmpiPrivStrategies::NONE) {
69 #if HAVE_PRIVATIZATION
70 fprintf(stderr, "Try to enable SMPI variable privatization with --cfg=smpi/privatization:yes.\n");
72 fprintf(stderr, "Sadly, your system does not support --cfg=smpi/privatization:yes (yet).\n");
73 #endif /* HAVE_PRIVATIZATION */
75 #endif /* HAVE_SMPI */
80 unsigned char sigsegv_stack[SIGSTKSZ]; /* alternate stack for SIGSEGV handler */
83 * Install signal handler for SIGSEGV. Check that nobody has already installed
84 * its own handler. For example, the Java VM does this.
86 static void install_segvhandler()
90 stack.ss_sp = sigsegv_stack;
91 stack.ss_size = sizeof sigsegv_stack;
94 if (sigaltstack(&stack, &old_stack) == -1) {
95 XBT_WARN("Failed to register alternate signal stack: %s", strerror(errno));
98 if (not(old_stack.ss_flags & SS_DISABLE)) {
99 XBT_DEBUG("An alternate stack was already installed (sp=%p, size=%zu, flags=%x). Restore it.", old_stack.ss_sp,
100 old_stack.ss_size, (unsigned)old_stack.ss_flags);
101 sigaltstack(&old_stack, nullptr);
104 struct sigaction action;
105 struct sigaction old_action;
106 action.sa_sigaction = &segvhandler;
107 action.sa_flags = SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
108 sigemptyset(&action.sa_mask);
110 if (sigaction(SIGSEGV, &action, &old_action) == -1) {
111 XBT_WARN("Failed to register signal handler for SIGSEGV: %s", strerror(errno));
114 if ((old_action.sa_flags & SA_SIGINFO) || old_action.sa_handler != SIG_DFL) {
115 XBT_DEBUG("A signal handler was already installed for SIGSEGV (%p). Restore it.",
116 (old_action.sa_flags & SA_SIGINFO) ? (void*)old_action.sa_sigaction : (void*)old_action.sa_handler);
117 sigaction(SIGSEGV, &old_action, nullptr);
123 /********************************* SIMIX **************************************/
127 Timer* Timer::set(double date, simgrid::xbt::Task<void()>&& callback)
129 Timer* timer = new Timer(date, std::move(callback));
130 timer->handle_ = simix_timers.emplace(std::make_pair(date, timer));
134 /** @brief cancels a timer that was added earlier */
137 simgrid::simix::simix_timers.erase(handle_);
141 void Global::empty_trash()
143 while (not actors_to_destroy.empty()) {
144 smx_actor_t actor = &actors_to_destroy.front();
145 actors_to_destroy.pop_front();
146 XBT_DEBUG("Getting rid of %p", actor);
147 intrusive_ptr_release(actor);
150 xbt_dynar_reset(simix_global->dead_actors_vector);
154 * @brief Executes the actors in simix_global->actors_to_run.
156 * The actors in simix_global->actors_to_run are run (in parallel if possible). On exit, simix_global->actors_to_run
157 * is empty, and simix_global->actors_that_ran contains the list of actors that just ran.
158 * The two lists are swapped so, be careful when using them before and after a call to this function.
160 void Global::run_all_actors()
162 SIMIX_context_runall();
164 simix_global->actors_to_run.swap(simix_global->actors_that_ran);
165 simix_global->actors_to_run.clear();
168 simgrid::config::Flag<double> breakpoint{"simix/breakpoint",
169 "When non-negative, raise a SIGTRAP after given (simulated) time", -1.0};
173 static simgrid::simix::ActorCode maestro_code;
174 void SIMIX_set_maestro(void (*code)(void*), void* data)
177 XBT_INFO("WARNING, SIMIX_set_maestro is believed to not work on windows. Please help us investigating this issue if you need that feature");
179 maestro_code = std::bind(code, data);
184 * @brief Initialize SIMIX internal data.
186 void SIMIX_global_init(int *argc, char **argv)
189 // The communication initialization is done ASAP.
190 // We need to communicate initialization of the different layers to the model-checker.
191 simgrid::mc::Client::initialize();
194 if (simix_global == nullptr) {
195 simix_global.reset(new simgrid::simix::Global());
196 simix_global->maestro_process = nullptr;
198 surf_init(argc, argv); /* Initialize SURF structures */
199 SIMIX_context_mod_init();
201 // Either create a new context with maestro or create
202 // a context object with the current context mestro):
203 simgrid::kernel::actor::create_maestro(maestro_code);
205 /* Prepare to display some more info when dying on Ctrl-C pressing */
206 std::signal(SIGINT, inthandler);
209 install_segvhandler();
211 /* register a function to be called by SURF after the environment creation */
213 simgrid::s4u::on_platform_created.connect(surf_presolve);
215 simgrid::s4u::Storage::on_creation.connect([](simgrid::s4u::Storage const& storage) {
216 sg_storage_t s = simgrid::s4u::Storage::by_name(storage.get_name());
217 xbt_assert(s != nullptr, "Storage not found for name %s", storage.get_cname());
221 if (simgrid::config::get_value<bool>("clean-atexit"))
224 if (_sg_cfg_exit_asap)
231 * @brief Clean the SIMIX simulation
233 * This functions remove the memory used by SIMIX
238 return; // to avoid double cleaning by java and C
241 XBT_DEBUG("SIMIX_clean called. Simulation's over.");
242 if (not simix_global->actors_to_run.empty() && SIMIX_get_clock() <= 0.0) {
244 XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
245 XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
246 xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
250 if (SIMIX_process_count()>0){
251 if(smpi_process()->initialized()){
252 xbt_die("Process exited without calling MPI_Finalize - Killing simulation");
254 XBT_WARN("Process called exit when leaving - Skipping cleanups");
260 /* Kill all processes (but maestro) */
261 simix_global->maestro_process->kill_all();
262 SIMIX_context_runall();
263 simix_global->empty_trash();
265 /* Exit the SIMIX network module */
266 SIMIX_mailbox_exit();
268 while (not simgrid::simix::simix_timers.empty()) {
269 delete simgrid::simix::simix_timers.top().second;
270 simgrid::simix::simix_timers.pop();
272 /* Free the remaining data structures */
273 simix_global->actors_to_run.clear();
274 simix_global->actors_that_ran.clear();
275 simix_global->actors_to_destroy.clear();
276 simix_global->process_list.clear();
279 xbt_dynar_free(&simix_global->actors_vector);
280 xbt_dynar_free(&simix_global->dead_actors_vector);
283 /* Let's free maestro now */
284 delete simix_global->maestro_process;
285 simix_global->maestro_process = nullptr;
287 /* Finish context module and SURF */
288 SIMIX_context_mod_exit();
292 simix_global = nullptr;
297 * @brief A clock (in second).
299 * @return Return the clock.
301 double SIMIX_get_clock()
303 if(MC_is_active() || MC_record_replay_is_active()){
304 return MC_process_clock_get(SIMIX_process_self());
306 return surf_get_clock();
310 /** Wake up all processes waiting for a Surf action to finish */
311 static void SIMIX_wake_processes()
313 for (auto const& model : all_existing_models) {
314 simgrid::kernel::resource::Action* action;
316 XBT_DEBUG("Handling the processes whose action failed (if any)");
317 while ((action = model->extract_failed_action())) {
318 XBT_DEBUG(" Handling Action %p",action);
319 SIMIX_simcall_exit(static_cast<simgrid::kernel::activity::ActivityImpl*>(action->get_data()));
321 XBT_DEBUG("Handling the processes whose action terminated normally (if any)");
322 while ((action = model->extract_done_action())) {
323 XBT_DEBUG(" Handling Action %p",action);
324 if (action->get_data() == nullptr)
325 XBT_DEBUG("probably vcpu's action %p, skip", action);
327 SIMIX_simcall_exit(static_cast<simgrid::kernel::activity::ActivityImpl*>(action->get_data()));
332 /** Handle any pending timer */
333 static bool SIMIX_execute_timers()
336 while (not simgrid::simix::simix_timers.empty() && SIMIX_get_clock() >= simgrid::simix::simix_timers.top().first) {
338 // FIXME: make the timers being real callbacks (i.e. provide dispatchers that read and expand the args)
339 smx_timer_t timer = simgrid::simix::simix_timers.top().second;
340 simgrid::simix::simix_timers.pop();
344 xbt_die("Exception thrown ouf of timer callback");
351 /** Execute all the tasks that are queued
353 * e.g. `.then()` callbacks of futures.
355 static bool SIMIX_execute_tasks()
357 xbt_assert(simix_global->tasksTemp.empty());
359 if (simix_global->tasks.empty())
363 // We don't want the callbacks to modify the vector we are iterating over:
364 simix_global->tasks.swap(simix_global->tasksTemp);
366 // Execute all the queued tasks:
367 for (auto& task : simix_global->tasksTemp)
370 simix_global->tasksTemp.clear();
371 } while (not simix_global->tasks.empty());
378 * @brief Run the main simulation loop.
382 if (not MC_record_path.empty()) {
383 simgrid::mc::replay(MC_record_path);
390 XBT_DEBUG("New Schedule Round; size(queue)=%zu", simix_global->actors_to_run.size());
392 if (simgrid::simix::breakpoint >= 0.0 && surf_get_clock() >= simgrid::simix::breakpoint) {
393 XBT_DEBUG("Breakpoint reached (%g)", simgrid::simix::breakpoint.get());
394 simgrid::simix::breakpoint = -1.0;
402 SIMIX_execute_tasks();
404 while (not simix_global->actors_to_run.empty()) {
405 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", simix_global->actors_to_run.size());
407 /* Run all processes that are ready to run, possibly in parallel */
408 simix_global->run_all_actors();
410 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
412 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
414 /* Here, the order is ok because:
416 * Short proof: only maestro adds stuff to the actors_to_run array, so the execution order of user contexts do
417 * not impact its order.
419 * Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
421 * - if there is no kill during the simulation, processes remain sorted according by their PID.
422 * Rationale: This can be proved inductively.
423 * Assume that actors_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
424 * is parsed linearly).
425 * Let's show that it is still so at the end of this round.
426 * - if a process is added when being created, that's from maestro. It can be either at startup
427 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
428 * in arbitrary order (inductive hypothesis), we are fine.
429 * - If a process is added because it's getting killed, its subsequent actions shouldn't matter
430 * - If a process gets added to actors_to_run because one of their blocking action constituting the meat
431 * of a simcall terminates, we're still good. Proof:
432 * - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
433 * kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an
435 * - For communications, this function is called from SIMIX_comm_finish().
436 * This function itself don't mess with the order since simcalls are handled in FIFO order.
437 * The function is called:
438 * - before the comm starts (invalid parameters, or resource already dead or whatever).
439 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
440 * - because the communication failed or were canceled after startup. In this case, it's called from
441 * the function we are in, by the chunk:
442 * set = model->states.failed_action_set;
443 * while ((synchro = extract(set)))
444 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
445 * This order is also fixed because it depends of the order in which the surf actions were
446 * added to the system, and only maestro can add stuff this way, through simcalls.
447 * We thus use the inductive hypothesis once again to conclude that the order in which synchros are
448 * poped out of the set does not depend on the user code's execution order.
449 * - because the communication terminated. In this case, synchros are served in the order given by
450 * set = model->states.done_action_set;
451 * while ((synchro = extract(set)))
452 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
453 * and the argument is very similar to the previous one.
454 * So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user
455 * processes are executed.
456 * So, in any cases, the orders of processes within actors_to_run do not depend on the order in which
457 * user processes were executed previously.
458 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
459 * - If there is some process killings, the order is changed by this decision that comes from user-land
460 * But this decision may not have been motivated by a situation that were different because the simulation is
462 * So, even the order change induced by the process killing is perfectly reproducible.
464 * So science works, bitches [http://xkcd.com/54/].
466 * We could sort the actors_that_ran array completely so that we can describe the order in which simcalls are
467 * handled (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if
469 * That would thus be a pure waste of time.
472 for (smx_actor_t const& process : simix_global->actors_that_ran) {
473 if (process->simcall.call != SIMCALL_NONE) {
474 SIMIX_simcall_handle(&process->simcall, 0);
478 SIMIX_execute_tasks();
480 SIMIX_wake_processes();
481 } while (SIMIX_execute_tasks());
483 /* If only daemon processes remain, cancel their actions, mark them to die and reschedule them */
484 if (simix_global->process_list.size() == simix_global->daemons.size())
485 for (auto const& dmon : simix_global->daemons) {
486 XBT_DEBUG("Kill %s", dmon->get_cname());
487 simix_global->maestro_process->kill(dmon);
491 time = simgrid::simix::Timer::next();
492 if (time > -1.0 || not simix_global->process_list.empty()) {
493 XBT_DEBUG("Calling surf_solve");
494 time = surf_solve(time);
495 XBT_DEBUG("Moving time ahead : %g", time);
498 /* Notify all the hosts that have failed */
499 /* FIXME: iterate through the list of failed host and mark each of them */
500 /* as failed. On each host, signal all the running processes with host_fail */
502 // Execute timers and tasks until there isn't anything to be done:
505 again = SIMIX_execute_timers();
506 if (SIMIX_execute_tasks())
508 SIMIX_wake_processes();
511 /* Clean actors to destroy */
512 simix_global->empty_trash();
514 XBT_DEBUG("### time %f, #processes %zu, #to_run %zu", time, simix_global->process_list.size(),
515 simix_global->actors_to_run.size());
517 } while (time > -1.0 || not simix_global->actors_to_run.empty());
519 if (not simix_global->process_list.empty()) {
521 if (simix_global->process_list.size() <= simix_global->daemons.size()) {
522 XBT_CRITICAL("Oops! Daemon actors cannot do any blocking activity (communications, synchronization, etc) "
523 "once the simulation is over. Please fix your on_exit() functions.");
525 XBT_CRITICAL("Oops! Deadlock or code not perfectly clean.");
527 SIMIX_display_process_status();
528 simgrid::s4u::on_deadlock();
531 simgrid::s4u::on_simulation_end();
534 double SIMIX_timer_next()
536 return simgrid::simix::Timer::next();
539 smx_timer_t SIMIX_timer_set(double date, void (*callback)(void*), void *arg)
541 return simgrid::simix::Timer::set(date, std::bind(callback, arg));
544 smx_timer_t SIMIX_timer_set(double date, simgrid::xbt::Task<void()>&& callback) // deprecated
546 return simgrid::simix::Timer::set(date, std::move(callback));
549 /** @brief cancels a timer that was added earlier */
550 void SIMIX_timer_remove(smx_timer_t timer) {
554 /** @brief Returns the date at which the timer will trigger (or 0 if nullptr timer) */
555 double SIMIX_timer_get_date(smx_timer_t timer) {
556 return timer ? timer->get_date() : 0;
559 void SIMIX_display_process_status()
561 int nbprocess = simix_global->process_list.size();
563 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
564 /* List the process and their state */
565 XBT_INFO("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
566 for (auto const& kv : simix_global->process_list) {
567 smx_actor_t process = kv.second;
569 if (process->waiting_synchro) {
571 const char* synchro_description = "unknown";
573 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro) != nullptr)
574 synchro_description = "execution";
576 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro) != nullptr)
577 synchro_description = "communication";
579 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro) != nullptr)
580 synchro_description = "sleeping";
582 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro) != nullptr)
583 synchro_description = "synchronization";
585 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro) != nullptr)
586 synchro_description = "I/O";
588 XBT_INFO("Process %ld (%s@%s): waiting for %s synchro %p (%s) in state %d to finish", process->get_pid(),
589 process->get_cname(), process->get_host()->get_cname(), synchro_description,
590 process->waiting_synchro.get(), process->waiting_synchro->get_cname(),
591 (int)process->waiting_synchro->state_);
594 XBT_INFO("Process %ld (%s@%s)", process->get_pid(), process->get_cname(), process->get_host()->get_cname());
599 int SIMIX_is_maestro()
601 smx_actor_t self = SIMIX_process_self();
602 return simix_global == nullptr /*SimDag*/ || self == nullptr || self == simix_global->maestro_process;