src/kernel/actor/ActorImpl.cpp

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