src/simix/ActorImpl.cpp

   1 /* Copyright (c) 2007-2018. 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 "smx_private.hpp"
   8 #include "src/kernel/activity/CommImpl.hpp"
   9 #include "src/kernel/activity/ExecImpl.hpp"
  10 #include "src/kernel/activity/IoImpl.hpp"
  11 #include "src/kernel/activity/SleepImpl.hpp"
  12 #include "src/kernel/activity/SynchroRaw.hpp"
  13 #include "src/mc/mc_replay.hpp"
  14 #include "src/mc/remote/Client.hpp"
  15 #include "src/simix/smx_host_private.hpp"
  16 #include "src/simix/smx_io_private.hpp"
  17 #include "src/simix/smx_synchro_private.hpp"
  18 #include "src/surf/HostImpl.hpp"
  19 #include "src/surf/cpu_interface.hpp"
  20 #include "xbt/ex.hpp"
  21
  22 #ifdef HAVE_SMPI
  23 #include "src/smpi/include/private.hpp"
  24 #endif
  25
  26 #include <boost/range/algorithm.hpp>
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
  29
  30 unsigned long simix_process_maxpid = 0;
  31
  32 /**
  33  * \brief Returns the current agent.
  34  *
  35  * This functions returns the currently running SIMIX process.
  36  *
  37  * \return The SIMIX process
  38  */
  39 smx_actor_t SIMIX_process_self()
  40 {
  41   smx_context_t self_context = SIMIX_context_self();
  42
  43   return (self_context != nullptr) ? self_context->process() : nullptr;
  44 }
  45
  46 /**
  47  * \brief Returns whether a process has pending asynchronous communications.
  48  * \return true if there are asynchronous communications in this process
  49  */
  50 int SIMIX_process_has_pending_comms(smx_actor_t process) {
  51
  52   return process->comms.size() > 0;
  53 }
  54
  55 /**
  56  * \brief Moves a process to the list of processes to destroy.
  57  */
  58 void SIMIX_process_cleanup(smx_actor_t process)
  59 {
  60   XBT_DEBUG("Cleanup process %s (%p), waiting synchro %p", process->get_cname(), process,
  61             process->waiting_synchro.get());
  62
  63   process->finished_ = true;
  64   SIMIX_process_on_exit_runall(process);
  65
  66   /* Unregister from the kill timer if any */
  67   if (process->kill_timer != nullptr) {
  68     SIMIX_timer_remove(process->kill_timer);
  69     process->kill_timer = nullptr;
  70   }
  71
  72   xbt_os_mutex_acquire(simix_global->mutex);
  73
  74   /* cancel non-blocking communications */
  75   while (not process->comms.empty()) {
  76     smx_activity_t synchro = process->comms.front();
  77     process->comms.pop_front();
  78     simgrid::kernel::activity::CommImplPtr comm =
  79         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
  80
  81     /* make sure no one will finish the comm after this process is destroyed,
  82      * because src_proc or dst_proc would be an invalid pointer */
  83
  84     if (comm->src_proc == process) {
  85       XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p", comm.get(),
  86                 comm->detached, (int)comm->state_, comm->src_proc, comm->dst_proc);
  87       comm->src_proc = nullptr;
  88
  89     } else if (comm->dst_proc == process) {
  90       XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p", comm.get(), (int)comm->state_,
  91                 comm->src_proc, comm->dst_proc);
  92       comm->dst_proc = nullptr;
  93
  94       if (comm->detached && comm->src_proc != nullptr) {
  95         /* the comm will be freed right now, remove it from the sender */
  96         comm->src_proc->comms.remove(comm);
  97       }
  98     } else {
  99       xbt_die("Communication synchro %p is in my list but I'm not the sender nor the receiver", synchro.get());
 100     }
 101     comm->cancel();
 102   }
 103
 104   XBT_DEBUG("%p should not be run anymore",process);
 105   simix_global->process_list.erase(process->pid_);
 106   if (process->host_ && process->host_process_list_hook.is_linked())
 107     simgrid::xbt::intrusive_erase(process->host_->pimpl_->process_list, *process);
 108   if (not process->smx_destroy_list_hook.is_linked()) {
 109 #if SIMGRID_HAVE_MC
 110     xbt_dynar_push_as(simix_global->dead_actors_vector, smx_actor_t, process);
 111 #endif
 112     simix_global->process_to_destroy.push_back(*process);
 113   }
 114   process->context_->iwannadie = 0;
 115
 116   xbt_os_mutex_release(simix_global->mutex);
 117 }
 118
 119 /**
 120  * Garbage collection
 121  *
 122  * Should be called some time to time to free the memory allocated for processes that have finished (or killed).
 123  */
 124 void SIMIX_process_empty_trash()
 125 {
 126   while (not simix_global->process_to_destroy.empty()) {
 127     smx_actor_t process = &simix_global->process_to_destroy.front();
 128     simix_global->process_to_destroy.pop_front();
 129     XBT_DEBUG("Getting rid of %p",process);
 130     intrusive_ptr_release(process);
 131   }
 132 #if SIMGRID_HAVE_MC
 133   xbt_dynar_reset(simix_global->dead_actors_vector);
 134 #endif
 135 }
 136
 137 namespace simgrid {
 138
 139 namespace kernel {
 140 namespace actor {
 141
 142 ActorImpl::~ActorImpl()
 143 {
 144   delete this->context_;
 145 }
 146
 147 static void dying_daemon(int /*exit_status*/, void* data)
 148 {
 149   std::vector<ActorImpl*>* vect = &simix_global->daemons;
 150
 151   auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
 152   xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
 153
 154   /* Don't move the whole content since we don't really care about the order */
 155   std::swap(*it, vect->back());
 156   vect->pop_back();
 157 }
 158
 159 /** This process will be terminated automatically when the last non-daemon process finishes */
 160 void ActorImpl::daemonize()
 161 {
 162   if (not daemon_) {
 163     daemon_ = true;
 164     simix_global->daemons.push_back(this);
 165     SIMIX_process_on_exit(this, dying_daemon, this);
 166   }
 167 }
 168
 169 simgrid::s4u::Actor* ActorImpl::restart()
 170 {
 171   XBT_DEBUG("Restarting process %s on %s", get_cname(), host_->get_cname());
 172
 173   // retrieve the arguments of the old process
 174   simgrid::kernel::actor::ProcessArg arg = ProcessArg(host_, this);
 175
 176   // kill the old process
 177   SIMIX_process_kill(this, (this == simix_global->maestro_process) ? this : SIMIX_process_self());
 178
 179   // start the new process
 180   ActorImpl* actor = simix_global->create_process_function(arg.name.c_str(), std::move(arg.code), arg.data, arg.host,
 181                                                            arg.properties.get(), nullptr);
 182   simcall_process_set_kill_time(actor, arg.kill_time);
 183   actor->set_auto_restart(arg.auto_restart);
 184
 185   return actor->ciface();
 186 }
 187
 188 smx_activity_t ActorImpl::suspend(ActorImpl* issuer)
 189 {
 190   if (suspended_) {
 191     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
 192     return nullptr;
 193   }
 194
 195   suspended_ = 1;
 196
 197   /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
 198   if (this != issuer) {
 199     if (waiting_synchro)
 200       waiting_synchro->suspend();
 201     /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
 202
 203     return nullptr;
 204   } else {
 205     return SIMIX_execution_start("suspend", 0.0, 1.0, 0.0, this->host_);
 206   }
 207 }
 208
 209 void ActorImpl::resume()
 210 {
 211   XBT_IN("process = %p", this);
 212
 213   if (context_->iwannadie) {
 214     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
 215     return;
 216   }
 217
 218   if (not suspended_)
 219     return;
 220   suspended_ = 0;
 221
 222   /* resume the synchronization that was blocking the resumed actor. */
 223   if (waiting_synchro)
 224     waiting_synchro->resume();
 225
 226   XBT_OUT();
 227 }
 228
 229 smx_activity_t ActorImpl::sleep(double duration)
 230 {
 231   if (host_->is_off())
 232     THROWF(host_error, 0, "Host %s failed, you cannot sleep there.", host_->get_cname());
 233
 234   simgrid::kernel::activity::SleepImpl* synchro = new simgrid::kernel::activity::SleepImpl();
 235   synchro->host                                 = host_;
 236   synchro->surf_sleep                           = host_->pimpl_cpu->sleep(duration);
 237   synchro->surf_sleep->set_data(synchro);
 238   XBT_DEBUG("Create sleep synchronization %p", synchro);
 239
 240   return synchro;
 241 }
 242
 243 void create_maestro(simgrid::simix::ActorCode code)
 244 {
 245   smx_actor_t maestro = nullptr;
 246   /* Create maestro process and initialize it */
 247   maestro           = new simgrid::kernel::actor::ActorImpl();
 248   maestro->pid_     = simix_process_maxpid++;
 249   maestro->name_    = "";
 250   maestro->set_user_data(nullptr);
 251
 252   if (not code) {
 253     maestro->context_ = SIMIX_context_new(simgrid::simix::ActorCode(), nullptr, maestro);
 254   } else {
 255     if (not simix_global)
 256       xbt_die("simix is not initialized, please call MSG_init first");
 257     maestro->context_ = simix_global->context_factory->create_maestro(code, maestro);
 258   }
 259
 260   maestro->simcall.issuer = maestro;
 261   simix_global->maestro_process = maestro;
 262 }
 263
 264 } // namespace actor
 265 }
 266 }
 267
 268 /** @brief Creates and runs the maestro process */
 269 void SIMIX_maestro_create(void (*code)(void*), void* data)
 270 {
 271   simgrid::kernel::actor::create_maestro(std::bind(code, data));
 272 }
 273
 274 /**
 275  * \brief Internal function to create a process.
 276  *
 277  * This function actually creates the process.
 278  * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
 279  * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
 280  *
 281  * \return the process created
 282  */
 283 smx_actor_t SIMIX_process_create(const char* name, simgrid::simix::ActorCode code, void* data, simgrid::s4u::Host* host,
 284                                  std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
 285 {
 286
 287   XBT_DEBUG("Start process %s on host '%s'", name, host->get_cname());
 288
 289   if (host->is_off()) {
 290     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, host->get_cname());
 291     return nullptr;
 292   }
 293
 294   smx_actor_t process = new simgrid::kernel::actor::ActorImpl();
 295
 296   xbt_assert(code && host != nullptr, "Invalid parameters");
 297   /* Process data */
 298   process->pid_           = simix_process_maxpid++;
 299   process->name_          = simgrid::xbt::string(name);
 300   process->host_          = host;
 301   process->set_user_data(data);
 302   process->simcall.issuer = process;
 303
 304   if (parent_process != nullptr) {
 305     process->ppid_ = parent_process->pid_;
 306   }
 307
 308   process->code         = code;
 309
 310   XBT_VERB("Create context %s", process->get_cname());
 311   process->context_ = SIMIX_context_new(std::move(code), simix_global->cleanup_process_function, process);
 312
 313   /* Add properties */
 314   if (properties != nullptr)
 315     for (auto const& kv : *properties)
 316       process->set_property(kv.first, kv.second);
 317
 318   /* Add the process to its host's process list */
 319   host->pimpl_->process_list.push_back(*process);
 320
 321   XBT_DEBUG("Start context '%s'", process->get_cname());
 322
 323   /* Now insert it in the global process list and in the process to run list */
 324   simix_global->process_list[process->pid_] = process;
 325   XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
 326   simix_global->process_to_run.push_back(process);
 327   intrusive_ptr_add_ref(process);
 328
 329   /* The onCreation() signal must be delayed until there, where the pid and everything is set */
 330   simgrid::s4u::ActorPtr tmp = process->iface(); // Passing this directly to onCreation will lead to crashes
 331   simgrid::s4u::Actor::on_creation(tmp);
 332
 333   return process;
 334 }
 335
 336 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
 337                                  std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
 338 {
 339   // This is mostly a copy/paste from SIMIX_process_new(),
 340   // it'd be nice to share some code between those two functions.
 341
 342   sg_host_t host = sg_host_by_name(hostname);
 343   XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
 344
 345   if (host->is_off()) {
 346     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
 347     return nullptr;
 348   }
 349
 350   smx_actor_t process = new simgrid::kernel::actor::ActorImpl();
 351   /* Process data */
 352   process->pid_  = simix_process_maxpid++;
 353   process->name_ = std::string(name);
 354   process->host_ = host;
 355   process->set_user_data(data);
 356   process->simcall.issuer = process;
 357
 358   if (parent_process != nullptr) {
 359     process->ppid_ = parent_process->pid_;
 360   }
 361
 362   /* Process data for auto-restart */
 363   process->code = nullptr;
 364
 365   XBT_VERB("Create context %s", process->get_cname());
 366   if (not simix_global)
 367     xbt_die("simix is not initialized, please call MSG_init first");
 368   process->context_ = simix_global->context_factory->attach(simix_global->cleanup_process_function, process);
 369
 370   /* Add properties */
 371   if (properties != nullptr)
 372     for (auto const& kv : *properties)
 373       process->set_property(kv.first, kv.second);
 374
 375   /* Add the process to it's host process list */
 376   host->pimpl_->process_list.push_back(*process);
 377
 378   /* Now insert it in the global process list and in the process to run list */
 379   simix_global->process_list[process->pid_] = process;
 380   XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
 381   simix_global->process_to_run.push_back(process);
 382   intrusive_ptr_add_ref(process);
 383
 384   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context_);
 385   if (not context)
 386     xbt_die("Not a suitable context");
 387
 388   context->attach_start();
 389
 390   /* The onCreation() signal must be delayed until there, where the pid and everything is set */
 391   simgrid::s4u::ActorPtr tmp = process->iface(); // Passing this directly to onCreation will lead to crashes
 392   simgrid::s4u::Actor::on_creation(tmp);
 393
 394   return process;
 395 }
 396
 397 void SIMIX_process_detach()
 398 {
 399   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
 400   if (not context)
 401     xbt_die("Not a suitable context");
 402
 403   auto process = context->process();
 404   simix_global->cleanup_process_function(process);
 405   context->attach_stop();
 406 }
 407
 408 /**
 409  * \brief Executes the processes from simix_global->process_to_run.
 410  *
 411  * The processes of simix_global->process_to_run are run (in parallel if
 412  * possible).  On exit, simix_global->process_to_run is empty, and
 413  * simix_global->process_that_ran contains the list of processes that just ran.
 414  * The two lists are swapped so, be careful when using them before and after a
 415  * call to this function.
 416  */
 417 void SIMIX_process_runall()
 418 {
 419   SIMIX_context_runall();
 420
 421   simix_global->process_to_run.swap(simix_global->process_that_ran);
 422   simix_global->process_to_run.clear();
 423 }
 424
 425 /**
 426  * \brief Internal function to kill a SIMIX process.
 427  *
 428  * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
 429  * or directly for SIMIX internal purposes.
 430  *
 431  * \param process poor victim
 432  * \param issuer the process which has sent the PROCESS_KILL. Important to not schedule twice the same process.
 433  */
 434 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
 435
 436   if (process->finished_) {
 437     XBT_DEBUG("Ignoring request to kill process %s@%s that is already dead", process->get_cname(),
 438               process->host_->get_cname());
 439     return;
 440   }
 441
 442   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", issuer->get_cname(), issuer->host_->get_cname(),
 443             process->get_cname(), process->host_->get_cname());
 444
 445   process->context_->iwannadie = 1;
 446   process->blocked_           = 0;
 447   process->suspended_         = 0;
 448   process->exception = nullptr;
 449
 450   /* destroy the blocking synchro if any */
 451   if (process->waiting_synchro != nullptr) {
 452
 453     simgrid::kernel::activity::ExecImplPtr exec =
 454         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
 455     simgrid::kernel::activity::CommImplPtr comm =
 456         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
 457     simgrid::kernel::activity::SleepImplPtr sleep =
 458         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro);
 459     simgrid::kernel::activity::RawImplPtr raw =
 460         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro);
 461     simgrid::kernel::activity::IoImplPtr io =
 462         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
 463
 464     if (exec != nullptr) {
 465       if (exec->surf_action_) {
 466         exec->surf_action_->cancel();
 467         exec->surf_action_->unref();
 468         exec->surf_action_ = nullptr;
 469       }
 470     } else if (comm != nullptr) {
 471       process->comms.remove(process->waiting_synchro);
 472       comm->cancel();
 473       // Remove first occurrence of &process->simcall:
 474       auto i = boost::range::find(process->waiting_synchro->simcalls_, &process->simcall);
 475       if (i != process->waiting_synchro->simcalls_.end())
 476         process->waiting_synchro->simcalls_.remove(&process->simcall);
 477     } else if (sleep != nullptr) {
 478       SIMIX_process_sleep_destroy(process->waiting_synchro);
 479
 480     } else if (raw != nullptr) {
 481       SIMIX_synchro_stop_waiting(process, &process->simcall);
 482
 483     } else if (io != nullptr) {
 484       SIMIX_io_destroy(process->waiting_synchro);
 485     } else {
 486       xbt_die("Unknown type of activity");
 487     }
 488
 489     process->waiting_synchro = nullptr;
 490   }
 491   if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), process) ==
 492           end(simix_global->process_to_run) &&
 493       process != issuer) {
 494     XBT_DEBUG("Inserting %s in the to_run list", process->get_cname());
 495     simix_global->process_to_run.push_back(process);
 496   }
 497 }
 498
 499 /** @brief Ask another process to raise the given exception
 500  *
 501  * @param process The process that should raise that exception
 502  * @param cat category of exception
 503  * @param value value associated to the exception
 504  * @param msg string information associated to the exception
 505  */
 506 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg) {
 507   SMX_EXCEPTION(process, cat, value, msg);
 508
 509   if (process->suspended_)
 510     process->resume();
 511
 512   /* cancel the blocking synchro if any */
 513   if (process->waiting_synchro) {
 514
 515     simgrid::kernel::activity::ExecImplPtr exec =
 516         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
 517     if (exec != nullptr && exec->surf_action_)
 518       exec->surf_action_->cancel();
 519
 520     simgrid::kernel::activity::CommImplPtr comm =
 521         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
 522     if (comm != nullptr) {
 523       process->comms.remove(comm);
 524       comm->cancel();
 525     }
 526
 527     simgrid::kernel::activity::SleepImplPtr sleep =
 528         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro);
 529     if (sleep != nullptr) {
 530       SIMIX_process_sleep_destroy(process->waiting_synchro);
 531       if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), process) ==
 532               end(simix_global->process_to_run) &&
 533           process != SIMIX_process_self()) {
 534         XBT_DEBUG("Inserting %s in the to_run list", process->get_cname());
 535         simix_global->process_to_run.push_back(process);
 536       }
 537     }
 538
 539     simgrid::kernel::activity::RawImplPtr raw =
 540         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro);
 541     if (raw != nullptr) {
 542       SIMIX_synchro_stop_waiting(process, &process->simcall);
 543     }
 544
 545     simgrid::kernel::activity::IoImplPtr io =
 546         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
 547     if (io != nullptr) {
 548       SIMIX_io_destroy(process->waiting_synchro);
 549     }
 550   }
 551   process->waiting_synchro = nullptr;
 552
 553 }
 554
 555 /**
 556  * \brief Kills all running processes.
 557  * \param issuer this one will not be killed
 558  */
 559 void SIMIX_process_killall(smx_actor_t issuer)
 560 {
 561   for (auto const& kv : simix_global->process_list)
 562     if (kv.second != issuer)
 563       SIMIX_process_kill(kv.second, issuer);
 564 }
 565
 566 void SIMIX_process_change_host(smx_actor_t actor, sg_host_t dest)
 567 {
 568   xbt_assert((actor != nullptr), "Invalid parameters");
 569   simgrid::xbt::intrusive_erase(actor->host_->pimpl_->process_list, *actor);
 570   actor->host_ = dest;
 571   dest->pimpl_->process_list.push_back(*actor);
 572 }
 573
 574 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
 575 {
 576   smx_activity_t sync_suspend = process->suspend(simcall->issuer);
 577
 578   if (process != simcall->issuer) {
 579     SIMIX_simcall_answer(simcall);
 580   } else {
 581     sync_suspend->simcalls_.push_back(simcall);
 582     process->waiting_synchro = sync_suspend;
 583     process->waiting_synchro->suspend();
 584   }
 585   /* If we are suspending ourselves, then just do not finish the simcall now */
 586 }
 587
 588 int SIMIX_process_get_maxpid() {
 589   return simix_process_maxpid;
 590 }
 591
 592 int SIMIX_process_count()
 593 {
 594   return simix_global->process_list.size();
 595 }
 596
 597 void* SIMIX_process_self_get_data()
 598 {
 599   smx_actor_t self = SIMIX_process_self();
 600
 601   if (not self) {
 602     return nullptr;
 603   }
 604   return self->get_user_data();
 605 }
 606
 607 void SIMIX_process_self_set_data(void *data)
 608 {
 609   SIMIX_process_self()->set_user_data(data);
 610 }
 611
 612
 613 /* needs to be public and without simcall because it is called
 614    by exceptions and logging events */
 615 const char* SIMIX_process_self_get_name() {
 616
 617   smx_actor_t process = SIMIX_process_self();
 618   if (process == nullptr || process == simix_global->maestro_process)
 619     return "maestro";
 620
 621   return process->get_cname();
 622 }
 623
 624 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
 625 {
 626   if (process->finished_) {
 627     // The joined process is already finished, just wake up the issuer process right away
 628     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 629     SIMIX_simcall_answer(simcall);
 630     return;
 631   }
 632   smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
 633   sync->simcalls_.push_back(simcall);
 634   simcall->issuer->waiting_synchro = sync;
 635 }
 636
 637 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
 638 {
 639   smx_activity_t res = issuer->sleep(timeout);
 640   intrusive_ptr_add_ref(res.get());
 641   SIMIX_process_on_exit(process,
 642                         [](int, void* arg) {
 643                           auto sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(arg);
 644                           if (sleep->surf_sleep)
 645                             sleep->surf_sleep->finish(simgrid::kernel::resource::Action::State::FINISHED);
 646                           intrusive_ptr_release(sleep);
 647                         },
 648                         res.get());
 649   return res;
 650 }
 651
 652 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
 653 {
 654   if (MC_is_active() || MC_record_replay_is_active()) {
 655     MC_process_clock_add(simcall->issuer, duration);
 656     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 657     SIMIX_simcall_answer(simcall);
 658     return;
 659   }
 660   smx_activity_t sync = simcall->issuer->sleep(duration);
 661   sync->simcalls_.push_back(simcall);
 662   simcall->issuer->waiting_synchro = sync;
 663 }
 664
 665 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
 666 {
 667   XBT_DEBUG("Destroy sleep synchro %p", synchro.get());
 668   simgrid::kernel::activity::SleepImplPtr sleep =
 669       boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(synchro);
 670
 671   if (sleep->surf_sleep) {
 672     sleep->surf_sleep->unref();
 673     sleep->surf_sleep = nullptr;
 674   }
 675 }
 676
 677 /**
 678  * \brief Calling this function makes the process to yield.
 679  *
 680  * Only the current process can call this function, giving back the control to maestro.
 681  *
 682  * \param self the current process
 683  */
 684 void SIMIX_process_yield(smx_actor_t self)
 685 {
 686   XBT_DEBUG("Yield actor '%s'", self->get_cname());
 687
 688   /* Go into sleep and return control to maestro */
 689   self->context_->suspend();
 690
 691   /* Ok, maestro returned control to us */
 692   XBT_DEBUG("Control returned to me: '%s'", self->get_cname());
 693
 694   if (self->context_->iwannadie) {
 695     XBT_DEBUG("I wanna die!");
 696     self->finished_ = true;
 697     /* execute the on_exit functions */
 698     SIMIX_process_on_exit_runall(self);
 699     /* Add the process to the list of process to restart, only if the host is down */
 700     if (self->auto_restart_ && self->host_->is_off()) {
 701       SIMIX_host_add_auto_restart_process(self->host_, self);
 702     }
 703     XBT_DEBUG("Process %s@%s is dead", self->get_cname(), self->host_->get_cname());
 704     self->context_->stop();
 705   }
 706
 707   if (self->suspended_) {
 708     XBT_DEBUG("Hey! I'm suspended.");
 709     xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
 710     self->suspended_ = 0;
 711     self->suspend(self);
 712   }
 713
 714   if (self->exception != nullptr) {
 715     XBT_DEBUG("Wait, maestro left me an exception");
 716     std::exception_ptr exception = std::move(self->exception);
 717     self->exception = nullptr;
 718     std::rethrow_exception(std::move(exception));
 719   }
 720
 721   if (SMPI_switch_data_segment && not self->finished_) {
 722     SMPI_switch_data_segment(self->iface());
 723   }
 724 }
 725
 726 /** @brief Returns the list of processes to run. */
 727 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
 728 {
 729   return simix_global->process_to_run;
 730 }
 731
 732 /** @brief Returns the process from PID. */
 733 smx_actor_t SIMIX_process_from_PID(aid_t PID)
 734 {
 735   auto process = simix_global->process_list.find(PID);
 736   return process == simix_global->process_list.end() ? nullptr : process->second;
 737 }
 738
 739 void SIMIX_process_on_exit_runall(smx_actor_t process) {
 740   simgrid::s4u::Actor::on_destruction(process->iface());
 741   smx_process_exit_status_t exit_status = (process->context_->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
 742   while (not process->on_exit.empty()) {
 743     s_smx_process_exit_fun_t exit_fun = process->on_exit.back();
 744     process->on_exit.pop_back();
 745     (exit_fun.fun)(exit_status, exit_fun.arg);
 746   }
 747 }
 748
 749 void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data)
 750 {
 751   SIMIX_process_on_exit(process, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 752 }
 753
 754 void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data)
 755 {
 756   xbt_assert(process, "current process not found: are you in maestro context ?");
 757
 758   process->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
 759 }
 760
 761 /** @brief Restart a process, starting it again from the beginning. */
 762 /**
 763  * \ingroup simix_process_management
 764  * \brief Creates and runs a new SIMIX process.
 765  *
 766  * The structure and the corresponding thread are created and put in the list of ready processes.
 767  *
 768  * \param name a name for the process. It is for user-level information and can be nullptr.
 769  * \param code the main function of the process
 770  * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
 771  * be nullptr.
 772  * It can be retrieved with the method ActorImpl::getUserData().
 773  * \param host where the new agent is executed.
 774  * \param argc first argument passed to \a code
 775  * \param argv second argument passed to \a code
 776  * \param properties the properties of the process
 777  */
 778 smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc,
 779                                    char** argv, std::unordered_map<std::string, std::string>* properties)
 780 {
 781   if (name == nullptr)
 782     name = "";
 783   auto wrapped_code = simgrid::xbt::wrap_main(code, argc, argv);
 784   for (int i = 0; i != argc; ++i)
 785     xbt_free(argv[i]);
 786   xbt_free(argv);
 787   smx_actor_t res = simcall_process_create(name, std::move(wrapped_code), data, host, properties);
 788   return res;
 789 }
 790
 791 smx_actor_t simcall_process_create(const char* name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
 792                                    std::unordered_map<std::string, std::string>* properties)
 793 {
 794   if (name == nullptr)
 795     name = "";
 796   smx_actor_t self = SIMIX_process_self();
 797   return simgrid::simix::simcall([name, code, data, host, properties, self] {
 798     return SIMIX_process_create(name, std::move(code), data, host, properties, self);
 799   });
 800 }