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 smx_actor_t 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 static unsigned long maxpid = 0;
  42 unsigned long get_maxpid()
  43 {
  44   return maxpid;
  45 }
  46 unsigned long* get_maxpid_addr()
  47 {
  48   return &maxpid;
  49 }
  50 ActorImpl* ActorImpl::by_pid(aid_t pid)
  51 {
  52   return EngineImpl::get_instance()->get_actor_by_pid(pid);
  53 }
  54
  55 ActorImpl* ActorImpl::self()
  56 {
  57   const context::Context* self_context = context::Context::self();
  58
  59   return (self_context != nullptr) ? self_context->get_actor() : nullptr;
  60 }
  61
  62 ActorImpl::ActorImpl(xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
  63 {
  64   pid_            = maxpid++;
  65   simcall_.issuer_ = this;
  66   stacksize_       = context::stack_size;
  67 }
  68
  69 ActorImpl::~ActorImpl()
  70 {
  71   if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
  72     s4u::Actor::on_destruction(*get_ciface());
  73 }
  74
  75 /* Become an actor in the simulation
  76  *
  77  * Currently this can only be called by the main thread (once) and only work with some thread factories
  78  * (currently ThreadContextFactory).
  79  *
  80  * In the future, it might be extended in order to attach other threads created by a third party library.
  81  */
  82
  83 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
  84 {
  85   // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
  86   auto* engine = EngineImpl::get_instance();
  87   XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
  88
  89   if (not host->is_on()) {
  90     XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
  91     throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
  92   }
  93
  94   auto* actor = new ActorImpl(xbt::string(name), host);
  95   /* Actor data */
  96   actor->piface_.set_data(data);
  97   actor->code_ = nullptr;
  98
  99   XBT_VERB("Create context %s", actor->get_cname());
 100   actor->context_.reset(engine->get_context_factory()->attach(actor));
 101
 102   /* Add the actor to it's host actor list */
 103   host->get_impl()->add_actor(actor);
 104
 105   /* Now insert it in the global actor list and in the actors to run list */
 106   engine->add_actor(actor->get_pid(), actor);
 107   engine->add_actor_to_run_list_no_check(actor);
 108   intrusive_ptr_add_ref(actor);
 109
 110   auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
 111   xbt_assert(nullptr != context, "Not a suitable context");
 112   context->attach_start();
 113
 114   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 115   s4u::Actor::on_creation(*actor->get_ciface());
 116
 117   return ActorImplPtr(actor);
 118 }
 119 /** @brief Detach an actor attached with `attach()`
 120  *
 121  *  This is called when the current actor has finished its job.
 122  *  Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
 123  *  simulated actors and the maestro are destroyed.
 124  */
 125 void ActorImpl::detach()
 126 {
 127   auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
 128   xbt_assert(context != nullptr, "Not a suitable context");
 129
 130   context->get_actor()->cleanup_from_self();
 131   context->attach_stop();
 132 }
 133
 134 /** Whether this actor is actually maestro */
 135 bool ActorImpl::is_maestro() const
 136 {
 137   return context_->is_maestro();
 138 }
 139
 140 void ActorImpl::cleanup_from_kernel()
 141 {
 142   xbt_assert(s4u::Actor::is_maestro(), "Cleanup_from_kernel called from '%s' on '%s'", ActorImpl::self()->get_cname(),
 143              get_cname());
 144
 145   auto* engine = EngineImpl::get_instance();
 146   engine->remove_actor(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
 160   while (not mailboxes.empty())
 161     mailboxes.back()->set_receiver(nullptr);
 162 }
 163
 164 /* Do all the cleanups from the actor context. Warning, the simcall mechanism was not reignited so doing simcalls in
 165  * this context is dangerous */
 166 void ActorImpl::cleanup_from_self()
 167 {
 168   xbt_assert(not ActorImpl::is_maestro(), "Cleanup_from_self called from maestro on '%s'", get_cname());
 169   context_->set_to_be_freed();
 170
 171   if (on_exit) {
 172     // Execute the termination callbacks
 173     bool failed = context_->wannadie();
 174     for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
 175       (*exit_fun)(failed);
 176     on_exit.reset();
 177   }
 178
 179   /* cancel non-blocking activities */
 180   for (auto activity : activities_)
 181     activity->cancel();
 182   activities_.clear();
 183
 184   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
 185
 186   /* Unregister associated timers if any */
 187   if (kill_timer_ != nullptr) {
 188     kill_timer_->remove();
 189     kill_timer_ = nullptr;
 190   }
 191   if (simcall_.timeout_cb_) {
 192     simcall_.timeout_cb_->remove();
 193     simcall_.timeout_cb_ = nullptr;
 194   }
 195
 196   context_->set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
 197   actor::simcall_answered([this] { s4u::Actor::on_termination(*get_ciface()); });
 198   context_->set_wannadie();
 199 }
 200
 201 void ActorImpl::exit()
 202 {
 203   context_->set_wannadie();
 204   suspended_ = false;
 205   exception_ = nullptr;
 206
 207   /* destroy the blocking synchro if any */
 208   if (waiting_synchro_ != nullptr) {
 209     activities_.remove(waiting_synchro_);
 210     waiting_synchro_->cancel();
 211     waiting_synchro_->set_state(activity::State::FAILED);
 212     waiting_synchro_->post();
 213     waiting_synchro_ = nullptr;
 214   }
 215   for (auto const& activity : activities_)
 216     activity->cancel();
 217   activities_.clear();
 218
 219   while (not mailboxes.empty())
 220     mailboxes.back()->set_receiver(nullptr);
 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->context_->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 (context_->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 context_->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 (context_->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   actor->on_exit->emplace_back([sleep](bool) {
 380     if (sleep->surf_action_)
 381       sleep->surf_action_->finish(resource::Action::State::FINISHED);
 382   });
 383   return sleep;
 384 }
 385
 386 activity::ActivityImplPtr ActorImpl::sleep(double duration)
 387 {
 388   if (not host_->is_on())
 389     throw_exception(std::make_exception_ptr(HostFailureException(
 390         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
 391
 392   auto sleep = new activity::SleepImpl();
 393   sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
 394   return activity::SleepImplPtr(sleep);
 395 }
 396
 397 void ActorImpl::throw_exception(std::exception_ptr e)
 398 {
 399   exception_ = e;
 400
 401   if (suspended_)
 402     resume();
 403
 404   /* cancel the blocking synchro if any */
 405   if (waiting_synchro_) {
 406     waiting_synchro_->cancel();
 407     activities_.remove(waiting_synchro_);
 408     waiting_synchro_ = nullptr;
 409   }
 410 }
 411
 412 void ActorImpl::simcall_answer()
 413 {
 414   auto* engine = EngineImpl::get_instance();
 415   if (not this->is_maestro()) {
 416     XBT_DEBUG("Answer simcall %s issued by %s (%p)", simcall_.get_cname(), get_cname(), this);
 417     xbt_assert(simcall_.call_ != Simcall::Type::NONE);
 418     simcall_.call_            = Simcall::Type::NONE;
 419     const auto& actors_to_run = engine->get_actors_to_run();
 420     xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
 421                    std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
 422                "Actor %p should not exist in actors_to_run!", this);
 423     engine->add_actor_to_run_list_no_check(this);
 424   }
 425 }
 426
 427 void ActorImpl::set_host(s4u::Host* dest)
 428 {
 429   host_->get_impl()->remove_actor(this);
 430   host_ = dest;
 431   dest->get_impl()->add_actor(this);
 432 }
 433
 434 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
 435 {
 436   auto* actor = new ActorImpl(xbt::string(name), host);
 437   actor->set_ppid(this->pid_);
 438
 439   intrusive_ptr_add_ref(actor);
 440   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 441   s4u::Actor::on_creation(*actor->get_ciface());
 442
 443   return ActorImplPtr(actor);
 444 }
 445
 446 ActorImpl* ActorImpl::start(const ActorCode& code)
 447 {
 448   xbt_assert(code && host_ != nullptr, "Invalid parameters");
 449   auto* engine = EngineImpl::get_instance();
 450
 451   if (not host_->is_on()) {
 452     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
 453     intrusive_ptr_release(this);
 454     throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
 455   }
 456
 457   this->code_ = code;
 458   XBT_VERB("Create context %s", get_cname());
 459   context_.reset(engine->get_context_factory()->create_context(ActorCode(code), this));
 460
 461   XBT_DEBUG("Start context '%s'", get_cname());
 462
 463   /* Add the actor to its host's actor list */
 464   host_->get_impl()->add_actor(this);
 465   engine->add_actor(pid_, this);
 466
 467   /* Now insert it in the global actor list and in the actor to run list */
 468   engine->add_actor_to_run_list_no_check(this);
 469
 470   return this;
 471 }
 472
 473 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
 474                                const ActorImpl* parent_actor)
 475 {
 476   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
 477
 478   ActorImplPtr actor;
 479   if (parent_actor != nullptr)
 480     actor = parent_actor->init(xbt::string(name), host);
 481   else
 482     actor = self()->init(xbt::string(name), host);
 483
 484   actor->piface_.set_data(data); /* actor data */
 485
 486   actor->start(code);
 487
 488   return actor;
 489 }
 490 ActorImplPtr ActorImpl::create(ProcessArg* args)
 491 {
 492   ActorImplPtr actor    = ActorImpl::create(args->name, args->code, nullptr, args->host, nullptr);
 493   actor->restart_count_ = args->restart_count_;
 494   actor->set_properties(args->properties);
 495   if (args->on_exit)
 496     *actor->on_exit = *args->on_exit;
 497   if (args->kill_time >= 0)
 498     actor->set_kill_time(args->kill_time);
 499   if (args->auto_restart)
 500     actor->set_auto_restart(args->auto_restart);
 501   if (args->daemon_)
 502     actor->daemonize();
 503   return actor;
 504 }
 505
 506 void create_maestro(const std::function<void()>& code)
 507 {
 508   auto* engine = EngineImpl::get_instance();
 509   /* Create maestro actor and initialize it */
 510   auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
 511
 512   if (not code) {
 513     maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
 514   } else {
 515     maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
 516   }
 517
 518   maestro->simcall_.issuer_ = maestro;
 519   engine->set_maestro(maestro);
 520 }
 521
 522 } // namespace actor
 523 } // namespace kernel
 524 } // namespace simgrid
 525
 526 /* needs to be public and without simcall because it is called by exceptions and logging events */
 527 const char* SIMIX_process_self_get_name() // XBT_ATTRIB_DEPRECATED_v333
 528 {
 529   return simgrid::s4u::Actor::is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
 530 }
 531
 532 int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
 533 {
 534   const auto* self = simgrid::kernel::actor::ActorImpl::self();
 535   return self != nullptr && self->is_maestro();
 536 }