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     engine->add_actor_to_destroy_list(*this);
 146 }
 147
 148 void ActorImpl::cleanup()
 149 {
 150   finished_ = true;
 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   if (on_exit) {
 159     // Execute the termination callbacks
 160     bool failed = context_->wannadie();
 161     for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
 162       (*exit_fun)(failed);
 163     on_exit.reset();
 164   }
 165   undaemonize();
 166
 167   /* cancel non-blocking activities */
 168   for (auto activity : activities_)
 169     activity->cancel();
 170   activities_.clear();
 171
 172   while (not mailboxes.empty())
 173     mailboxes.back()->set_receiver(nullptr);
 174
 175   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
 176
 177   if (EngineImpl::get_instance()->is_maestro(this)) /* Do not cleanup maestro */
 178     return;
 179
 180   XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro_.get());
 181
 182   /* Unregister associated timers if any */
 183   if (kill_timer_ != nullptr) {
 184     kill_timer_->remove();
 185     kill_timer_ = nullptr;
 186   }
 187   if (simcall_.timeout_cb_) {
 188     simcall_.timeout_cb_->remove();
 189     simcall_.timeout_cb_ = nullptr;
 190   }
 191
 192   cleanup_from_simix();
 193
 194   context_->set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
 195   actor::simcall_answered([this] { s4u::Actor::on_termination(*get_ciface()); });
 196   context_->set_wannadie();
 197 }
 198
 199 void ActorImpl::exit()
 200 {
 201   context_->set_wannadie();
 202   suspended_          = false;
 203   exception_          = nullptr;
 204
 205   /* destroy the blocking synchro if any */
 206   if (auto activity = waiting_synchro_) {
 207     activities_.remove(waiting_synchro_);
 208     waiting_synchro_ = nullptr;
 209
 210     activity->cancel();
 211     activity->set_state(activity::State::FAILED);
 212     activity->post();
 213   }
 214   for (auto const& activity : activities_)
 215     activity->cancel();
 216   activities_.clear();
 217
 218   while (not mailboxes.empty())
 219     mailboxes.back()->set_receiver(nullptr);
 220
 221   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
 222   this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
 223 }
 224
 225 void ActorImpl::kill(ActorImpl* actor) const
 226 {
 227   xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
 228   if (actor->finished_) {
 229     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
 230               actor->host_->get_cname());
 231     return;
 232   }
 233
 234   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
 235             actor->host_ ? actor->host_->get_cname() : "");
 236
 237   actor->exit();
 238
 239   if (actor == this) {
 240     XBT_DEBUG("Go on, this is a suicide,");
 241   } else
 242     EngineImpl::get_instance()->add_actor_to_run_list(actor);
 243 }
 244
 245 void ActorImpl::kill_all() const
 246 {
 247   for (auto const& kv : EngineImpl::get_instance()->get_actor_list())
 248     if (kv.second != this)
 249       this->kill(kv.second);
 250 }
 251
 252 void ActorImpl::set_kill_time(double kill_time)
 253 {
 254   if (kill_time <= s4u::Engine::get_clock())
 255     return;
 256   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
 257   kill_timer_ = timer::Timer::set(kill_time, [this] {
 258     this->exit();
 259     kill_timer_ = nullptr;
 260   });
 261 }
 262
 263 double ActorImpl::get_kill_time() const
 264 {
 265   return kill_timer_ ? kill_timer_->get_date() : 0.0;
 266 }
 267
 268 void ActorImpl::yield()
 269 {
 270   XBT_DEBUG("Yield actor '%s'", get_cname());
 271
 272   /* Go into sleep and return control to maestro */
 273   context_->suspend();
 274   /* Ok, maestro returned control to us */
 275   XBT_DEBUG("Control returned to me: '%s'", get_cname());
 276
 277   if (context_->wannadie()) {
 278     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
 279     context_->stop();
 280     THROW_IMPOSSIBLE;
 281   }
 282
 283   if (suspended_) {
 284     XBT_DEBUG("Hey! I'm suspended.");
 285     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
 286     yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
 287   }
 288
 289   if (exception_ != nullptr) {
 290     XBT_DEBUG("Wait, maestro left me an exception");
 291     std::exception_ptr exception = std::move(exception_);
 292     exception_                   = nullptr;
 293     try {
 294       std::rethrow_exception(std::move(exception));
 295     } catch (const simgrid::Exception& e) {
 296       e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
 297     }
 298   }
 299 #if HAVE_SMPI
 300   if (not finished_)
 301     smpi_switch_data_segment(get_iface());
 302 #endif
 303 }
 304
 305 /** This actor will be terminated automatically when the last non-daemon actor finishes */
 306 void ActorImpl::daemonize()
 307 {
 308   if (not daemon_) {
 309     daemon_ = true;
 310     EngineImpl::get_instance()->add_daemon(this);
 311   }
 312 }
 313
 314 void ActorImpl::undaemonize()
 315 {
 316   if (daemon_) {
 317     daemon_ = false;
 318     EngineImpl::get_instance()->remove_daemon(this);
 319   }
 320 }
 321
 322 s4u::Actor* ActorImpl::restart()
 323 {
 324   xbt_assert(not this->is_maestro(), "Restarting maestro is not supported");
 325
 326   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
 327
 328   // retrieve the arguments of the old actor
 329   ProcessArg arg(host_, this);
 330
 331   // kill the old actor
 332   context::Context::self()->get_actor()->kill(this);
 333
 334   // start the new actor
 335   ActorImplPtr actor = ActorImpl::create(arg.name, arg.code, arg.data, arg.host, nullptr);
 336   actor->set_properties(arg.properties);
 337   *actor->on_exit = std::move(*arg.on_exit);
 338   actor->set_kill_time(arg.kill_time);
 339   actor->set_auto_restart(arg.auto_restart);
 340
 341   return actor->get_ciface();
 342 }
 343
 344 void ActorImpl::suspend()
 345 {
 346   if (suspended_) {
 347     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
 348     return;
 349   }
 350
 351   suspended_ = true;
 352
 353   /* Suspend the activities associated with this actor. */
 354   for (auto const& activity : activities_)
 355     activity->suspend();
 356 }
 357
 358 void ActorImpl::resume()
 359 {
 360   XBT_IN("actor = %p", this);
 361
 362   if (context_->wannadie()) {
 363     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
 364     return;
 365   }
 366
 367   if (not suspended_)
 368     return;
 369   suspended_ = false;
 370
 371   /* resume the activities that were blocked when suspending the actor. */
 372   for (auto const& activity : activities_)
 373     activity->resume();
 374   if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
 375     EngineImpl::get_instance()->add_actor_to_run_list_no_check(this);
 376
 377   XBT_OUT();
 378 }
 379
 380 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
 381 {
 382   activity::ActivityImplPtr sleep = this->sleep(timeout);
 383   actor->on_exit->emplace_back([sleep](bool) {
 384     if (sleep->surf_action_)
 385       sleep->surf_action_->finish(resource::Action::State::FINISHED);
 386   });
 387   return sleep;
 388 }
 389
 390 activity::ActivityImplPtr ActorImpl::sleep(double duration)
 391 {
 392   if (not host_->is_on())
 393     throw_exception(std::make_exception_ptr(HostFailureException(
 394         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
 395
 396   auto sleep = new activity::SleepImpl();
 397   sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
 398   return activity::SleepImplPtr(sleep);
 399 }
 400
 401 void ActorImpl::throw_exception(std::exception_ptr e)
 402 {
 403   exception_ = e;
 404
 405   if (suspended_)
 406     resume();
 407
 408   /* cancel the blocking synchro if any */
 409   if (waiting_synchro_) {
 410     waiting_synchro_->cancel();
 411     activities_.remove(waiting_synchro_);
 412     waiting_synchro_ = nullptr;
 413   }
 414 }
 415
 416 void ActorImpl::simcall_answer()
 417 {
 418   auto* engine = EngineImpl::get_instance();
 419   if (not this->is_maestro()) {
 420     XBT_DEBUG("Answer simcall %s issued by %s (%p)", SIMIX_simcall_name(simcall_), get_cname(), this);
 421     xbt_assert(simcall_.call_ != simix::Simcall::NONE);
 422     simcall_.call_ = simix::Simcall::NONE;
 423     const auto& actors_to_run = engine->get_actors_to_run();
 424     xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
 425                    std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
 426                "Actor %p should not exist in actors_to_run!", this);
 427     engine->add_actor_to_run_list_no_check(this);
 428   }
 429 }
 430
 431 void ActorImpl::set_host(s4u::Host* dest)
 432 {
 433   host_->get_impl()->remove_actor(this);
 434   host_ = dest;
 435   dest->get_impl()->add_actor(this);
 436 }
 437
 438 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
 439 {
 440   auto* actor = new ActorImpl(xbt::string(name), host);
 441   actor->set_ppid(this->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'", name_.c_str(), 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(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
 495 void create_maestro(const std::function<void()>& code)
 496 {
 497   auto* engine = EngineImpl::get_instance();
 498   /* Create maestro actor and initialize it */
 499   auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
 500
 501   if (not code) {
 502     maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
 503   } else {
 504     maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
 505   }
 506
 507   maestro->simcall_.issuer_ = maestro;
 508   engine->set_maestro(maestro);
 509 }
 510
 511 } // namespace actor
 512 } // namespace kernel
 513 } // namespace simgrid
 514
 515 /* needs to be public and without simcall because it is called by exceptions and logging events */
 516 const char* SIMIX_process_self_get_name() // XBT_ATTRIB_DEPRECATED_v333
 517 {
 518   return simgrid::s4u::Actor::is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
 519 }
 520
 521 int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
 522 {
 523   const auto* self = simgrid::kernel::actor::ActorImpl::self();
 524   return self != nullptr && self->is_maestro();
 525 }