src/kernel/EngineImpl.cpp

   1 /* Copyright (c) 2016-2021. 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 "src/kernel/EngineImpl.hpp"
   7 #include "mc/mc.h"
   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
  22
  23 #include <boost/algorithm/string/predicate.hpp>
  24 #ifndef _WIN32
  25 #include <dlfcn.h>
  26 #endif /* _WIN32 */
  27
  28 XBT_LOG_NEW_DEFAULT_CATEGORY(ker_engine, "Logging specific to Engine (kernel)");
  29
  30 namespace simgrid {
  31 namespace kernel {
  32
  33 config::Flag<double> cfg_breakpoint{"debug/breakpoint",
  34                                     "When non-negative, raise a SIGTRAP after given (simulated) time", -1.0};
  35 EngineImpl::~EngineImpl()
  36 {
  37   while (not timer::kernel_timers().empty()) {
  38     delete timer::kernel_timers().top().second;
  39     timer::kernel_timers().pop();
  40   }
  41
  42   /* Since hosts_ is a std::map, the hosts are destroyed in the lexicographic order, which ensures that the output is
  43    * reproducible.
  44    */
  45   while (not hosts_.empty())
  46     hosts_.begin()->second->destroy();
  47
  48   /* Also delete the other data */
  49   delete netzone_root_;
  50   for (auto const& kv : netpoints_)
  51     delete kv.second;
  52
  53   for (auto const& kv : links_)
  54     if (kv.second)
  55       kv.second->destroy();
  56
  57   for (auto const& kv : mailboxes_)
  58     delete kv.second;
  59
  60     /* Free the remaining data structures */
  61 #if SIMGRID_HAVE_MC
  62   xbt_dynar_free(&actors_vector_);
  63   xbt_dynar_free(&dead_actors_vector_);
  64 #endif
  65   /* clear models before freeing handle, network models can use external callback defined in the handle */
  66   models_prio_.clear();
  67 }
  68
  69 void EngineImpl::load_platform(const std::string& platf)
  70 {
  71   double start = xbt_os_time();
  72   if (boost::algorithm::ends_with(platf, ".so") or boost::algorithm::ends_with(platf, ".dylib")) {
  73 #ifdef _WIN32
  74     xbt_die("loading platform through shared library isn't supported on windows");
  75 #else
  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());
  84 #endif /* _WIN32 */
  85   } else {
  86     parse_platform_file(platf);
  87   }
  88
  89   double end = xbt_os_time();
  90   XBT_DEBUG("PARSE TIME: %g", (end - start));
  91 }
  92
  93 void EngineImpl::load_deployment(const std::string& file) const
  94 {
  95   sg_platf_exit();
  96   sg_platf_init();
  97
  98   surf_parse_open(file);
  99   surf_parse();
 100   surf_parse_close();
 101 }
 102
 103 void EngineImpl::register_function(const std::string& name, const actor::ActorCodeFactory& code)
 104 {
 105   registered_functions[name] = code;
 106 }
 107 void EngineImpl::register_default(const actor::ActorCodeFactory& code)
 108 {
 109   default_function = code;
 110 }
 111
 112 void EngineImpl::add_model(std::shared_ptr<resource::Model> model, const std::vector<resource::Model*>& dependencies)
 113 {
 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());
 117
 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());
 121   }
 122   models_.push_back(model.get());
 123   models_prio_[model_name] = std::move(model);
 124 }
 125
 126 void EngineImpl::add_split_duplex_link(const std::string& name, std::unique_ptr<resource::SplitDuplexLinkImpl> link)
 127 {
 128   split_duplex_links_[name] = std::move(link);
 129 }
 130
 131 /** Wake up all actors waiting for a Surf action to finish */
 132 void EngineImpl::wake_all_waiting_actors() const
 133 {
 134   for (auto const& model : models_) {
 135     XBT_DEBUG("Handling the failed actions (if any)");
 136     while (auto* action = model->extract_failed_action()) {
 137       XBT_DEBUG("   Handling Action %p", action);
 138       if (action->get_activity() != nullptr)
 139         activity::ActivityImplPtr(action->get_activity())->post();
 140     }
 141     XBT_DEBUG("Handling the terminated actions (if any)");
 142     while (auto* action = model->extract_done_action()) {
 143       XBT_DEBUG("   Handling Action %p", action);
 144       if (action->get_activity() == nullptr)
 145         XBT_DEBUG("probably vcpu's action %p, skip", action);
 146       else
 147         activity::ActivityImplPtr(action->get_activity())->post();
 148     }
 149   }
 150 }
 151 /**
 152  * @brief Executes the actors in actors_to_run.
 153  *
 154  * The actors in actors_to_run are run (in parallel if possible). On exit, actors_to_run is empty, and actors_that_ran
 155  * contains the list of actors that just ran.  The two lists are swapped so, be careful when using them before and after
 156  * a call to this function.
 157  */
 158 void EngineImpl::run_all_actors()
 159 {
 160   simix_global->get_context_factory()->run_all();
 161
 162   actors_to_run_.swap(actors_that_ran_);
 163   actors_to_run_.clear();
 164 }
 165
 166 actor::ActorImpl* EngineImpl::get_actor_by_pid(aid_t pid)
 167 {
 168   auto item = actor_list_.find(pid);
 169   if (item != actor_list_.end())
 170     return item->second;
 171
 172   // Search the trash
 173   for (auto& a : actors_to_destroy_)
 174     if (a.get_pid() == pid)
 175       return &a;
 176   return nullptr; // Not found, even in the trash
 177 }
 178 /** Execute all the tasks that are queued, e.g. `.then()` callbacks of futures. */
 179 bool EngineImpl::execute_tasks()
 180 {
 181   if (tasks.empty())
 182     return false;
 183
 184   std::vector<xbt::Task<void()>> tasksTemp;
 185   do {
 186     // We don't want the callbacks to modify the vector we are iterating over:
 187     tasks.swap(tasksTemp);
 188
 189     // Execute all the queued tasks:
 190     for (auto& task : tasksTemp)
 191       task();
 192
 193     tasksTemp.clear();
 194   } while (not tasks.empty());
 195
 196   return true;
 197 }
 198
 199 void EngineImpl::remove_daemon(actor::ActorImpl* actor)
 200 {
 201   auto it = daemons_.find(actor);
 202   xbt_assert(it != daemons_.end(), "The dying daemon is not a daemon after all. Please report that bug.");
 203   daemons_.erase(it);
 204 }
 205
 206 void EngineImpl::add_actor_to_run_list_no_check(actor::ActorImpl* actor)
 207 {
 208   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), actor->get_host()->get_cname());
 209   actors_to_run_.push_back(actor);
 210 }
 211
 212 void EngineImpl::add_actor_to_run_list(actor::ActorImpl* actor)
 213 {
 214   if (std::find(begin(actors_to_run_), end(actors_to_run_), actor) != end(actors_to_run_)) {
 215     XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
 216   } else {
 217     XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), actor->get_host()->get_cname());
 218     actors_to_run_.push_back(actor);
 219   }
 220 }
 221 void EngineImpl::empty_trash()
 222 {
 223   while (not actors_to_destroy_.empty()) {
 224     actor::ActorImpl* actor = &actors_to_destroy_.front();
 225     actors_to_destroy_.pop_front();
 226     XBT_DEBUG("Getting rid of %s (refcount: %d)", actor->get_cname(), actor->get_refcount());
 227     intrusive_ptr_release(actor);
 228   }
 229 #if SIMGRID_HAVE_MC
 230   xbt_dynar_reset(dead_actors_vector_);
 231 #endif
 232 }
 233
 234 void EngineImpl::display_all_actor_status() const
 235 {
 236   XBT_INFO("%zu actors are still running, waiting for something.", actor_list_.size());
 237   /*  List the actors and their state */
 238   XBT_INFO("Legend of the following listing: \"Actor <pid> (<name>@<host>): <status>\"");
 239   for (auto const& kv : actor_list_) {
 240     actor::ActorImpl* actor = kv.second;
 241
 242     if (actor->waiting_synchro_) {
 243       const char* synchro_description = "unknown";
 244
 245       if (boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(actor->waiting_synchro_) != nullptr)
 246         synchro_description = "execution";
 247
 248       if (boost::dynamic_pointer_cast<kernel::activity::CommImpl>(actor->waiting_synchro_) != nullptr)
 249         synchro_description = "communication";
 250
 251       if (boost::dynamic_pointer_cast<kernel::activity::SleepImpl>(actor->waiting_synchro_) != nullptr)
 252         synchro_description = "sleeping";
 253
 254       if (boost::dynamic_pointer_cast<kernel::activity::RawImpl>(actor->waiting_synchro_) != nullptr)
 255         synchro_description = "synchronization";
 256
 257       if (boost::dynamic_pointer_cast<kernel::activity::IoImpl>(actor->waiting_synchro_) != nullptr)
 258         synchro_description = "I/O";
 259
 260       XBT_INFO("Actor %ld (%s@%s): waiting for %s activity %#zx (%s) in state %d to finish", actor->get_pid(),
 261                actor->get_cname(), actor->get_host()->get_cname(), synchro_description,
 262                (xbt_log_no_loc ? (size_t)0xDEADBEEF : (size_t)actor->waiting_synchro_.get()),
 263                actor->waiting_synchro_->get_cname(), (int)actor->waiting_synchro_->state_);
 264     } else {
 265       XBT_INFO("Actor %ld (%s@%s) simcall %s", actor->get_pid(), actor->get_cname(), actor->get_host()->get_cname(),
 266                SIMIX_simcall_name(actor->simcall_));
 267     }
 268   }
 269 }
 270
 271 void EngineImpl::run()
 272 {
 273   if (MC_record_replay_is_active()) {
 274     mc::replay(MC_record_path());
 275     empty_trash();
 276     return;
 277   }
 278
 279   double time = 0;
 280
 281   do {
 282     XBT_DEBUG("New Schedule Round; size(queue)=%zu", actors_to_run_.size());
 283
 284     if (cfg_breakpoint >= 0.0 && surf_get_clock() >= cfg_breakpoint) {
 285       XBT_DEBUG("Breakpoint reached (%g)", cfg_breakpoint.get());
 286       cfg_breakpoint = -1.0;
 287 #ifdef SIGTRAP
 288       std::raise(SIGTRAP);
 289 #else
 290       std::raise(SIGABRT);
 291 #endif
 292     }
 293
 294     execute_tasks();
 295
 296     while (not actors_to_run_.empty()) {
 297       XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", actors_to_run_.size());
 298
 299       /* Run all actors that are ready to run, possibly in parallel */
 300       run_all_actors();
 301
 302       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
 303
 304       /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
 305
 306       /* Here, the order is ok because:
 307        *
 308        *   Short proof: only maestro adds stuff to the actors_to_run array, so the execution order of user contexts do
 309        *   not impact its order.
 310        *
 311        *   Long proof: actors remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
 312        *
 313        *   - if there is no kill during the simulation, actors remain sorted according by their PID.
 314        *     Rationale: This can be proved inductively.
 315        *        Assume that actors_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
 316        *        is parsed linearly).
 317        *        Let's show that it is still so at the end of this round.
 318        *        - if an actor is added when being created, that's from maestro. It can be either at startup
 319        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
 320        *          in arbitrary order (inductive hypothesis), we are fine.
 321        *        - If an actor is added because it's getting killed, its subsequent actions shouldn't matter
 322        *        - If an actor gets added to actors_to_run because one of their blocking action constituting the meat
 323        *          of a simcall terminates, we're still good. Proof:
 324        *          - You are added from ActorImpl::simcall_answer() only. When this function is called depends on the
 325        *            resource kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications
 326        *            as an example.
 327        *          - For communications, this function is called from SIMIX_comm_finish().
 328        *            This function itself don't mess with the order since simcalls are handled in FIFO order.
 329        *            The function is called:
 330        *            - before the comm starts (invalid parameters, or resource already dead or whatever).
 331        *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
 332        *            - because the communication failed or were canceled after startup. In this case, it's called from
 333        *              the function we are in, by the chunk:
 334        *                       set = model->states.failed_action_set;
 335        *                       while ((synchro = extract(set)))
 336        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
 337        *              This order is also fixed because it depends of the order in which the surf actions were
 338        *              added to the system, and only maestro can add stuff this way, through simcalls.
 339        *              We thus use the inductive hypothesis once again to conclude that the order in which synchros are
 340        *              popped out of the set does not depend on the user code's execution order.
 341        *            - because the communication terminated. In this case, synchros are served in the order given by
 342        *                       set = model->states.done_action_set;
 343        *                       while ((synchro = extract(set)))
 344        *                          SIMIX_simcall_post((smx_synchro_t) synchro->data);
 345        *              and the argument is very similar to the previous one.
 346        *            So, in any case, the orders of calls to CommImpl::finish() do not depend on the order in which user
 347        *            actors are executed.
 348        *          So, in any cases, the orders of actors within actors_to_run do not depend on the order in which
 349        *          user actors were executed previously.
 350        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
 351        *   - If there is some actor killings, the order is changed by this decision that comes from user-land
 352        *     But this decision may not have been motivated by a situation that were different because the simulation is
 353        *     not reproducible.
 354        *     So, even the order change induced by the actor killing is perfectly reproducible.
 355        *
 356        *   So science works, bitches [http://xkcd.com/54/].
 357        *
 358        *   We could sort the actors_that_ran array completely so that we can describe the order in which simcalls are
 359        *   handled (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if
 360        *   unfriendly).
 361        *   That would thus be a pure waste of time.
 362        */
 363
 364       for (auto const& actor : actors_that_ran_) {
 365         if (actor->simcall_.call_ != simix::Simcall::NONE) {
 366           actor->simcall_handle(0);
 367         }
 368       }
 369
 370       execute_tasks();
 371       do {
 372         wake_all_waiting_actors();
 373       } while (execute_tasks());
 374
 375       /* If only daemon actors remain, cancel their actions, mark them to die and reschedule them */
 376       if (actor_list_.size() == daemons_.size())
 377         for (auto const& dmon : daemons_) {
 378           XBT_DEBUG("Kill %s", dmon->get_cname());
 379           simix_global->get_maestro()->kill(dmon);
 380         }
 381     }
 382
 383     time = timer::Timer::next();
 384     if (time > -1.0 || not actor_list_.empty()) {
 385       XBT_DEBUG("Calling surf_solve");
 386       time = surf_solve(time);
 387       XBT_DEBUG("Moving time ahead : %g", time);
 388     }
 389
 390     /* Notify all the hosts that have failed */
 391     /* FIXME: iterate through the list of failed host and mark each of them */
 392     /* as failed. On each host, signal all the running actors with host_fail */
 393
 394     // Execute timers and tasks until there isn't anything to be done:
 395     bool again = false;
 396     do {
 397       again = timer::Timer::execute_all();
 398       if (execute_tasks())
 399         again = true;
 400       wake_all_waiting_actors();
 401     } while (again);
 402
 403     /* Clean actors to destroy */
 404     empty_trash();
 405
 406     XBT_DEBUG("### time %f, #actors %zu, #to_run %zu", time, actor_list_.size(), actors_to_run_.size());
 407
 408     if (time < 0. && actors_to_run_.empty() && not actor_list_.empty()) {
 409       if (actor_list_.size() <= daemons_.size()) {
 410         XBT_CRITICAL("Oops! Daemon actors cannot do any blocking activity (communications, synchronization, etc) "
 411                      "once the simulation is over. Please fix your on_exit() functions.");
 412       } else {
 413         XBT_CRITICAL("Oops! Deadlock or code not perfectly clean.");
 414       }
 415       display_all_actor_status();
 416       simgrid::s4u::Engine::on_deadlock();
 417       for (auto const& kv : actor_list_) {
 418         XBT_DEBUG("Kill %s", kv.second->get_cname());
 419         simix_global->get_maestro()->kill(kv.second);
 420       }
 421     }
 422   } while (time > -1.0 || has_actors_to_run());
 423
 424   if (not actor_list_.empty())
 425     THROW_IMPOSSIBLE;
 426
 427   simgrid::s4u::Engine::on_simulation_end();
 428 }
 429 } // namespace kernel
 430 } // namespace simgrid