1 /* Copyright (c) 2016-2021. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "src/kernel/EngineImpl.hpp"
8 #include "simgrid/Exception.hpp"
9 #include "simgrid/kernel/Timer.hpp"
10 #include "simgrid/kernel/routing/NetPoint.hpp"
11 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
12 #include "simgrid/s4u/Host.hpp"
13 #include "simgrid/sg_config.hpp"
14 #include "src/include/surf/surf.hpp" //get_clock() and surf_solve()
15 #include "src/kernel/resource/DiskImpl.hpp"
16 #include "src/mc/mc_record.hpp"
17 #include "src/mc/mc_replay.hpp"
18 #include "src/simix/smx_private.hpp"
19 #include "src/smpi/include/smpi_actor.hpp"
20 #include "src/surf/network_interface.hpp"
21 #include "src/surf/xml/platf.hpp" // FIXME: KILLME. There must be a better way than mimicking XML here
23 #include <boost/algorithm/string/predicate.hpp>
28 XBT_LOG_NEW_DEFAULT_CATEGORY(ker_engine, "Logging specific to Engine (kernel)");
33 config::Flag<double> cfg_breakpoint{"debug/breakpoint",
34 "When non-negative, raise a SIGTRAP after given (simulated) time", -1.0};
35 EngineImpl::~EngineImpl()
37 while (not timer::kernel_timers().empty()) {
38 delete timer::kernel_timers().top().second;
39 timer::kernel_timers().pop();
42 /* Since hosts_ is a std::map, the hosts are destroyed in the lexicographic order, which ensures that the output is
45 while (not hosts_.empty())
46 hosts_.begin()->second->destroy();
48 /* Also delete the other data */
50 for (auto const& kv : netpoints_)
53 for (auto const& kv : links_)
57 for (auto const& kv : mailboxes_)
60 /* Free the remaining data structures */
62 xbt_dynar_free(&actors_vector_);
63 xbt_dynar_free(&dead_actors_vector_);
65 /* clear models before freeing handle, network models can use external callback defined in the handle */
69 void EngineImpl::load_platform(const std::string& platf)
71 double start = xbt_os_time();
72 if (boost::algorithm::ends_with(platf, ".so") or boost::algorithm::ends_with(platf, ".dylib")) {
74 xbt_die("loading platform through shared library isn't supported on windows");
76 void* handle = dlopen(platf.c_str(), RTLD_LAZY);
77 xbt_assert(handle, "Impossible to open platform file: %s", platf.c_str());
78 platf_handle_ = std::unique_ptr<void, std::function<int(void*)>>(handle, dlclose);
79 using load_fct_t = void (*)(const simgrid::s4u::Engine&);
80 auto callable = (load_fct_t)dlsym(platf_handle_.get(), "load_platform");
81 const char* dlsym_error = dlerror();
82 xbt_assert(not dlsym_error, "Error: %s", dlsym_error);
83 callable(*simgrid::s4u::Engine::get_instance());
86 parse_platform_file(platf);
89 double end = xbt_os_time();
90 XBT_DEBUG("PARSE TIME: %g", (end - start));
93 void EngineImpl::load_deployment(const std::string& file) const
98 surf_parse_open(file);
103 void EngineImpl::register_function(const std::string& name, const actor::ActorCodeFactory& code)
105 registered_functions[name] = code;
107 void EngineImpl::register_default(const actor::ActorCodeFactory& code)
109 default_function = code;
112 void EngineImpl::add_model(std::shared_ptr<resource::Model> model, const std::vector<resource::Model*>& dependencies)
114 auto model_name = model->get_name();
115 xbt_assert(models_prio_.find(model_name) == models_prio_.end(),
116 "Model %s already exists, use model.set_name() to change its name", model_name.c_str());
118 for (const auto dep : dependencies) {
119 xbt_assert(models_prio_.find(dep->get_name()) != models_prio_.end(),
120 "Model %s doesn't exists. Impossible to use it as dependency.", dep->get_name().c_str());
122 models_.push_back(model.get());
123 models_prio_[model_name] = std::move(model);
126 /** Wake up all actors waiting for a Surf action to finish */
127 void EngineImpl::wake_all_waiting_actors() const
129 for (auto const& model : models_) {
130 XBT_DEBUG("Handling the failed actions (if any)");
131 while (auto* action = model->extract_failed_action()) {
132 XBT_DEBUG(" Handling Action %p", action);
133 if (action->get_activity() != nullptr)
134 activity::ActivityImplPtr(action->get_activity())->post();
136 XBT_DEBUG("Handling the terminated actions (if any)");
137 while (auto* action = model->extract_done_action()) {
138 XBT_DEBUG(" Handling Action %p", action);
139 if (action->get_activity() == nullptr)
140 XBT_DEBUG("probably vcpu's action %p, skip", action);
142 activity::ActivityImplPtr(action->get_activity())->post();
147 * @brief Executes the actors in actors_to_run.
149 * The actors in actors_to_run are run (in parallel if possible). On exit, actors_to_run is empty, and actors_that_ran
150 * contains the list of actors that just ran. The two lists are swapped so, be careful when using them before and after
151 * a call to this function.
153 void EngineImpl::run_all_actors()
155 simix_global->get_context_factory()->run_all();
157 actors_to_run_.swap(actors_that_ran_);
158 actors_to_run_.clear();
161 actor::ActorImpl* EngineImpl::get_actor_by_pid(aid_t pid)
163 auto item = actor_list_.find(pid);
164 if (item != actor_list_.end())
168 for (auto& a : actors_to_destroy_)
169 if (a.get_pid() == pid)
171 return nullptr; // Not found, even in the trash
173 /** Execute all the tasks that are queued, e.g. `.then()` callbacks of futures. */
174 bool EngineImpl::execute_tasks()
176 xbt_assert(tasksTemp.empty());
182 // We don't want the callbacks to modify the vector we are iterating over:
183 tasks.swap(tasksTemp);
185 // Execute all the queued tasks:
186 for (auto& task : tasksTemp)
190 } while (not tasks.empty());
195 void EngineImpl::remove_daemon(actor::ActorImpl* actor)
197 auto it = daemons_.find(actor);
198 xbt_assert(it != daemons_.end(), "The dying daemon is not a daemon after all. Please report that bug.");
202 void EngineImpl::add_actor_to_run_list_no_check(actor::ActorImpl* actor)
204 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), actor->get_host()->get_cname());
205 actors_to_run_.push_back(actor);
208 void EngineImpl::add_actor_to_run_list(actor::ActorImpl* actor)
210 if (std::find(begin(actors_to_run_), end(actors_to_run_), actor) != end(actors_to_run_)) {
211 XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
213 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), actor->get_host()->get_cname());
214 actors_to_run_.push_back(actor);
217 void EngineImpl::empty_trash()
219 while (not actors_to_destroy_.empty()) {
220 actor::ActorImpl* actor = &actors_to_destroy_.front();
221 actors_to_destroy_.pop_front();
222 XBT_DEBUG("Getting rid of %s (refcount: %d)", actor->get_cname(), actor->get_refcount());
223 intrusive_ptr_release(actor);
226 xbt_dynar_reset(dead_actors_vector_);
230 void EngineImpl::display_all_actor_status() const
232 XBT_INFO("%zu actors are still running, waiting for something.", actor_list_.size());
233 /* List the actors and their state */
234 XBT_INFO("Legend of the following listing: \"Actor <pid> (<name>@<host>): <status>\"");
235 for (auto const& kv : actor_list_) {
236 actor::ActorImpl* actor = kv.second;
238 if (actor->waiting_synchro_) {
239 const char* synchro_description = "unknown";
241 if (boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(actor->waiting_synchro_) != nullptr)
242 synchro_description = "execution";
244 if (boost::dynamic_pointer_cast<kernel::activity::CommImpl>(actor->waiting_synchro_) != nullptr)
245 synchro_description = "communication";
247 if (boost::dynamic_pointer_cast<kernel::activity::SleepImpl>(actor->waiting_synchro_) != nullptr)
248 synchro_description = "sleeping";
250 if (boost::dynamic_pointer_cast<kernel::activity::RawImpl>(actor->waiting_synchro_) != nullptr)
251 synchro_description = "synchronization";
253 if (boost::dynamic_pointer_cast<kernel::activity::IoImpl>(actor->waiting_synchro_) != nullptr)
254 synchro_description = "I/O";
256 XBT_INFO("Actor %ld (%s@%s): waiting for %s activity %#zx (%s) in state %d to finish", actor->get_pid(),
257 actor->get_cname(), actor->get_host()->get_cname(), synchro_description,
258 (xbt_log_no_loc ? (size_t)0xDEADBEEF : (size_t)actor->waiting_synchro_.get()),
259 actor->waiting_synchro_->get_cname(), (int)actor->waiting_synchro_->state_);
261 XBT_INFO("Actor %ld (%s@%s) simcall %s", actor->get_pid(), actor->get_cname(), actor->get_host()->get_cname(),
262 SIMIX_simcall_name(actor->simcall_));
267 void EngineImpl::run()
269 if (MC_record_replay_is_active()) {
270 mc::replay(MC_record_path());
278 XBT_DEBUG("New Schedule Round; size(queue)=%zu", actors_to_run_.size());
280 if (cfg_breakpoint >= 0.0 && surf_get_clock() >= cfg_breakpoint) {
281 XBT_DEBUG("Breakpoint reached (%g)", cfg_breakpoint.get());
282 cfg_breakpoint = -1.0;
292 while (not actors_to_run_.empty()) {
293 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", actors_to_run_.size());
295 /* Run all actors that are ready to run, possibly in parallel */
298 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
300 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
302 /* Here, the order is ok because:
304 * Short proof: only maestro adds stuff to the actors_to_run array, so the execution order of user contexts do
305 * not impact its order.
307 * Long proof: actors remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
309 * - if there is no kill during the simulation, actors remain sorted according by their PID.
310 * Rationale: This can be proved inductively.
311 * Assume that actors_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
312 * is parsed linearly).
313 * Let's show that it is still so at the end of this round.
314 * - if an actor is added when being created, that's from maestro. It can be either at startup
315 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
316 * in arbitrary order (inductive hypothesis), we are fine.
317 * - If an actor is added because it's getting killed, its subsequent actions shouldn't matter
318 * - If an actor gets added to actors_to_run because one of their blocking action constituting the meat
319 * of a simcall terminates, we're still good. Proof:
320 * - You are added from ActorImpl::simcall_answer() only. When this function is called depends on the
321 * resource kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications
323 * - For communications, this function is called from SIMIX_comm_finish().
324 * This function itself don't mess with the order since simcalls are handled in FIFO order.
325 * The function is called:
326 * - before the comm starts (invalid parameters, or resource already dead or whatever).
327 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
328 * - because the communication failed or were canceled after startup. In this case, it's called from
329 * the function we are in, by the chunk:
330 * set = model->states.failed_action_set;
331 * while ((synchro = extract(set)))
332 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
333 * This order is also fixed because it depends of the order in which the surf actions were
334 * added to the system, and only maestro can add stuff this way, through simcalls.
335 * We thus use the inductive hypothesis once again to conclude that the order in which synchros are
336 * popped out of the set does not depend on the user code's execution order.
337 * - because the communication terminated. In this case, synchros are served in the order given by
338 * set = model->states.done_action_set;
339 * while ((synchro = extract(set)))
340 * SIMIX_simcall_post((smx_synchro_t) synchro->data);
341 * and the argument is very similar to the previous one.
342 * So, in any case, the orders of calls to CommImpl::finish() do not depend on the order in which user
343 * actors are executed.
344 * So, in any cases, the orders of actors within actors_to_run do not depend on the order in which
345 * user actors were executed previously.
346 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
347 * - If there is some actor killings, the order is changed by this decision that comes from user-land
348 * But this decision may not have been motivated by a situation that were different because the simulation is
350 * So, even the order change induced by the actor killing is perfectly reproducible.
352 * So science works, bitches [http://xkcd.com/54/].
354 * We could sort the actors_that_ran array completely so that we can describe the order in which simcalls are
355 * handled (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if
357 * That would thus be a pure waste of time.
360 for (auto const& actor : actors_that_ran_) {
361 if (actor->simcall_.call_ != simix::Simcall::NONE) {
362 actor->simcall_handle(0);
368 wake_all_waiting_actors();
369 } while (execute_tasks());
371 /* If only daemon actors remain, cancel their actions, mark them to die and reschedule them */
372 if (actor_list_.size() == daemons_.size())
373 for (auto const& dmon : daemons_) {
374 XBT_DEBUG("Kill %s", dmon->get_cname());
375 simix_global->get_maestro()->kill(dmon);
379 time = timer::Timer::next();
380 if (time > -1.0 || not actor_list_.empty()) {
381 XBT_DEBUG("Calling surf_solve");
382 time = surf_solve(time);
383 XBT_DEBUG("Moving time ahead : %g", time);
386 /* Notify all the hosts that have failed */
387 /* FIXME: iterate through the list of failed host and mark each of them */
388 /* as failed. On each host, signal all the running actors with host_fail */
390 // Execute timers and tasks until there isn't anything to be done:
393 again = timer::Timer::execute_all();
396 wake_all_waiting_actors();
399 /* Clean actors to destroy */
402 XBT_DEBUG("### time %f, #actors %zu, #to_run %zu", time, actor_list_.size(), actors_to_run_.size());
404 if (time < 0. && actors_to_run_.empty() && not actor_list_.empty()) {
405 if (actor_list_.size() <= daemons_.size()) {
406 XBT_CRITICAL("Oops! Daemon actors cannot do any blocking activity (communications, synchronization, etc) "
407 "once the simulation is over. Please fix your on_exit() functions.");
409 XBT_CRITICAL("Oops! Deadlock or code not perfectly clean.");
411 display_all_actor_status();
412 simgrid::s4u::Engine::on_deadlock();
413 for (auto const& kv : actor_list_) {
414 XBT_DEBUG("Kill %s", kv.second->get_cname());
415 simix_global->get_maestro()->kill(kv.second);
418 } while (time > -1.0 || has_actors_to_run());
420 if (not actor_list_.empty())
423 simgrid::s4u::Engine::on_simulation_end();
425 } // namespace kernel
426 } // namespace simgrid