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