src/kernel/actor/ActorImpl.cpp

   1 /* Copyright (c) 2007-2019. 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
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
  24
  25 static unsigned long simix_process_maxpid = 0;
  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   smx_context_t self_context = simgrid::kernel::context::Context::self();
  37
  38   return (self_context != nullptr) ? self_context->get_actor() : nullptr;
  39 }
  40
  41 /**
  42  * @brief Returns whether a process has pending asynchronous communications.
  43  * @return true if there are asynchronous communications in this process
  44  * @deprecated
  45  */
  46 int SIMIX_process_has_pending_comms(smx_actor_t process)
  47 {
  48
  49   return process->comms.size() > 0;
  50 }
  51
  52 namespace simgrid {
  53 namespace kernel {
  54 namespace actor {
  55
  56 ActorImpl::ActorImpl(const simgrid::xbt::string& name, s4u::Host* host) : host_(host), name_(name), piface_(this)
  57 {
  58   pid_           = simix_process_maxpid++;
  59   simcall.issuer = this;
  60 }
  61
  62 ActorImpl::~ActorImpl() = default;
  63
  64 /* Become an actor in the simulation
  65  *
  66  * Currently this can only be called by the main thread (once) and only work with some thread factories
  67  * (currently ThreadContextFactory).
  68  *
  69  * In the future, it might be extended in order to attach other threads created by a third party library.
  70  */
  71
  72 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
  73                                std::unordered_map<std::string, std::string>* properties)
  74 {
  75   // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
  76
  77   XBT_DEBUG("Attach process %s on host '%s'", name.c_str(), host->get_cname());
  78
  79   if (not host->is_on()) {
  80     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
  81     std::rethrow_exception(
  82         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.")));
  83   }
  84
  85   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
  86   /* Actor data */
  87   actor->set_user_data(data);
  88   actor->code = nullptr;
  89
  90   XBT_VERB("Create context %s", actor->get_cname());
  91   xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
  92   actor->context_.reset(simix_global->context_factory->attach(actor));
  93
  94   /* Add properties */
  95   if (properties != nullptr)
  96     for (auto const& kv : *properties)
  97       actor->set_property(kv.first, kv.second);
  98
  99   /* Add the process to it's host process list */
 100   host->pimpl_->process_list_.push_back(*actor);
 101
 102   /* Now insert it in the global process list and in the process to run list */
 103   simix_global->process_list[actor->get_pid()] = actor;
 104   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
 105   simix_global->actors_to_run.push_back(actor);
 106   intrusive_ptr_add_ref(actor);
 107
 108   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_.get());
 109   xbt_assert(nullptr != context, "Not a suitable context");
 110   context->attach_start();
 111
 112   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 113   simgrid::s4u::ActorPtr tmp = actor->iface(); // Passing this directly to on_creation will lead to crashes
 114   simgrid::s4u::Actor::on_creation(tmp);
 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()
 135 {
 136   finished_ = true;
 137
 138   if (has_to_auto_restart() && not get_host()->is_on()) {
 139     XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
 140               get_cname());
 141     watched_hosts.insert(get_host()->get_name());
 142   }
 143
 144   // Execute the termination callbacks
 145   smx_process_exit_status_t exit_status = (context_->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
 146   while (not on_exit.empty()) {
 147     s_smx_process_exit_fun_t exit_fun = on_exit.back();
 148     on_exit.pop_back();
 149     (exit_fun.fun)(exit_status, exit_fun.arg);
 150   }
 151
 152   /* cancel non-blocking activities */
 153   for (auto activity : comms)
 154     boost::static_pointer_cast<activity::CommImpl>(activity)->cancel();
 155   comms.clear();
 156
 157   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
 158
 159   if (this == simix_global->maestro_process) /* Do not cleanup maestro */
 160     return;
 161
 162   XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
 163
 164   /* Unregister from the kill timer if any */
 165   if (kill_timer != nullptr) {
 166     kill_timer->remove();
 167     kill_timer = nullptr;
 168   }
 169
 170   simix_global->mutex.lock();
 171
 172   simix_global->process_list.erase(pid_);
 173   if (host_ && host_process_list_hook.is_linked())
 174     simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
 175   if (not smx_destroy_list_hook.is_linked()) {
 176 #if SIMGRID_HAVE_MC
 177     xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
 178 #endif
 179     simix_global->actors_to_destroy.push_back(*this);
 180   }
 181
 182   simix_global->mutex.unlock();
 183
 184   context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
 185   simgrid::simix::simcall([this] { simgrid::s4u::Actor::on_destruction(iface()); });
 186   context_->iwannadie = true;
 187 }
 188
 189 void ActorImpl::exit()
 190 {
 191   context_->iwannadie = true;
 192   blocked_            = false;
 193   suspended_          = false;
 194   exception_          = nullptr;
 195
 196   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
 197   if (not host_->is_on())
 198     this->throw_exception(std::make_exception_ptr(ForcefulKillException("host failed")));
 199
 200   /* destroy the blocking synchro if any */
 201   if (waiting_synchro != nullptr) {
 202
 203     activity::ExecImplPtr exec   = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
 204     activity::CommImplPtr comm   = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
 205     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
 206     activity::RawImplPtr raw     = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
 207     activity::IoImplPtr io       = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
 208
 209     if (exec != nullptr && exec->surf_action_) {
 210       exec->cancel();
 211       exec->surf_action_->unref();
 212       exec->surf_action_ = nullptr;
 213     } else if (comm != nullptr) {
 214       comms.remove(waiting_synchro);
 215       comm->cancel();
 216       // Remove first occurrence of &actor->simcall:
 217       auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
 218       if (i != waiting_synchro->simcalls_.end())
 219         waiting_synchro->simcalls_.remove(&simcall);
 220     } else if (sleep != nullptr) {
 221       if (sleep->surf_action_)
 222         sleep->surf_action_->cancel();
 223       sleep->post();
 224     } else if (raw != nullptr) {
 225       raw->finish();
 226     } else if (io != nullptr) {
 227       io->cancel();
 228     } else {
 229       simgrid::kernel::activity::ActivityImplPtr activity = waiting_synchro;
 230       xbt_die("Activity %s is of unknown type %s", activity->get_cname(),
 231               simgrid::xbt::demangle(typeid(activity).name()).get());
 232     }
 233
 234     waiting_synchro = nullptr;
 235   }
 236 }
 237
 238 void ActorImpl::kill(ActorImpl* actor)
 239 {
 240   if (actor->finished_) {
 241     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
 242               actor->host_->get_cname());
 243     return;
 244   }
 245
 246   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
 247             actor->host_ ? actor->host_->get_cname() : "");
 248
 249   actor->exit();
 250
 251   if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
 252           end(simix_global->actors_to_run) &&
 253       actor != this) {
 254     XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
 255     simix_global->actors_to_run.push_back(actor);
 256   }
 257 }
 258
 259 void ActorImpl::kill_all()
 260 {
 261   for (auto const& kv : simix_global->process_list)
 262     if (kv.second != this)
 263       this->kill(kv.second);
 264 }
 265
 266 void ActorImpl::set_kill_time(double kill_time)
 267 {
 268   if (kill_time <= SIMIX_get_clock())
 269     return;
 270   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
 271   kill_timer = simix::Timer::set(kill_time, [this] {
 272     this->exit();
 273     kill_timer = nullptr;
 274   });
 275 }
 276
 277 double ActorImpl::get_kill_time()
 278 {
 279   return kill_timer ? kill_timer->get_date() : 0;
 280 }
 281
 282 static void dying_daemon(int /*exit_status*/, void* data)
 283 {
 284   std::vector<ActorImpl*>* vect = &simix_global->daemons;
 285
 286   auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
 287   xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
 288
 289   /* Don't move the whole content since we don't really care about the order */
 290   std::swap(*it, vect->back());
 291   vect->pop_back();
 292 }
 293
 294 void ActorImpl::yield()
 295 {
 296   XBT_DEBUG("Yield actor '%s'", get_cname());
 297
 298   /* Go into sleep and return control to maestro */
 299   context_->suspend();
 300
 301   /* Ok, maestro returned control to us */
 302   XBT_DEBUG("Control returned to me: '%s'", get_cname());
 303
 304   if (context_->iwannadie) {
 305     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
 306     // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
 307     context_->stop();
 308     THROW_IMPOSSIBLE;
 309   }
 310
 311   if (suspended_) {
 312     XBT_DEBUG("Hey! I'm suspended.");
 313
 314     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
 315     suspended_ = false;
 316     suspend(this);
 317   }
 318
 319   if (exception_ != nullptr) {
 320     XBT_DEBUG("Wait, maestro left me an exception");
 321     std::exception_ptr exception = std::move(exception_);
 322     exception_                   = nullptr;
 323     std::rethrow_exception(std::move(exception));
 324   }
 325
 326   if (SMPI_switch_data_segment && not finished_) {
 327     SMPI_switch_data_segment(iface());
 328   }
 329 }
 330
 331 /** This actor will be terminated automatically when the last non-daemon actor finishes */
 332 void ActorImpl::daemonize()
 333 {
 334   if (not daemon_) {
 335     daemon_ = true;
 336     simix_global->daemons.push_back(this);
 337     SIMIX_process_on_exit(this, dying_daemon, this);
 338   }
 339 }
 340
 341 s4u::Actor* ActorImpl::restart()
 342 {
 343   xbt_assert(this != simix_global->maestro_process, "Restarting maestro is not supported");
 344
 345   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
 346
 347   // retrieve the arguments of the old actor
 348   ProcessArg arg = ProcessArg(host_, this);
 349
 350   // kill the old actor
 351   context::Context::self()->get_actor()->kill(this);
 352
 353   // start the new actor
 354   ActorImplPtr actor =
 355       ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
 356   actor->set_kill_time(arg.kill_time);
 357   actor->set_auto_restart(arg.auto_restart);
 358
 359   return actor->ciface();
 360 }
 361
 362 activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
 363 {
 364   if (suspended_) {
 365     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
 366     return nullptr;
 367   }
 368
 369   suspended_ = true;
 370
 371   /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
 372   if (this != issuer) {
 373     if (waiting_synchro)
 374       waiting_synchro->suspend();
 375     /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
 376
 377     return nullptr;
 378   } else {
 379     return activity::ExecImplPtr(new activity::ExecImpl("suspend", ""))->set_host(host_)->start(0.0, 1.0, 0.0);
 380   }
 381 }
 382
 383 void ActorImpl::resume()
 384 {
 385   XBT_IN("actor = %p", this);
 386
 387   if (context_->iwannadie) {
 388     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
 389     return;
 390   }
 391
 392   if (not suspended_)
 393     return;
 394   suspended_ = false;
 395
 396   /* resume the synchronization that was blocking the resumed actor. */
 397   if (waiting_synchro)
 398     waiting_synchro->resume();
 399
 400   XBT_OUT();
 401 }
 402
 403 activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
 404 {
 405   activity::ActivityImplPtr res = this->sleep(timeout);
 406   intrusive_ptr_add_ref(res.get());
 407   SIMIX_process_on_exit(actor,
 408                         [](int, void* arg) {
 409                           auto sleep = static_cast<activity::SleepImpl*>(arg);
 410                           if (sleep->surf_action_)
 411                             sleep->surf_action_->finish(resource::Action::State::FINISHED);
 412                           intrusive_ptr_release(sleep);
 413                         },
 414                         res.get());
 415   return res;
 416 }
 417
 418 activity::ActivityImplPtr ActorImpl::sleep(double duration)
 419 {
 420   if (not host_->is_on())
 421     throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
 422         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
 423
 424   return activity::SleepImplPtr(new activity::SleepImpl())
 425       ->set_name("sleep")
 426       ->set_host(host_)
 427       ->set_duration(duration)
 428       ->start();
 429 }
 430
 431 void ActorImpl::throw_exception(std::exception_ptr e)
 432 {
 433   exception_ = e;
 434
 435   if (suspended_)
 436     resume();
 437
 438   /* cancel the blocking synchro if any */
 439   if (waiting_synchro) {
 440
 441     activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
 442     if (exec != nullptr)
 443       exec->cancel();
 444
 445     activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
 446     if (comm != nullptr) {
 447       comms.remove(comm);
 448       comm->cancel();
 449     }
 450
 451     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
 452     if (sleep != nullptr) {
 453       SIMIX_process_sleep_destroy(sleep);
 454       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
 455               end(simix_global->actors_to_run) &&
 456           this != SIMIX_process_self()) {
 457         XBT_DEBUG("Inserting [%p] %s in the to_run list", this, get_cname());
 458         simix_global->actors_to_run.push_back(this);
 459       }
 460     }
 461
 462     activity::RawImplPtr raw = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
 463     if (raw != nullptr) {
 464       raw->finish();
 465     }
 466
 467     activity::IoImplPtr io = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
 468     if (io != nullptr) {
 469       io->cancel();
 470     }
 471   }
 472   waiting_synchro = nullptr;
 473 }
 474
 475 void ActorImpl::set_host(s4u::Host* dest)
 476 {
 477   xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
 478   host_ = dest;
 479   dest->pimpl_->process_list_.push_back(*this);
 480 }
 481
 482 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
 483 {
 484   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
 485   actor->set_ppid(this->pid_);
 486
 487   intrusive_ptr_add_ref(actor);
 488   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 489   s4u::Actor::on_creation(actor->iface());
 490
 491   return ActorImplPtr(actor);
 492 }
 493
 494 ActorImpl* ActorImpl::start(const simix::ActorCode& code)
 495 {
 496   xbt_assert(code && host_ != nullptr, "Invalid parameters");
 497
 498   if (not host_->is_on()) {
 499     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
 500     intrusive_ptr_release(this);
 501     std::rethrow_exception(
 502         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.")));
 503   }
 504
 505   this->code = code;
 506   XBT_VERB("Create context %s", get_cname());
 507   context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
 508
 509   XBT_DEBUG("Start context '%s'", get_cname());
 510
 511   /* Add the actor to its host's actor list */
 512   host_->pimpl_->process_list_.push_back(*this);
 513   simix_global->process_list[pid_] = this;
 514
 515   /* Now insert it in the global actor list and in the actor to run list */
 516   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
 517   simix_global->actors_to_run.push_back(this);
 518
 519   return this;
 520 }
 521
 522 ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
 523                                std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
 524 {
 525   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
 526
 527   ActorImplPtr actor;
 528   if (parent_actor != nullptr)
 529     actor = parent_actor->init(xbt::string(name), host);
 530   else
 531     actor = SIMIX_process_self()->init(xbt::string(name), host);
 532
 533   /* actor data */
 534   actor->set_user_data(data);
 535
 536   /* Add properties */
 537   if (properties != nullptr)
 538     for (auto const& kv : *properties)
 539       actor->set_property(kv.first, kv.second);
 540
 541   actor->start(code);
 542
 543   return actor;
 544 }
 545
 546 void create_maestro(const std::function<void()>& code)
 547 {
 548   /* Create maestro actor and initialize it */
 549   ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
 550
 551   if (not code) {
 552     maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
 553   } else {
 554     maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
 555   }
 556
 557   maestro->simcall.issuer       = maestro;
 558   simix_global->maestro_process = maestro;
 559 }
 560
 561 } // namespace actor
 562 } // namespace kernel
 563 } // namespace simgrid
 564
 565 void SIMIX_process_detach()
 566 {
 567   simgrid::kernel::actor::ActorImpl::detach();
 568 }
 569
 570 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
 571                                  std::unordered_map<std::string, std::string>* properties,
 572                                  smx_actor_t /*parent_process*/)
 573 {
 574   return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
 575 }
 576
 577 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
 578  * transition */
 579 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
 580 {
 581   SMX_EXCEPTION(actor, cat, value, msg);
 582
 583   if (actor->is_suspended())
 584     actor->resume();
 585
 586   /* cancel the blocking synchro if any */
 587   if (actor->waiting_synchro) {
 588
 589     simgrid::kernel::activity::ExecImplPtr exec =
 590         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
 591     if (exec != nullptr)
 592       exec->cancel();
 593
 594     simgrid::kernel::activity::CommImplPtr comm =
 595         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
 596     if (comm != nullptr) {
 597       actor->comms.remove(comm);
 598       comm->cancel();
 599     }
 600
 601     simgrid::kernel::activity::SleepImplPtr sleep =
 602         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
 603     if (sleep != nullptr) {
 604       SIMIX_process_sleep_destroy(sleep);
 605       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
 606               end(simix_global->actors_to_run) &&
 607           actor != SIMIX_process_self()) {
 608         XBT_DEBUG("Inserting [%p] %s in the to_run list", actor, actor->get_cname());
 609         simix_global->actors_to_run.push_back(actor);
 610       }
 611     }
 612
 613     simgrid::kernel::activity::RawImplPtr raw =
 614         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
 615     if (raw != nullptr) {
 616       raw->finish();
 617     }
 618
 619     simgrid::kernel::activity::IoImplPtr io =
 620         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
 621     if (io != nullptr) {
 622       io->cancel();
 623     }
 624   }
 625   actor->waiting_synchro = nullptr;
 626 }
 627
 628 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
 629 {
 630   smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
 631
 632   if (actor != simcall->issuer) {
 633     SIMIX_simcall_answer(simcall);
 634   } else {
 635     sync_suspend->simcalls_.push_back(simcall);
 636     actor->waiting_synchro = sync_suspend;
 637     actor->waiting_synchro->suspend();
 638   }
 639   /* If we are suspending ourselves, then just do not finish the simcall now */
 640 }
 641
 642 int SIMIX_process_get_maxpid()
 643 {
 644   return simix_process_maxpid;
 645 }
 646
 647 int SIMIX_process_count()
 648 {
 649   return simix_global->process_list.size();
 650 }
 651
 652 void* SIMIX_process_self_get_data() // deprecated
 653 {
 654   smx_actor_t self = SIMIX_process_self();
 655
 656   if (self == nullptr) {
 657     return nullptr;
 658   }
 659   return self->get_user_data();
 660 }
 661
 662 void SIMIX_process_self_set_data(void* data) // deprecated
 663 {
 664   SIMIX_process_self()->set_user_data(data);
 665 }
 666
 667 /* needs to be public and without simcall because it is called
 668    by exceptions and logging events */
 669 const char* SIMIX_process_self_get_name()
 670 {
 671
 672   smx_actor_t process = SIMIX_process_self();
 673   if (process == nullptr || process == simix_global->maestro_process)
 674     return "maestro";
 675
 676   return process->get_cname();
 677 }
 678
 679 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
 680 {
 681   if (process->finished_) {
 682     // The joined process is already finished, just wake up the issuer process right away
 683     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 684     SIMIX_simcall_answer(simcall);
 685     return;
 686   }
 687   smx_activity_t sync = simcall->issuer->join(process, timeout);
 688   sync->simcalls_.push_back(simcall);
 689   simcall->issuer->waiting_synchro = sync;
 690 }
 691
 692 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
 693 {
 694   if (MC_is_active() || MC_record_replay_is_active()) {
 695     MC_process_clock_add(simcall->issuer, duration);
 696     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 697     SIMIX_simcall_answer(simcall);
 698     return;
 699   }
 700   smx_activity_t sync = simcall->issuer->sleep(duration);
 701   sync->simcalls_.push_back(simcall);
 702   simcall->issuer->waiting_synchro = sync;
 703 }
 704
 705 void SIMIX_process_sleep_destroy(simgrid::kernel::activity::SleepImplPtr sleep)
 706 {
 707   XBT_DEBUG("Destroy sleep synchro %p", sleep.get());
 708
 709   if (sleep->surf_action_) {
 710     sleep->surf_action_->unref();
 711     sleep->surf_action_ = nullptr;
 712   }
 713 }
 714
 715 /**
 716  * @brief Calling this function makes the process to yield.
 717  *
 718  * Only the current process can call this function, giving back the control to maestro.
 719  *
 720  * @param self the current process
 721  */
 722
 723 /** @brief Returns the list of processes to run.
 724  * @deprecated
 725  */
 726 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
 727 {
 728   return simix_global->actors_to_run;
 729 }
 730
 731 /** @brief Returns the process from PID. */
 732 smx_actor_t SIMIX_process_from_PID(aid_t PID)
 733 {
 734   auto actor = simix_global->process_list.find(PID);
 735   return actor == simix_global->process_list.end() ? nullptr : actor->second;
 736 }
 737
 738 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
 739 {
 740   SIMIX_process_on_exit(actor, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 741 }
 742
 743 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool, void*)>& fun, void* data)
 744 {
 745   xbt_assert(actor, "current process not found: are you in maestro context ?");
 746
 747   actor->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
 748 }
 749
 750 /** @brief Restart a process, starting it again from the beginning. */
 751 /**
 752  * @ingroup simix_process_management
 753  * @brief Creates and runs a new SIMIX process.
 754  *
 755  * The structure and the corresponding thread are created and put in the list of ready processes.
 756  *
 757  * @param name a name for the process. It is for user-level information and can be nullptr.
 758  * @param code the main function of the process
 759  * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
 760  * be nullptr.
 761  * It can be retrieved with the method ActorImpl::getUserData().
 762  * @param host where the new agent is executed.
 763  * @param properties the properties of the process
 764  */
 765 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
 766                                    sg_host_t host, std::unordered_map<std::string, std::string>* properties)
 767 {
 768   smx_actor_t self = SIMIX_process_self();
 769   return simgrid::simix::simcall([&name, &code, data, host, properties, self] {
 770     return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
 771   });
 772 }
 773
 774 void simcall_process_set_data(smx_actor_t process, void* data)
 775 {
 776   simgrid::simix::simcall([process, data] { process->set_user_data(data); });
 777 }