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