src/kernel/actor/ActorImpl.cpp

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