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