Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Only compile stateless MC when libevent is found
[simgrid.git] / src / kernel / EngineImpl.cpp
1 /* Copyright (c) 2016-2023. 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 <simgrid/Exception.hpp>
7 #include <simgrid/kernel/Timer.hpp>
8 #include <simgrid/kernel/routing/NetPoint.hpp>
9 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
10 #include <simgrid/s4u/Host.hpp>
11
12 #include "src/kernel/EngineImpl.hpp"
13 #include "src/kernel/resource/StandardLinkImpl.hpp"
14 #include "src/kernel/resource/profile/Profile.hpp"
15 #include "src/kernel/xml/platf.hpp"
16 #include "src/mc/mc.h"
17 #include "src/mc/mc_record.hpp"
18 #include "src/mc/mc_replay.hpp"
19 #include "src/simgrid/math_utils.h"
20 #include "src/simgrid/sg_config.hpp"
21 #include "src/smpi/include/smpi_actor.hpp"
22
23 #if SIMGRID_HAVE_MC
24 #include "src/mc/remote/AppSide.hpp"
25 #endif
26
27 #include "xbt/log.hpp"
28
29 #include <boost/algorithm/string/predicate.hpp>
30 #include <dlfcn.h>
31
32 XBT_LOG_NEW_DEFAULT_CATEGORY(ker_engine, "Logging specific to Engine (kernel)");
33
34 namespace simgrid::kernel {
35 double EngineImpl::now_           = 0.0;
36 EngineImpl* EngineImpl::instance_ = nullptr; /* That singleton is awful too. */
37
38 config::Flag<double> cfg_breakpoint{"debug/breakpoint",
39                                     "When non-negative, raise a SIGTRAP after given (simulated) time", -1.0};
40 config::Flag<bool> cfg_verbose_exit{"debug/verbose-exit", "Display the actor status at exit", true};
41
42 constexpr std::initializer_list<std::pair<const char*, context::ContextFactory* (*)()>> context_factories = {
43 #if HAVE_RAW_CONTEXTS
44     {"raw", &context::raw_factory},
45 #endif
46 #if HAVE_UCONTEXT_CONTEXTS
47     {"ucontext", &context::sysv_factory},
48 #endif
49 #if HAVE_BOOST_CONTEXTS
50     {"boost", &context::boost_factory},
51 #endif
52     {"thread", &context::thread_factory},
53 };
54
55 static_assert(context_factories.size() > 0, "No context factories are enabled for this build");
56
57 // Create the list of possible contexts:
58 static inline std::string contexts_list()
59 {
60   std::string res;
61   std::string sep = "";
62   for (auto const& [factory_name, _] : context_factories) {
63     res += sep + factory_name;
64     sep = ", ";
65   }
66   return res;
67 }
68
69 static config::Flag<std::string> context_factory_name("contexts/factory",
70                                                       ("Possible values: " + contexts_list()).c_str(),
71                                                       context_factories.begin()->first);
72
73 } // namespace simgrid::kernel
74
75 XBT_ATTRIB_NORETURN static void inthandler(int)
76 {
77   if (simgrid::kernel::cfg_verbose_exit) {
78     XBT_INFO("CTRL-C pressed. The current status will be displayed before exit (disable that behavior with option "
79              "'debug/verbose-exit').");
80     simgrid::kernel::EngineImpl::get_instance()->display_all_actor_status();
81   } else {
82     XBT_INFO("CTRL-C pressed, exiting. Hiding the current process status since 'debug/verbose-exit' is set to false.");
83   }
84   exit(1);
85 }
86
87 static void segvhandler(int signum, siginfo_t* siginfo, void* /*context*/)
88 {
89   if ((siginfo->si_signo == SIGSEGV && siginfo->si_code == SEGV_ACCERR) || siginfo->si_signo == SIGBUS) {
90     fprintf(stderr,
91             "Access violation or Bus error detected.\n"
92             "This probably comes from a programming error in your code, or from a stack\n"
93             "overflow. If you are certain of your code, try increasing the stack size\n"
94             "   --cfg=contexts/stack-size:XXX (current size is %u KiB).\n"
95             "\n"
96             "If it does not help, this may have one of the following causes:\n"
97             "a bug in SimGrid, a bug in the OS or a bug in a third-party libraries.\n"
98             "Failing hardware can sometimes generate such errors too.\n"
99             "\n"
100             "If you think you've found a bug in SimGrid, please report it along with a\n"
101             "Minimal Working Example (MWE) reproducing your problem and a full backtrace\n"
102             "of the fault captured with gdb or valgrind.\n",
103             simgrid::kernel::context::Context::stack_size / 1024);
104   } else if (siginfo->si_signo == SIGSEGV) {
105     fprintf(stderr, "Segmentation fault.\n");
106 #if HAVE_SMPI
107     if (SMPI_is_inited() && smpi_cfg_privatization() == SmpiPrivStrategies::NONE) {
108 #if HAVE_PRIVATIZATION
109       fprintf(stderr, "Try to enable SMPI variable privatization with --cfg=smpi/privatization:yes.\n");
110 #else
111       fprintf(stderr, "Sadly, your system does not support --cfg=smpi/privatization:yes (yet).\n");
112 #endif /* HAVE_PRIVATIZATION */
113     }
114 #endif /* HAVE_SMPI */
115   }
116   std::raise(signum);
117 }
118
119 static void install_signal_handlers()
120 {
121   /* Install signal handler for SIGINT */
122   std::signal(SIGINT, inthandler);
123
124   /* Install signal handler for SIGSEGV */
125   if (simgrid::kernel::context::Context::install_sigsegv_stack(true) == -1) {
126     XBT_WARN("Failed to register alternate signal stack: %s", strerror(errno));
127     return;
128   }
129
130   struct sigaction action;
131   action.sa_sigaction = &segvhandler;
132   action.sa_flags     = SA_ONSTACK | SA_RESETHAND | SA_SIGINFO;
133   sigemptyset(&action.sa_mask);
134
135   /* Linux tend to raise only SIGSEGV where other systems also raise SIGBUS on severe error */
136   for (int sig : {SIGSEGV, SIGBUS}) {
137     if (sigaction(sig, &action, nullptr) == -1)
138       XBT_WARN("Failed to register signal handler for signal %d: %s", sig, strerror(errno));
139   }
140 }
141
142 static simgrid::config::Flag<bool> cfg_dbg_clean_atexit{
143     "debug/clean-atexit", "Whether to cleanup SimGrid at exit. Disable it if your code segfaults after its end.", true};
144
145 namespace simgrid::kernel {
146
147 EngineImpl::~EngineImpl()
148 {
149   /* Also delete the other data */
150   delete netzone_root_;
151   for (auto const& [_, netpoint] : netpoints_)
152     delete netpoint;
153
154   for (auto const& [_, mailbox] : mailboxes_)
155     delete mailbox;
156
157   /* Kill all actors (but maestro) */
158   maestro_->kill_all();
159   run_all_actors();
160   empty_trash();
161
162   delete maestro_;
163   delete context_factory_;
164
165   /* clear models before freeing handle, network models can use external callback defined in the handle */
166   models_prio_.clear();
167 }
168
169 void EngineImpl::initialize(int* argc, char** argv)
170 {
171   xbt_assert(EngineImpl::instance_ == nullptr,
172              "It is currently forbidden to create more than one instance of kernel::EngineImpl");
173   EngineImpl::instance_ = this;
174 #if SIMGRID_HAVE_MC
175   // The communication initialization is done ASAP, as we need to get some init parameters from the MC for different
176   // layers. But instance_ needs to be created, as we send the address of some of its fields to the MC that wants to
177   // read them directly.
178   simgrid::mc::AppSide::initialize();
179 #endif
180
181   if (static bool inited = false; not inited) {
182     inited = true;
183     xbt_log_init(argc, argv);
184
185     simgrid::xbt::install_exception_handler();
186
187     sg_config_init(argc, argv);
188   }
189
190   cmdline_.assign(argv, argv + *argc);
191
192   instance_->context_mod_init();
193
194   install_signal_handlers();
195
196   /* register a function to be called after the environment creation */
197   s4u::Engine::on_platform_created_cb([this]() { this->presolve(); });
198
199   if (cfg_dbg_clean_atexit)
200     atexit(shutdown);
201 }
202
203 void EngineImpl::context_mod_init() const
204 {
205   xbt_assert(not instance_->has_context_factory());
206
207 #if HAVE_SMPI && defined(__NetBSD__)
208   smpi_init_options_internal(false);
209   std::string priv = config::get_value<std::string>("smpi/privatization");
210   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
211     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
212     context_factory_name = "raw";
213   }
214 #endif
215
216 #if HAVE_SMPI && defined(__FreeBSD__)
217   smpi_init_options_internal(false);
218   if (context_factory_name == "thread" && config::get_value<std::string>("smpi/privatization") != "no") {
219     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
220     context_factory_name = "raw";
221   }
222 #endif
223
224   /* use the factory specified by --cfg=contexts/factory:value */
225   for (auto const& [factory_name, factory] : context_factories)
226     if (context_factory_name == factory_name) {
227       instance_->set_context_factory(factory());
228       break;
229     }
230
231   if (not instance_->has_context_factory()) {
232     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
233 #if HAVE_RAW_CONTEXTS
234     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
235 #else
236     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
237 #endif
238 #if HAVE_UCONTEXT_CONTEXTS
239     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
240 #else
241     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
242 #endif
243 #if HAVE_BOOST_CONTEXTS
244     XBT_ERROR("  boost: this uses the boost libraries context implementation");
245 #else
246     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you "
247               "install the libboost-context-dev package?)");
248 #endif
249     XBT_ERROR("  thread: slow portability layer using standard threads as provided by libstdc");
250     xbt_die("Please use a valid factory.");
251   }
252 }
253
254 void EngineImpl::shutdown()
255 {
256   if (EngineImpl::instance_ == nullptr)
257     return;
258   XBT_DEBUG("EngineImpl::shutdown() called. Simulation's over.");
259 #if HAVE_SMPI
260   if (not instance_->actor_list_.empty()) {
261     if (smpi_process() && smpi_process()->initialized()) {
262       xbt_die("Process exited without calling MPI_Finalize - Killing simulation");
263     } else {
264       XBT_WARN("Process called exit when leaving - Skipping cleanups");
265       return;
266     }
267   }
268 #endif
269
270   if (instance_->has_actors_to_run() && simgrid_get_clock() <= 0.0) {
271     XBT_CRITICAL("   ");
272     XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
273     XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
274     xbt_die("Bailing out to avoid that stop-before-start madness. Please fix your code.");
275   }
276
277   while (not timer::kernel_timers().empty()) {
278     delete timer::kernel_timers().top().second;
279     timer::kernel_timers().pop();
280   }
281
282   tmgr_finalize();
283   sg_platf_parser_finalize();
284
285   delete instance_;
286   instance_ = nullptr;
287 }
288
289 void EngineImpl::seal_platform() const
290 {
291   /* Seal only once */
292   static bool sealed = false;
293   if (sealed)
294     return;
295   sealed = true;
296
297   /* seal netzone root, recursively seal children netzones, hosts and disks */
298   netzone_root_->seal();
299 }
300
301 void EngineImpl::load_platform(const std::string& platf)
302 {
303   double start = xbt_os_time();
304   if (boost::algorithm::ends_with(platf, ".so") || boost::algorithm::ends_with(platf, ".dylib")) {
305     void* handle = dlopen(platf.c_str(), RTLD_LAZY);
306     xbt_assert(handle, "Impossible to open platform file: %s", platf.c_str());
307     platf_handle_           = std::unique_ptr<void, std::function<int(void*)>>(handle, dlclose);
308     using load_fct_t = void (*)(const simgrid::s4u::Engine&);
309     auto callable           = (load_fct_t)dlsym(platf_handle_.get(), "load_platform");
310     const char* dlsym_error = dlerror();
311     xbt_assert(not dlsym_error, "Error: %s", dlsym_error);
312     callable(*simgrid::s4u::Engine::get_instance());
313   } else {
314     parse_platform_file(platf);
315   }
316
317   double end = xbt_os_time();
318   XBT_DEBUG("PARSE TIME: %g", (end - start));
319 }
320
321 void EngineImpl::load_deployment(const std::string& file) const
322 {
323   sg_platf_parser_finalize();
324
325   simgrid_parse_open(file);
326   simgrid_parse();
327   simgrid_parse_close();
328 }
329
330 void EngineImpl::register_function(const std::string& name, const actor::ActorCodeFactory& code)
331 {
332   registered_functions[name] = code;
333 }
334 void EngineImpl::register_default(const actor::ActorCodeFactory& code)
335 {
336   default_function = code;
337 }
338
339 void EngineImpl::add_model(std::shared_ptr<resource::Model> model, const std::vector<resource::Model*>& dependencies)
340 {
341   auto model_name = model->get_name();
342   xbt_assert(models_prio_.find(model_name) == models_prio_.end(),
343              "Model %s already exists, use model.set_name() to change its name", model_name.c_str());
344
345   for (const auto* dep : dependencies) {
346     xbt_assert(models_prio_.find(dep->get_name()) != models_prio_.end(),
347                "Model %s doesn't exists. Impossible to use it as dependency.", dep->get_name().c_str());
348   }
349   models_.push_back(model.get());
350   models_prio_[model_name] = std::move(model);
351 }
352
353 /** Wake up all actors waiting for an action to finish */
354 void EngineImpl::handle_ended_actions() const
355 {
356   for (auto const& model : models_) {
357     XBT_DEBUG("Handling the failed actions (if any)");
358     while (auto* action = model->extract_failed_action()) {
359       XBT_DEBUG("   Handling Action %p", action);
360       if (action->get_activity() != nullptr) { // Skip vcpu actions
361         // Action failures are not automatically reported when the action is started by maestro (as in SimDAG)
362         if (action->get_activity()->get_actor() == maestro_)
363           action->get_activity()->get_iface()->complete(s4u::Activity::State::FAILED);
364
365         activity::ActivityImplPtr(action->get_activity())->finish();
366       }
367     }
368     XBT_DEBUG("Handling the terminated actions (if any)");
369     while (auto* action = model->extract_done_action()) {
370       XBT_DEBUG("   Handling Action %p", action);
371       if (action->get_activity() != nullptr) {
372         // Action termination are not automatically reported when the action is started by maestro (as in SimDAG)
373         action->get_activity()->set_finish_time(action->get_finish_time());
374
375         if (action->get_activity()->get_actor() == maestro_)
376           action->get_activity()->get_iface()->complete(s4u::Activity::State::FINISHED);
377
378         activity::ActivityImplPtr(action->get_activity())->finish();
379       }
380     }
381   }
382 }
383 /**
384  * @brief Executes the actors in actors_to_run.
385  *
386  * The actors in actors_to_run are run (in parallel if possible). On exit, actors_to_run is empty, and actors_that_ran
387  * contains the list of actors that just ran.  The two lists are swapped so, be careful when using them before and after
388  * a call to this function.
389  */
390 void EngineImpl::run_all_actors()
391 {
392   instance_->get_context_factory()->run_all(actors_to_run_);
393
394   for (auto const& actor : actors_to_run_)
395     if (actor->to_be_freed())
396       actor->cleanup_from_kernel();
397
398   actors_to_run_.swap(actors_that_ran_);
399   actors_to_run_.clear();
400 }
401
402 actor::ActorImpl* EngineImpl::get_actor_by_pid(aid_t pid)
403 {
404   auto item = actor_list_.find(pid);
405   return item == actor_list_.end() ? nullptr : item->second;
406 }
407
408 void EngineImpl::remove_daemon(actor::ActorImpl* actor)
409 {
410   auto it = daemons_.find(actor);
411   xbt_assert(it != daemons_.end(), "The dying daemon is not a daemon after all. Please report that bug.");
412   daemons_.erase(it);
413 }
414
415 void EngineImpl::add_actor_to_run_list_no_check(actor::ActorImpl* actor)
416 {
417   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), actor->get_host()->get_cname());
418   actors_to_run_.push_back(actor);
419 }
420
421 void EngineImpl::add_actor_to_run_list(actor::ActorImpl* actor)
422 {
423   if (std::find(begin(actors_to_run_), end(actors_to_run_), actor) != end(actors_to_run_)) {
424     XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
425   } else {
426     XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), actor->get_host()->get_cname());
427     actors_to_run_.push_back(actor);
428   }
429 }
430 void EngineImpl::empty_trash()
431 {
432   while (not actors_to_destroy_.empty()) {
433     actor::ActorImpl* actor = &actors_to_destroy_.front();
434     actors_to_destroy_.pop_front();
435     XBT_DEBUG("Getting rid of %s (refcount: %d)", actor->get_cname(), actor->get_refcount());
436     intrusive_ptr_release(actor);
437   }
438 }
439
440 void EngineImpl::display_all_actor_status() const
441 {
442   XBT_INFO("%zu actors are still running, waiting for something.", actor_list_.size());
443   /*  List the actors and their state */
444   XBT_INFO("Legend of the following listing: \"Actor <pid> (<name>@<host>): <status>\"");
445   for (auto const& [_, actor] : actor_list_) {
446     if (actor->waiting_synchro_) {
447       const char* synchro_description = "unknown";
448
449       if (boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(actor->waiting_synchro_) != nullptr)
450         synchro_description = "execution";
451
452       if (boost::dynamic_pointer_cast<kernel::activity::CommImpl>(actor->waiting_synchro_) != nullptr)
453         synchro_description = "communication";
454
455       if (boost::dynamic_pointer_cast<kernel::activity::SleepImpl>(actor->waiting_synchro_) != nullptr)
456         synchro_description = "sleeping";
457
458       if (boost::dynamic_pointer_cast<kernel::activity::SynchroImpl>(actor->waiting_synchro_) != nullptr)
459         synchro_description = "synchronization";
460
461       if (boost::dynamic_pointer_cast<kernel::activity::IoImpl>(actor->waiting_synchro_) != nullptr)
462         synchro_description = "I/O";
463
464       XBT_INFO("Actor %ld (%s@%s): waiting for %s activity %#zx (%s) in state %s to finish %s", actor->get_pid(),
465                actor->get_cname(), actor->get_host()->get_cname(), synchro_description,
466                (xbt_log_no_loc ? (size_t)0xDEADBEEF : (size_t)actor->waiting_synchro_.get()),
467                actor->waiting_synchro_->get_cname(), actor->waiting_synchro_->get_state_str(),
468                (actor->simcall_.observer_ != nullptr && not xbt_log_no_loc
469                     ? actor->simcall_.observer_->to_string().c_str()
470                     : ""));
471     } else {
472       XBT_INFO("Actor %ld (%s@%s) simcall %s", actor->get_pid(), actor->get_cname(), actor->get_host()->get_cname(),
473                (actor->simcall_.observer_ != nullptr ? actor->simcall_.observer_->to_string().c_str()
474                                                      : actor->simcall_.get_cname()));
475     }
476   }
477 }
478
479 void EngineImpl::presolve() const
480 {
481   XBT_DEBUG("Consume all trace events occurring before the starting time.");
482   double next_event_date;
483   while ((next_event_date = profile::future_evt_set.next_date()) != -1.0) {
484     if (next_event_date > now_)
485       break;
486
487     double value                 = -1.0;
488     resource::Resource* resource = nullptr;
489     while (auto* event = profile::future_evt_set.pop_leq(next_event_date, &value, &resource)) {
490       if (value >= 0)
491         resource->apply_event(event, value);
492     }
493   }
494
495   XBT_DEBUG("Set every models in the right state by updating them to 0.");
496   for (auto const& model : models_)
497     model->update_actions_state(now_, 0.0);
498 }
499
500 double EngineImpl::solve(double max_date) const
501 {
502   double time_delta            = -1.0; /* duration */
503   double value                 = -1.0;
504   resource::Resource* resource = nullptr;
505
506   if (max_date != -1.0) {
507     xbt_assert(max_date >= now_, "You asked to simulate up to %f, but that's in the past already", max_date);
508
509     time_delta = max_date - now_;
510   }
511
512   XBT_DEBUG("Looking for next event in all models");
513   for (auto model : models_) {
514     if (not model->next_occurring_event_is_idempotent()) {
515       continue;
516     }
517     double next_event = model->next_occurring_event(now_);
518     if ((time_delta < 0.0 || next_event < time_delta) && next_event >= 0.0) {
519       time_delta = next_event;
520     }
521   }
522
523   XBT_DEBUG("Min for resources (remember that NS3 don't update that value): %f", time_delta);
524
525   XBT_DEBUG("Looking for next trace event");
526
527   while (true) { // Handle next occurring events until none remains
528     double next_event_date = profile::future_evt_set.next_date();
529     XBT_DEBUG("Next TRACE event: %f", next_event_date);
530
531     for (auto model : models_) {
532       /* Skip all idempotent models, they were already treated above
533        * NS3 is the one to handled here */
534       if (model->next_occurring_event_is_idempotent())
535         continue;
536
537       if (next_event_date != -1.0) {
538         time_delta = std::min(next_event_date - now_, time_delta);
539       } else {
540         time_delta = std::max(next_event_date - now_, time_delta); // Get the positive component
541       }
542
543       XBT_DEBUG("Run the NS3 network at most %fs", time_delta);
544       // run until min or next flow
545       double model_next_action_end = model->next_occurring_event(time_delta);
546
547       XBT_DEBUG("Min for network : %f", model_next_action_end);
548       if (model_next_action_end >= 0.0)
549         time_delta = model_next_action_end;
550     }
551
552     if (next_event_date < 0.0 || (next_event_date > now_ + time_delta)) {
553       // next event may have already occurred or will after the next resource change, then bail out
554       XBT_DEBUG("no next usable TRACE event. Stop searching for it");
555       break;
556     }
557
558     XBT_DEBUG("Updating models (min = %g, NOW = %g, next_event_date = %g)", time_delta, now_, next_event_date);
559
560     while (auto* event = profile::future_evt_set.pop_leq(next_event_date, &value, &resource)) {
561       if(value<0)
562               continue;
563       if (resource->is_used()) {
564         time_delta = next_event_date - now_;
565         XBT_DEBUG("This event invalidates the next_occurring_event() computation of models. Next event set to %f",
566                   time_delta);
567       }
568       // FIXME: I'm too lame to update now_ live, so I change it and restore it so that the real update works
569       double round_start = now_;
570       now_               = next_event_date;
571       /* update state of the corresponding resource to the new value. Does not touch lmm.
572          It will be modified if needed when updating actions */
573       XBT_DEBUG("Calling update_resource_state for resource %s", resource->get_cname());
574       resource->apply_event(event, value);
575       now_ = round_start;
576     }
577   }
578
579   /* FIXME: Moved this test to here to avoid stopping simulation if there are actions running on cpus and all cpus are
580    * with availability = 0. This may cause an infinite loop if one cpu has a trace with periodicity = 0 and the other a
581    * trace with periodicity > 0.
582    * The options are: all traces with same periodicity(0 or >0) or we need to change the way how the events are managed
583    */
584   if (time_delta < 0) {
585     XBT_DEBUG("No next event at all. Bail out now.");
586     return -1.0;
587   }
588
589   XBT_DEBUG("Duration set to %f", time_delta);
590
591   // Bump the time: jump into the future
592   now_ += time_delta;
593
594   // Inform the models of the date change
595   for (auto const& model : models_)
596     model->update_actions_state(now_, time_delta);
597
598   s4u::Engine::on_time_advance(time_delta);
599
600   return time_delta;
601 }
602
603 void EngineImpl::run(double max_date)
604 {
605   seal_platform();
606
607   if (MC_is_active()) {
608 #if SIMGRID_HAVE_MC
609     mc::AppSide::get()->main_loop();
610 #else
611     xbt_die("MC_is_active() is not supposed to return true in non-MC settings");
612 #endif
613     THROW_IMPOSSIBLE; // main_loop never returns
614   }
615
616   if (MC_record_replay_is_active()) {
617     mc::RecordTrace::replay(MC_record_path());
618     empty_trash();
619     return;
620   }
621
622   double elapsed_time = -1;
623   const std::set<s4u::Activity*>* vetoed_activities = s4u::Activity::get_vetoed_activities();
624
625   do {
626     XBT_DEBUG("New Schedule Round; size(queue)=%zu", actors_to_run_.size());
627
628     if (cfg_breakpoint >= 0.0 && simgrid_get_clock() >= cfg_breakpoint) {
629       XBT_DEBUG("Breakpoint reached (%g)", cfg_breakpoint.get());
630       cfg_breakpoint = -1.0; // Let the simulation continue without hiting the breakpoint again and again
631 #ifdef SIGTRAP
632       std::raise(SIGTRAP);
633 #else
634       std::raise(SIGABRT);
635 #endif
636     }
637
638     while (not actors_to_run_.empty()) {
639       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", actors_to_run_.size());
640
641       /* Run all actors that are ready to run, possibly in parallel */
642       run_all_actors();
643
644       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round.
645        * The order must be fixed for the simulation to be reproducible (see RR-7653). It's OK here because only maestro
646        * changes the list. Killer actors are moved to the end to let victims finish their simcall before dying, but
647        * the order remains reproducible (even if arbitrarily). No need to sort the vector for sake of reproducibility.
648        */
649       for (auto const& actor : actors_that_ran_)
650         if (actor->simcall_.call_ != actor::Simcall::Type::NONE)
651           actor->simcall_handle(0);
652
653       handle_ended_actions();
654
655       /* If only daemon actors remain, cancel their actions, mark them to die and reschedule them */
656       if (actor_list_.size() == daemons_.size())
657         for (auto const& dmon : daemons_) {
658           XBT_DEBUG("Kill %s", dmon->get_cname());
659           maestro_->kill(dmon);
660         }
661     }
662
663     // Compute the max_date of the next solve.
664     // It's either when a timer occurs, or when user-specified deadline is reached, or -1 if none is given
665     double next_time = timer::Timer::next();
666     if (next_time < 0 && max_date > -1) {
667       next_time = max_date;
668     } else if (next_time > -1 && max_date > -1) { // either both <0, or both >0
669       next_time = std::min(next_time, max_date);
670     }
671
672     XBT_DEBUG("Calling solve(%g) %g", next_time, now_);
673     elapsed_time = solve(next_time);
674     XBT_DEBUG("Moving time ahead. NOW=%g; elapsed: %g", now_, elapsed_time);
675
676     // Execute timers until there isn't anything to be done:
677     bool again = false;
678     do {
679       again = timer::Timer::execute_all();
680       handle_ended_actions();
681     } while (again);
682
683     /* Clean actors to destroy */
684     empty_trash();
685
686     XBT_DEBUG("### elapsed time %f, #actors %zu, #to_run %zu, #vetoed %d", elapsed_time, actor_list_.size(),
687               actors_to_run_.size(), (vetoed_activities == nullptr ? -1 : static_cast<int>(vetoed_activities->size())));
688
689     if (elapsed_time < 0. && actors_to_run_.empty() && not actor_list_.empty()) {
690       if (actor_list_.size() <= daemons_.size()) {
691         XBT_CRITICAL("Oops! Daemon actors cannot do any blocking activity (communications, synchronization, etc) "
692                      "once the simulation is over. Please fix your on_exit() functions.");
693       } else {
694         XBT_CRITICAL("Oops! Deadlock detected, some activities are still around but will never complete. "
695                      "This usually happens when the user code is not perfectly clean.");
696       }
697       display_all_actor_status();
698       simgrid::s4u::Engine::on_deadlock();
699       for (auto const& [_, actor] : actor_list_) {
700         XBT_DEBUG("Kill %s", actor->get_cname());
701         maestro_->kill(actor);
702       }
703     }
704   } while ((vetoed_activities == nullptr || vetoed_activities->empty()) &&
705            ((elapsed_time > -1.0 && not double_equals(max_date, now_, 0.00001)) || has_actors_to_run()));
706
707   if (not actor_list_.empty() && max_date < 0 && not(vetoed_activities == nullptr || vetoed_activities->empty()))
708     THROW_IMPOSSIBLE;
709
710   simgrid::s4u::Engine::on_simulation_end();
711 }
712
713 double EngineImpl::get_clock()
714 {
715   return now_;
716 }
717 } // namespace simgrid::kernel