1 /* Copyright (c) 2007-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. */
9 #include <signal.h> /* Signal handling */
11 #include "src/internal_config.h"
13 #include <xbt/functional.hpp>
15 #include "simgrid/s4u/engine.hpp"
16 #include "simgrid/s4u/host.hpp"
18 #include "src/surf/surf_interface.hpp"
19 #include "src/surf/storage_interface.hpp"
20 #include "src/surf/xml/platf.hpp"
21 #include "smx_private.h"
23 #include "xbt/ex.h" /* ex_backtrace_display */
25 #include "src/mc/mc_replay.h"
26 #include "simgrid/sg_config.h"
28 #include "src/kernel/activity/SynchroExec.hpp"
29 #include "src/kernel/activity/SynchroComm.hpp"
30 #include "src/kernel/activity/SynchroSleep.hpp"
31 #include "src/kernel/activity/SynchroIo.hpp"
32 #include "src/kernel/activity/SynchroRaw.hpp"
35 #include "src/mc/mc_private.h"
36 #include "src/mc/remote/Client.hpp"
37 #include "src/mc/remote/mc_protocol.h"
41 #include "src/mc/mc_record.h"
44 #include "src/smpi/private.h"
47 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
48 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix, "Logging specific to SIMIX (kernel)");
50 std::unique_ptr<simgrid::simix::Global> simix_global;
51 static xbt_heap_t simix_timers = nullptr;
53 /** @brief Timer datatype */
54 typedef struct s_smx_timer {
56 simgrid::xbt::Task<void()> callback;
58 s_smx_timer()=default;
59 s_smx_timer(double date, simgrid::xbt::Task<void()> callback) : date(date), callback(std::move(callback)) {}
62 void (*SMPI_switch_data_segment)(int) = nullptr;
64 int _sg_do_verbose_exit = 1;
65 static void inthandler(int ignored)
67 if ( _sg_do_verbose_exit ) {
68 XBT_INFO("CTRL-C pressed. The current status will be displayed before exit (disable that behavior with option 'verbose-exit').");
69 SIMIX_display_process_status();
72 XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'verbose-exit' is set to false.");
78 static void segvhandler(int signum, siginfo_t *siginfo, void *context)
80 if (siginfo->si_signo == SIGSEGV && siginfo->si_code == SEGV_ACCERR) {
81 fprintf(stderr, "Access violation detected.\n"
82 "This probably comes from a programming error in your code, or from a stack\n"
83 "overflow. If you are certain of your code, try increasing the stack size\n"
84 " --cfg=contexts/stack-size=XXX (current size is %d KiB).\n"
86 "If it does not help, this may have one of the following causes:\n"
87 "a bug in SimGrid, a bug in the OS or a bug in a third-party libraries.\n"
88 "Failing hardware can sometimes generate such errors too.\n"
90 "If you think you've found a bug in SimGrid, please report it along with a\n"
91 "Minimal Working Example (MWE) reproducing your problem and a full backtrace\n"
92 "of the fault captured with gdb or valgrind.\n",
93 smx_context_stack_size / 1024);
94 } else if (siginfo->si_signo == SIGSEGV) {
95 fprintf(stderr, "Segmentation fault.\n");
97 if (smpi_enabled() && smpi_privatize_global_variables == SMPI_PRIVATIZE_NONE) {
98 #if HAVE_PRIVATIZATION
99 fprintf(stderr, "Try to enable SMPI variable privatization with --cfg=smpi/privatization:yes.\n");
101 fprintf(stderr, "Sadly, your system does not support --cfg=smpi/privatization:yes (yet).\n");
102 #endif /* HAVE_PRIVATIZATION */
104 #endif /* HAVE_SMPI */
109 char sigsegv_stack[SIGSTKSZ]; /* alternate stack for SIGSEGV handler */
112 * Install signal handler for SIGSEGV. Check that nobody has already installed
113 * its own handler. For example, the Java VM does this.
115 static void install_segvhandler()
119 stack.ss_sp = sigsegv_stack;
120 stack.ss_size = sizeof sigsegv_stack;
123 if (sigaltstack(&stack, &old_stack) == -1) {
124 XBT_WARN("Failed to register alternate signal stack: %s", strerror(errno));
127 if (!(old_stack.ss_flags & SS_DISABLE)) {
128 XBT_DEBUG("An alternate stack was already installed (sp=%p, size=%zd, flags=%x). Restore it.",
129 old_stack.ss_sp, old_stack.ss_size, old_stack.ss_flags);
130 sigaltstack(&old_stack, nullptr);
133 struct sigaction action;
134 struct sigaction old_action;
135 action.sa_sigaction = &segvhandler;
136 action.sa_flags = SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
137 sigemptyset(&action.sa_mask);
139 if (sigaction(SIGSEGV, &action, &old_action) == -1) {
140 XBT_WARN("Failed to register signal handler for SIGSEGV: %s", strerror(errno));
143 if ((old_action.sa_flags & SA_SIGINFO) || old_action.sa_handler != SIG_DFL) {
144 XBT_DEBUG("A signal handler was already installed for SIGSEGV (%p). Restore it.",
145 (old_action.sa_flags & SA_SIGINFO) ? (void*)old_action.sa_sigaction : (void*)old_action.sa_handler);
146 sigaction(SIGSEGV, &old_action, nullptr);
152 /********************************* SIMIX **************************************/
153 double SIMIX_timer_next()
155 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
158 static void kill_process(smx_actor_t process)
160 SIMIX_process_kill(process, nullptr);
163 static std::function<void()> maestro_code;
168 simgrid::xbt::signal<void()> onDeadlock;
170 XBT_PUBLIC(void) set_maestro(std::function<void()> code)
172 maestro_code = std::move(code);
178 void SIMIX_set_maestro(void (*code)(void*), void* data)
181 XBT_INFO("WARNING, SIMIX_set_maestro is believed to not work on windows. Please help us investigating this issue if you need that feature");
183 maestro_code = std::bind(code, data);
188 * \brief Initialize SIMIX internal data.
193 void SIMIX_global_init(int *argc, char **argv)
196 // The communication initialization is done ASAP.
197 // We need to communicate initialization of the different layers to the model-checker.
198 simgrid::mc::Client::initialize();
202 simix_global = std::unique_ptr<simgrid::simix::Global>(new simgrid::simix::Global());
204 simgrid::simix::ActorImpl proc;
205 simix_global->process_to_run = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
206 simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
207 simix_global->process_to_destroy = xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
208 simix_global->maestro_process = nullptr;
209 simix_global->create_process_function = &SIMIX_process_create;
210 simix_global->kill_process_function = &kill_process;
211 simix_global->cleanup_process_function = &SIMIX_process_cleanup;
212 simix_global->mutex = xbt_os_mutex_init();
214 surf_init(argc, argv); /* Initialize SURF structures */
215 SIMIX_context_mod_init();
217 // Either create a new context with maestro or create
218 // a context object with the current context mestro):
219 simgrid::simix::create_maestro(maestro_code);
221 /* Prepare to display some more info when dying on Ctrl-C pressing */
222 signal(SIGINT, inthandler);
225 install_segvhandler();
227 /* register a function to be called by SURF after the environment creation */
229 simgrid::s4u::onPlatformCreated.connect(SIMIX_post_create_environment);
230 simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
231 if (host.extension<simgrid::simix::Host>() == nullptr) // another callback to the same signal may have created it
232 host.extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
235 simgrid::surf::storageCreatedCallbacks.connect([](simgrid::surf::Storage* storage) {
236 const char* name = storage->cname();
237 // TODO, create sg_storage_by_name
238 sg_storage_t s = xbt_lib_get_elm_or_null(storage_lib, name);
239 xbt_assert(s != nullptr, "Storage not found for name %s", name);
241 SIMIX_storage_create(name, s, nullptr);
244 SIMIX_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, SIMIX_storage_destroy);
247 simix_timers = xbt_heap_new(8, [](void* p) {
248 delete static_cast<smx_timer_t>(p);
251 if (xbt_cfg_get_boolean("clean-atexit"))
254 if (_sg_cfg_exit_asap)
261 * \brief Clean the SIMIX simulation
263 * This functions remove the memory used by SIMIX
268 return; // to avoid double cleaning by java and C
271 if (SIMIX_process_count()>0){
272 if(smpi_process()->initialized()){
273 xbt_die("Process exited without calling MPI_Finalize - Killing simulation");
275 XBT_WARN("Process called exit when leaving - Skipping cleanups");
282 XBT_DEBUG("SIMIX_clean called. Simulation's over.");
283 if (!xbt_dynar_is_empty(simix_global->process_to_run) && SIMIX_get_clock() <= 0.0) {
285 XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
286 XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
287 xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
289 /* Kill all processes (but maestro) */
290 SIMIX_process_killall(simix_global->maestro_process, 1);
292 /* Exit the SIMIX network module */
293 SIMIX_mailbox_exit();
295 xbt_heap_free(simix_timers);
296 simix_timers = nullptr;
297 /* Free the remaining data structures */
298 xbt_dynar_free(&simix_global->process_to_run);
299 xbt_dynar_free(&simix_global->process_that_ran);
300 xbt_swag_free(simix_global->process_to_destroy);
301 simix_global->process_list.clear();
302 simix_global->process_to_destroy = nullptr;
304 xbt_os_mutex_destroy(simix_global->mutex);
305 simix_global->mutex = nullptr;
307 xbt_dynar_free(&simix_global->actors_vector);
310 /* Let's free maestro now */
311 delete simix_global->maestro_process->context;
312 simix_global->maestro_process->context = nullptr;
313 delete simix_global->maestro_process;
314 simix_global->maestro_process = nullptr;
316 /* Finish context module and SURF */
317 SIMIX_context_mod_exit();
321 simix_global = nullptr;
327 * \brief A clock (in second).
329 * \return Return the clock.
331 double SIMIX_get_clock()
333 if(MC_is_active() || MC_record_replay_is_active()){
334 return MC_process_clock_get(SIMIX_process_self());
336 return surf_get_clock();
340 static int process_syscall_color(void *p)
342 switch ((*(smx_actor_t *)p)->simcall.call) {
344 case SIMCALL_PROCESS_KILL:
346 case SIMCALL_PROCESS_RESUME:
353 /** Wake up all processes waiting for a Surf action to finish */
354 static void SIMIX_wake_processes()
356 surf_action_t action;
358 for(auto model : *all_existing_models) {
359 XBT_DEBUG("Handling the processes whose action failed (if any)");
360 while ((action = surf_model_extract_failed_action_set(model))) {
361 XBT_DEBUG(" Handling Action %p",action);
362 SIMIX_simcall_exit((smx_activity_t) action->getData());
364 XBT_DEBUG("Handling the processes whose action terminated normally (if any)");
365 while ((action = surf_model_extract_done_action_set(model))) {
366 XBT_DEBUG(" Handling Action %p",action);
367 if (action->getData() == nullptr)
368 XBT_DEBUG("probably vcpu's action %p, skip", action);
370 SIMIX_simcall_exit((smx_activity_t) action->getData());
375 /** Handle any pending timer */
376 static bool SIMIX_execute_timers()
379 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
381 //FIXME: make the timers being real callbacks
382 // (i.e. provide dispatchers that read and expand the args)
383 smx_timer_t timer = (smx_timer_t) xbt_heap_pop(simix_timers);
388 xbt_die("Exception throwed ouf of timer callback");
395 /** Execute all the tasks that are queued
397 * e.g. `.then()` callbacks of futures.
399 static bool SIMIX_execute_tasks()
401 xbt_assert(simix_global->tasksTemp.empty());
403 if (simix_global->tasks.empty())
408 // We don't want the callbacks to modify the vector we are iterating over:
409 swap(simix_global->tasks, simix_global->tasksTemp);
411 // Execute all the queued tasks:
412 for (auto& task : simix_global->tasksTemp)
415 simix_global->tasksTemp.clear();
416 } while (!simix_global->tasks.empty());
423 * \brief Run the main simulation loop.
427 if (MC_record_path) {
428 simgrid::mc::replay(MC_record_path);
435 XBT_DEBUG("New Schedule Round; size(queue)=%lu", xbt_dynar_length(simix_global->process_to_run));
437 SIMIX_execute_tasks();
439 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
440 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu", xbt_dynar_length(simix_global->process_to_run));
442 /* Run all processes that are ready to run, possibly in parallel */
443 SIMIX_process_runall();
445 /* Move all killer processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
446 xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
448 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
450 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
452 /* Here, the order is ok because:
454 * Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
456 * Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
458 * - if there is no kill during the simulation, processes remain sorted according by their PID.
459 * rational: This can be proved inductively.
460 * Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
461 * Let's show that it is still so at the end of this round.
462 * - if a process is added when being created, that's from maestro. It can be either at startup
463 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
464 * in arbitrary order (inductive hypothesis), we are fine.
465 * - If a process is added because it's getting killed, its subsequent actions shouldn't matter
466 * - If a process gets added to process_to_run because one of their blocking action constituting the meat
467 * of a simcall terminates, we're still good. Proof:
468 * - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
469 * kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
470 * - For communications, this function is called from SIMIX_comm_finish().
471 * This function itself don't mess with the order since simcalls are handled in FIFO order.
472 * The function is called:
473 * - before the comm starts (invalid parameters, or resource already dead or whatever).
474 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
475 * - because the communication failed or were canceled after startup. In this case, it's called from the function
476 * we are in, by the chunk:
477 * set = model->states.failed_action_set;
478 * while ((synchro = xbt_swag_extract(set)))
479 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
480 * This order is also fixed because it depends of the order in which the surf actions were
481 * added to the system, and only maestro can add stuff this way, through simcalls.
482 * We thus use the inductive hypothesis once again to conclude that the order in which synchros are
483 * poped out of the swag does not depend on the user code's execution order.
484 * - because the communication terminated. In this case, synchros are served in the order given by
485 * set = model->states.done_action_set;
486 * while ((synchro = xbt_swag_extract(set)))
487 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
488 * and the argument is very similar to the previous one.
489 * So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
490 * So, in any cases, the orders of processes within process_to_run do not depend on the order in which user processes were executed previously.
491 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
492 * - If there is some process killings, the order is changed by this decision that comes from user-land
493 * But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
494 * So, even the order change induced by the process killing is perfectly reproducible.
496 * So science works, bitches [http://xkcd.com/54/].
498 * We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
499 * (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
500 * That would thus be a pure waste of time.
505 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
506 if (process->simcall.call != SIMCALL_NONE) {
507 SIMIX_simcall_handle(&process->simcall, 0);
511 SIMIX_execute_tasks();
513 SIMIX_wake_processes();
514 } while (SIMIX_execute_tasks());
516 /* If only daemon processes remain, cancel their actions, mark them to die and reschedule them */
517 if (simix_global->process_list.size() == simix_global->daemons.size())
518 for (const auto& dmon : simix_global->daemons) {
519 XBT_DEBUG("Kill %s", dmon->cname());
520 SIMIX_process_kill(dmon, simix_global->maestro_process);
524 time = SIMIX_timer_next();
525 if (time > -1.0 || simix_global->process_list.empty() == false) {
526 XBT_DEBUG("Calling surf_solve");
527 time = surf_solve(time);
528 XBT_DEBUG("Moving time ahead : %g", time);
531 /* Notify all the hosts that have failed */
532 /* FIXME: iterate through the list of failed host and mark each of them */
533 /* as failed. On each host, signal all the running processes with host_fail */
535 // Execute timers and tasks until there isn't anything to be done:
538 again = SIMIX_execute_timers();
539 if (SIMIX_execute_tasks())
541 SIMIX_wake_processes();
544 /* Autorestart all process */
545 for (auto host: host_that_restart) {
546 XBT_INFO("Restart processes on host %s", host->cname());
547 SIMIX_host_autorestart(host);
549 host_that_restart.clear();
551 /* Clean processes to destroy */
552 SIMIX_process_empty_trash();
554 XBT_DEBUG("### time %f, #processes %zu, #to_run %lu", time, simix_global->process_list.size(),
555 xbt_dynar_length(simix_global->process_to_run));
558 if (xbt_dynar_is_empty(simix_global->process_to_run) &&
559 !simix_global->process_list.empty())
560 simgrid::simix::onDeadlock();
562 } while (time > -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
564 if (simix_global->process_list.size() != 0) {
568 XBT_CRITICAL("Oops ! Deadlock or code not perfectly clean.");
569 SIMIX_display_process_status();
572 simgrid::s4u::onSimulationEnd();
576 * \brief Set the date to execute a function
578 * Set the date to execute the function on the surf.
579 * \param date Date to execute function
580 * \param callback Function to be executed
581 * \param arg Parameters of the function
584 smx_timer_t SIMIX_timer_set(double date, void (*callback)(void*), void *arg)
586 smx_timer_t timer = new s_smx_timer_t(date, [=](){ callback(arg); });
587 xbt_heap_push(simix_timers, timer, date);
591 smx_timer_t SIMIX_timer_set(double date, simgrid::xbt::Task<void()> callback)
593 smx_timer_t timer = new s_smx_timer_t(date, std::move(callback));
594 xbt_heap_push(simix_timers, timer, date);
598 /** @brief cancels a timer that was added earlier */
599 void SIMIX_timer_remove(smx_timer_t timer) {
600 xbt_heap_rm_elm(simix_timers, timer, timer->date);
603 /** @brief Returns the date at which the timer will trigger (or 0 if nullptr timer) */
604 double SIMIX_timer_get_date(smx_timer_t timer) {
605 return timer?timer->date:0;
609 * \brief Registers a function to create a process.
611 * This function registers a function to be called
612 * when a new process is created. The function has
613 * to call SIMIX_process_create().
614 * \param function create process function
616 void SIMIX_function_register_process_create(smx_creation_func_t function)
618 simix_global->create_process_function = function;
622 * \brief Registers a function to kill a process.
624 * This function registers a function to be called when a process is killed. The function has to call the
625 * SIMIX_process_kill().
627 * \param function Kill process function
629 void SIMIX_function_register_process_kill(void_pfn_smxprocess_t function)
631 simix_global->kill_process_function = function;
635 * \brief Registers a function to cleanup a process.
637 * This function registers a user function to be called when a process ends properly.
639 * \param function cleanup process function
641 void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function)
643 simix_global->cleanup_process_function = function;
647 void SIMIX_display_process_status()
649 int nbprocess = simix_global->process_list.size();
651 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
652 /* List the process and their state */
653 XBT_INFO("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
654 for (auto kv : simix_global->process_list) {
655 smx_actor_t process = kv.second;
657 if (process->waiting_synchro) {
659 const char* synchro_description = "unknown";
661 if (dynamic_cast<simgrid::kernel::activity::Exec*>(process->waiting_synchro) != nullptr)
662 synchro_description = "execution";
664 if (dynamic_cast<simgrid::kernel::activity::Comm*>(process->waiting_synchro) != nullptr)
665 synchro_description = "communication";
667 if (dynamic_cast<simgrid::kernel::activity::Sleep*>(process->waiting_synchro) != nullptr)
668 synchro_description = "sleeping";
670 if (dynamic_cast<simgrid::kernel::activity::Raw*>(process->waiting_synchro) != nullptr)
671 synchro_description = "synchronization";
673 if (dynamic_cast<simgrid::kernel::activity::Io*>(process->waiting_synchro) != nullptr)
674 synchro_description = "I/O";
678 switch (process->waiting_synchro->type) {
679 case SIMIX_SYNC_PARALLEL_EXECUTE:
680 synchro_description = "parallel execution";
683 case SIMIX_SYNC_JOIN:
684 synchro_description = "joining";
688 XBT_INFO("Process %lu (%s@%s): waiting for %s synchro %p (%s) in state %d to finish", process->pid,
689 process->cname(), process->host->cname(), synchro_description, process->waiting_synchro,
690 process->waiting_synchro->name.c_str(), (int)process->waiting_synchro->state);
693 XBT_INFO("Process %lu (%s@%s)", process->pid, process->cname(), process->host->cname());
698 int SIMIX_is_maestro()
700 smx_actor_t self = SIMIX_process_self();
701 return simix_global == nullptr /*SimDag*/ || self == nullptr || self == simix_global->maestro_process;