src/simix/ActorImpl.cpp

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