1 /* Copyright (c) 2007-2018. 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. */
6 #include <boost/heap/fibonacci_heap.hpp>
10 #include "src/internal_config.h"
11 #include <csignal> /* Signal handling */
14 #include <xbt/functional.hpp>
15 #include <xbt/utility.hpp>
17 #include "simgrid/s4u/Engine.hpp"
18 #include "simgrid/s4u/Host.hpp"
20 #include "smx_private.hpp"
21 #include "src/surf/surf_interface.hpp"
22 #include "src/surf/xml/platf.hpp"
23 #include "xbt/ex.h" /* ex_backtrace_display */
26 #include "simgrid/sg_config.h"
27 #include "src/mc/mc_replay.hpp"
28 #include "src/surf/StorageImpl.hpp"
30 #include "src/smpi/include/smpi_process.hpp"
32 #include "src/kernel/activity/CommImpl.hpp"
33 #include "src/kernel/activity/ExecImpl.hpp"
34 #include "src/kernel/activity/SleepImpl.hpp"
35 #include "src/kernel/activity/SynchroIo.hpp"
36 #include "src/kernel/activity/SynchroRaw.hpp"
39 #include "src/mc/mc_private.hpp"
40 #include "src/mc/remote/Client.hpp"
41 #include "src/mc/remote/mc_protocol.h"
44 #include "src/mc/mc_record.hpp"
47 #include "src/smpi/include/private.hpp"
50 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
51 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix, "Logging specific to SIMIX (kernel)");
53 std::unique_ptr<simgrid::simix::Global> simix_global;
56 typedef std::pair<double, smx_timer_t> TimerQelt;
57 boost::heap::fibonacci_heap<TimerQelt, boost::heap::compare<simgrid::xbt::HeapComparator<TimerQelt>>> simix_timers;
60 /** @brief Timer datatype */
65 decltype(simix_timers)::handle_type handle_;
66 simgrid::xbt::Task<void()> callback;
67 double getDate() { return date; }
68 s_smx_timer_t(double date, simgrid::xbt::Task<void()> callback) : date(date), callback(std::move(callback)) {}
71 void (*SMPI_switch_data_segment)(int) = nullptr;
73 int _sg_do_verbose_exit = 1;
74 static void inthandler(int)
76 if ( _sg_do_verbose_exit ) {
77 XBT_INFO("CTRL-C pressed. The current status will be displayed before exit (disable that behavior with option 'verbose-exit').");
78 SIMIX_display_process_status();
81 XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'verbose-exit' is set to false.");
87 static void segvhandler(int signum, siginfo_t* siginfo, void* /*context*/)
89 if (siginfo->si_signo == SIGSEGV && siginfo->si_code == SEGV_ACCERR) {
90 fprintf(stderr, "Access violation detected.\n"
91 "This probably comes from a programming error in your code, or from a stack\n"
92 "overflow. If you are certain of your code, try increasing the stack size\n"
93 " --cfg=contexts/stack-size=XXX (current size is %u KiB).\n"
95 "If it does not help, this may have one of the following causes:\n"
96 "a bug in SimGrid, a bug in the OS or a bug in a third-party libraries.\n"
97 "Failing hardware can sometimes generate such errors too.\n"
99 "If you think you've found a bug in SimGrid, please report it along with a\n"
100 "Minimal Working Example (MWE) reproducing your problem and a full backtrace\n"
101 "of the fault captured with gdb or valgrind.\n",
102 smx_context_stack_size / 1024);
103 } else if (siginfo->si_signo == SIGSEGV) {
104 fprintf(stderr, "Segmentation fault.\n");
106 if (smpi_enabled() && smpi_privatize_global_variables == SMPI_PRIVATIZE_NONE) {
107 #if HAVE_PRIVATIZATION
108 fprintf(stderr, "Try to enable SMPI variable privatization with --cfg=smpi/privatization:yes.\n");
110 fprintf(stderr, "Sadly, your system does not support --cfg=smpi/privatization:yes (yet).\n");
111 #endif /* HAVE_PRIVATIZATION */
113 #endif /* HAVE_SMPI */
118 char sigsegv_stack[SIGSTKSZ]; /* alternate stack for SIGSEGV handler */
121 * Install signal handler for SIGSEGV. Check that nobody has already installed
122 * its own handler. For example, the Java VM does this.
124 static void install_segvhandler()
128 stack.ss_sp = sigsegv_stack;
129 stack.ss_size = sizeof sigsegv_stack;
132 if (sigaltstack(&stack, &old_stack) == -1) {
133 XBT_WARN("Failed to register alternate signal stack: %s", strerror(errno));
136 if (not(old_stack.ss_flags & SS_DISABLE)) {
137 XBT_DEBUG("An alternate stack was already installed (sp=%p, size=%zu, flags=%x). Restore it.", old_stack.ss_sp,
138 old_stack.ss_size, (unsigned)old_stack.ss_flags);
139 sigaltstack(&old_stack, nullptr);
142 struct sigaction action;
143 struct sigaction old_action;
144 action.sa_sigaction = &segvhandler;
145 action.sa_flags = SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
146 sigemptyset(&action.sa_mask);
148 if (sigaction(SIGSEGV, &action, &old_action) == -1) {
149 XBT_WARN("Failed to register signal handler for SIGSEGV: %s", strerror(errno));
152 if ((old_action.sa_flags & SA_SIGINFO) || old_action.sa_handler != SIG_DFL) {
153 XBT_DEBUG("A signal handler was already installed for SIGSEGV (%p). Restore it.",
154 (old_action.sa_flags & SA_SIGINFO) ? (void*)old_action.sa_sigaction : (void*)old_action.sa_handler);
155 sigaction(SIGSEGV, &old_action, nullptr);
161 /********************************* SIMIX **************************************/
162 double SIMIX_timer_next()
164 return simix_timers.empty() ? -1.0 : simix_timers.top().first;
167 static void kill_process(smx_actor_t process)
169 SIMIX_process_kill(process, nullptr);
172 static std::function<void()> maestro_code;
177 simgrid::xbt::signal<void()> onDeadlock;
179 XBT_PUBLIC(void) set_maestro(std::function<void()> code)
181 maestro_code = std::move(code);
187 void SIMIX_set_maestro(void (*code)(void*), void* data)
190 XBT_INFO("WARNING, SIMIX_set_maestro is believed to not work on windows. Please help us investigating this issue if you need that feature");
192 maestro_code = std::bind(code, data);
197 * \brief Initialize SIMIX internal data.
202 void SIMIX_global_init(int *argc, char **argv)
205 // The communication initialization is done ASAP.
206 // We need to communicate initialization of the different layers to the model-checker.
207 simgrid::mc::Client::initialize();
210 if (not simix_global) {
211 simix_global = std::unique_ptr<simgrid::simix::Global>(new simgrid::simix::Global());
212 simix_global->maestro_process = nullptr;
213 simix_global->create_process_function = &SIMIX_process_create;
214 simix_global->kill_process_function = &kill_process;
215 simix_global->cleanup_process_function = &SIMIX_process_cleanup;
216 simix_global->mutex = xbt_os_mutex_init();
218 surf_init(argc, argv); /* Initialize SURF structures */
219 SIMIX_context_mod_init();
221 // Either create a new context with maestro or create
222 // a context object with the current context mestro):
223 simgrid::simix::create_maestro(maestro_code);
225 /* Prepare to display some more info when dying on Ctrl-C pressing */
226 signal(SIGINT, inthandler);
229 install_segvhandler();
231 /* register a function to be called by SURF after the environment creation */
233 simgrid::s4u::onPlatformCreated.connect(SIMIX_post_create_environment);
234 simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
235 if (host.extension<simgrid::simix::Host>() == nullptr) // another callback to the same signal may have created it
236 host.extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
239 simgrid::surf::storageCreatedCallbacks.connect([](simgrid::surf::StorageImpl* storage) {
240 sg_storage_t s = simgrid::s4u::Storage::byName(storage->getCname());
241 xbt_assert(s != nullptr, "Storage not found for name %s", storage->getCname());
245 if (xbt_cfg_get_boolean("clean-atexit"))
248 if (_sg_cfg_exit_asap)
255 * \brief Clean the SIMIX simulation
257 * This functions remove the memory used by SIMIX
262 return; // to avoid double cleaning by java and C
265 XBT_DEBUG("SIMIX_clean called. Simulation's over.");
266 if (not simix_global->process_to_run.empty() && SIMIX_get_clock() <= 0.0) {
268 XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
269 XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
270 xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
274 if (SIMIX_process_count()>0){
275 if(smpi_process()->initialized()){
276 xbt_die("Process exited without calling MPI_Finalize - Killing simulation");
278 XBT_WARN("Process called exit when leaving - Skipping cleanups");
284 /* Kill all processes (but maestro) */
285 SIMIX_process_killall(simix_global->maestro_process, 1);
286 SIMIX_context_runall();
287 SIMIX_process_empty_trash();
289 /* Exit the SIMIX network module */
290 SIMIX_mailbox_exit();
292 while (not simix_timers.empty()) {
293 delete simix_timers.top().second;
296 /* Free the remaining data structures */
297 simix_global->process_to_run.clear();
298 simix_global->process_that_ran.clear();
299 simix_global->process_to_destroy.clear();
300 simix_global->process_list.clear();
302 xbt_os_mutex_destroy(simix_global->mutex);
303 simix_global->mutex = nullptr;
305 xbt_dynar_free(&simix_global->actors_vector);
306 xbt_dynar_free(&simix_global->dead_actors_vector);
309 /* Let's free maestro now */
310 delete simix_global->maestro_process->context;
311 simix_global->maestro_process->context = nullptr;
312 delete simix_global->maestro_process;
313 simix_global->maestro_process = nullptr;
315 /* Finish context module and SURF */
316 SIMIX_context_mod_exit();
320 simix_global = nullptr;
326 * \brief A clock (in second).
328 * \return Return the clock.
330 double SIMIX_get_clock()
332 if(MC_is_active() || MC_record_replay_is_active()){
333 return MC_process_clock_get(SIMIX_process_self());
335 return surf_get_clock();
339 /** Wake up all processes waiting for a Surf action to finish */
340 static void SIMIX_wake_processes()
342 surf_action_t action;
344 for (auto const& model : *all_existing_models) {
345 XBT_DEBUG("Handling the processes whose action failed (if any)");
346 while ((action = surf_model_extract_failed_action_set(model))) {
347 XBT_DEBUG(" Handling Action %p",action);
348 SIMIX_simcall_exit(static_cast<simgrid::kernel::activity::ActivityImpl*>(action->getData()));
350 XBT_DEBUG("Handling the processes whose action terminated normally (if any)");
351 while ((action = surf_model_extract_done_action_set(model))) {
352 XBT_DEBUG(" Handling Action %p",action);
353 if (action->getData() == nullptr)
354 XBT_DEBUG("probably vcpu's action %p, skip", action);
356 SIMIX_simcall_exit(static_cast<simgrid::kernel::activity::ActivityImpl*>(action->getData()));
361 /** Handle any pending timer */
362 static bool SIMIX_execute_timers()
365 while (not simix_timers.empty() && SIMIX_get_clock() >= simix_timers.top().first) {
367 // FIXME: make the timers being real callbacks
368 // (i.e. provide dispatchers that read and expand the args)
369 smx_timer_t timer = simix_timers.top().second;
374 xbt_die("Exception thrown ouf of timer callback");
381 /** Execute all the tasks that are queued
383 * e.g. `.then()` callbacks of futures.
385 static bool SIMIX_execute_tasks()
387 xbt_assert(simix_global->tasksTemp.empty());
389 if (simix_global->tasks.empty())
394 // We don't want the callbacks to modify the vector we are iterating over:
395 swap(simix_global->tasks, simix_global->tasksTemp);
397 // Execute all the queued tasks:
398 for (auto& task : simix_global->tasksTemp)
401 simix_global->tasksTemp.clear();
402 } while (not simix_global->tasks.empty());
409 * \brief Run the main simulation loop.
413 if (not MC_record_path.empty()) {
414 simgrid::mc::replay(MC_record_path);
421 XBT_DEBUG("New Schedule Round; size(queue)=%zu", simix_global->process_to_run.size());
423 SIMIX_execute_tasks();
425 while (not simix_global->process_to_run.empty()) {
426 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", simix_global->process_to_run.size());
428 /* Run all processes that are ready to run, possibly in parallel */
429 SIMIX_process_runall();
431 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
433 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
435 /* Here, the order is ok because:
437 * Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do
438 * not impact its order.
440 * Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
442 * - if there is no kill during the simulation, processes remain sorted according by their PID.
443 * Rationale: This can be proved inductively.
444 * Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
445 * is parsed linearly).
446 * Let's show that it is still so at the end of this round.
447 * - if a process is added when being created, that's from maestro. It can be either at startup
448 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
449 * in arbitrary order (inductive hypothesis), we are fine.
450 * - If a process is added because it's getting killed, its subsequent actions shouldn't matter
451 * - If a process gets added to process_to_run because one of their blocking action constituting the meat
452 * of a simcall terminates, we're still good. Proof:
453 * - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
454 * kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an
456 * - For communications, this function is called from SIMIX_comm_finish().
457 * This function itself don't mess with the order since simcalls are handled in FIFO order.
458 * The function is called:
459 * - before the comm starts (invalid parameters, or resource already dead or whatever).
460 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
461 * - because the communication failed or were canceled after startup. In this case, it's called from
462 * the function we are in, by the chunk:
463 * set = model->states.failed_action_set;
464 * while ((synchro = extract(set)))
465 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
466 * This order is also fixed because it depends of the order in which the surf actions were
467 * added to the system, and only maestro can add stuff this way, through simcalls.
468 * We thus use the inductive hypothesis once again to conclude that the order in which synchros are
469 * poped out of the set does not depend on the user code's execution order.
470 * - because the communication terminated. In this case, synchros are served in the order given by
471 * set = model->states.done_action_set;
472 * while ((synchro = extract(set)))
473 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
474 * and the argument is very similar to the previous one.
475 * So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user
476 * processes are executed.
477 * So, in any cases, the orders of processes within process_to_run do not depend on the order in which
478 * user processes were executed previously.
479 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
480 * - If there is some process killings, the order is changed by this decision that comes from user-land
481 * But this decision may not have been motivated by a situation that were different because the simulation is
483 * So, even the order change induced by the process killing is perfectly reproducible.
485 * So science works, bitches [http://xkcd.com/54/].
487 * We could sort the process_that_ran array completely so that we can describe the order in which simcalls are
488 * handled (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if
490 * That would thus be a pure waste of time.
493 for (smx_actor_t const& process : simix_global->process_that_ran) {
494 if (process->simcall.call != SIMCALL_NONE) {
495 SIMIX_simcall_handle(&process->simcall, 0);
499 SIMIX_execute_tasks();
501 SIMIX_wake_processes();
502 } while (SIMIX_execute_tasks());
504 /* If only daemon processes remain, cancel their actions, mark them to die and reschedule them */
505 if (simix_global->process_list.size() == simix_global->daemons.size())
506 for (auto const& dmon : simix_global->daemons) {
507 XBT_DEBUG("Kill %s", dmon->getCname());
508 SIMIX_process_kill(dmon, simix_global->maestro_process);
512 time = SIMIX_timer_next();
513 if (time > -1.0 || not simix_global->process_list.empty()) {
514 XBT_DEBUG("Calling surf_solve");
515 time = surf_solve(time);
516 XBT_DEBUG("Moving time ahead : %g", time);
519 /* Notify all the hosts that have failed */
520 /* FIXME: iterate through the list of failed host and mark each of them */
521 /* as failed. On each host, signal all the running processes with host_fail */
523 // Execute timers and tasks until there isn't anything to be done:
526 again = SIMIX_execute_timers();
527 if (SIMIX_execute_tasks())
529 SIMIX_wake_processes();
532 /* Autorestart all process */
533 for (auto const& host : host_that_restart) {
534 XBT_INFO("Restart processes on host %s", host->getCname());
535 SIMIX_host_autorestart(host);
537 host_that_restart.clear();
539 /* Clean processes to destroy */
540 SIMIX_process_empty_trash();
542 XBT_DEBUG("### time %f, #processes %zu, #to_run %zu", time, simix_global->process_list.size(),
543 simix_global->process_to_run.size());
545 if (simix_global->process_to_run.empty() && not simix_global->process_list.empty())
546 simgrid::simix::onDeadlock();
548 } while (time > -1.0 || not simix_global->process_to_run.empty());
550 if (not simix_global->process_list.empty()) {
554 XBT_CRITICAL("Oops ! Deadlock or code not perfectly clean.");
555 SIMIX_display_process_status();
556 simgrid::s4u::onDeadlock();
559 simgrid::s4u::onSimulationEnd();
563 * \brief Set the date to execute a function
565 * Set the date to execute the function on the surf.
566 * \param date Date to execute function
567 * \param callback Function to be executed
568 * \param arg Parameters of the function
571 smx_timer_t SIMIX_timer_set(double date, void (*callback)(void*), void *arg)
573 smx_timer_t timer = new s_smx_timer_t(date, simgrid::xbt::makeTask([callback, arg]() { callback(arg); }));
574 timer->handle_ = simix_timers.emplace(std::make_pair(date, timer));
578 smx_timer_t SIMIX_timer_set(double date, simgrid::xbt::Task<void()> callback)
580 smx_timer_t timer = new s_smx_timer_t(date, std::move(callback));
581 timer->handle_ = simix_timers.emplace(std::make_pair(date, timer));
585 /** @brief cancels a timer that was added earlier */
586 void SIMIX_timer_remove(smx_timer_t timer) {
587 simix_timers.erase(timer->handle_);
591 /** @brief Returns the date at which the timer will trigger (or 0 if nullptr timer) */
592 double SIMIX_timer_get_date(smx_timer_t timer) {
593 return timer ? timer->getDate() : 0;
597 * \brief Registers a function to create a process.
599 * This function registers a function to be called
600 * when a new process is created. The function has
601 * to call SIMIX_process_create().
602 * \param function create process function
604 void SIMIX_function_register_process_create(smx_creation_func_t function)
606 simix_global->create_process_function = function;
610 * \brief Registers a function to kill a process.
612 * This function registers a function to be called when a process is killed. The function has to call the
613 * SIMIX_process_kill().
615 * \param function Kill process function
617 void SIMIX_function_register_process_kill(void_pfn_smxprocess_t function)
619 simix_global->kill_process_function = function;
623 * \brief Registers a function to cleanup a process.
625 * This function registers a user function to be called when a process ends properly.
627 * \param function cleanup process function
629 void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function)
631 simix_global->cleanup_process_function = function;
635 void SIMIX_display_process_status()
637 int nbprocess = simix_global->process_list.size();
639 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
640 /* List the process and their state */
641 XBT_INFO("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
642 for (auto const& kv : simix_global->process_list) {
643 smx_actor_t process = kv.second;
645 if (process->waiting_synchro) {
647 const char* synchro_description = "unknown";
649 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro) != nullptr)
650 synchro_description = "execution";
652 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro) != nullptr)
653 synchro_description = "communication";
655 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro) != nullptr)
656 synchro_description = "sleeping";
658 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro) != nullptr)
659 synchro_description = "synchronization";
661 if (boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro) != nullptr)
662 synchro_description = "I/O";
664 XBT_INFO("Process %lu (%s@%s): waiting for %s synchro %p (%s) in state %d to finish", process->pid,
665 process->getCname(), process->host->getCname(), synchro_description, process->waiting_synchro.get(),
666 process->waiting_synchro->name.c_str(), (int)process->waiting_synchro->state);
669 XBT_INFO("Process %lu (%s@%s)", process->pid, process->getCname(), process->host->getCname());
674 int SIMIX_is_maestro()
676 smx_actor_t self = SIMIX_process_self();
677 return simix_global == nullptr /*SimDag*/ || self == nullptr || self == simix_global->maestro_process;