src/kernel/actor/ActorImpl.cpp

   1 /* Copyright (c) 2007-2022. 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/s4u/Actor.hpp>
   8 #include <simgrid/s4u/Host.hpp>
   9
  10 #define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333)
  11 #include <simgrid/simix.h>
  12
  13 #include "src/kernel/EngineImpl.hpp"
  14 #if HAVE_SMPI
  15 #include "src/smpi/include/private.hpp"
  16 #endif
  17 #include "src/surf/HostImpl.hpp"
  18
  19 #include <boost/core/demangle.hpp>
  20 #include <typeinfo>
  21 #include <utility>
  22
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_actor, kernel, "Logging specific to Actor's kernel side");
  24
  25 /**
  26  * @brief Returns the current agent.
  27  *
  28  * This functions returns the currently running SIMIX process.
  29  *
  30  * @return The SIMIX process
  31  */
  32 simgrid::kernel::actor::ActorImpl* SIMIX_process_self() // XBT_ATTRIB_DEPRECATED_v333
  33 {
  34   return simgrid::kernel::actor::ActorImpl::self();
  35 }
  36
  37 namespace simgrid {
  38 namespace kernel {
  39 namespace actor {
  40
  41 /*------------------------- [ ActorIDTrait ] -------------------------*/
  42 static unsigned long maxpid = 0;
  43 unsigned long get_maxpid()
  44 {
  45   return maxpid;
  46 }
  47 unsigned long* get_maxpid_addr()
  48 {
  49   return &maxpid;
  50 }
  51 ActorIDTrait::ActorIDTrait(std::string name, aid_t ppid) : name_(std::move(name)), pid_(maxpid++), ppid_(ppid) {}
  52
  53 ActorImpl* ActorImpl::self()
  54 {
  55   const context::Context* self_context = context::Context::self();
  56
  57   return (self_context != nullptr) ? self_context->get_actor() : nullptr;
  58 }
  59
  60 ActorImpl::ActorImpl(xbt::string name, s4u::Host* host, aid_t ppid)
  61     : ActorIDTrait(std::move(name), ppid), host_(host), piface_(this)
  62 {
  63   simcall_.issuer_ = this;
  64   stacksize_       = context::stack_size;
  65 }
  66
  67 ActorImpl::~ActorImpl()
  68 {
  69   if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
  70     s4u::Actor::on_destruction(*get_ciface());
  71 }
  72
  73 /* Become an actor in the simulation
  74  *
  75  * Currently this can only be called by the main thread (once) and only work with some thread factories
  76  * (currently ThreadContextFactory).
  77  *
  78  * In the future, it might be extended in order to attach other threads created by a third party library.
  79  */
  80
  81 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
  82 {
  83   // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
  84   auto* engine = EngineImpl::get_instance();
  85   XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
  86
  87   if (not host->is_on()) {
  88     XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
  89     throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
  90   }
  91
  92   auto* actor = new ActorImpl(xbt::string(name), host, /*ppid*/ -1);
  93   /* Actor data */
  94   actor->piface_.set_data(data);
  95   actor->code_ = nullptr;
  96
  97   XBT_VERB("Create context %s", actor->get_cname());
  98   actor->context_.reset(engine->get_context_factory()->attach(actor));
  99
 100   /* Add the actor to it's host actor list */
 101   host->get_impl()->add_actor(actor);
 102
 103   /* Now insert it in the global actor list and in the actors to run list */
 104   engine->add_actor(actor->get_pid(), actor);
 105   engine->add_actor_to_run_list_no_check(actor);
 106   intrusive_ptr_add_ref(actor);
 107
 108   auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
 109   xbt_assert(nullptr != context, "Not a suitable context");
 110   context->attach_start();
 111
 112   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 113   s4u::Actor::on_creation(*actor->get_ciface());
 114
 115   return ActorImplPtr(actor);
 116 }
 117 /** @brief Detach an actor attached with `attach()`
 118  *
 119  *  This is called when the current actor has finished its job.
 120  *  Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
 121  *  simulated actors and the maestro are destroyed.
 122  */
 123 void ActorImpl::detach()
 124 {
 125   auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
 126   xbt_assert(context != nullptr, "Not a suitable context");
 127
 128   context->get_actor()->cleanup_from_self();
 129   context->attach_stop();
 130 }
 131
 132 /** Whether this actor is actually maestro */
 133 bool ActorImpl::is_maestro() const
 134 {
 135   return context_->is_maestro();
 136 }
 137
 138 void ActorImpl::cleanup_from_kernel()
 139 {
 140   xbt_assert(s4u::Actor::is_maestro(), "Cleanup_from_kernel must be called in maestro context");
 141
 142   auto* engine = EngineImpl::get_instance();
 143   if (engine->get_actor_by_pid(get_pid()) == nullptr)
 144     return; // Already cleaned
 145
 146   engine->remove_actor(get_pid());
 147   if (host_ && host_actor_list_hook.is_linked())
 148     host_->get_impl()->remove_actor(this);
 149   if (not kernel_destroy_list_hook.is_linked())
 150     engine->add_actor_to_destroy_list(*this);
 151
 152   if (has_to_auto_restart() && not get_host()->is_on()) {
 153     XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
 154               get_cname());
 155     watched_hosts().insert(get_host()->get_name());
 156   }
 157
 158   undaemonize();
 159   s4u::Actor::on_termination(*get_ciface());
 160
 161   while (not mailboxes_.empty())
 162     mailboxes_.back()->set_receiver(nullptr);
 163 }
 164
 165 /* Do all the cleanups from the actor context. Warning, the simcall mechanism was not reignited so doing simcalls in
 166  * this context is dangerous */
 167 void ActorImpl::cleanup_from_self()
 168 {
 169   xbt_assert(not ActorImpl::is_maestro(), "Cleanup_from_self called from maestro on '%s'", get_cname());
 170   set_to_be_freed();
 171
 172   if (on_exit) {
 173     // Execute the termination callbacks
 174     bool failed = wannadie();
 175     for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
 176       (*exit_fun)(failed);
 177     on_exit.reset();
 178   }
 179
 180   /* cancel non-blocking activities */
 181   for (auto activity : activities_)
 182     activity->cancel();
 183   activities_.clear();
 184
 185   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
 186
 187   /* Unregister associated timers if any */
 188   if (kill_timer_ != nullptr) {
 189     kill_timer_->remove();
 190     kill_timer_ = nullptr;
 191   }
 192   if (simcall_.timeout_cb_) {
 193     simcall_.timeout_cb_->remove();
 194     simcall_.timeout_cb_ = nullptr;
 195   }
 196
 197   set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
 198   actor::simcall_answered([] {}); // This empty callback is mandatory even if it drives me nuts.
 199   set_wannadie();
 200 }
 201
 202 void ActorImpl::exit()
 203 {
 204   set_wannadie();
 205   suspended_ = false;
 206   exception_ = nullptr;
 207
 208   if (waiting_synchro_ != nullptr) {
 209     /* Take an extra reference on the activity object that may be unref by Comm::finish() or friends */
 210     activity::ActivityImplPtr activity = waiting_synchro_;
 211     activity->cancel();
 212     activity->set_state(activity::State::FAILED);
 213     activity->post();
 214
 215     activities_.remove(waiting_synchro_);
 216     waiting_synchro_ = nullptr;
 217   }
 218   for (auto const& activity : activities_)
 219     activity->cancel();
 220   activities_.clear();
 221
 222   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
 223   this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
 224 }
 225
 226 void ActorImpl::kill(ActorImpl* actor) const
 227 {
 228   xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
 229   if (actor->wannadie()) {
 230     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
 231               actor->host_->get_cname());
 232     return;
 233   }
 234
 235   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
 236             actor->host_ ? actor->host_->get_cname() : "");
 237
 238   actor->exit();
 239
 240   if (actor == this) {
 241     XBT_DEBUG("Go on, this is a suicide,");
 242   } else
 243     EngineImpl::get_instance()->add_actor_to_run_list(actor);
 244 }
 245
 246 void ActorImpl::kill_all() const
 247 {
 248   for (auto const& kv : EngineImpl::get_instance()->get_actor_list())
 249     if (kv.second != this)
 250       this->kill(kv.second);
 251 }
 252
 253 void ActorImpl::set_kill_time(double kill_time)
 254 {
 255   if (kill_time <= s4u::Engine::get_clock())
 256     return;
 257   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
 258   kill_timer_ = timer::Timer::set(kill_time, [this] {
 259     this->exit();
 260     kill_timer_ = nullptr;
 261     EngineImpl::get_instance()->add_actor_to_run_list(this);
 262   });
 263 }
 264
 265 double ActorImpl::get_kill_time() const
 266 {
 267   return kill_timer_ ? kill_timer_->get_date() : 0.0;
 268 }
 269
 270 void ActorImpl::yield()
 271 {
 272   XBT_DEBUG("Yield actor '%s'", get_cname());
 273
 274   /* Go into sleep and return control to maestro */
 275   context_->suspend();
 276   /* Ok, maestro returned control to us */
 277   XBT_DEBUG("Control returned to me: '%s'", get_cname());
 278
 279   if (wannadie()) {
 280     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
 281     context_->stop();
 282     THROW_IMPOSSIBLE;
 283   }
 284
 285   if (suspended_) {
 286     XBT_DEBUG("Hey! I'm suspended.");
 287     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
 288     yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
 289   }
 290
 291   if (exception_ != nullptr) {
 292     XBT_DEBUG("Wait, maestro left me an exception");
 293     std::exception_ptr exception = std::move(exception_);
 294     exception_                   = nullptr;
 295     try {
 296       std::rethrow_exception(std::move(exception));
 297     } catch (const simgrid::Exception& e) {
 298       e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
 299     }
 300   }
 301 #if HAVE_SMPI
 302   if (not wannadie())
 303     smpi_switch_data_segment(get_iface());
 304 #endif
 305 }
 306
 307 /** This actor will be terminated automatically when the last non-daemon actor finishes */
 308 void ActorImpl::daemonize()
 309 {
 310   if (not daemon_) {
 311     daemon_ = true;
 312     EngineImpl::get_instance()->add_daemon(this);
 313   }
 314 }
 315
 316 void ActorImpl::undaemonize()
 317 {
 318   if (daemon_) {
 319     daemon_ = false;
 320     EngineImpl::get_instance()->remove_daemon(this);
 321   }
 322 }
 323
 324 s4u::Actor* ActorImpl::restart()
 325 {
 326   xbt_assert(not this->is_maestro(), "Restarting maestro is not supported");
 327
 328   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
 329
 330   // retrieve the arguments of the old actor
 331   ProcessArg args(host_, this);
 332
 333   // kill the old actor
 334   context::Context::self()->get_actor()->kill(this);
 335
 336   // start the new actor
 337   return create(&args)->get_ciface();
 338 }
 339
 340 void ActorImpl::suspend()
 341 {
 342   if (suspended_) {
 343     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
 344     return;
 345   }
 346
 347   suspended_ = true;
 348
 349   /* Suspend the activities associated with this actor. */
 350   for (auto const& activity : activities_)
 351     activity->suspend();
 352 }
 353
 354 void ActorImpl::resume()
 355 {
 356   XBT_IN("actor = %p", this);
 357
 358   if (wannadie()) {
 359     XBT_VERB("Ignoring request to resume an actor that is currently dying.");
 360     return;
 361   }
 362
 363   if (not suspended_)
 364     return;
 365   suspended_ = false;
 366
 367   /* resume the activities that were blocked when suspending the actor. */
 368   for (auto const& activity : activities_)
 369     activity->resume();
 370   if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
 371     EngineImpl::get_instance()->add_actor_to_run_list_no_check(this);
 372
 373   XBT_OUT();
 374 }
 375
 376 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
 377 {
 378   activity::ActivityImplPtr sleep = this->sleep(timeout);
 379   if (actor->wannadie() || actor->to_be_freed()) {
 380     if (sleep->surf_action_)
 381       sleep->surf_action_->finish(resource::Action::State::FINISHED);
 382   } else {
 383     actor->on_exit->emplace_back([sleep](bool) {
 384       if (sleep->surf_action_)
 385         sleep->surf_action_->finish(resource::Action::State::FINISHED);
 386     });
 387   }
 388   return sleep;
 389 }
 390
 391 activity::ActivityImplPtr ActorImpl::sleep(double duration)
 392 {
 393   if (not host_->is_on())
 394     throw_exception(std::make_exception_ptr(HostFailureException(
 395         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
 396
 397   auto sleep = new activity::SleepImpl();
 398   sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
 399   return activity::SleepImplPtr(sleep);
 400 }
 401
 402 void ActorImpl::throw_exception(std::exception_ptr e)
 403 {
 404   exception_ = e;
 405
 406   if (suspended_)
 407     resume();
 408
 409   /* cancel the blocking synchro if any */
 410   if (waiting_synchro_) {
 411     waiting_synchro_->cancel();
 412     activities_.remove(waiting_synchro_);
 413     waiting_synchro_ = nullptr;
 414   }
 415 }
 416
 417 void ActorImpl::simcall_answer()
 418 {
 419   auto* engine = EngineImpl::get_instance();
 420   if (not this->is_maestro()) {
 421     XBT_DEBUG("Answer simcall %s issued by %s (%p)", simcall_.get_cname(), get_cname(), this);
 422     xbt_assert(simcall_.call_ != Simcall::Type::NONE);
 423     simcall_.call_            = Simcall::Type::NONE;
 424     const auto& actors_to_run = engine->get_actors_to_run();
 425     xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
 426                    std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
 427                "Actor %p should not exist in actors_to_run!", this);
 428     engine->add_actor_to_run_list_no_check(this);
 429   }
 430 }
 431
 432 void ActorImpl::set_host(s4u::Host* dest)
 433 {
 434   host_->get_impl()->remove_actor(this);
 435   host_ = dest;
 436   dest->get_impl()->add_actor(this);
 437 }
 438
 439 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
 440 {
 441   auto* actor = new ActorImpl(xbt::string(name), host, get_pid());
 442
 443   intrusive_ptr_add_ref(actor);
 444   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 445   s4u::Actor::on_creation(*actor->get_ciface());
 446
 447   return ActorImplPtr(actor);
 448 }
 449
 450 ActorImpl* ActorImpl::start(const ActorCode& code)
 451 {
 452   xbt_assert(code && host_ != nullptr, "Invalid parameters");
 453   auto* engine = EngineImpl::get_instance();
 454
 455   if (not host_->is_on()) {
 456     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", get_cname(), host_->get_cname());
 457     intrusive_ptr_release(this);
 458     throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
 459   }
 460
 461   this->code_ = code;
 462   XBT_VERB("Create context %s", get_cname());
 463   context_.reset(engine->get_context_factory()->create_context(ActorCode(code), this));
 464
 465   XBT_DEBUG("Start context '%s'", get_cname());
 466
 467   /* Add the actor to its host's actor list */
 468   host_->get_impl()->add_actor(this);
 469   engine->add_actor(get_pid(), this);
 470
 471   /* Now insert it in the global actor list and in the actor to run list */
 472   engine->add_actor_to_run_list_no_check(this);
 473
 474   return this;
 475 }
 476
 477 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
 478                                const ActorImpl* parent_actor)
 479 {
 480   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
 481
 482   ActorImplPtr actor;
 483   if (parent_actor != nullptr)
 484     actor = parent_actor->init(xbt::string(name), host);
 485   else
 486     actor = self()->init(xbt::string(name), host);
 487
 488   actor->piface_.set_data(data); /* actor data */
 489
 490   actor->start(code);
 491
 492   return actor;
 493 }
 494 ActorImplPtr ActorImpl::create(ProcessArg* args)
 495 {
 496   ActorImplPtr actor    = ActorImpl::create(args->name, args->code, nullptr, args->host, nullptr);
 497   actor->restart_count_ = args->restart_count_;
 498   actor->set_properties(args->properties);
 499   if (args->on_exit)
 500     *actor->on_exit = *args->on_exit;
 501   if (args->kill_time >= 0)
 502     actor->set_kill_time(args->kill_time);
 503   if (args->auto_restart)
 504     actor->set_auto_restart(args->auto_restart);
 505   if (args->daemon_)
 506     actor->daemonize();
 507   return actor;
 508 }
 509 void ActorImpl::set_wannadie(bool value)
 510 {
 511   XBT_DEBUG("Actor %s gonna die.", get_cname());
 512   iwannadie_ = value;
 513 }
 514
 515 void create_maestro(const std::function<void()>& code)
 516 {
 517   auto* engine = EngineImpl::get_instance();
 518   /* Create maestro actor and initialize it */
 519   auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr, /*ppid*/ -1);
 520
 521   if (not code) {
 522     maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
 523   } else {
 524     maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
 525   }
 526
 527   maestro->simcall_.issuer_ = maestro;
 528   engine->set_maestro(maestro);
 529 }
 530
 531 } // namespace actor
 532 } // namespace kernel
 533 } // namespace simgrid
 534
 535 /* needs to be public and without simcall because it is called by exceptions and logging events */
 536 const char* SIMIX_process_self_get_name() // XBT_ATTRIB_DEPRECATED_v333
 537 {
 538   return simgrid::s4u::Actor::is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
 539 }
 540
 541 int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
 542 {
 543   const auto* self = simgrid::kernel::actor::ActorImpl::self();
 544   return self != nullptr && self->is_maestro();
 545 }