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