Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Save a cast per action completion
[simgrid.git] / src / simix / smx_global.cpp
1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "mc/mc.h"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "simgrid/s4u/Host.hpp"
9 #include "src/smpi/include/smpi_actor.hpp"
10
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"
22
23 #if SIMGRID_HAVE_MC
24 #include "src/mc/remote/Client.hpp"
25 #endif
26
27
28 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix, "Logging specific to SIMIX (kernel)");
30
31 std::unique_ptr<simgrid::simix::Global> simix_global;
32
33 void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr) = nullptr;
34
35 bool _sg_do_verbose_exit = true;
36 static void inthandler(int)
37 {
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();
41   }
42   else {
43      XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'verbose-exit' is set to false.");
44   }
45   exit(1);
46 }
47
48 #ifndef _WIN32
49 static void segvhandler(int signum, siginfo_t* siginfo, void* /*context*/)
50 {
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"
56                     "\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"
60                     "\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");
67 #if HAVE_SMPI
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");
71 #else
72       fprintf(stderr, "Sadly, your system does not support --cfg=smpi/privatization:yes (yet).\n");
73 #endif /* HAVE_PRIVATIZATION */
74     }
75 #endif /* HAVE_SMPI */
76   }
77   std::raise(signum);
78 }
79
80 unsigned char sigsegv_stack[SIGSTKSZ]; /* alternate stack for SIGSEGV handler */
81
82 /**
83  * Install signal handler for SIGSEGV.  Check that nobody has already installed
84  * its own handler.  For example, the Java VM does this.
85  */
86 static void install_segvhandler()
87 {
88   stack_t stack;
89   stack_t old_stack;
90   stack.ss_sp = sigsegv_stack;
91   stack.ss_size = sizeof sigsegv_stack;
92   stack.ss_flags = 0;
93
94   if (sigaltstack(&stack, &old_stack) == -1) {
95     XBT_WARN("Failed to register alternate signal stack: %s", strerror(errno));
96     return;
97   }
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);
102   }
103
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);
109
110   if (sigaction(SIGSEGV, &action, &old_action) == -1) {
111     XBT_WARN("Failed to register signal handler for SIGSEGV: %s", strerror(errno));
112     return;
113   }
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);
118   }
119 }
120
121 #endif /* _WIN32 */
122
123 /********************************* SIMIX **************************************/
124 namespace simgrid {
125 namespace simix {
126
127 Timer* Timer::set(double date, simgrid::xbt::Task<void()>&& callback)
128 {
129   Timer* timer   = new Timer(date, std::move(callback));
130   timer->handle_ = simix_timers.emplace(std::make_pair(date, timer));
131   return timer;
132 }
133
134 /** @brief cancels a timer that was added earlier */
135 void Timer::remove()
136 {
137   simgrid::simix::simix_timers.erase(handle_);
138   delete this;
139 }
140
141 void Global::empty_trash()
142 {
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);
148   }
149 #if SIMGRID_HAVE_MC
150   xbt_dynar_reset(simix_global->dead_actors_vector);
151 #endif
152 }
153 /**
154  * @brief Executes the actors in simix_global->actors_to_run.
155  *
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.
159  */
160 void Global::run_all_actors()
161 {
162   SIMIX_context_runall();
163
164   simix_global->actors_to_run.swap(simix_global->actors_that_ran);
165   simix_global->actors_to_run.clear();
166 }
167
168 simgrid::config::Flag<double> breakpoint{"simix/breakpoint",
169                                          "When non-negative, raise a SIGTRAP after given (simulated) time", -1.0};
170 }
171 }
172
173 static simgrid::simix::ActorCode maestro_code;
174 void SIMIX_set_maestro(void (*code)(void*), void* data)
175 {
176 #ifdef _WIN32
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");
178 #endif
179   maestro_code = std::bind(code, data);
180 }
181
182 /**
183  * @ingroup SIMIX_API
184  * @brief Initialize SIMIX internal data.
185  */
186 void SIMIX_global_init(int *argc, char **argv)
187 {
188 #if SIMGRID_HAVE_MC
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();
192 #endif
193
194   if (simix_global == nullptr) {
195     surf_init(argc, argv); /* Initialize SURF structures */
196
197     simix_global.reset(new simgrid::simix::Global());
198     simix_global->maestro_process = nullptr;
199     SIMIX_context_mod_init();
200
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);
204
205     /* Prepare to display some more info when dying on Ctrl-C pressing */
206     std::signal(SIGINT, inthandler);
207
208 #ifndef _WIN32
209     install_segvhandler();
210 #endif
211     /* register a function to be called by SURF after the environment creation */
212     sg_platf_init();
213     simgrid::s4u::on_platform_created.connect(surf_presolve);
214
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());
218     });
219   }
220
221   if (simgrid::config::get_value<bool>("clean-atexit"))
222     atexit(SIMIX_clean);
223 }
224
225 int smx_cleaned = 0;
226 /**
227  * @ingroup SIMIX_API
228  * @brief Clean the SIMIX simulation
229  *
230  * This functions remove the memory used by SIMIX
231  */
232 void SIMIX_clean()
233 {
234   if (smx_cleaned)
235     return; // to avoid double cleaning by java and C
236
237   smx_cleaned = 1;
238   XBT_DEBUG("SIMIX_clean called. Simulation's over.");
239   if (not simix_global->actors_to_run.empty() && SIMIX_get_clock() <= 0.0) {
240     XBT_CRITICAL("   ");
241     XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
242     XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
243     xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
244   }
245
246 #if HAVE_SMPI
247   if (SIMIX_process_count()>0){
248     if(smpi_process()->initialized()){
249       xbt_die("Process exited without calling MPI_Finalize - Killing simulation");
250     }else{
251       XBT_WARN("Process called exit when leaving - Skipping cleanups");
252       return;
253     }
254   }
255 #endif
256
257   /* Kill all processes (but maestro) */
258   simix_global->maestro_process->kill_all();
259   SIMIX_context_runall();
260   simix_global->empty_trash();
261
262   /* Exit the SIMIX network module */
263   SIMIX_mailbox_exit();
264
265   while (not simgrid::simix::simix_timers.empty()) {
266     delete simgrid::simix::simix_timers.top().second;
267     simgrid::simix::simix_timers.pop();
268   }
269   /* Free the remaining data structures */
270   simix_global->actors_to_run.clear();
271   simix_global->actors_that_ran.clear();
272   simix_global->actors_to_destroy.clear();
273   simix_global->process_list.clear();
274
275 #if SIMGRID_HAVE_MC
276   xbt_dynar_free(&simix_global->actors_vector);
277   xbt_dynar_free(&simix_global->dead_actors_vector);
278 #endif
279
280   /* Let's free maestro now */
281   delete simix_global->maestro_process;
282   simix_global->maestro_process = nullptr;
283
284   /* Finish context module and SURF */
285   SIMIX_context_mod_exit();
286
287   surf_exit();
288
289   simix_global = nullptr;
290 }
291
292 /**
293  * @ingroup SIMIX_API
294  * @brief A clock (in second).
295  *
296  * @return Return the clock.
297  */
298 double SIMIX_get_clock()
299 {
300   if(MC_is_active() || MC_record_replay_is_active()){
301     return MC_process_clock_get(SIMIX_process_self());
302   }else{
303     return surf_get_clock();
304   }
305 }
306
307 /** Wake up all processes waiting for a Surf action to finish */
308 static void SIMIX_wake_processes()
309 {
310   for (auto const& model : all_existing_models) {
311     simgrid::kernel::resource::Action* action;
312
313     XBT_DEBUG("Handling the processes whose action failed (if any)");
314     while ((action = model->extract_failed_action())) {
315       XBT_DEBUG("   Handling Action %p",action);
316       SIMIX_simcall_exit(action->get_activity());
317     }
318     XBT_DEBUG("Handling the processes whose action terminated normally (if any)");
319     while ((action = model->extract_done_action())) {
320       XBT_DEBUG("   Handling Action %p",action);
321       if (action->get_activity() == nullptr)
322         XBT_DEBUG("probably vcpu's action %p, skip", action);
323       else
324         SIMIX_simcall_exit(action->get_activity());
325     }
326   }
327 }
328
329 /** Handle any pending timer */
330 static bool SIMIX_execute_timers()
331 {
332   bool result = false;
333   while (not simgrid::simix::simix_timers.empty() && SIMIX_get_clock() >= simgrid::simix::simix_timers.top().first) {
334     result = true;
335     // FIXME: make the timers being real callbacks (i.e. provide dispatchers that read and expand the args)
336     smx_timer_t timer = simgrid::simix::simix_timers.top().second;
337     simgrid::simix::simix_timers.pop();
338     try {
339       timer->callback();
340     } catch (...) {
341       xbt_die("Exception thrown ouf of timer callback");
342     }
343     delete timer;
344   }
345   return result;
346 }
347
348 /** Execute all the tasks that are queued
349  *
350  *  e.g. `.then()` callbacks of futures.
351  **/
352 static bool SIMIX_execute_tasks()
353 {
354   xbt_assert(simix_global->tasksTemp.empty());
355
356   if (simix_global->tasks.empty())
357     return false;
358
359   do {
360     // We don't want the callbacks to modify the vector we are iterating over:
361     simix_global->tasks.swap(simix_global->tasksTemp);
362
363     // Execute all the queued tasks:
364     for (auto& task : simix_global->tasksTemp)
365       task();
366
367     simix_global->tasksTemp.clear();
368   } while (not simix_global->tasks.empty());
369
370   return true;
371 }
372
373 /**
374  * @ingroup SIMIX_API
375  * @brief Run the main simulation loop.
376  */
377 void SIMIX_run()
378 {
379   if (not MC_record_path.empty()) {
380     simgrid::mc::replay(MC_record_path);
381     return;
382   }
383
384   double time = 0;
385
386   do {
387     XBT_DEBUG("New Schedule Round; size(queue)=%zu", simix_global->actors_to_run.size());
388
389     if (simgrid::simix::breakpoint >= 0.0 && surf_get_clock() >= simgrid::simix::breakpoint) {
390       XBT_DEBUG("Breakpoint reached (%g)", simgrid::simix::breakpoint.get());
391       simgrid::simix::breakpoint = -1.0;
392 #ifdef SIGTRAP
393       std::raise(SIGTRAP);
394 #else
395       std::raise(SIGABRT);
396 #endif
397     }
398
399     SIMIX_execute_tasks();
400
401     while (not simix_global->actors_to_run.empty()) {
402       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", simix_global->actors_to_run.size());
403
404       /* Run all processes that are ready to run, possibly in parallel */
405       simix_global->run_all_actors();
406
407       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
408
409       /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
410
411       /* Here, the order is ok because:
412        *
413        *   Short proof: only maestro adds stuff to the actors_to_run array, so the execution order of user contexts do
414        *   not impact its order.
415        *
416        *   Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
417        *
418        *   - if there is no kill during the simulation, processes remain sorted according by their PID.
419        *     Rationale: This can be proved inductively.
420        *        Assume that actors_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
421        *        is parsed linearly).
422        *        Let's show that it is still so at the end of this round.
423        *        - if a process is added when being created, that's from maestro. It can be either at startup
424        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
425        *          in arbitrary order (inductive hypothesis), we are fine.
426        *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
427        *        - If a process gets added to actors_to_run because one of their blocking action constituting the meat
428        *          of a simcall terminates, we're still good. Proof:
429        *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
430        *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an
431        *            example.
432        *          - For communications, this function is called from SIMIX_comm_finish().
433        *            This function itself don't mess with the order since simcalls are handled in FIFO order.
434        *            The function is called:
435        *            - before the comm starts (invalid parameters, or resource already dead or whatever).
436        *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
437        *            - because the communication failed or were canceled after startup. In this case, it's called from
438        *              the function we are in, by the chunk:
439        *                       set = model->states.failed_action_set;
440        *                       while ((synchro = extract(set)))
441        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
442        *              This order is also fixed because it depends of the order in which the surf actions were
443        *              added to the system, and only maestro can add stuff this way, through simcalls.
444        *              We thus use the inductive hypothesis once again to conclude that the order in which synchros are
445        *              poped out of the set does not depend on the user code's execution order.
446        *            - because the communication terminated. In this case, synchros are served in the order given by
447        *                       set = model->states.done_action_set;
448        *                       while ((synchro = extract(set)))
449        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
450        *              and the argument is very similar to the previous one.
451        *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user
452        *            processes are executed.
453        *          So, in any cases, the orders of processes within actors_to_run do not depend on the order in which
454        *          user processes were executed previously.
455        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
456        *   - If there is some process killings, the order is changed by this decision that comes from user-land
457        *     But this decision may not have been motivated by a situation that were different because the simulation is
458        *     not reproducible.
459        *     So, even the order change induced by the process killing is perfectly reproducible.
460        *
461        *   So science works, bitches [http://xkcd.com/54/].
462        *
463        *   We could sort the actors_that_ran array completely so that we can describe the order in which simcalls are
464        *   handled (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if
465        *   unfriendly).
466        *   That would thus be a pure waste of time.
467        */
468
469       for (smx_actor_t const& process : simix_global->actors_that_ran) {
470         if (process->simcall.call != SIMCALL_NONE) {
471           SIMIX_simcall_handle(&process->simcall, 0);
472         }
473       }
474
475       SIMIX_execute_tasks();
476       do {
477         SIMIX_wake_processes();
478       } while (SIMIX_execute_tasks());
479
480       /* If only daemon processes remain, cancel their actions, mark them to die and reschedule them */
481       if (simix_global->process_list.size() == simix_global->daemons.size())
482         for (auto const& dmon : simix_global->daemons) {
483           XBT_DEBUG("Kill %s", dmon->get_cname());
484           simix_global->maestro_process->kill(dmon);
485         }
486     }
487
488     time = simgrid::simix::Timer::next();
489     if (time > -1.0 || not simix_global->process_list.empty()) {
490       XBT_DEBUG("Calling surf_solve");
491       time = surf_solve(time);
492       XBT_DEBUG("Moving time ahead : %g", time);
493     }
494
495     /* Notify all the hosts that have failed */
496     /* FIXME: iterate through the list of failed host and mark each of them */
497     /* as failed. On each host, signal all the running processes with host_fail */
498
499     // Execute timers and tasks until there isn't anything to be done:
500     bool again = false;
501     do {
502       again = SIMIX_execute_timers();
503       if (SIMIX_execute_tasks())
504         again = true;
505       SIMIX_wake_processes();
506     } while (again);
507
508     /* Clean actors to destroy */
509     simix_global->empty_trash();
510
511     XBT_DEBUG("### time %f, #processes %zu, #to_run %zu", time, simix_global->process_list.size(),
512               simix_global->actors_to_run.size());
513
514   } while (time > -1.0 || not simix_global->actors_to_run.empty());
515
516   if (not simix_global->process_list.empty()) {
517
518     if (simix_global->process_list.size() <= simix_global->daemons.size()) {
519       XBT_CRITICAL("Oops! Daemon actors cannot do any blocking activity (communications, synchronization, etc) "
520                    "once the simulation is over. Please fix your on_exit() functions.");
521     } else {
522       XBT_CRITICAL("Oops! Deadlock or code not perfectly clean.");
523     }
524     SIMIX_display_process_status();
525     simgrid::s4u::on_deadlock();
526     xbt_abort();
527   }
528   simgrid::s4u::on_simulation_end();
529 }
530
531 double SIMIX_timer_next()
532 {
533   return simgrid::simix::Timer::next();
534 }
535
536 smx_timer_t SIMIX_timer_set(double date, void (*callback)(void*), void *arg)
537 {
538   return simgrid::simix::Timer::set(date, std::bind(callback, arg));
539 }
540
541 smx_timer_t SIMIX_timer_set(double date, simgrid::xbt::Task<void()>&& callback) // deprecated
542 {
543   return simgrid::simix::Timer::set(date, std::move(callback));
544 }
545
546 /** @brief cancels a timer that was added earlier */
547 void SIMIX_timer_remove(smx_timer_t timer) {
548   timer->remove();
549 }
550
551 /** @brief Returns the date at which the timer will trigger (or 0 if nullptr timer) */
552 double SIMIX_timer_get_date(smx_timer_t timer) {
553   return timer ? timer->get_date() : 0;
554 }
555
556 void SIMIX_display_process_status()
557 {
558   int nbprocess = simix_global->process_list.size();
559
560   XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
561   /*  List the process and their state */
562   XBT_INFO("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
563   for (auto const& kv : simix_global->process_list) {
564     smx_actor_t process = kv.second;
565
566     if (process->waiting_synchro) {
567
568       const char* synchro_description = "unknown";
569       // we don't care about the Activity type to get its name, use RawImpl
570       const char* name =
571           boost::static_pointer_cast<simgrid::kernel::activity::ActivityImpl_T<simgrid::kernel::activity::RawImpl>>(
572               process->waiting_synchro)
573               ->get_cname();
574
575       if (boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro) != nullptr)
576         synchro_description = "execution";
577
578       if (boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro) != nullptr)
579         synchro_description = "communication";
580
581       if (boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro) != nullptr)
582         synchro_description = "sleeping";
583
584       if (boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro) != nullptr)
585         synchro_description = "synchronization";
586
587       if (boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro) != nullptr)
588         synchro_description = "I/O";
589
590       XBT_INFO("Process %ld (%s@%s): waiting for %s synchro %p (%s) in state %d to finish", process->get_pid(),
591                process->get_cname(), process->get_host()->get_cname(), synchro_description,
592                process->waiting_synchro.get(), name, (int)process->waiting_synchro->state_);
593     }
594     else {
595       XBT_INFO("Process %ld (%s@%s)", process->get_pid(), process->get_cname(), process->get_host()->get_cname());
596     }
597   }
598 }
599
600 int SIMIX_is_maestro()
601 {
602   smx_actor_t self = SIMIX_process_self();
603   return simix_global == nullptr /*SimDag*/ || self == nullptr || self == simix_global->maestro_process;
604 }