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