1 /* Copyright (c) 2007-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include <signal.h> /* Signal handling */
9 #include "src/internal_config.h"
11 #include "src/surf/surf_interface.hpp"
12 #include "src/surf/storage_interface.hpp"
13 #include "src/surf/xml/platf.hpp"
14 #include "smx_private.h"
15 #include "smx_private.hpp"
17 #include "xbt/ex.h" /* ex_backtrace_display */
19 #include "src/mc/mc_replay.h"
20 #include "simgrid/sg_config.h"
22 #include "src/simix/SynchroExec.hpp"
23 #include "src/simix/SynchroComm.hpp"
24 #include "src/simix/SynchroSleep.hpp"
25 #include "src/simix/SynchroIo.hpp"
26 #include "src/simix/SynchroRaw.hpp"
29 #include "src/mc/mc_private.h"
30 #include "src/mc/mc_protocol.h"
31 #include "src/mc/Client.hpp"
34 #include "src/mc/mc_protocol.h"
37 #include "src/mc/mc_record.h"
40 #include "src/smpi/private.h"
43 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
44 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix, "Logging specific to SIMIX (kernel)");
46 smx_global_t simix_global = NULL;
47 static xbt_heap_t simix_timers = NULL;
49 /** @brief Timer datatype */
50 typedef struct s_smx_timer {
56 void (*SMPI_switch_data_segment)(int) = NULL;
58 int _sg_do_verbose_exit = 1;
59 static void inthandler(int ignored)
61 if ( _sg_do_verbose_exit ) {
62 XBT_INFO("CTRL-C pressed. The current status will be displayed before exit (disable that behavior with option 'verbose-exit').");
63 SIMIX_display_process_status();
66 XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'verbose-exit' is set to false.");
72 static void segvhandler(int signum, siginfo_t *siginfo, void *context)
74 if (siginfo->si_signo == SIGSEGV && siginfo->si_code == SEGV_ACCERR) {
76 "Access violation detected.\n"
77 "This can result from a programming error in your code or, although less likely,\n"
78 "from a bug in SimGrid itself. This can also be the sign of a bug in the OS or\n"
79 "in third-party libraries. Failing hardware can sometimes generate such errors\n"
81 "Finally, if nothing of the above applies, this can result from a stack overflow.\n"
82 "Try to increase stack size with --cfg=contexts/stack_size (current size is %d KiB).\n",
83 smx_context_stack_size / 1024);
84 if (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
86 "siginfo = {si_signo = %d, si_errno = %d, si_code = %d, si_addr = %p}\n",
87 siginfo->si_signo, siginfo->si_errno, siginfo->si_code, siginfo->si_addr);
89 } else if (siginfo->si_signo == SIGSEGV) {
90 fprintf(stderr, "Segmentation fault.\n");
92 if (smpi_enabled() && !smpi_privatize_global_variables) {
93 #if HAVE_PRIVATIZATION
95 "Try to enable SMPI variable privatization with --cfg=smpi/privatize-global-variables:yes.\n");
98 "Sadly, your system does not support --cfg=smpi/privatize-global-variables:yes (yet).\n");
99 #endif /* HAVE_PRIVATIZATION */
101 #endif /* HAVE_SMPI */
106 char sigsegv_stack[SIGSTKSZ]; /* alternate stack for SIGSEGV handler */
109 * Install signal handler for SIGSEGV. Check that nobody has already installed
110 * its own handler. For example, the Java VM does this.
112 static void install_segvhandler(void)
114 stack_t stack, old_stack;
115 stack.ss_sp = sigsegv_stack;
116 stack.ss_size = sizeof sigsegv_stack;
119 if (sigaltstack(&stack, &old_stack) == -1) {
120 XBT_WARN("Failed to register alternate signal stack: %s", strerror(errno));
123 if (!(old_stack.ss_flags & SS_DISABLE)) {
124 XBT_DEBUG("An alternate stack was already installed (sp=%p, size=%zd, flags=%x). Restore it.",
125 old_stack.ss_sp, old_stack.ss_size, old_stack.ss_flags);
126 sigaltstack(&old_stack, NULL);
129 struct sigaction action, old_action;
130 action.sa_sigaction = segvhandler;
131 action.sa_flags = SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
132 sigemptyset(&action.sa_mask);
134 if (sigaction(SIGSEGV, &action, &old_action) == -1) {
135 XBT_WARN("Failed to register signal handler for SIGSEGV: %s", strerror(errno));
138 if ((old_action.sa_flags & SA_SIGINFO) || old_action.sa_handler != SIG_DFL) {
139 XBT_DEBUG("A signal handler was already installed for SIGSEGV (%p). Restore it.",
140 (old_action.sa_flags & SA_SIGINFO) ?
141 (void*)old_action.sa_sigaction : (void*)old_action.sa_handler);
142 sigaction(SIGSEGV, &old_action, NULL);
148 /********************************* SIMIX **************************************/
149 double SIMIX_timer_next(void)
151 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
154 static void kill_process(smx_process_t process)
156 SIMIX_process_kill(process, NULL);
159 static std::function<void()> maestro_code;
164 XBT_PUBLIC(void) set_maestro(std::function<void()> code)
166 maestro_code = std::move(code);
172 void SIMIX_set_maestro(void (*code)(void*), void* data)
174 maestro_code = std::bind(code, data);
179 * \brief Initialize SIMIX internal data.
184 void SIMIX_global_init(int *argc, char **argv)
187 // The communication initialization is done ASAP.
188 // We need to communicate initialization of the different layers to the model-checker.
189 simgrid::mc::Client::initialize();
192 s_smx_process_t proc;
195 simix_global = xbt_new0(s_smx_global_t, 1);
197 simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
198 simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
199 simix_global->process_list = xbt_swag_new(xbt_swag_offset(proc, process_hookup));
200 simix_global->process_to_destroy = xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
202 simix_global->maestro_process = NULL;
203 simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
205 simix_global->create_process_function = SIMIX_process_create;
206 simix_global->kill_process_function = kill_process;
207 simix_global->cleanup_process_function = SIMIX_process_cleanup;
208 simix_global->mutex = xbt_os_mutex_init();
210 surf_init(argc, argv); /* Initialize SURF structures */
211 SIMIX_context_mod_init();
213 // Either create a new context with maestro or create
214 // a context object with the current context mestro):
215 simgrid::simix::create_maestro(maestro_code);
217 /* context exception handlers */
218 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
219 __xbt_ex_terminate = SIMIX_process_exception_terminate;
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::surf::on_postparse.connect(SIMIX_post_create_environment);
230 simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
231 SIMIX_host_create(&host);
233 SIMIX_HOST_LEVEL = simgrid::s4u::Host::extension_create(SIMIX_host_destroy);
235 simgrid::surf::storageCreatedCallbacks.connect([](simgrid::surf::Storage* storage) {
236 const char* name = storage->getName();
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 != NULL, "Storage not found for name %s", name);
241 SIMIX_storage_create(name, s, NULL);
244 SIMIX_STORAGE_LEVEL = xbt_lib_add_level(storage_lib, SIMIX_storage_destroy);
247 simix_timers = xbt_heap_new(8, &free);
250 if (xbt_cfg_get_boolean("clean-atexit"))
253 if (_sg_cfg_exit_asap)
260 * \brief Clean the SIMIX simulation
262 * This functions remove the memory used by SIMIX
264 void SIMIX_clean(void)
266 if (smx_cleaned) return; // to avoid double cleaning by java and C
268 XBT_DEBUG("SIMIX_clean called. Simulation's over.");
269 if (!xbt_dynar_is_empty(simix_global->process_to_run) && SIMIX_get_clock() == 0.0) {
271 XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
272 XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
273 xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
275 /* Kill all processes (but maestro) */
276 SIMIX_process_killall(simix_global->maestro_process, 1);
278 /* Exit the SIMIX network module */
279 SIMIX_mailbox_exit();
281 xbt_heap_free(simix_timers);
283 /* Free the remaining data structures */
284 xbt_dynar_free(&simix_global->process_to_run);
285 xbt_dynar_free(&simix_global->process_that_ran);
286 xbt_swag_free(simix_global->process_to_destroy);
287 xbt_swag_free(simix_global->process_list);
288 simix_global->process_list = NULL;
289 simix_global->process_to_destroy = NULL;
290 xbt_dict_free(&(simix_global->registered_functions));
292 xbt_os_mutex_destroy(simix_global->mutex);
293 simix_global->mutex = NULL;
295 /* Let's free maestro now */
296 SIMIX_context_free(simix_global->maestro_process->context);
297 xbt_free(simix_global->maestro_process->running_ctx);
298 xbt_free(simix_global->maestro_process);
299 simix_global->maestro_process = NULL;
301 /* Restore the default exception setup */
302 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
303 __xbt_ex_terminate = &__xbt_ex_terminate_default;
305 /* Finish context module and SURF */
306 SIMIX_context_mod_exit();
310 xbt_free(simix_global);
319 * \brief A clock (in second).
321 * \return Return the clock.
323 double SIMIX_get_clock(void)
325 if(MC_is_active() || MC_record_replay_is_active()){
326 return MC_process_clock_get(SIMIX_process_self());
328 return surf_get_clock();
332 static int process_syscall_color(void *p)
334 switch ((*(smx_process_t *)p)->simcall.call) {
336 case SIMCALL_PROCESS_KILL:
338 case SIMCALL_PROCESS_RESUME:
347 * \brief Run the main simulation loop.
351 if (MC_record_path) {
352 simgrid::mc::replay(MC_record_path);
357 smx_process_t process;
358 surf_action_t action;
364 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
365 xbt_dynar_length(simix_global->process_to_run));
366 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
367 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
368 xbt_dynar_length(simix_global->process_to_run));
370 /* Run all processes that are ready to run, possibly in parallel */
371 SIMIX_process_runall();
373 /* Move all killer processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
374 xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
376 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
378 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
380 /* Here, the order is ok because:
382 * Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
384 * Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
386 * - if there is no kill during the simulation, processes remain sorted according by their PID.
387 * rational: This can be proved inductively.
388 * Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
389 * Let's show that it is still so at the end of this round.
390 * - if a process is added when being created, that's from maestro. It can be either at startup
391 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
392 * in arbitrary order (inductive hypothesis), we are fine.
393 * - If a process is added because it's getting killed, its subsequent actions shouldn't matter
394 * - If a process gets added to process_to_run because one of their blocking action constituting the meat
395 * of a simcall terminates, we're still good. Proof:
396 * - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
397 * kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
398 * - For communications, this function is called from SIMIX_comm_finish().
399 * This function itself don't mess with the order since simcalls are handled in FIFO order.
400 * The function is called:
401 * - before the comm starts (invalid parameters, or resource already dead or whatever).
402 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
403 * - because the communication failed or were canceled after startup. In this case, it's called from the function
404 * we are in, by the chunk:
405 * set = model->states.failed_action_set;
406 * while ((synchro = xbt_swag_extract(set)))
407 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
408 * This order is also fixed because it depends of the order in which the surf actions were
409 * added to the system, and only maestro can add stuff this way, through simcalls.
410 * We thus use the inductive hypothesis once again to conclude that the order in which synchros are
411 * poped out of the swag does not depend on the user code's execution order.
412 * - because the communication terminated. In this case, synchros are served in the order given by
413 * set = model->states.done_action_set;
414 * while ((synchro = xbt_swag_extract(set)))
415 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
416 * and the argument is very similar to the previous one.
417 * So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
418 * 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.
419 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
420 * - If there is some process killings, the order is changed by this decision that comes from user-land
421 * But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
422 * So, even the order change induced by the process killing is perfectly reproducible.
424 * So science works, bitches [http://xkcd.com/54/].
426 * We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
427 * (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
428 * That would thus be a pure waste of time.
431 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
432 if (process->simcall.call != SIMCALL_NONE) {
433 SIMIX_simcall_handle(&process->simcall, 0);
436 /* Wake up all processes waiting for a Surf action to finish */
437 xbt_dynar_foreach(all_existing_models, iter, model) {
438 XBT_DEBUG("Handling process whose action failed");
439 while ((action = surf_model_extract_failed_action_set(model))) {
440 XBT_DEBUG(" Handling Action %p",action);
441 SIMIX_simcall_exit((smx_synchro_t) action->getData());
443 XBT_DEBUG("Handling process whose action terminated normally");
444 while ((action = surf_model_extract_done_action_set(model))) {
445 XBT_DEBUG(" Handling Action %p",action);
446 if (action->getData() == NULL)
447 XBT_DEBUG("probably vcpu's action %p, skip", action);
449 SIMIX_simcall_exit((smx_synchro_t) action->getData());
454 time = SIMIX_timer_next();
455 if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0) {
456 XBT_DEBUG("Calling surf_solve");
457 time = surf_solve(time);
458 XBT_DEBUG("Moving time ahead : %g", time);
460 /* Notify all the hosts that have failed */
461 /* FIXME: iterate through the list of failed host and mark each of them */
462 /* as failed. On each host, signal all the running processes with host_fail */
464 /* Handle any pending timer */
465 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
466 //FIXME: make the timers being real callbacks
467 // (i.e. provide dispatchers that read and expand the args)
468 timer = (smx_timer_t) xbt_heap_pop(simix_timers);
470 timer->func(timer->args);
474 /* Wake up all processes waiting for a Surf action to finish */
475 xbt_dynar_foreach(all_existing_models, iter, model) {
476 XBT_DEBUG("Handling process whose action failed");
477 while ((action = surf_model_extract_failed_action_set(model))) {
478 XBT_DEBUG(" Handling Action %p",action);
479 SIMIX_simcall_exit((smx_synchro_t) action->getData());
481 XBT_DEBUG("Handling process whose action terminated normally");
482 while ((action = surf_model_extract_done_action_set(model))) {
483 XBT_DEBUG(" Handling Action %p",action);
484 if (action->getData() == NULL)
485 XBT_DEBUG("probably vcpu's action %p, skip", action);
487 SIMIX_simcall_exit((smx_synchro_t) action->getData());
491 /* Autorestart all process */
492 char *hostname = NULL;
493 xbt_dynar_foreach(host_that_restart,iter,hostname) {
494 XBT_INFO("Restart processes on host: %s",hostname);
495 SIMIX_host_autorestart(sg_host_by_name(hostname));
497 xbt_dynar_reset(host_that_restart);
499 /* Clean processes to destroy */
500 SIMIX_process_empty_trash();
503 XBT_DEBUG("### time %f, empty %d", time, xbt_dynar_is_empty(simix_global->process_to_run));
505 } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
507 if (xbt_swag_size(simix_global->process_list) != 0) {
511 XBT_CRITICAL("Oops ! Deadlock or code not perfectly clean.");
512 SIMIX_display_process_status();
518 * \brief Set the date to execute a function
520 * Set the date to execute the function on the surf.
521 * \param date Date to execute function
522 * \param function Function to be executed
523 * \param arg Parameters of the function
526 smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void *arg)
528 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
531 timer->func = function;
533 xbt_heap_push(simix_timers, timer, date);
536 /** @brief cancels a timer that was added earlier */
537 void SIMIX_timer_remove(smx_timer_t timer) {
538 xbt_heap_rm_elm(simix_timers, timer, timer->date);
541 /** @brief Returns the date at which the timer will trigger (or 0 if NULL timer) */
542 double SIMIX_timer_get_date(smx_timer_t timer) {
543 return timer?timer->date:0;
547 * \brief Registers a function to create a process.
549 * This function registers a function to be called
550 * when a new process is created. The function has
551 * to call SIMIX_process_create().
552 * \param function create process function
554 void SIMIX_function_register_process_create(smx_creation_func_t
557 simix_global->create_process_function = function;
561 * \brief Registers a function to kill a process.
563 * This function registers a function to be called when a
564 * process is killed. The function has to call the SIMIX_process_kill().
566 * \param function Kill process function
568 void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
571 simix_global->kill_process_function = function;
575 * \brief Registers a function to cleanup a process.
577 * This function registers a user function to be called when
578 * a process ends properly.
580 * \param function cleanup process function
582 void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
585 simix_global->cleanup_process_function = function;
589 void SIMIX_display_process_status(void)
591 if (simix_global->process_list == NULL) {
595 smx_process_t process = NULL;
596 int nbprocess = xbt_swag_size(simix_global->process_list);
598 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
599 /* List the process and their state */
601 ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
602 xbt_swag_foreach(process, simix_global->process_list) {
604 if (process->waiting_synchro) {
606 const char* synchro_description = "unknown";
608 if (dynamic_cast<simgrid::simix::Exec*>(process->waiting_synchro) != nullptr)
609 synchro_description = "execution";
611 if (dynamic_cast<simgrid::simix::Comm*>(process->waiting_synchro) != nullptr)
612 synchro_description = "communication";
614 if (dynamic_cast<simgrid::simix::Sleep*>(process->waiting_synchro) != nullptr)
615 synchro_description = "sleeping";
617 if (dynamic_cast<simgrid::simix::Raw*>(process->waiting_synchro) != nullptr)
618 synchro_description = "synchronization";
620 if (dynamic_cast<simgrid::simix::Io*>(process->waiting_synchro) != nullptr)
621 synchro_description = "I/O";
625 switch (process->waiting_synchro->type) {
626 case SIMIX_SYNC_PARALLEL_EXECUTE:
627 synchro_description = "parallel execution";
630 case SIMIX_SYNC_JOIN:
631 synchro_description = "joining";
635 XBT_INFO("Process %lu (%s@%s): waiting for %s synchro %p (%s) in state %d to finish",
636 process->pid, process->name, sg_host_get_name(process->host),
637 synchro_description, process->waiting_synchro,
638 process->waiting_synchro->name, (int)process->waiting_synchro->state);
641 XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, sg_host_get_name(process->host));
646 xbt_dict_t simcall_HANDLER_asr_get_properties(smx_simcall_t simcall, const char *name){
647 return SIMIX_asr_get_properties(name);
649 xbt_dict_t SIMIX_asr_get_properties(const char *name)
651 return (xbt_dict_t) xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);
654 int SIMIX_is_maestro()
656 return simix_global==NULL /*SimDag*/|| SIMIX_process_self() == simix_global->maestro_process;